IDirect3DLight::GetLight

The IDirect3DLight::GetLight method retrieves the light information for the Direct3DLight object.

HRESULT GetLight(
  LPD3DLIGHT lpLight  
);
 

Parameters

lpLight

Address of a D3DLIGHT2 structure that will be filled with the current light data.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value may be one of the following values:

Remarks

Although this method's declaration specifies the lpLight parameter as being the address of a D3DLIGHT structure, that structure is not normally used. Rather, the D3DLIGHT2 structure is recommended to achieve the best lighting effects.

QuickInfo

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

IDirect3DLight::SetLight