⏳ This skill is pending AI review.

Scores will appear once the review pipeline completes.

version unknown

release

microsoft@microsoft⭐ 2.9k stars· last commit 12d ago· 35 open issues

Guide for performing the DirectX Tool Kit for DirectX 11 release process. Use this skill when asked to help with releasing a new version, publishing packages, or updating ports.

Choose how to use this skill

You do not need every option. Choose the path your AI client supports. The stable page stays the same; versioned files are immutable.

1. Native installer

This listing has no registered native installer command. Use the complete package or source fallback below, depending on what your client supports.

Do not guess an installer command or replace an existing version without reviewing the diff.

2. Complete package recommended

Download the ZIP when available. It includes SKILL.md plus the references, security notes and version metadata.

No complete ProSkills package is published for this listing yet.

3. Prompt-only

Copy the prompt above when the agent can read the stable page or when you want to adopt the workflow without installing a skill.

Need only the instruction file?

Download SKILL.md only if your client requires a single file. The complete ZIP is safer for a full installation because it preserves the references and release context.

No path installs or executes anything by itself. Your agent still needs access to the project files. Before updating, compare the installed version and review the diff.

—/10

// RATINGS

⭐GitHub Stars
⭐⭐⭐⭐⭐ 2.9k on GitHubGitHub ↗

Very popular

🟢ProSkills Score
—
📍

Not yet listed on ClawHub or SkillsMP

// README

DirectX Logo

DirectX Tool Kit for DirectX 11

https://go.microsoft.com/fwlink/?LinkId=248929

Copyright (c) Microsoft Corporation.

May 7, 2026

This package contains the "DirectX Tool Kit", a collection of helper classes for writing Direct3D 11 C++ code for Win32 desktop applications for Windows 8.1 or later, Xbox One, and Universal Windows Platform (UWP) apps for Windows 10 and Windows 11.

This code is designed to build with Visual Studio 2022, Visual Studio 2026, clang for Windows v12 or later, or MinGW. Use of the Windows 11 SDK (22000) or later is required for Visual Studio.

These components are designed to work without requiring any content from the legacy DirectX SDK. For details, see Where is the DirectX SDK?.

Directory Layout

  • Inc\

    • Public Header Files (in the DirectX C++ namespace):

      • Audio.h - low-level audio API using XAudio2 (DirectXTK for Audio public header)
      • BufferHelpers.h - C++ helpers for creating D3D resources from CPU data
      • CommonStates.h - factory providing commonly used D3D state objects
      • DDSTextureLoader.h - light-weight DDS file texture loader
      • DirectXHelpers.h - misc C++ helpers for D3D programming
      • Effects.h - set of built-in shaders for common rendering tasks
      • GamePad.h - gamepad controller helper using XInput, Windows.Gaming.Input, or GameInput
      • GeometricPrimitive.h - draws basic shapes such as cubes and spheres
      • GraphicsMemory.h - helper for managing dynamic graphics memory allocation
      • Keyboard.h - keyboard state tracking helper
      • Model.h - draws meshes loaded from .CMO, .SDKMESH, or .VBO files
      • Mouse.h - mouse helper
      • PostProcess.h - set of built-in shaders for common post-processing operations
      • PrimitiveBatch.h - simple and efficient way to draw user primitives
      • ScreenGrab.h - light-weight screen shot saver
      • SimpleMath.h - simplified C++ wrapper for DirectXMath
      • SpriteBatch.h - simple & efficient 2D sprite rendering
      • SpriteFont.h - bitmap based text rendering
      • VertexTypes.h - structures for commonly used vertex data formats
      • WICTextureLoader.h - WIC-based image file texture loader
      • XboxDDSTextureLoader.h - Xbox One exclusive apps variant of DDSTextureLoader
  • Src\

    • DirectXTK source files and internal implementation headers
  • Audio\

    • DirectXTK for Audio source files and internal implementation headers
  • MakeSpriteFont\

    • Command line tool used to generate binary resources for use with SpriteFont
  • XWBTool\

    • Command line tool for building XACT-style wave banks for use with DirectXTK for Audio's WaveBank class
  • build\

    • Contains miscellaneous build files and scripts.
  • skills\

    • Contains published CoPilot skills for use by developers.

Documentation

Documentation is available on the GitHub wiki.

CoPilot Usage

For CoPilot CLI assistance with using DirectX Tool Kit, try:

winget install GitHub.Copilot
winget install GitHub.cli
gh skill install microsoft/directxtk
copilot
/skills list

Notices

All content and source code for this package are subject to the terms of the MIT License.

For the latest version of DirectXTK, bug reports, etc. please visit the project site on GitHub.

Release Notes

FOR SECURITY ADVISORIES, see GitHub.

For a full change history, see CHANGELOG.md.

  • clang-format use for this project must match the version use by GitHub Super-Linter to pass the validation. VS 2022 and VS 2026 come with different versions, so to match use:
winget install --id=LLVM.LLVM --version 22.1.3
powershell -File build/Format.ps1 -LLVM
  • The directxtk_desktop_win10 and directxtk_uwp NuGet packages are deprecated. The best way to integrate the latest DirectX Tool Kit into your C++ project is using vcpkg.

  • The CMake projects require 3.21 or later.

  • Starting with the July 2026 release, support for Direct3D Hardware Feature Level 9.x has been retired. All shaders are built using Shader Model 4, and therefore require D3D_FEATURE_LEVEL_10_0 or greater.

  • Starting with the March 2025 release, Windows 7 and Windows 8.0 support has been retired. For DirectX ToolKit for Audio this means that DirectXTKAudio_Desktop_*_Win7 has been removed, and DirectXTKAudio_Desktop_*_Win8 has been integrated into the DirectXTK_Desktop_* vcxproj which uses XAudio 2.8 for Windows 8.1 compatibility.

    • Remove any References to or use of DirectXTKAudio_Desktop_*_Win8.vcxproj or DirectXTKAudio_Desktop_*_Win7. If using DirectXTK_Desktop_*.vcxproj you will be using XAudio 2.8 as before. Client code will need to build with _WIN32_WINNT=0x0603.

    • If you want to use XAudio2Redist with Windows 8.1, the CMake project supports this with the build option BUILD_XAUDIO_REDIST. The CMake build option BUILD_XAUDIO_WIN7 was renamed.

    • When using XAudio 2.8 for Windows 8.1, there is no xWMA format support. This is available when using XAudio 2.9 or XAudio2Redist.

  • Starting with the February 2023 release, the Mouse class implementation of relative mouse movement was updated to accumulate changes between calls to GetState. By default, each time you call GetState the deltas are reset which works for scenarios where you use relative movement but only call the method once per frame. If you call it more than once per frame, then add an explicit call to EndOfInputFrame to use an explicit reset model instead.

  • As of the September 2022 release, the library makes use of C++11 inline namespaces for differing types that have the same names in the DirectX 11 and DirectX 12 version of the DirectX Tool Kit. This provides a link-unique name such as DirectX::DX11::SpriteBatch that will appear in linker output messages. In most use cases, however, there is no need to add explicit DX11 namespace resolution in client code.

  • Starting with the July 2022 release, the bool forceSRGB parameter for DDSTextureLoader Ex functions is now a DDS_LOADER_FLAGS typed enum bitmask flag parameter. This may have a breaking change impact to client code. Replace true with DDS_LOADER_FORCE_SRGB and false with DDS_LOADER_DEFAULT.

  • As of the October 2021 release, the DGSLEffect no longer directly supports skinning. Instead, make use of SkinnedDGSLEffect which is derived from DGSLEffect.

  • Starting with the June 2020 release, this library makes use of typed enum bitmask flags per the recommendation of the C++ Standard section 17.5.2.1.3 Bitmask types. This may have breaking change impacts to client code:

    • You cannot pass the 0 literal as your flags value. Instead you must make use of the appropriate default enum value: AudioEngine_Default, SoundEffectInstance_Default, ModelLoader_Clockwise, or WIC_LOADER_DEFAULT.

    • Use the enum type instead of DWORD if building up flags values locally with bitmask operations. For example, WIC_LOADER_FLAGS flags = WIC_LOADER_DEFAULT; if (...) flags |= WIC_LOADER_FORCE_SRGB;

  • The UWP projects and the Win10 classic desktop project include configurations for the ARM64 platform. Building these requires installing the ARM64 toolset.

  • When using clang/LLVM for the ARM64/AArch64 platform, the Windows 11 SDK (22000) or later is required.

  • The CompileShaders.cmd script must have Windows-style (CRLF) line-endings. If it is

// HOW IT'S BUILT

// FILES

2 files shipped with this skill. Inline text is the catalog copy. The upstream link is the source repository.

  • .github/skills/release/SKILL.md5.6 KBupstream ↗
    ---
    name: release
    description: Guide for performing the DirectX Tool Kit for DirectX 11 release process. Use this skill when asked to help with releasing a new version, publishing packages, or updating ports.
    ---
    
    # Release Process
    
    ## Prerequisites
    
    - All changes merged into the `main` branch with all tests passing.
    - GPG signing configured for your GitHub account (for verified tags).
    - Access to the MSCodeHub mirror repository and Azure DevOps pipelines.
    - Local repositories:
      - VCPKG at `d:\vcpkg` (synced with `main` branch)
      - WinGet at `D:\winget-pkgs` (synced with `master` branch, only if tool updates needed)
    - PATs will be needed for scripts that access GitHub and ADO.
    
    <!-- markdownlint-disable MD029 -->
    ## Steps
    
    ### Phase 1: Prepare Release
    
    1. Git pull the local repository to ensure it is up to date with the `main` branch.
    2. Run the PowerShell script `build\preparerelease.ps1` which will generate a topic branch for the release, update the version number in `CMakeLists.txt`, the `README.md` file, the release notes in the nuspec files, and create a stub in the `CHANGELOG.md` file for the new release.
    3. Edit the `CHANGELOG.md` file to update it with a summary of changes.
    4. Submit the topic branch for review and merge into `main` once approved. Allow the GitHub Actions workflows and the Azure DevOps pipelines to complete successfully before proceeding.
    
    ### Phase 2: Tag and Create GitHub Release
    
    5. Run the PowerShell script `build\completerelease.ps1` which will set a tag on the project repo and the test repo, and create a release on GitHub with the release notes from `CHANGELOG.md`. Ensure you have set up GPG signing for your GitHub account so that the tags will be verified.
    6. Git pull the local repository to ensure it is up to date with the `main` branch. Be sure to include `--tags`.
    
    ### Phase 3: MSCodeHub and Signed Binaries
    
    7. Push the `main` branch to the MSCodeHub mirror repository. Be sure to include `--tags`.
    8. Create a PR on MSCodeHub from the `main` branch to the `release` branch.
    9. Merge the PR on MSCodeHub to update the release branch, which will trigger the Azure DevOps pipeline to build signed binaries and the NuGet packages.
    10. Run the PowerShell script `build\downloadbuild.ps1` to download the signed binaries from the Azure DevOps pipeline artifacts.
    11. Edit the GitHub release and upload the signed binaries to the release assets.
    
    ### Phase 4: Source Archive Signing
    
    12. Download the GitHub source .zip archive from the release. Unzip and compare to the local repo to ensure it matches — keep in mind there may be some CR/LF differences.
    13. Run minisign on the .zip to generate a signature file, and upload the signature file to the release assets.
    
    ### Phase 5: NuGet Validation and Publishing
    
    14. Validate the NuGet packages with <https://github.com/walbourn/directxtk-tutorials> by pushing the NuGet packages to a local Packages Source folder, and refreshing the NuGet packages from that folder. Then build using BuildAllSolutions.targets.
    15. Run the PowerShell script `build\promotenuget.ps1 -Version <version> -Release` to promote the version to the Release view on the project-scoped ADO feed. The `-Version` parameter is required and should match the NuGet package version (e.g., `2026.6.2.1`).
    16. Run the MSCodeHub pipeline to publish the NuGet packages to nuget.org. The pipeline will automatically push the most recent package promoted to the Release view to nuget.org.
    
    ### Phase 6: VCPKG Port Update
    
    17. Git pull a local repository of VCPKG to `d:\vcpkg` in sync with the `main` branch of the VCPKG repository.
    18. Run the PowerShell script `build�pdatevcpkg.ps1` to update the DirectXTK port in VCPKG with the new release version. This will edit the files in `ports\directxtk`.
        If the port includes patches, review them to determine if they should be removed or updated for the new release (the `updatevcpkg.ps1` script will warn about this).
    19. Test the VCPKG port using the script at `assets/vcpkgdxtk.cmd` (in this skill folder). Copy it to `d:\vcpkg` and run from there after bootstrapping VCPKG.
    20. Run `.\vcpkg x-add-version directxtk` to update the VCPKG versioning history.
    21. Submit a PR to the VCPKG repository to update the DirectXTK port back to the main GitHub repo. The PR will be reviewed and merged by the VCPKG maintainers.
    
    ### Phase 7: WinGet Manifests (Conditional)
    
    If relevant changes were made to the `xwbtool` or `MakeSpriteFont` tools:
    
    22. Git pull a local repository to `D:\winget-pkgs` in sync with the `master` branch of the WinGet repository.
    23. Run the PowerShell script `build�pdatewinget.ps1` to update the winget manifests for the tools with the new release version.
    24. Submit a PR to the `winget` repository to update the manifests for each tool — they must be done as distinct PRs. The PRs will be reviewed and merged by the winget maintainers.
    
    ### Phase 8: Finalize
    
    When fully completed, be sure to update the GitHub release with links to the matching NuGet packages, the VCPKG port, and the winget manifests for the tools.
    
    ## Key Scripts
    
    | Script | Purpose |
    | --- | --- |
    | `build\preparerelease.ps1` | Creates topic branch, updates version numbers and changelog stub |
    | `build\completerelease.ps1` | Sets tags, creates GitHub release from changelog |
    | `build\downloadbuild.ps1` | Downloads signed binaries from Azure DevOps |
    | `build\promotenuget.ps1` | Promotes NuGet package to Release view on ADO feed |
    | `build�pdatevcpkg.ps1` | Updates DirectXTK VCPKG port files |
    | `assets\vcpkgdxtk.cmd` | Tests VCPKG port across all triplets and features |
    | `build�pdatewinget.ps1` | Updates winget manifests for CLI tools |
    
  • README.mdupstream ↗

    Contents are not inlined in the catalog. Open the upstream file.

Plain-text copy, no login: /skill-bundles/microsoft-directxtk-github-skills-release.md

// REPO STATS

2.9k stars
35 open issues
Last commit: 12d ago