Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
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
);

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 IDirect3DMobileDevice::SetLightmethod.

pLight

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

pFormat

[in] A pointer to a of the D3DMFORMATenumerated type that describes the format of the light.

Return Value

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).

Requirements

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

See Also