DirectXTK |
---|
This is a version of DDSTextureLoader for use by Xbox One XDK developers. This loads pre-tiled texture resources for use with the CreatePlacement
APIs available to Xbox One exclusive app developers.
These pre-tiled resources are stored in a variant of the .DDS
file format marked with the "XBOX" FourCC pixel format. To generate these .DDS
files, see the xtexconv.
To load legacy
DDPIXELFORMAT
or FourCC "DX10"DXGI_FORMAT
variant DDS files, use DDSTextureLoader
This function is only usable by Xbox registered developers via the Xbox One XDK.
Header
#include <XboxDDSTextureLoader.h>
Functions
These are in the Xbox namespace rather than DirectX
CreateDDSTextureFromMemory, CreateDDSTextureFromFile
These are equivalent to the same functions in DDSTextureLoader.
HRESULT CreateDDSTextureFromMemory( ID3D11DeviceX* d3dDevice,
const uint8_t* ddsData, size_t ddsDataSize,
ID3D11Resource** texture, ID3D11ShaderResourceView** textureView,
void** grfxMemory, DDS_ALPHA_MODE* alphaMode = nullptr,
bool forceSRGB = false );
HRESULT CreateDDSTextureFromFile( ID3D11DeviceX* d3dDevice,
const wchar_t* szFileName,
ID3D11Resource** texture, ID3D11ShaderResourceView** textureView,
void** grfxMemory,
DDS_ALPHA_MODE* alphaMode = nullptr,
bool forceSRGB = false );
Parameters
Either texture or textureView can be nullptr, but not both.
The grfxMemory is returned as a pointer to the video memory which the caller is responsible for releasing with FreeDDSTextureMemory:
void FreeDDSTextureMemory( _In_opt_ void* grfxMemory );
There is also a forceSRGB option for working around gamma issues with content that is in the sRGB or similar color space but is not encoded explicitly as an SRGB format. This will force return format be one of the of DXGI_FORMAT_*_SRGB
formats if it exist. Note that no pixel data conversion takes place.
Remark
Auto-gen mipmaps are not supported with these functions.
Example
using namespace Microsoft::WRL;
ComPtr<ID3D11ShaderResourceView> srv;
void *grfxMemory = nullptr;
HRESULT hr = Xbox::CreateDDSTextureFromFile( m_device.Get(),
L"XboxTiledTexturedds", nullptr,
srv.GetAddressOf(), &grfxMemory );
DX::ThrowIfFailed( hr );
DDS File Format
This function expects the DDS file to contain a pixel format with FourCC "XBOX" which signifies a specific variant of the file.
DWORD dwMagic
DDS_HEADER header
DDS_HEADER_XBOX
{
DXGI_FORMAT dxgiFormat;
uint32_t resourceDimension;
uint32_t miscFlag; // see DDS_RESOURCE_MISC_FLAG
uint32_t arraySize;
uint32_t miscFlags2; // see DDS_MISC_FLAGS2
uint32_t tileMode; // see XG_TILE_MODE
uint32_t baseAlignment;
uint32_t dataSize;
uint32_t xdkVer; // matching _XDK_VER
} headerXbox
// Remainder of file is a tiled texture binary layout suitable
// for use with CreatePlacement APIs
Other DDS
loaders and viewers will fail to recognize this pixel format, and other DDS
creation tools do not support creating it. See the xtexconv sample for more information on creating this variant form of DDS files.
For Use
- Universal Windows Platform apps
- Windows desktop apps
- Windows 11
- Windows 10
- Windows 8.1
- Windows 7 Service Pack 1
- Xbox One
Architecture
- x86
- x64
- ARM64
For Development
- Visual Studio 2022
- Visual Studio 2019 (16.11)
- clang/LLVM v12 - v18
- MinGW 12.2, 13.2
- CMake 3.20
Related Projects
DirectX Tool Kit for DirectX 12
Tools
All content and source code for this package are subject to the terms of the MIT License.
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.