ILampArray::GetLampInfo

Returns an ILampInfo for the Lamp at the given index.

Syntax

HRESULT GetLampInfo(
    uint32_t lampIndex,
    ILampInfo** lampInfo)

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