See the version list below for details.
Requires NuGet 2.8.6 or higher.
Install-Package directxtk_desktop_win10 -Version 2021.10.15.1
dotnet add package directxtk_desktop_win10 --version 2021.10.15.1
<PackageReference Include="directxtk_desktop_win10" Version="2021.10.15.1" />
paket add directxtk_desktop_win10 --version 2021.10.15.1
#r "nuget: directxtk_desktop_win10, 2021.10.15.1"
// Install directxtk_desktop_win10 as a Cake Addin #addin nuget:?package=directxtk_desktop_win10&version=2021.10.15.1 // Install directxtk_desktop_win10 as a Cake Tool #tool nuget:?package=directxtk_desktop_win10&version=2021.10.15.1
DirectX Tool Kit for DirectX 11
Copyright (c) Microsoft Corporation.
October 13, 2021
This package contains the "DirectX Tool Kit", a collection of helper classes for writing Direct3D 11 C++ code for Universal Windows Platform (UWP) apps for Windows 11, Windows 10, Xbox One, and Win32 desktop applications for Windows 7 Service Pack 1 or later.
These components are designed to work without requiring any content from the legacy DirectX SDK. For details, see Where is the DirectX SDK?.
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
- 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
- DirectXTK source files and internal implementation headers
- DirectXTK for Audio source files and internal implementation headers
- Command line tool used to generate binary resources for use with SpriteFont
- Command line tool for building XACT-style wave banks for use with DirectXTK for Audio's WaveBank class
Documentation is available on the GitHub wiki.
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.
As of the October 2021 release, the DGSLEffect no longer directly supports skinning. Instead, make use of SkinnedDGSLEffect which is derived from DGSLEffect.
As of the August 2021 release, MakeSpriteFont requires the .NET version 4.7.2 targeting pack to be installed to build. For VS 2017, this is an optional individual component .NET Framework 4.7.2 development tools (
Starting with the June 2020 release, this library makes use of typed enum bitmask flags per the recommendation of the C++ Standard section 188.8.131.52.3 Bitmask types. This may have breaking change impacts to client code:
You cannot pass the
0literal as your flags value. Instead you must make use of the appropriate default enum value:
Use the enum type instead of
DWORDif 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 VS 2019 Win10 classic desktop project include configurations for the ARM64 platform. These require VS 2017 (15.9 update) or VS 2019 to build, with the ARM64 toolset installed.
CompileShaders.cmdscript must have Windows-style (CRLF) line-endings. If it is changed to Linux-style (LF) line-endings, it can fail to build all the required shaders.
For bug reports and feature requests, please use GitHub issues for this project.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
The DirectX Tool Kit is the work of Shawn Hargreaves and Chuck Walbourn, with contributions from Aaron Rodriguez Hernandez, and Dani Roman.
Thanks to Shanon Drone for the SDKMESH file format.
Thanks to Adrian Tsai for the geodesic sphere implementation.
Thanks to Garrett Serack for his help in creating the NuGet packages for DirectX Tool Kit.
Thanks to Roberto Sonnino for his help with the
CMO, DGSL rendering, and the VS Starter Kit animation.
Thanks to Pete Lewis and Justin Saunders for the normal-mapped and PBR shaders implementation.
This package has no dependencies.
This package is not used by any NuGet packages.
This package is not used by any popular GitHub repositories.
Matches the October 13, 2021 release on GitHub.
DirectX Tool Kit for Audio in this package uses XAudio 2.9 which requires Windows 10 or later.