IDirect3DMobileDevice::GetLight

A version of this page is also available for

4/8/2010

This method retrieves a set of lighting properties that this device uses.

Syntax

HRESULT GetLight(
  DWORD Index,
  D3DMLIGHT* pLight,
  D3DMFORMAT* pFormat
);

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 IDirect3DMobileDevice::SetLight method.

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

pFormat
[in] A pointer to a of the D3DMFORMAT enumerated type that describes the format of the light.

If the method succeeds, the return value is D3DM_OK (see D3DM Values).

If the method fails, the return value can be D3DMERR_INVALIDCALL (see D3DMERR Values).

Header	d3dm.h
Library	D3dm.lib, D3dmguid.lib
Windows Embedded CE	Windows CE 5.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later