Copyright (c) Microsoft Corporation.
December 31, 2023
This package contains DirectXTex, a shared source library for reading and writing
.DDS files, and performing various texture content processing operations including resizing, format conversion, mip-map generation, block compression for Direct3D runtime texture resources, and height-map to normal-map conversion. This library makes use of the Windows Image Component (WIC) APIs. It also includes
.HDR readers and writers since these image file formats are commonly used for texture content processing pipelines, but are not currently supported by a built-in WIC codec.
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) or later is required for Visual Studio. It can also be built for Windows Subsystem for Linux using GCC 11 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?.
The majority of the header files here are intended for internal implementation of the library only (
DirectXTexP.h, etc.). Only
DirectXTex.inlare meant as the 'public' header for the library.
This DirectXTex sample is an implementation of the texconv command-line texture utility from the DirectX SDK utilizing DirectXTex rather than D3DX.
It supports the same arguments as the Texture Conversion Tool Extended (
texconvex.exe) legacy DirectX SDK utility. The primary differences are the
-11 arguments are not applicable and the filter names (
*_DITHER_DIFFUSION). This also includes support for the JPEG XR (HD Photo) bitmap format.
DDSTextureLoader11, ScreenGrab11, and WICTextureLoader11 are 'stand-alone' versions of the same modules provided in the DirectX Tool Kit for DX11
DDSTextureLoader12, ScreenGrab12, and WICTextureLoader12 are 'stand-alone' versions of the same modules provided in the DirectX Tool Kit for DX12.
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 DirectXTex, bug reports, etc. please visit the project site on GitHub.
Starting with the July 2022 release, the
bool forceSRGB parameter for the CreateTextureEx and CreateShaderResourceViewEx functions is now a
CREATETEX_FLAGS typed enum bitmask flag parameter. This may have a breaking change impact to client code. Replace
Starting with the June 2020 release, this library makes use of typed enum bitmask flags per the recommendation of the C++ Standard section 126.96.36.199.3 Bitmask types. This is consistent with Direct3D 12's use of the
DEFINE_ENUM_FLAG_OPERATORS macro. 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:
Use the enum type instead of
DWORD if building up flags values locally with bitmask operations. For example,
DDS_FLAGS flags = DDS_FLAGS_NONE; if (...) flags |= DDS_FLAGS_EXPAND_LUMINANCE;
In cases where some of the flags overlap, you can use the
| to combine the relevant types:
TEX_FILTER_FLAGS filter modes combine with
TEX_FILTER_FLAGS sRGB flags combine with
TEX_COMPRESS_FLAGS. No other bitwise operators are defined. For example,
WIC_FLAGS wicFlags = WIC_FLAGS_NONE | TEX_FILTER_CUBIC;
WICTextureLoader cannot load
.HDR files unless the system has a 3rd party WIC codec installed. You must use the DirectXTex library for TGA/HDR file format support without relying on an add-on WIC codec.
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 platform, the Windows 11 SDK (22000) or later is required.
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.
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 DirectXTex library is the work of Chuck Walbourn, with contributions from Matt Lee, Xin Huang, Craig Peeper, and the numerous other Microsoft engineers who developed the D3DX utility library over the years.
Thanks to Paul Penson for his help with the implementation of
Thanks to Andrew Farrier and Scott Matloff for their on-going help with code reviews.
Thanks to Park DongHa for their contribution of the JPEG/PNG auxiliary functions.