Device.GetRenderTargetData(Surface,Surface) Method (Microsoft.DirectX.Direct3D)

  • Article

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(
    Surface^ renderTarget,
    Surface^ destSurface
);
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:

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

Exceptions

InvalidCallException

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