This method retrieves the activity status — enabled or disabled — for a set of lighting parameters within a device.

HRESULT GetLightEnable(
  DWORD Index,
  BOOL* pEnable


  • Index
    [in] Zero-based index of the set of lighting parameters that are the target of this method.
  • pEnable
    [out, retval] Pointer to a variable to fill 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 can be D3DERR_INVALIDCALL.


OS Versions: Windows CE .NET 4.0 and later.
Header: D3d8.h.
Link Library: D3d8.lib.

See Also

IDirect3DDevice8::GetLight | IDirect3DDevice8::LightEnable | IDirect3DDevice8::SetLight | IDirect3DDevice8

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.