IDirect3DViewport3::GetBackground

The IDirect3DViewport3::GetBackground method retrieves the handle to a material that represents the current background associated with the viewport.

HRESULT GetBackground(
  LPD3DMATERIALHANDLE lphMat,  
  LPBOOL lpValid               
);
 

Parameters

lphMat

Address that will contain the handle to the material being used as the background.

lpValid

Address of a variable that will be filled to indicate whether a background is associated with the viewport. If this parameter is FALSE, no background 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:

Remarks

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