D3DXCreateRenderToSurface function

Creates a render surface.

Syntax

HRESULT D3DXCreateRenderToSurface(
  _In_  LPDIRECT3DDEVICE9     pDevice,
  _In_  UINT                  Width,
  _In_  UINT                  Height,
  _In_  D3DFORMAT             Format,
  _In_  BOOL                  DepthStencil,
  _In_  D3DFORMAT             DepthStencilFormat,
  _Out_ LPD3DXRENDERTOSURFACE *ppRenderToSurface
);

Parameters

pDevice [in]

Type: LPDIRECT3DDEVICE9

Pointer to an IDirect3DDevice9 interface, the device to be associated with the render surface.

Width [in]

Type: UINT

Width of the render surface, in pixels.

Height [in]

Type: UINT

Height of the render surface, in pixels.

Format [in]

Type: D3DFORMAT

Member of the D3DFORMAT enumerated type, describing the pixel format of the render surface.

DepthStencil [in]

Type: BOOL

If TRUE, the render surface supports a depth-stencil surface. Otherwise, this member is set to FALSE. This function will create a new depth buffer.

DepthStencilFormat [in]

Type: D3DFORMAT

If DepthStencil is set to TRUE, this parameter is a member of the D3DFORMAT enumerated type, describing the depth-stencil format of the render surface.

ppRenderToSurface [out]

Type: LPD3DXRENDERTOSURFACE*

Address of a pointer to an ID3DXRenderToSurface interface, representing the created render surface.

Return value

Type: HRESULT

If the function succeeds, the return value is D3D_OK. If the function fails, the return value can be one of the following: D3DERR_INVALIDCALL, E_OUTOFMEMORY.

Requirements

See also

General Purpose Functions