IDirect3DDevice7::GetLight

The IDirect3DDevice7::GetLight method retrieves a set of lighting properties that this device uses.

HRESULT GetLight( 
  DWORD dwLightIndex, 
  LPD3DLIGHT7 lpLight
); 

Parameters

dwLightIndex

Zero-based index of the lighting property set to be retrieved.

lpLight

Address of a D3DLIGHT7 structure that is filled with the retrieved lighting-parameter set.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value is an error. The method returns DDERR_INVALIDPARAMS if the lpLight parameter is invalid.

Remarks

This method was introduced with the IDirect3DDevice7 interface.

Unlike its predecessors, the IDirect3DDevice7 interface does not use light objects. This method, and its use of the D3DLIGHT7 structure to describe a set of lighting properties, replaces the lighting semantics used by previous versions of the device interface.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Version: Requires DirectX 7.0.
  Header: Declared in d3d.h.

See Also

IDirect3DDevice7::SetLight, IDirect3DDevice7::GetLightEnable, IDirect3DDevice7::LightEnable