IDirect3DDevice7::GetLightEnable

The IDirect3DDevice7::GetLightEnable method retrieves the activity status—enabled or disabled—for a set of lighting parameters within a device.

HRESULT GetLightEnable( 
  DWORD dwLightIndex,
  BOOL* pbEnable
); 

Parameters

dwLightIndex

Zero-based index of the set of lighting parameters that are the target of this method.

pbEnable

Address of a variable to be filled with the status of the specified lighting parameters. After the call, a nonzero value at this address indicates that the specified lighting parameters are enabled; a value of 0 indicates that they are disabled.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value is an error. For a complete list of Direct3D Immediate Mode error values and descriptions, see Return Values.

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::GetLight, IDirect3DDevice7::LightEnable, IDirect3DDevice7::SetLight