mirror of https://github.com/microsoft/DirectXTex synced 2024-11-09 14:30:05 +00:00

Table of Contents

Example
Remarks

DirectXTex

Captures a Direct3D render target and returns an image.

This function is intended for use with tools or editor programs. For runtime/engine use, we strongly recommend using ScreenGrab DX11 / DX12 instead of DirectXTex.

 HRESULT CaptureTexture(
    ID3D11Device* pDevice, ID3D11DeviceContext* pContext,
    ID3D11Resource* pSource,
    ScratchImage& result );

HRESULT CaptureTexture(
    ID3D12CommandQueue* pCommandQueue,
    ID3D12Resource* pSource,
    bool isCubeMap,
    ScratchImage& result,
    D3D12_RESOURCE_STATES beforeState = D3D12_RESOURCE_STATE_RENDER_TARGET,
    D3D12_RESOURCE_STATES afterState = D3D12_RESOURCE_STATE_RENDER_TARGET );

Example

ScratchImage image;
HRESULT hr = CaptureTexture( device, context, pResource, image );
if ( SUCCEEDED(hr) )
{
    hr = SaveToDDSFile( image.GetImages(),
        image.GetImageCount(), image.GetMetadata(),
        DDS_FLAGS_NONE, filename );
    if ( FAILED(hr) )
    {
        ...