IDirect3DDevice9::GetLightEnable Method

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

Syntax

HRESULT GetLightEnable(      

    DWORD Index,
    BOOL *pEnable
);

Parameters

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 Value

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be D3DERR_INVALIDCALL.

Remarks

This method will not return device state for a device that is created using D3DCREATE_PUREDEVICE. If you want to use this method, you must create your device with any of the other values in D3DCREATE.

See Also

IDirect3DDevice9::GetLight, IDirect3DDevice9::LightEnable, IDirect3DDevice9::SetLight