XrEventDataLocalizationChangedML(3)

C Specification

The XrEventDataLocalizationChangedML structure is defined as:

// Provided by XR_ML_localization_map
typedef struct XrEventDataLocalizationChangedML {
     XrStructureType                 type;
    const void*                      next;
    XrSession                        session;
    XrLocalizationMapStateML         state;
    XrLocalizationMapML              map;
    XrLocalizationMapConfidenceML    confidence;
    XrLocalizationMapErrorFlagsML    errorFlags;
} XrEventDataLocalizationChangedML;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain.
session is the session to which this change event applies.
state is the current XrLocalizationMapStateML of the map.
map is the XrLocalizationMapML of the current map.
confidence is the XrLocalizationMapConfidenceML of the current map.
errorFlags is a a bitwise-OR of zero or more of the bits defined in XrLocalizationMapErrorFlagBitsML in the case that the localization map has low confidence.

Description

By default the runtime does not send these events but calling xrEnableLocalizationEventsML function enables the events. When this function is called the XrEventDataLocalizationChangedML event will always be posted to the event queue, regardless of whether the map localization state has changed. This allows the application to synchronize with the current state.

Note

The arrival of the event is asynchronous to this call.

Valid Usage (Implicit)

The XR_ML_localization_map extension must be enabled prior to using XrEventDataLocalizationChangedML
type must be XR_TYPE_EVENT_DATA_LOCALIZATION_CHANGED_ML
next must be NULL or a valid pointer to the next structure in a structure chain

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

This work is licensed under a Creative Commons Attribution 4.0 International License.

XrEventDataLocalizationChangedML(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright