Use Clang/LLVM with the GDK for consoles

​

Required Visual Studio versions and components

​

Compiler and linker switches

  -Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-reserved-id-macro
  -Wno-pragma-pack -Wno-unknown-pragmas
  -Wno-unused-command-line-argument

​

Supported CPU intrinsics

• https://walbourn.github.io/directxmath-3.14/

​

Using Clang/LLVM with msbuild

<PlatformToolset>ClangCl</PlatformToolset>

1>Game.cpp(56,13): warning : Game.cpp: TODO in Update [-W#pragma-messages]
1>Game.cpp(58,5): warning : expression result unused [-Wunused-value]
1>Game.cpp(79,13): warning : Game.cpp: TODO in Render [-W#pragma-messages]
1>Game.cpp(81,5): warning : expression result unused [-Wunused-value]
1>Game.cpp(137,13): warning : Game.cpp: TODO in CreateDeviceDependentResources [-W#pragma-messages]
1>Game.cpp(139,5): warning : expression result unused [-Wunused-value]
1>Game.cpp(145,13): warning : Game.cpp: TODO in CreateWindowSizeDependentResources [-W#pragma-messages]

​

Using Clang/LLVM with cmake

​

Using CMakeExample

1. Use Visual Studio’s Open Local Folder option to open the Desktop, XBOX Series X|S, or XboxOne folder in the root CMakeExample folder.

​

CMakePresets.json integration

2. In Solution Explorer, double-click the CMakePresets.json file.

"cacheVariables": {
  "XdkEditionTarget": "260400",
  "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}"
}

3. Select the x64-Debug-Clang or x64-Release-Clang preset.

​

CMakeSettings.json integration

2. In Solution Explorer, double-click the CMakeSettings.json file.
3. Select the PLUS icon and choose x64-Clang-Debug and x64-Clang-Release as shown in the following figure. Save the changes.

4. Select Edit Json, and then cut and paste the variables section from another configuration to the new Clang configurations as in the following example. Set the XDKEditionTarget value to the one appropriate for your version of the GDK including QFE level.

"variables": [
  {
    "name": "XdkEditionTarget",
    "value": "260400",
    "type": "STRING"
  }
]

5. After saving all changes, select x64-Clang-Debug or x64-Clang-Release from the build configuration dropdown and build.

​

Using CMakeGDKExample

1. Use Visual Studio’s Open Local Folder option to open the CMakeGDKExample folder.

​

CMakePresets.json integration

2. In Solution Explorer, double-click the CMakePresets.json file.

"cacheVariables": {
  "XdkEditionTarget": "260400",
  "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}"
}

3. Select the x64-Scarlett-Clang or x64-XboxOne-Clang preset.

​

CMakeSettings.json integration

2. In Solution Explorer, double-click the CMakeSettings.json file.
3. Select the configuration you want to edit. Set the Toolset value to clang_cl_x64. Save and close.

4. For XBOX One and XBOX Series X|S configurations, select Edit Json and ensure the XdkEditionTarget variable matches your GDK edition and QFE level.
5. Select the desired value from the configuration dropdown and choose Rebuild All from the Build menu.
6. Use File -> Open -> Project/Solution to select the generated solution and project. For example:

​

Obtaining support

​

Known issues

• The Clang/LLVM toolset is significantly more verbose than Visual C++, especially when you use -Wall -Wextra -Wpedantic. At a minimum, suppress the following warnings either on the command line or as a #pragma:

#ifdef __clang__
#pragma clang diagnostic ignored "-Wc++98-compat"
#pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
#pragma clang diagnostic ignored "-Wgnu-anonymous-struct"
#pragma clang diagnostic ignored "-Wlanguage-extension-token"
#pragma clang diagnostic ignored "-Wnested-anon-types"
#pragma clang diagnostic ignored "-Wreserved-id-macro"
#pragma clang diagnostic ignored "-Wunknown-pragmas"
#endif

• The XBOX tooling only works with Microsoft PDBs for debugging symbols, and it doesn’t support the CodeView or DWARF debugging information that LLVM .ld files emit.
• Clang/LLVM’s implementation of Link-Time Code Generation is distinctly different from the Microsoft Visual C++ solution. You can’t mix code that uses Link-Time Code Generation between MSVC and clang/LLVM.
• As of the October 2022 release and the Windows SDK (10.0.22621), C++ static libraries include eXtended Flow Control Guard (XFG) metadata. The ld linker before the v15 release always emits a harmless warning when you use these libraries:

lld-link: warning/error: ignoring unknown debug$S subsection kind 0xFF in file xgameruntime.lib

• vcpkg Package Manager MSBuild integration doesn’t work properly with lld-link since it uses wildcards in library filenames. You can work around this problem by setting <UseLldLink>false</UseLldLink> in the vcxproj. This problem doesn’t affect vcpkg CMake integration using VS project generators.
• When building for XBOX with clang v18 in C++20 mode, two symbols are undefined when using WRL headers due to template evaluation changes.

wrl\implements.h(115,11): error : no member named 'RoOriginateError' in the global namespace
wrl/event.h(681,17): error : no member named 'RoTransformError' in the global namespace
wrl/event.h(712,18): error : no member named 'RoTransformError' in the global namespace

#include <wrl/client.h>

#if (__cplusplus >= 202002L) && (WINAPI_FAMILY == WINAPI_FAMILY_GAMES)
inline BOOL RoOriginateError(HRESULT, HSTRING) { return TRUE; }
inline BOOL RoTransformError(HRESULT, HRESULT, HSTRING) { return TRUE; }
#endif

#include <wrl/event.h>

​

See also