IDirect3DDevice9::GetRenderTargetData Method

Copies the render target data from device memory to system memory.

Syntax

HRESULT GetRenderTargetData(      

    IDirect3DSurface9* pRenderTarget,
    IDirect3DSurface9* pDestSurface
);

Parameters

pRenderTarget

[in] Pointer to an IDirect3DSurface9 object, representing a render target.

pDestSurface

[in] Pointer to an IDirect3DSurface9 object, representing a destination surface.

Return Value

If the method succeeds, the return value is D3D_OK.

D3DERR_INVALIDCALL if one of the arguments is invalid.

Remarks

The destination surface must be either an off-screen plain surface or a level of a texture (mipmap or cube texture) created with D3DPOOL_SYSTEMMEM.

The source surface must be a regular render target or a level of a render target texture (mipmap or cube texture) created with POOL_DEFAULT.

This method will fail if:

• The render target is multisampled.
• The source render target is a different size than the destination surface.
• The source render target and destination surface formats do not match.