directxtk12_uwp 2021.8.2.1

This version is for Universal Windows Platform apps on Windows 10 using Visual Studio 2017 or Visual Studio 2019.

Features:
Audio - low-level audio API using XAudio2
BufferHelpers - C++ helpers for creating D3D resources from CPU data
CommonStates - common D3D state combinations
DDSTextureLoader - light-weight DDS file texture loader
DescriptorHeap - helper for managing DX12 descriptor heaps
DirectXHelpers - misc C++ helpers for D3D programming
Effects - set of built-in shaders for common rendering tasks
EffectPipelineStateDescription - helper for creating PSOs
GamePad - gamepad controller helper using XInput
GeometricPrimitive - draws basic shapes such as cubes and spheres
GraphicsMemory - helper for managing graphics memory allocation
Keyboard - keyboard state tracking helper
Model - draws simple meshes loaded from .SDKMESH or .VBO files
Mouse - mouse helper
PostProcess - set of built-in shaders for common post-processing operations
PrimitiveBatch - simple and efficient way to draw user primitives
RenderTargetState - helper for communicating render target requirements when creating PSOs
ResourceUploadBatch - helper for managing texture resource upload to the GPU
ScreenGrab - light-weight screen shot saver
SimpleMath - simplified C++ wrapper for DirectXMath
SpriteBatch - simple & efficient 2D sprite rendering
SpriteFont - bitmap based text rendering
VertexTypes - structures for commonly used vertex data formats
WICTextureLoader - WIC-based image file texture loader

Requires NuGet 2.8.6 or higher.

Install-Package directxtk12_uwp -Version 2021.8.2.1
dotnet add package directxtk12_uwp --version 2021.8.2.1
<PackageReference Include="directxtk12_uwp" Version="2021.8.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add directxtk12_uwp --version 2021.8.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: directxtk12_uwp, 2021.8.2.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install directxtk12_uwp as a Cake Addin
#addin nuget:?package=directxtk12_uwp&version=2021.8.2.1

// Install directxtk12_uwp as a Cake Tool
#tool nuget:?package=directxtk12_uwp&version=2021.8.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

DirectX Logo

DirectX Tool Kit for DirectX 12

http://go.microsoft.com/fwlink/?LinkID=615561

Copyright (c) Microsoft Corporation.

August 1, 2021

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

This code is designed to build with Visual Studio 2017 (15.9), Visual Studio 2019, or clang for Windows v11 or later. It is recommended that you make use of the Windows 10 May 2020 Update SDK (19041) 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?.

Documentation

Documentation is available on the GitHub wiki.

Notices

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

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

Comparisons to DirectX 11 Version

  • No support for loading .CMO models or DGSL effect shaders (i.e. DGSLEffect)

  • VertexTypes does not include VertexPositionNormalTangentColorTexture or VertexPositionNormalTangentColorTextureSkinning which were intended for use with the DGSL pipeline.

  • DirectX Tool Kit for DirectX 11 supports Feature Level 9.x, while DirectX 12 requires Direct3D Feature Level 11.0. There are no expected DirectX 12 drivers for any lower feature level devices.

  • The library assumes it is building for Windows 10 (aka _WIN32_WINNT=0x0A00) so it makes use of XAudio 2.9 and WIC2 as well as DirectX 12.

  • DirectX Tool Kit for Audio, GamePad, Keyboard, Mouse, and SimpleMath are identical to the DirectX 11 version.

Release Notes

  • 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, DDS_LOADER_DEFAULT, 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 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.

  • The CompileShaders.cmd script 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.

Contributing

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 has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

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.

DirectX Logo

DirectX Tool Kit for DirectX 12

http://go.microsoft.com/fwlink/?LinkID=615561

Copyright (c) Microsoft Corporation.

August 1, 2021

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

This code is designed to build with Visual Studio 2017 (15.9), Visual Studio 2019, or clang for Windows v11 or later. It is recommended that you make use of the Windows 10 May 2020 Update SDK (19041) 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?.

Documentation

Documentation is available on the GitHub wiki.

Notices

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

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

Comparisons to DirectX 11 Version

  • No support for loading .CMO models or DGSL effect shaders (i.e. DGSLEffect)

  • VertexTypes does not include VertexPositionNormalTangentColorTexture or VertexPositionNormalTangentColorTextureSkinning which were intended for use with the DGSL pipeline.

  • DirectX Tool Kit for DirectX 11 supports Feature Level 9.x, while DirectX 12 requires Direct3D Feature Level 11.0. There are no expected DirectX 12 drivers for any lower feature level devices.

  • The library assumes it is building for Windows 10 (aka _WIN32_WINNT=0x0A00) so it makes use of XAudio 2.9 and WIC2 as well as DirectX 12.

  • DirectX Tool Kit for Audio, GamePad, Keyboard, Mouse, and SimpleMath are identical to the DirectX 11 version.

Release Notes

  • 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, DDS_LOADER_DEFAULT, 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 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.

  • The CompileShaders.cmd script 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.

Contributing

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 has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

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.

Release Notes

Matches the August 1, 2021 release on GitHub.

Dependencies

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2021.8.2.1 148 8/3/2021
2021.6.10.2 142 6/10/2021
2021.4.7.2 155 4/7/2021
2021.1.10.1 297 1/10/2021
2020.11.12.1 315 11/12/2020
2020.9.30.1 308 10/1/2020
2020.8.15.1 357 8/16/2020
2020.7.2.1 228 7/3/2020
2020.6.15.1 219 6/15/2020
2020.6.2.1 190 6/2/2020
2020.5.11.1 210 5/11/2020
2020.2.24.1 371 2/25/2020
2019.12.17.1 307 12/18/2019
2019.10.17.1 985 10/18/2019
2019.8.23.1 299 8/23/2019
2019.5.31.1 402 5/31/2019
2019.4.26.1 363 4/29/2019
2019.2.7.1 437 2/10/2019
2018.11.20.1 9,909 11/20/2018
2018.10.31.1 451 10/31/2018
2018.10.26.1 500 10/26/2018
2018.9.13.1 650 9/18/2018
2018.8.18.2 732 8/18/2018
2018.7.3.1 653 7/3/2018
2018.6.1.2 594 6/1/2018
2018.5.14.1 1,115 5/14/2018
2018.4.23.1 763 4/24/2018
2017.12.13.1 838 12/15/2017
2017.9.22.1 752 9/22/2017
2017.6.21.1 810 6/21/2017
2017.4.24.1 753 4/25/2017
2017.2.10.1 780 2/11/2017
2016.12.5.1 789 12/8/2016
2016.10.6.1 797 10/6/2016
2016.9.15.1 784 9/16/2016
2016.9.1.1 744 9/2/2016
2016.8.4.1 722 8/4/2016
2016.7.18.1 685 7/18/2016
2016.6.30.1 728 7/1/2016