C Specification

XR_DEFINE_HANDLE(XrSession)

Description

A session represents an application’s intention to display XR content to the user. An application makes its XR content eligible to be displayed by beginning a session with xrBeginSession, causing it to enter the running state. It may then hide its XR content for some period by ending its session with xrEndSession, causing it to leave the running state.

Only running sessions may become focused sessions that receive XR input. When a session is not running, the application must not submit frames. This is important because without a running session, the runtime no longer has to spend resources on sub-systems (tracking etc.) that are no longer needed by the application.

A session may be running but not currently visible, as another running session may take precedence. The XrEventDataSessionStateChanged event indicates changes to visibility or input focus states. Runtimes each establish their own policy for when an application has the right to make its running session visible in the XR display.

An application must set the current view configuration and supported view configurations before calling xrBeginSession.

See Also

Document Notes

For more information, see the OpenXR Specification at URL

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

Copyright (c) 2014-2019 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.