IDirect3DViewport2::GetBackgroundDepth
The IDirect3DViewport2::GetBackgroundDepth method retrieves a DirectDraw surface that represents the current background-depth field associated with the viewport.
HRESULT GetBackgroundDepth(
LPDIRECTDRAWSURFACE* lplpDDSurface,
LPBOOL lpValid
);
Parameters
lplpDDSurface
Address that will be initialized to point to a DirectDrawSurface object representing 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:
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
Remarks
This method is unchanged from its implementation in the IDirect3DViewport interface.
QuickInfo
Windows NT: Use version 5.0 or later.
Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
Windows CE: Unsupported.
Header: Declared in d3d.h.
Import Library: Use ddraw.lib.
See Also