LampArrayCallback

Title defined callback for LampArray connected and disconnected events. This function is registered with RegisterLampArrayCallback.

Syntax

typedef void (CALLBACK * LampArrayCallback)(
    void * context,
    bool isAttached,
    ILampArray * lampArray);  

Parameters

context   _In_opt_
Type: void*

A pointer to an object containing relevant information for the callback. This pointer was passed to RegisterLampArrayCallback.

isAttached
Type: bool

Indicates whether the LampArray was attached to the system.

lampArray   _In_
Type: ILampArray*

Device which triggered the callback.

Return value

Type: void

Remarks

This function's definition is determined by the developer, but the parameters of that function must match in order for the callback to occur. This function is used to define the LampArray device callback registered with RegisterLampArrayCallback. It will define the function that is called whenever a LampArray is attached or removed from the system.

Requirements

Header: LampArray.h

Library: xgameplatform.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

Lighting API Overview
Lighting Basics
RegisterLampArrayCallback
UnregisterLampArrayCallback