March 20, 2025 (#542)

Author: walbourn

.nuget/directxtk_desktop_2019.nuspec

@@ -30,7 +30,7 @@ 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</description>
-        <releaseNotes>Matches the October 28, 2024 release on GitHub.
+        <releaseNotes>Matches the March 20, 2025 release on GitHub.
 
 DirectX Tool Kit for Audio in this package uses XAudio 2.8 to support Windows 8.1.</releaseNotes>
         <projectUrl>http://go.microsoft.com/fwlink/?LinkId=248929</projectUrl>

.nuget/directxtk_desktop_win10.nuspec

@@ -30,7 +30,7 @@ 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</description>
-        <releaseNotes>Matches the October 28, 2024 release on GitHub.
+        <releaseNotes>Matches the March 20, 2025 release on GitHub.
 
 DirectX Tool Kit for Audio in this package uses XAudio 2.9 which requires Windows 10 or later.</releaseNotes>
         <projectUrl>http://go.microsoft.com/fwlink/?LinkId=248929</projectUrl>

.nuget/directxtk_uwp.nuspec

@@ -30,7 +30,7 @@ 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</description>
-        <releaseNotes>Matches the October 28, 2024 release on GitHub.</releaseNotes>
+        <releaseNotes>Matches the March 20, 2025 release on GitHub.</releaseNotes>
         <projectUrl>http://go.microsoft.com/fwlink/?LinkId=248929</projectUrl>
         <repository type="git" url="https://github.com/microsoft/DirectXTK.git" />
         <icon>images\icon.jpg</icon>

Audio/AudioEngine.cpp

@@ -603,14 +603,14 @@ HRESULT AudioEngine::Impl::Reset(const WAVEFORMATEX* wfx, const wchar_t* deviceI
         mX3DCalcFlags |= X3DAUDIO_CALCULATE_REDIRECT_TO_LFE;
     }
 
-    if (mEngineFlags & AudioEngine_ZeroCenter3D)
+    if (!(mEngineFlags & AudioEngine_DisableDopplerEffect))
     {
-        mX3DCalcFlags |= X3DAUDIO_CALCULATE_ZEROCENTER;
+        mX3DCalcFlags |= X3DAUDIO_CALCULATE_DOPPLER;
     }
 
-    if (!(mEngineFlags & AudioEngine_DisableDopplerEffect))
+    if (mEngineFlags & AudioEngine_ZeroCenter3D)
     {
-        mX3DCalcFlags |= X3DAUDIO_CALCULATE_DOPPLER;
+        mX3DCalcFlags |= X3DAUDIO_CALCULATE_ZEROCENTER;
     }
 
     //

CHANGELOG.md

@@ -6,6 +6,19 @@ Release available for download on [GitHub](https://github.com/microsoft/DirectXT
 
 ## Release History
 
+### March 20, 2025
+* C++17 `std::byte` support for `FromMemory` functions
+* GamePad, Keyboard, and Mouse _GameInput_ implementation now supports both v0 and v1 of the API
+* SimpleMath changes for Vector2/Vector3 operators to speed up performance particularly in debug builds
+* *DirectX Tool Kit for Audio* changes:
+  * Added more audio engine flags to control X3DAudio usage: `AudioEngine_DisableLFERedirect`, `AudioEngine_DisableDopplerEffect`, `AudioEngine_ZeroCenter3D`
+  * Repurposed `SoundEffectInstance_UseRedirectLFE` from an internal flag to a per voice override
+  * Added `SoundEffectInstance_ZeroCenter3D` as a per voice override
+  * Bug fixes for recent ``IsValid`` methods
+* Retired support for Windows 7 and Windows 8.0
+* Minor code review
+* CMake project updates including support for BUILD_SHARED_LIBS (i.e. DLL vs. static library)
+
 ### October 28, 2024
 * All enums now use ``uint32_t`` as the underlying type rather than ``unsigned long`` or ``int``.
 * Added `DDS_LOADER_INGNORE_MIPS` flag to DDSTextureLoader
@@ -119,8 +132,8 @@ Release available for download on [GitHub](https://github.com/microsoft/DirectXT
 * Dropped support for legacy Xbox One XDK prior to April 2018
 
 ### February 28, 2022
-* SimpleMath Matrix updated with ToEuler and Vector3 version of CreateFromYawPitchRoll methods
-* SimpleMath Quaternion updated with ToEuler, RotateTowards, FromToRotation, LookRotation, and Angle methods
+* SimpleMath Matrix updated with **ToEuler** and Vector3 version of **CreateFromYawPitchRoll** methods
+* SimpleMath Quaternion updated with **ToEuler**, **RotateTowards**, **FromToRotation**, **LookRotation**, and **Angle** methods
 * Keyboard updated with new IME On/Off v-keys
 * Win32 Mouse now uses ``WM_ACTIVATE`` for more robust behavior
 * *DirectX Tool Kit for Audio* updated for Advanced Format (4Kn) wavebank streaming
@@ -395,7 +408,7 @@ Release available for download on [GitHub](https://github.com/microsoft/DirectXT
 * Added ``forceSRGB`` optional parameter to SpriteFont ctor
 * EffectFactory method **EnableForceSRGB** added
 * DGSLEffect now defaults to diffuse/alpha of 1
-* Removed problematic ABI::Windows::Foundation::Rect interop for SimpleMath
+* Removed problematic `ABI::Windows::Foundation::Rect` interop for SimpleMath
 * Minor code cleanup
 
 ### August 4, 2016

CMakeLists.txt

@@ -3,7 +3,11 @@
 
 cmake_minimum_required (VERSION 3.20)
 
-set(DIRECTXTK_VERSION 1.9.0)
+set(DIRECTXTK_VERSION 1.9.1)
+
+if(XBOX_CONSOLE_TARGET STREQUAL "durango")
+  set(CMAKE_TRY_COMPILE_TARGET_TYPE "STATIC_LIBRARY")
+endif()
 
 project (DirectXTK
   VERSION ${DIRECTXTK_VERSION}
@@ -139,6 +143,15 @@ set(SHADER_SOURCES
     Src/Shaders/SpriteEffect.fx
     Src/Shaders/ToneMap.fx)
 
+# Xbox-specific extensions
+if(DEFINED XBOX_CONSOLE_TARGET)
+  set(LIBRARY_HEADERS ${LIBRARY_HEADERS}
+      Inc/XboxDDSTextureLoader.h)
+
+  set(LIBRARY_SOURCES ${LIBRARY_SOURCES}
+      Src/XboxDDSTextureLoader.cpp)
+endif()
+
 # These source files are identical in both DX11 and DX12 version.
 set(LIBRARY_HEADERS ${LIBRARY_HEADERS}
     Inc/GamePad.h

Inc/XboxDDSTextureLoader.h

@@ -69,7 +69,7 @@ namespace Xbox
 
     DIRECTX_TOOLKIT_API
     HRESULT __cdecl CreateDDSTextureFromFile(
-            _In_ ID3D11DeviceX* d3dDevice,
+        _In_ ID3D11DeviceX* d3dDevice,
         _In_z_ const wchar_t* szFileName,
         _Outptr_opt_ ID3D11Resource** texture,
         _Outptr_opt_ ID3D11ShaderResourceView** textureView,
@@ -84,7 +84,7 @@ namespace Xbox
     DIRECTX_TOOLKIT_API
     inline HRESULT __cdecl CreateDDSTextureFromMemory(
         _In_ ID3D11DeviceX* d3dDevice,
-        _In_reads_bytes_(ddsDataSize) const uint8_t* ddsData,
+        _In_reads_bytes_(ddsDataSize) const std::byte* ddsData,
         _In_ size_t ddsDataSize,
         _Outptr_opt_ ID3D11Resource** texture,
         _Outptr_opt_ ID3D11ShaderResourceView** textureView,

README.md

@@ -6,9 +6,9 @@ http://go.microsoft.com/fwlink/?LinkId=248929
 
 Copyright (c) Microsoft Corporation.
 
-**October 28, 2024**
+**March 20, 2025**
 
-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.
+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 8.1 or later.
 
 This code is designed to build with Visual Studio 2019 (16.11), Visual Studio 2022, clang for Windows v12 or later, or MinGW 12.2. Use of the Windows 10 May 2020 Update SDK ([19041](https://walbourn.github.io/windows-10-may-2020-update-sdk/)) or later is required for Visual Studio.
 
@@ -78,7 +78,7 @@ FOR SECURITY ADVISORIES, see [GitHub](https://github.com/microsoft/DirectXTK/sec
 
 For a full change history, see [CHANGELOG.md](https://github.com/microsoft/DirectXTK/blob/main/CHANGELOG.md).
 
-* Starting with the December 2024 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.
+* 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`.
 
@@ -108,10 +108,10 @@ For a full change history, see [CHANGELOG.md](https://github.com/microsoft/Direc
 
 * 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.
 
-* Xbox One support for DirectX 11 requires the legacy Xbox One XDK. See February 2023 or earlier releases of *DirectX Tool Kit* for the required project files.
-
 * As of the October 2024 release, the xwbtool command-line tool also supports GNU-style long options using ``--``. All existing switches continue to function. MakeSpriteFont supports only `--version` and ``--help`` for POSIX-style parameters.
 
+* Xbox One support for DirectX 11 requires the legacy Xbox One XDK. See February 2023 or earlier releases of *DirectX Tool Kit* for the required MSBuild project files. It can also be built using the current CMake project from an *Xbox One XDK Developer Command Prompt* with the addition of CMake 3.20 or later to the path via the `x64-Debug-Durango` or `x64-Release-Durango` CMake preset.
+
 ## Support
 
 For questions, consider using [Stack Overflow](https://stackoverflow.com/questions/tagged/directxtk) with the *directxtk* tag, or the [DirectX Discord Server](https://discord.gg/directx) in the *dx9-dx11-developers* channel.