IDirect3DViewport3::GetBackgroundDepth2

The IDirect3DViewport3::GetBackgroundDepth2 method retrieves a DirectDraw surface that represents the current background-depth field associated with the viewport.

HRESULT GetBackgroundDepth2(
  LPDIRECTDRAWSURFACE4* lplpDDS,
  LPBOOL lpValid
); 
 

Parameters

lplpDDS

Address of a variable that will be filled with the IDirectDrawSurface4 interface for the surface object that represents the background depth.

lpValid

Address of a variable that is set to FALSE if no background depth is associated with the viewport.

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:

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::SetBackgroundDepth2