XrVector4f - Four-dimensional vector

Member Descriptions

Description

If used to represent physical distances, x, y, and z values must be in meters.

See Also

Posef, Quaternionf, Vector2f, Vector3f

XrColor4f - Color Vector

Member Descriptions

Description

Unless otherwise specified, colors are encoded as linear (not with sRGB nor other gamma compression) values with individual components being in the range of 0.0 through 1.0, and without the RGB components being premultiplied by the alpha component.

See Also

CompositionLayerColorScaleBiasKHR

XrFovf - Field of view

Member Descriptions

Description

Angles to the right of the center and upwards from the center are positive, and angles to the left of the center and down from the center are negative. The total horizontal field of view is angleRight minus angleLeft, and the total vertical field of view is angleUp minus angleDown. For a symmetric FoV, angleRight and angleUp will have positive values, angleLeft will be -angleRight, and angleDown will be -angleUp.

The angles must be specified in radians, and must be between -π/2 and π/2 exclusively.

When angleLeft > angleRight, the content of the view must be flipped horizontally. When angleDown > angleUp, the content of the view must be flipped vertically.

See Also

CompositionLayerProjectionView, View, ViewConfigurationViewFovEPIC

XrSwapchainSubImage - Composition layer data

Valid Usage (Implicit)

See Also

CompositionLayerCylinderKHR, CompositionLayerDepthInfoKHR, CompositionLayerEquirect2KHR, CompositionLayerEquirectKHR, CompositionLayerProjectionView, CompositionLayerQuad, FrameEndInfo, Rect2Di, Swapchain

XrCompositionLayerBaseHeader - Composition layer base header

Member Descriptions

Description

All composition layer structures begin with the elements described in the CompositionLayerBaseHeader. The CompositionLayerBaseHeader structure is not intended to be directly used, but forms a basis for defining current and future structures containing composition layer information. The FrameEndInfo structure contains an array of pointers to these polymorphic header structures. All composition layer type pointers must be type-castable as an CompositionLayerBaseHeader pointer.

Valid Usage (Implicit)

See Also

CompositionLayerFlags, FrameEndInfo, SecondaryViewConfigurationLayerInfoMSFT, Space, StructureType, SwapchainSubImage

XrCompositionLayerProjectionView - Projection layer element

Member Descriptions

Description

The count and order of view poses submitted with CompositionLayerProjection must be the same order as that returned by locateViews. The CompositionLayerProjectionView::pose and CompositionLayerProjectionView::fov should almost always derive from View::pose and View::fov as found in the locateViews::views array. However, applications may submit an CompositionLayerProjectionView which has a different view or FOV than that from locateViews. In this case, the runtime will map the view and FOV to the system display appropriately. In the case that two submitted views within a single layer overlap, they must be composited in view array order.

Valid Usage (Implicit)

See Also

CompositionLayerProjection, Fovf, Posef, StructureType, SwapchainSubImage

XrCompositionLayerProjection - Composition layer for projection

Member Descriptions

Description

Note

Because a runtime may reproject the layer over time, a projection layer should specify an Space in which to maximize stability of the layer content. For example, a projection layer containing world-locked content should use an Space which is also world-locked, such as the LOCAL or STAGE reference spaces. In the case that the projection layer should be head-locked, such as a heads up display, the VIEW reference space would provide the highest quality layer reprojection.

Valid Usage (Implicit)

• type must be TYPE_COMPOSITION_LAYER_PROJECTION

• next must be NULL or a valid pointer to the next structure in a structure chain
• layerFlags must be 0 or a valid combination of XrCompositionLayerFlagBits values
• space must be a valid Space handle
• views must be a pointer to an array of viewCount valid CompositionLayerProjectionView structures
• The viewCount parameter must be greater than 0

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, CompositionLayerProjectionView, Space, StructureType, SwapchainSubImage

XrCompositionLayerQuad - Quad composition layer

Member Descriptions

Description

The CompositionLayerQuad layer is useful for user interface elements or 2D content rendered into the virtual world. The layer’s SwapchainSubImage::swapchain image is applied to a quad in the virtual world space. Only front face of the quad surface is visible; the back face is not visible and must not be drawn by the runtime. A quad layer has no thickness; it is a two-dimensional object positioned and oriented in 3D space. The position of a quad refers to the center of the quad within the given Space. The orientation of the quad refers to the orientation of the normal vector from the front face. The size of a quad refers to the quad’s size in the x-y plane of the given Space’s coordinate system. A quad with a position of {0,0,0}, rotation of {0,0,0,1} (no rotation), and a size of {1,1} refers to a 1 meter x 1 meter quad centered at {0,0,0} with its front face normal vector coinciding with the +z axis.

Valid Usage (Implicit)

See Also

CompositionLayerBaseHeader, CompositionLayerFlags, Extent2Df, EyeVisibility, Posef, Space, StructureType, SwapchainSubImage

XrHapticVibration - Base header for haptic feedback

Member Descriptions

Description

The HapticVibration is used in calls to applyHapticFeedback that trigger vibration output actions.

The duration, and frequency parameters may be clamped to implementation-dependent ranges.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrDuration, HapticBaseHeader, StructureType, applyHapticFeedback

XrEventDataBaseHeader - Base header for an event

Parameter Descriptions

Description

The EventDataBaseHeader is a generic structure used to identify the common event data elements.

Upon receipt, the EventDataBaseHeader pointer should be type-cast to a pointer of the appropriate event data based on the type parameter.

Valid Usage (Implicit)

See Also

StructureType, pollEvent

XrEventDataEventsLost - Event indicating events were lost

Member Descriptions

Description

Receiving the EventDataEventsLost event structure indicates that the event queue overflowed and some events were removed at the position within the queue at which this event was found.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, StructureType, pollEvent

XrEventDataInstanceLossPending - Event indicating instance loss will occur

Members

Receiving the EventDataInstanceLossPending event structure indicates that the application is about to lose the indicated Instance at the indicated lossTime in the future. The application should call destroyInstance and relinquish any instance-specific resources. This typically occurs to make way for a replacement of the underlying runtime, such as via a software update.

Description

After the application has destroyed all of its instances and their children and waited past the specified time, it may then re-try createInstance in a loop waiting for whatever maintenance the runtime is performing to complete. The runtime will return ERROR_INSTANCE_LOST from createInstance as long as it is unable to create the instance. Once the runtime has returned and is able to continue, it must resume returning SUCCESS from createInstance if valid data is passed in.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, pollEvent

XrEventDataSessionStateChanged - Event indicating session state changed

Member Descriptions

Description

Receiving the EventDataSessionStateChanged event structure indicates that the application has changed lifecycle state.

Valid Usage (Implicit)

See Also

EventDataBaseHeader, Session, SessionState, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, pollEvent

XrEventDataReferenceSpaceChangePending - Notifies the application that a reference space is changing

Valid Usage (Implicit)

See Also

REFERENCE_SPACE_TYPE_STAGE, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, Posef, ReferenceSpaceType, Session, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, createReferenceSpace

XrEventDataInteractionProfileChanged - Notifies the application than the active interaction profile has changed

Member Descriptions

Description

The EventDataInteractionProfileChanged event is sent to the application to notify it that the active input form factor for one or more top level user paths has changed. This event must only be sent for interaction profiles that the application indicated its support for via suggestInteractionProfileBindings. This event must only be sent for running sessions.

The application can call getCurrentInteractionProfile if it wants to change its own behavior based on the active hardware.

Valid Usage (Implicit)

See Also

Session, StructureType, getCurrentInteractionProfile, suggestInteractionProfileBindings

XrOffset2Df - Float offset in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point). If used to represent physical distances, values must be in meters.

See Also

Extent2Df, Rect2Df

XrExtent2Df - Extent in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point). If used to represent physical distances, values must be in meters.

The width and height value must be non-negative.

See Also

CompositionLayerQuad, Offset2Df, Rect2Df, getReferenceSpaceBoundsRect

XrRect2Df - Rect in two dimensions

Member Descriptions

Description

This structure is used for component values that may be fractional (floating-point).

See Also

Extent2Df, Offset2Df

XrBaseInStructure - Convenience type for iterating (read only)

Member Descriptions

Description

BaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

BaseInStructure, BaseOutStructure, StructureType

XrBaseOutStructure - Convenience type for iterating (mutable)

Member Descriptions

Description

BaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

BaseInStructure, BaseOutStructure, StructureType

XrObjectType - Specify an enumeration to track object handle types

Description

The ObjectType enumeration defines values, each of which corresponds to a specific OpenXR handle type. These values can be used to associate debug information with a particular type of object through one or more extensions.

The following table defines ObjectType and OpenXR Handle relationships:

See Also

DebugUtilsObjectNameInfoEXT