Skip to main content

ILampArray::GetLampInfo

Returns an ILampInfo for the Lamp at the given index.

Syntax

Parameters

lampIndex
Type: uint32_t
The desired index in the ILampArray for which to obtain an ILampInfo. lampInfo  _COM_Outptr_
Type: ILampInfo**
The ILampInfo corresponding to lampIndex. This will be null if lampIndex is greater than or equal to ILampArray::GetLampCount;

Return value

Type: HRESULT Function result.

Remarks

The ILampInfo contains properties about a Lamp at a given index in the ILampArray.

Requirements

Header: LampArray.h Library: xgameplatform.lib Supported platforms: XBOX One family consoles and XBOX Series consoles

See also

Lighting API Overview
ILampArray
ILampInfo
Last modified on August 20, 2026