IDirect3DDevice8::GetLight

Retrieves a set of lighting properties that this device uses.

HRESULT GetLight(
  DWORD Index,
  D3DLIGHT8* pLight
);

Parameters

Index

[in] Zero-based index of the lighting property set to retrieve. This method will fail if a lighting property has not been set for this index by calling the IDirect3DDevice8::SetLight method.

pLight

[out] Pointer to a D3DLIGHT8 structure that is filled with the retrieved lighting-parameter set.

Return Values

If the method succeeds, the return value is D3D_OK.

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

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.

See Also

IDirect3DDevice8::SetLight, IDirect3DDevice8::GetLightEnable, IDirect3DDevice8::LightEnable