IDirect3DDevice7::SetLight

The IDirect3DDevice7::SetLight method assigns a set of lighting properties for this device.

HRESULT SetLight( 
  DWORD dwLightIndex, 
  LPD3DLIGHT7 lpLight
); 

Parameters

dwLightIndex

Zero-based index of the set of lighting properties to be set. If a set of lighting properties already exists at this index, it is overwritten by the new properties in lpLight.

lpLight

Address of a D3DLIGHT7 structure that contains the lighting-parameters to be set.

Return Values

If the method succeeds, the return value is D3D_OK.

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

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.
  Windows CE: Unsupported.
  Version: Requires DirectX 7.0.
  Header: Declared in d3d.h.

See Also

IDirect3DDevice7::GetLight, IDirect3DDevice7::GetLightEnable, IDirect3DDevice7::LightEnable