A Direct3D 11 2D texture save routine for generating a "screenshot" from a render target texture. There is a function that will dump the 2D texture to a .DDS file, and another that will write using WIC (BMP, JPEG, PNG, TIFF, GIF, JPEG-XR / HD Photo, or other WIC supported file container).
These writers do not support array textures, 1D textures, 3D volume textures, or cubemaps. Mipmaps are also ignored. For those scenarios, use the DirectXTex library functionality. The ScreenGrab module is really designed to make a quick and light-weight solution for capturing screenshots at runtime.
MSAA textures are resolved before being written.
Also part of DirectXTex http://go.microsoft.com/fwlink/?LinkId=248926
Saves a texture to a DDS file on disk. It performs no format conversions, but will try to favor writing legacy .DDS files when possible for improved tool support.
SaveWICTextureToFile
Saves a texture to a WIC-supported bitmap file on disk. The caller provides the desired WIC container format via guidContainerFormat and can optionally specify a desired WIC pixel format via targetFormat (which will result in E_FAIL if the requested pixel format is not supported by the WIC codec). If no WIC pixel format GUID is provided as the targetFormat parameter, it will default to a non-alpha format since 'screenshots' usually ignore the alpha channel in render targets.
NOTE: SaveWICTextureToFile is not supported on Windows Phone 8, because WIC is not available on that platform
These writers do not support array textures, 1D textures, 3D volume textures, or cubemaps. Mipmaps are also ignored. For those scenarios, use the DirectXTex library functionality. The ScreenGrab module is really designed to make a quick and light-weight solution for capturing screenshots at runtime.
MSAA textures are resolved before being written.
Also part of DirectXTex http://go.microsoft.com/fwlink/?LinkId=248926
Functions
SaveDDSTextureToFileSaves a texture to a DDS file on disk. It performs no format conversions, but will try to favor writing legacy .DDS files when possible for improved tool support.
SaveWICTextureToFile
Saves a texture to a WIC-supported bitmap file on disk. The caller provides the desired WIC container format via guidContainerFormat and can optionally specify a desired WIC pixel format via targetFormat (which will result in E_FAIL if the requested pixel format is not supported by the WIC codec). If no WIC pixel format GUID is provided as the targetFormat parameter, it will default to a non-alpha format since 'screenshots' usually ignore the alpha channel in render targets.
NOTE: SaveWICTextureToFile is not supported on Windows Phone 8, because WIC is not available on that platform
Example
This example saves a JPEG screenshot given a ID3D11DeviceContext immContext and IDXGISwapChain swapChain.usingnamespace DirectX; usingnamespace Microsoft::WRL; ComPtr<ID3D11Texture2D> backBuffer; HRESULT hr = swapChain->GetBuffer( 0, __uuidof( *backBuffer ), ( LPVOID* )&backBuffer ); if ( SUCCEEDED(hr) ) { hr = SaveWICTextureToFile( immContext, backBuffer, GUID_ContainerFormatJpeg, L"SCREENSHOT.JPG" ); } ThrowIfFailed(hr);
Release Notes
- If built with #define DXGI_1_2_FORMATS the DDS writer supports BGRA 4:4:4:4 files.
- JPEG-XR / HD Photo supports nearly all WIC pixel formats including floating-point for both encoding and decoding.
- TIFF can contain floating-point data (128bpp or 96bpp), but the WIC built-in codec can only decode such images. It always converts floating-point data to unorm when encoding.