IDirect3DDevice9::LightEnable method (d3d9.h)
Enables or disables a set of lighting parameters within a device.
Syntax
HRESULT LightEnable(
[in] DWORD Index,
[in] BOOL Enable
);
Parameters
[in] Index
Type: DWORD
Zero-based index of the set of lighting parameters that are the target of this method.
[in] Enable
Type: BOOL
Value that indicates if the set of lighting parameters are being enabled or disabled. Set this parameter to TRUE to enable lighting with the parameters at the specified index, or FALSE to disable it.
Return value
Type: HRESULT
If the method succeeds, the return value is D3D_OK. If the method fails, the return value can be D3DERR_INVALIDCALL.
Remarks
If a value for LightIndex is outside the range of the light property sets assigned within the device, the IDirect3DDevice9::LightEnable method creates a light source represented by a D3DLIGHT9 structure with the following properties and sets its enabled state to the value specified in bEnable.
| Member | Default |
|---|---|
| Type | D3DLIGHT_DIRECTIONAL |
| Diffuse | (R:1, G:1, B:1, A:0) |
| Specular | (R:0, G:0, B:0, A:0) |
| Ambient | (R:0, G:0, B:0, A:0) |
| Position | (0, 0, 0) |
| Direction | (0, 0, 1) |
| Range | 0 |
| Falloff | 0 |
| Attenuation0 | 0 |
| Attenuation1 | 0 |
| Attenuation2 | 0 |
| Theta | 0 |
| Phi | 0 |
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | d3d9.h (include D3D9.h) |
| Library | D3D9.lib |