ILampArray::SetIsEnabled

Sets the enabled state of an ILampArray for the current process.

Syntax

void SetIsEnabled(
    bool isEnabled)

Parameters

isEnabled
Type: bool

The desired enabled state of the ILampArray.

Return value

Type: void

Remarks

When disabled, state for Lamps can be set internally, but will not be sent to the device. When set back to enabled, modified Lamp state is flushed to the device.

By default, ILampArrays are always enabled.

Requirements

Header: LampArray.h

Library: xgameplatform.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

Lighting API Overview
ILampArray::GetIsEnabled
ILampArray