Share via


LampArrayStatusCallback

Title defined callback for LampArray status changed events. This function is registered with RegisterLampArrayStatusCallback.

Syntax

typedef void (CALLBACK * LampArrayStatusCallback)(
    _In_opt_ void * context,
    LampArrayStatus currentStatus,
    LampArrayStatus previousStatus,
    _In_ ILampArray * lampArray);

Parameters

context   _In_opt_
Type: void*

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

currentStatus
Type: LampArrayStatus

The new status of the LampArray.

previousStatus
Type: LampArrayStatus

The previous status of the LampArray.

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 RegisterLampArrayStatusCallback. It will define the function that is called whenever the LampArray status changes.

Requirements

Header: LampArray.h

Library: xgameplatform.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

Lighting API Overview
Lighting Basics
RegisterLampArrayStatusCallback
UnregisterLampArrayCallback