Share via


ILampInfo::GetScanCode

Returns the keyboard scan code associated with this Lamp.

Syntax

uint32_t GetScanCode(
)

Parameters

This method has no parameters.

Return value

Type: uint32_t

The keyboard scan code associated with this Lamp. Returns 0 if this Lamp is not addressable by a keyboard scan code.

Remarks

This method will return 0 if the LampArray does not support scan codes (see ILampArray::SupportsScanCodes).

Requirements

Header: LampArray.h

Library: xgameplatform.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

Lighting API Overview
Windows Keyboard Input Reference - Scan Codes
ILampInfo