IDirect3DViewport3::SetBackgroundDepth

The IDirect3DViewport3::SetBackgroundDepth method sets the background-depth field for the viewport.

HRESULT SetBackgroundDepth(
  LPDIRECTDRAWSURFACE lpDDSurface  
);
 

Parameters

lpDDSurface

Address of the DirectDrawSurface object representing the background depth.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value may be one of the following values:

Remarks

The depth-buffer is filled with the specified depth field when the IDirect3DViewport3::Clear method is called and the D3DCLEAR_ZBUFFER flag is specified. The bit depth must be 16 bits.

This method is unchanged from its implementation in the IDirect3DViewport2 interface.

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in d3d.h.
  Import Library: Use ddraw.lib.

See Also

IDirect3DViewport3::GetBackgroundDepth