D3DXCreateRenderToSurface Function

Creates a render surface.

Syntax

HRESULT D3DXCreateRenderToSurface(      

    LPDIRECT3DDEVICE9 pDevice,
    UINT Width,
    UINT Height,
    D3DFORMAT Format,
    BOOL DepthStencil,
    D3DFORMAT DepthStencilFormat,
    LPD3DXRENDERTOSURFACE *ppRenderToSurface
);

Parameters

pDevice

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

Width

[in] Width of the render surface, in pixels.

Height

[in] Height of the render surface, in pixels.

Format

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

DepthStencil

[in] 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] 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, retval] Address of a pointer to an ID3DXRenderToSurface interface, representing the created render surface.

Return Value

If the function succeeds, the return value is D3D_OK.

If the function fails, the return value can be one of the following values.

D3DERR_INVALIDCALL	The method call is invalid. For example, a method's parameter may have an invalid value.
E_OUTOFMEMORY	Microsoft?Direct3D?could not allocate sufficient memory to complete the call.

Function Information

Header	d3dx9core.h
Import library	d3dx9.lib
Minimum operating systems	Windows 98