XrResult xrPollEvent( XrInstance instance, XrEventDataBuffer* eventData);
xrPollEvent polls for the next event and returns an event if one is
xrPollEvent returns immediately regardless of whether an event was
The event (if present) is unilaterally removed from the queue if a valid
XrInstance is provided.
On return the
eventData parameter is filled with the event’s data and
the type field is changed to the event’s type.
Runtimes may create valid next chains depending on enabled extensions, but
they must guarantee that any such chains point only to objects which fit
completely within the original XrEventDataBuffer pointed to by
The runtime must discard queued events which contain destroyed or otherwise invalid handles.
event queue has overflowed and some events were lost
application is about to lose the instance
active input form factor for one or more top level user paths has changed
runtime will begin operating with updated space bounds
application has changed lifecycle state
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 (c) 2014-2021, The Khronos Group Inc.
This work is licensed under a Creative Commons Attribution 4.0 International License.