Platform SDK: DirectX

Direct3DDevice7.GetLightEnable

The Direct3DDevice7.GetLightEnable method retrieves the activity status—enabled or disabled—for a light.

object.GetLightEnable( _ 
    LightIndex As Long) As Boolean

Parameters

object
Object expression that resolves to a Direct3DDevice7 object.
LightIndex
Zero-based index of the set of lighting parameters that are the target of this method.

Return Values

If the method succeeds, the return value indicates the activity status of the light. The method returns True to indicate that the specified light is enabled, and False to indicate that it is disabled.

Error Codes

If the method fails, it sets Err.Number to an error code and raises an error. For a list of possible error codes, see Direct3D Immediate Mode Error Codes.

See Also

Direct3DDevice7.GetLight, Direct3DDevice7.LightEnable, Direct3DDevice7.SetLight, Lighting and Materials