Device.GetRenderTargetData Method

Language:

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

Definition

Visual Basic Public Sub GetRenderTargetData( _
    ByVal renderTarget As Surface, _
    ByVal destSurface As Surface _
)
C# public void GetRenderTargetData(
    Surface renderTarget,
    Surface destSurface
);
C++ public:
void GetRenderTargetData(
    SurfacerenderTarget,
    SurfacedestSurface
);
JScript public function GetRenderTargetData(
    renderTarget : Surface,
    destSurface : Surface
);

Parameters

renderTarget Microsoft.DirectX.Direct3D.Surface
A Surface object that represents a render target.
destSurface Microsoft.DirectX.Direct3D.Surface
[in, out] A Surface object that represents a destination surface.

Remarks

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

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

This method will fail if:

Exceptions
InvalidCallException The method call is invalid. For example, a method's parameter might contain an invalid value.


Send comments about this topic to Microsoft. © Microsoft Corporation. All rights reserved.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center