Namespace UnityEngine.XR.OpenXR.NativeTypes
Classes
OpenXRNativeApi
OpenXR native API.
For more information, refer to OpenXR native API in the user manual.
PollEventRouter
Manages subscriptions to events received from xrPollEvent.
The OpenXR Plug-in calls xrPollEvent every frame during UnityEngine.Application.onBeforeRender.
XrEyeVisibility
Specifies which eye to display a composition layer to, as defined by the OpenXR specification.
XrResultExtensions
Extension methods for XrResult.
XrSpatialPersistenceContextResultEXTExtensions
Extension methods for XrSpatialPersistenceContextResultEXT.
Structs
OpenXRResultStatus
Represents the status of a completed operation as a Unity-provided statusCode and a runtime-provided nativeStatusCode.
XrBaseInStructure
Convenience type for iterating (read only).
XrBoxf
Represents a 3D bounding box. Provided by XR_VERSION_1_1.
XrCompositionLayerBaseHeader
Composition layer base header.
XrCompositionLayerCubeKHR
XrCompositionLayerCylinderKHR
XrCompositionLayerEquirect2KHR
XrCompositionLayerEquirectKHR
XrCompositionLayerProjection
XrCompositionLayerProjectionView
Projection layer element
XrCompositionLayerQuad
Quad composition layer.
XrCreateSpatialContextCompletionEXT
The completion struct for OpenXRNativeApi.xrCreateSpatialContextCompleteEXT.
Provided by XR_EXT_spatial_entity.
XrCreateSpatialDiscoverySnapshotCompletionEXT
The completion struct for OpenXRNativeApi.xrCreateSpatialDiscoverySnapshotCompleteEXT.
Provided by XR_EXT_spatial_entity.
XrCreateSpatialDiscoverySnapshotCompletionInfoEXT
The completion info for xrCreateSpatialDiscoverySnapshotCompleteEXT(ulong, in XrCreateSpatialDiscoverySnapshotCompletionInfoEXT, out XrCreateSpatialDiscoverySnapshotCompletionEXT).
Provided by XR_EXT_spatial_entity.
XrCreateSpatialImageTrackingDatabaseCompletionEXT
Completion struct populated by
xrCreateSpatialImageTrackingDatabaseCompleteEXT
when the future returned by
xrCreateSpatialImageTrackingDatabaseAsyncEXT
is ready.
Provided by XR_EXT_spatial_image_tracking.
XrCreateSpatialPersistenceContextCompletionEXT
The completion struct for OpenXRNativeApi.xrCreateSpatialPersistenceContextCompleteEXT.
Provided by XR_EXT_spatial_persistence.
XrEventDataBaseHeader
The base header for events. Use the type field to identify which event type this struct contains, then cast the pointer to the corresponding struct type.
XrEventDataSpatialDiscoveryRecommendedEXT
Represents an event where the runtime recommends that you call
xrCreateSpatialDiscoverySnapshotAsyncEXT(ulong, in XrSpatialDiscoverySnapshotCreateInfoEXT, out ulong) for the given spatial context.
Provided by XR_EXT_spatial_entity.
XrExtent2Df
Extent in two dimensions.
XrExtent2Di
Extent in two dimensions.
XrExtent3Df
Represents the extents of a 3D bounding box. The width, height, and depth values must be non-negative.
Provided by XR_VERSION_1_1.
XrFoveationLevelProfileCreateInfoFB
Extends XrFoveationProfileCreateInfoFB to request a foveation profile that applies a
fixed foveation pattern at a chosen level. Provided by XR_FB_foveation_configuration.
XrFovf
Field of view.
XrFutureCancelInfoEXT
The cancel info struct used by OpenXRNativeApi.xrCancelFutureEXT. Provided by XR_EXT_future.
XrFutureCompletionBaseHeaderEXT
Base header for future completion structs. Provided by EXT_future.
XrFutureCompletionEXT
A minimal implementation of XrFutureCompletionBaseHeaderEXT, containing only the properties
present in the base header structure. This struct is intended for use by asynchronous operations that do not
have other outputs or return values beyond an XrResult value. Provided by EXT_future.
XrFuturePollInfoEXT
The poll info struct used by OpenXRNativeApi.xrPollFutureEXT. Provided by EXT_future.
XrFuturePollResultEXT
The poll result struct used by OpenXRNativeApi.xrPollFutureEXT. Provided by EXT_future.
XrHandJointLocationEXT
Describes the location and radius of a hand joint. Provided by XR_EXT_hand_tracking.
XrHandJointLocationsEXT
Contains the output of a hand joint locate operation. Provided by XR_EXT_hand_tracking.
XrHandJointVelocitiesEXT
Contains the velocities of hand joints. Provided by XR_EXT_hand_tracking.
XrHandJointVelocityEXT
Describes the velocity of a hand joint. Provided by XR_EXT_hand_tracking.
XrHandJointsLocateInfoEXT
Describes the information to locate hand joints. Provided by XR_EXT_hand_tracking.
XrHandJointsMotionRangeInfoEXT
Extends XrHandJointsLocateInfoEXT to constrain the returned hand joint
poses to either natural movement or movement that conforms to a held
controller. Provided by XR_EXT_hand_joints_motion_range.
XrHandTrackerCreateInfoEXT
Describes the information to create a hand tracker. Provided by XR_EXT_hand_tracking.
XrHandTrackingDataSourceInfoEXT
Extends XrHandTrackerCreateInfoEXT to specify which hand tracking data
sources the application prefers. Provided by XR_EXT_hand_tracking_data_source.
XrHandTrackingDataSourceStateEXT
Extends XrHandJointLocationsEXT to report which hand tracking data source
the runtime used to produce the joint locations for the most recent
xrLocateHandJointsEXT call. Provided by XR_EXT_hand_tracking_data_source.
XrOffset2Di
Offset in two dimensions
XrPersistSpatialEntityCompletionEXT
The completion struct for xrPersistSpatialEntityCompleteEXT(ulong, ulong, out XrPersistSpatialEntityCompletionEXT).
Provided by XR_EXT_spatial_persistence_operations.
XrPosef
A construct representing a position and orientation within a space, with position expressed in meters, and orientation represented as a unit quaternion. OpenXR Spec
XrQuaternionf
Represents a quaternion in OpenXR coordinates.
XrRect2Di
Rect in two dimensions, integer values.
XrSpatialAnchorCreateInfoEXT
Creation info struct used by
xrCreateSpatialAnchorEXT(ulong, in XrSpatialAnchorCreateInfoEXT, out ulong, out ulong).
Provided by XR_EXT_spatial_anchor.
XrSpatialAnchorParentANDROID
Chains into next to specify a parent spatial entity
when creating a bound anchor via xrCreateSpatialAnchorEXT.
Provided by XR_ANDROID_spatial_entity_bound_anchor.
XrSpatialBounded2DDataEXT
The bounded 2D component. Provided by XR_EXT_spatial_entity.
XrSpatialBufferEXT
Represents of buffer of variable-sized data contained in spatial component. Provided by XR_EXT_spatial_entity.
XrSpatialBufferGetInfoEXT
Represents the information necessary to get the contents of a XrSpatialBufferEXT.
Provided by XR_EXT_spatial_entity.
XrSpatialCapabilityComponentTypesEXT
Used by OpenXRNativeApi.xrEnumerateSpatialCapabilityComponentTypesEXT to get the supported
component types for a given capability. Provided by XR_EXT_spatial_entity.
XrSpatialCapabilityConfigurationAnchorEXT
Capability configuration struct for the anchor capability.
Provided by XR_EXT_spatial_anchor.
XrSpatialCapabilityConfigurationAprilTagEXT
Capability configuration struct for the April Tag tracking capability.
Provided by XR_EXT_spatial_marker_tracking.
XrSpatialCapabilityConfigurationArucoMarkerEXT
Capability configuration struct for the ArUco marker tracking capability.
Provided by XR_EXT_spatial_marker_tracking.
XrSpatialCapabilityConfigurationBaseHeaderEXT
Base header for capability configuration structs. Provided by XR_EXT_spatial_entity.
XrSpatialCapabilityConfigurationDepthRaycastANDROID
Capability configuration struct for the depth raycast capability.
Provided by XR_ANDROID_spatial_discovery_raycast.
XrSpatialCapabilityConfigurationImageTrackingEXT
Capability configuration struct for the image tracking capability.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialCapabilityConfigurationMicroQrCodeEXT
Capability configuration struct for the Micro QR code tracking capability.
Provided by XR_EXT_spatial_marker_tracking.
XrSpatialCapabilityConfigurationPlaneTrackingEXT
Capability configuration struct for the plane tracking capability.
Provided by XR_EXT_spatial_plane_tracking.
XrSpatialCapabilityConfigurationQrCodeEXT
Capability configuration struct for the QR code tracking capability.
Provided by XR_EXT_spatial_marker_tracking.
XrSpatialComponentAnchorListEXT
Anchor component list structure, used to query component data. Provided by XR_EXT_spatial_anchor.
XrSpatialComponentBounded2DListEXT
Bounded 2d component list structure, used to query component data. Provided by XR_EXT_spatial_entity.
XrSpatialComponentBounded3DListEXT
Bounded 3d component list structure, used to query component data. Provided by XR_EXT_spatial_entity.
XrSpatialComponentDataQueryConditionEXT
Represents a spatial component data query condition,
used by OpenXRNativeApi.xrQuerySpatialComponentDataEXT. Provided by XR_EXT_spatial_entity.
XrSpatialComponentDataQueryResultEXT
Represents the result of the OpenXRNativeApi.xrQuerySpatialComponentDataEXT operation.
Provided by XR_EXT_spatial_entity.
XrSpatialComponentImage2DListEXT
Output list struct for the Image 2D component, chained to
XrSpatialComponentDataQueryResultEXT.next when
querying image tracking entities.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialComponentMarkerListEXT
Marker component list structure, used to query component data. Provided by XR_EXT_spatial_marker_tracking.
XrSpatialComponentMesh2DListEXT
Mesh 2D component list structure, used to query for component data. Provided by XR_EXT_spatial_plane_tracking.
XrSpatialComponentMesh3DListEXT
Mesh 3d component list structure, used to query component data. Provided by XR_EXT_spatial_entity.
XrSpatialComponentParentListEXT
Parent component list structure, used to query component data. Provided by XR_EXT_spatial_entity.
XrSpatialComponentPersistenceListEXT
Persistence component list structure, used to query component data. Provided by XR_EXT_spatial_persistence.
XrSpatialComponentPlaneAlignmentListEXT
Plane alignment component list structure, used to query component data.
Provided by XR_EXT_spatial_plane_tracking.
XrSpatialComponentPlaneSemanticLabelListEXT
Plane semantic label component list structure, used to query component data.
Provided by XR_EXT_spatial_plane_tracking.
XrSpatialComponentPolygon2DListEXT
Polygon 2D component list structure, used to query component data. Provided by XR_EXT_spatial_plane_tracking.
XrSpatialComponentRaycastResultListANDROID
Raycast result component list structure, used to query component data.
Provided by XR_ANDROID_spatial_discovery_raycast.
XrSpatialComponentSubsumedByListANDROID
Subsumed-by component list structure, used to query component data.
Provided by XR_ANDROID_spatial_component_subsumed_by.
XrSpatialContextCreateInfoEXT
Represents the creation info for a spatial context. Provided by XR_EXT_spatial_entity.
XrSpatialContextPersistenceConfigEXT
Capability configuration struct for the persistence capability.
Provided by XR_EXT_spatial_persistence.
XrSpatialDiscoveryPersistenceUuidFilterEXT
Use this struct in the next chain of XrSpatialDiscoverySnapshotCreateInfoEXT to scope the
discovery operation to only include entities whose persisted UUIDs are in the given array.
Provided by XR_EXT_spatial_persistence.
XrSpatialDiscoverySnapshotCreateInfoEXT
Creation info for a discovery snapshot, used by
xrCreateSpatialDiscoverySnapshotAsyncEXT(ulong, in XrSpatialDiscoverySnapshotCreateInfoEXT, out ulong). Provided by XR_EXT_spatial_entity.
XrSpatialDiscoveryUniqueEntitiesFilterANDROID
Filter that excludes subsumed entities from a discovery snapshot. Chain to the
next pointer.
Provided by XR_ANDROID_spatial_component_subsumed_by.
XrSpatialEntityFromIdCreateInfoEXT
Creation info for a spatial entity handle from the entity's ID, used by
xrCreateSpatialEntityFromIdEXT(ulong, in XrSpatialEntityFromIdCreateInfoEXT, out ulong). Provided by XR_EXT_spatial_entity.
XrSpatialEntityPersistInfoEXT
The persist info struct used by xrPersistSpatialEntityAsyncEXT(ulong, in XrSpatialEntityPersistInfoEXT, out ulong).
Provided by XR_EXT_persistence_operations.
XrSpatialEntityUnpersistInfoEXT
The unpersist info struct used by xrUnpersistSpatialEntityAsyncEXT(ulong, in XrSpatialEntityUnpersistInfoEXT, out ulong).
Provided by XR_EXT_spatial_persistence_operations.
XrSpatialFilterTrackingStateEXT
Allows you to filter the entities in a snapshot based on their tracking state.
Provided by XR_EXT_spatial_entity.
XrSpatialImage2DDataEXT
Per-entity data returned for the Image 2D component when querying spatial component data.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialImageSizeEXT
Optional next-chain struct that informs the runtime of an image's physical width in meters.
Chain to XrSpatialReferenceImageEXT.next for per-image size or
to XrSpatialImageTrackingDatabaseCreateInfoEXT.next
for a database-wide default. Per-image chaining takes precedence.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialImageStaticOptimizationEXT
Optional next-chain struct that tells the runtime an image (or database of images) is not
expected to move. Chain to
XrSpatialReferenceImageEXT.next for per-image optimization or
to XrSpatialImageTrackingDatabaseCreateInfoEXT.next
for database-wide optimization. Per-image chaining takes precedence.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialImageTrackingDatabaseCreateInfoEXT
Creation info struct passed to xrCreateSpatialImageTrackingDatabaseAsyncEXT.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialMarkerDataEXT
The marker component. Provided by XR_EXT_spatial_marker_tracking.
XrSpatialMarkerSizeEXT
Use this struct with MarkerTrackingFixedSizeMarkers to specify a pre-defined size for your markers, enabling the runtime to generate more accurate pose and size information for tracked markers.
XrSpatialMarkerStaticOptimizationEXT
Use this struct with MarkerTrackingStaticMarkers to specify that the runtime should assume that all markers are static (unable to move), enabling the runtime to generate more accurate pose and size information for tracked markers in this case.
XrSpatialMeshDataEXT
The mesh component. Provided by XR_EXT_spatial_entity.
XrSpatialPersistenceContextCreateInfoEXT
Represents the creation info for a persistence context.
Used by OpenXRNativeApi.xrCreateSpatialPersistenceContextAsyncEXT.
Provided by XR_EXT_spatial_persistence.
XrSpatialPersistenceDataEXT
The persistence component. Provided by XR_EXT_spatial_persistence.
XrSpatialPolygon2DDataEXT
Polygon 2D component. Provided by XR_EXT_spatial_plane_tracking.
XrSpatialRaycastInfoANDROID
Describes a ray used to discover spatial entities that intersect with it. Include this struct in the
next chain, or reference it from
raycastInfo.
Provided by XR_ANDROID_spatial_discovery_raycast.
XrSpatialRaycastResultDataANDROID
The raycast result component, which describes where a ray hit a spatial entity.
Provided by XR_ANDROID_spatial_discovery_raycast.
XrSpatialRaycastSnapshotCreateInfoANDROID
Information used to synchronously create a snapshot handle via raycast.
Provided by XR_ANDROID_spatial_discovery_raycast.
XrSpatialReferenceImageEXT
Describes a single input reference image for image tracking.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialReferenceImagePlaneEXT
Describes a single plane of a reference image's pixel data.
Provided by XR_EXT_spatial_image_tracking.
XrSpatialUpdateSnapshotCreateInfoEXT
Creation info for spatial update snapshot, used by
xrCreateSpatialUpdateSnapshotEXT(ulong, in XrSpatialUpdateSnapshotCreateInfoEXT, out ulong).
Provided by XR_EXT_spatial_entity.
XrSwapchainCreateInfo
Creation info for a swapchain. OpenXR Spec
XrSwapchainSubImage
Composition layer data describing the associated swapchain.
XrSystemHandTrackingPropertiesEXT
Describes hand tracking system properties. Provided by XR_EXT_hand_tracking.
XrUnpersistSpatialEntityCompletionEXT
The completion struct for xrUnpersistSpatialEntityCompleteEXT(ulong, ulong, out XrUnpersistSpatialEntityCompletionEXT).
Provided by XR_EXT_spatial_persistence_operations.
XrUuid
Represents a 128-bit Universally Unique Identifier. Provided by XR_VERSION_1_1.
XrVector2f
Two-dimensional vector.
XrVector3f
Represents a three-dimensional vector in OpenXR coordinates.
XrView
Struct containing view projection state.
Interfaces
ISpatialCapabilityConfiguration
A C# interface used to enforce conformance of derived structs from XrSpatialCapabilityConfigurationBaseHeaderEXT.
Enums
OpenXRResultStatus.StatusCode
Indicates whether the operation succeeded or failed as well as whether additional status information is available in nativeStatusCode.
XrCompositionLayerFlags
Specifies options for individual composition layers, and contains a bitwise-OR of zero or more of the bits.
XrEnvironmentBlendMode
Runtime XR Environment Blend Mode. SetEnvironmentBlendMode(XrEnvironmentBlendMode)
XrFoveationDynamicFB
The desired dynamic foveation setting, which determines whether the runtime can vary the
applied foveation level while the app is running.
Provided by XR_FB_foveation_configuration.
XrFoveationLevelFB
The maximum desired foveation level, trading periphery visual fidelity for performance.
Provided by XR_FB_foveation_configuration.
XrFutureStateEXT
Represents the possible states of a future.
XrHandEXT
Identifies a hand. Provided by XR_EXT_hand_tracking.
XrHandJointEXT
Identifies a hand joint. Provided by XR_EXT_hand_tracking.
XrHandJointSetEXT
Identifies a set of hand joints to track. Provided by XR_EXT_hand_tracking.
XrHandJointsMotionRangeEXT
Specifies the motion range constraint that the runtime should apply
when returning hand joint poses. Provided by XR_EXT_hand_joints_motion_range.
XrHandTrackingDataSourceEXT
Identifies the source of hand tracking data reported by the runtime.
Provided by XR_EXT_hand_tracking_data_source.
XrReferenceSpaceType
Runtime XR Reference Space. Features.Mock.MockRuntime.SetSpace
XrResult
Represents OpenXR's XrResult, which is the return type of all OpenXR function calls.
XrSessionState
Runtime XR Session State. Features.Mock.MockRuntime.TransitionToState
XrSpaceLocationFlags
Space Location bit flags. Features.Mock.MockRuntime.SetSpace
XrSpaceVelocityFlags
Space velocity bit flags. Equivalent to the OpenXR XrSpaceVelocityFlags flag bits.
XrSpatialBufferTypeEXT
Represents the possible types of XrSpatialBufferEXT. Provided by XR_EXT_spatial_entity.
XrSpatialCapabilityEXT
Represents the types of capabilities that can be enabled for a spatial context.
Provided by XR_EXT_spatial_entity.
XrSpatialCapabilityFeatureEXT
Represents the types of features that can be configured for a capability. Provided by XR_EXT_spatial_entity.
XrSpatialComponentTypeEXT
Represents the types of components that can exist on a spatial entity. Provided by XR_EXT_spatial_entity.
XrSpatialEntityTrackingStateEXT
Describes the tracking state of a spatial entity. Provided by XR_EXT_spatial_entity.
XrSpatialMarkerAprilTagDictEXT
Represents the supported configurations of predefined AprilTag dictionaries.
Provided by XR_spatial_marker_tracking.
XrSpatialMarkerArucoDictEXT
Represents the supported configurations of predefined ArUco dictionaries.
Provided by XR_EXT_spatial_marker_tracking.
XrSpatialPersistenceContextResultEXT
Defines the types of result codes for a persistence operation.
Provided by XR_EXT_spatial_persistence.
XrSpatialPersistenceScopeEXT
Identifies the different types of persistence context scopes.
Provided XR_EXT_spatial_persistence.
XrSpatialPersistenceStateEXT
Represents the different states of a persisted UUID. Provided by XR_EXT_spatial_persistence.
XrSpatialPlaneAlignmentEXT
Plane alignment component type. Describes the orientation of a plane associated with a spatial entity.
Provided by XR_EXT_spatial_plane_tracking.
XrSpatialPlaneSemanticLabelEXT
Plane semantic label component type. Describes a set of semantic labels for planes.
Provided by XR_EXT_spatial_plane_tracking.
XrSpatialReferenceImageFormatEXT
Identifies a reference image format supported by the runtime for image tracking.
Provided by XR_EXT_spatial_image_tracking.
XrStructureType
Values for type members of structs.
XrSwapchainUsageFlags
Values to specify the intended usage of swapchain images.
XrViewConfigurationType
Runtime View Configuration. Features.Mock.MockRuntime.SetViewState
XrViewStateFlags
Runtime view state flags. Features.Mock.MockRuntime.SetViewState
Delegates
XrPollEventCallback
Delegate type for a method that handles an event received from xrPollEvent.