Skip to main content

ILampArray::GetIndicesForPurposes

Populates a buffer of Lamp indices that support a given set of LampPurposes. Prior to calling this method, the maximum buffer size should be obtained by calling ILampArray::GetIndicesCountForPurposes.

Syntax

Parameters

lampPurposes Type: LampPurposes The desired set of LampPurposes. lampIndicesCount
Type: uint32_t
The size of the buffer to populate. lampIndices  _Out_writes_(lampIndicesCount) Type: uint32_t* The Lamp indices buffer. Indices written into the buffer are for Lamps that match all of the flags in lampPurposes.

Return value

Type: void

Remarks

The following code demonstrates how to set a color for all branding Lamps on an ILampArray:

Requirements

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

See also

Lighting API Overview
ILampArray::GetIndicesCountForPurposes
ILampArray::SetColorsForIndices
ILampArray
Last modified on August 20, 2026