IDirect3DDevice9::GetDepthStencilSurface method (d3d9helper.h)

Gets the depth-stencil surface owned by the Direct3DDevice object.

Syntax

HRESULT GetDepthStencilSurface(
  [out, retval] IDirect3DSurface9 **ppZStencilSurface
);

Parameters

[out, retval] ppZStencilSurface

Type: IDirect3DSurface9**

Address of a pointer to an IDirect3DSurface9 interface, representing the returned depth-stencil surface.

Return value

Type: HRESULT

If the method succeeds, the return value is D3D_OK.If the device doesn't have a depth stencil buffer associated with it, the return value will be D3DERR_NOTFOUND. Otherwise, if the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

Calling this method will increase the internal reference count on the IDirect3DSurface9 interface. Failure to call IUnknown::Release when finished using this IDirect3DSurface9 interface results in a memory leak.

Requirements

Requirement Value
Target Platform Windows
Header d3d9helper.h (include D3D9.h)
Library D3D9.lib

See also

IDirect3DDevice9

IDirect3DDevice9::SetDepthStencilSurface