Crate openxr

Crate openxr 

Source
Expand description

To get started, construct an Entry object.

Re-exports§

pub use sys;

Modules§

headless
opengl
opengles
raw
vulkan

Structs§

Action
ActionSet
ActionState
ActionType
See XrActionType
ActiveActionSet
AnchorPersistStateANDROID
See XrAnchorPersistStateANDROID
AndroidSurfaceSwapchainFlagsFB
See XrAndroidSurfaceSwapchainFlagsFB
AndroidThreadTypeKHR
Android Thread Types - see XrAndroidThreadTypeKHR
ApiLayerProperties
See XrApiLayerProperties
ApplicationInfo
AsyncRequestIdFB
Binding
BlendFactorFB
See XrBlendFactorFB
BodyJointBD
See XrBodyJointBD
BodyJointConfidenceHTC
See XrBodyJointConfidenceHTC
BodyJointFB
See XrBodyJointFB
BodyJointHTC
See XrBodyJointHTC
BodyJointLocationBD
See XrBodyJointLocationBD - defined by XR_BD_body_tracking
BodyJointLocationFB
See XrBodyJointLocationFB - defined by XR_FB_body_tracking
BodyJointLocationHTC
See XrBodyJointLocationHTC - defined by XR_HTC_body_tracking
BodyJointSetBD
Describes the set of body joints to track when creating an XrBodyTrackerBD. - see XrBodyJointSetBD
BodyJointSetFB
Describes the set of body joints to track when creating an XrBodyTrackerFB. - see XrBodyJointSetFB
BodyJointSetHTC
See XrBodyJointSetHTC
BodySkeletonJointFB
See XrBodySkeletonJointFB - defined by XR_FB_body_tracking
BodySkeletonJointHTC
See XrBodySkeletonJointHTC
BodyTrackingCalibrationStateMETA
See XrBodyTrackingCalibrationStateMETA
Boxf
See XrBoxf
ColocationAdvertisementCompleteMETA
ColocationDiscoveryCompleteMETA
ColocationDiscoveryResultMETA
Color3f
See XrColor3f
Color4f
See XrColor4f
ColorSpaceFB
See XrColorSpaceFB
CompareOpFB
See XrCompareOpFB
CompositionLayerBase
CompositionLayerCubeKHR
CompositionLayerCylinderKHR
CompositionLayerEquirect2KHR
CompositionLayerEquirectKHR
CompositionLayerFlags
See XrCompositionLayerFlagBits
CompositionLayerImageLayoutFlagsFB
See XrCompositionLayerImageLayoutFlagsFB
CompositionLayerProjection
CompositionLayerProjectionView
CompositionLayerQuad
CompositionLayerSecureContentFlagsFB
See XrCompositionLayerSecureContentFlagsFB
CompositionLayerSettingsFlagsFB
See XrCompositionLayerSettingsFlagsFB
CompositionLayerSpaceWarpInfoFlagsFB
See XrCompositionLayerSpaceWarpInfoFlagsFB
DebugUtilsMessageSeverityFlagsEXT
See XrDebugUtilsMessageSeverityFlagsEXT
DebugUtilsMessageTypeFlagsEXT
See XrDebugUtilsMessageTypeFlagsEXT
DigitalLensControlFlagsALMALENCE
See XrDigitalLensControlFlagsALMALENCE
DisplayRefreshRateChangedFB
Duration
Entry
Entry point to the API. Start here.
EnvironmentBlendMode
See XrEnvironmentBlendMode
EnvironmentDepthProviderCreateFlagsMETA
See XrEnvironmentDepthProviderCreateFlagsMETA
EnvironmentDepthSwapchainCreateFlagsMETA
See XrEnvironmentDepthSwapchainCreateFlagsMETA
EventDataBuffer
EventsLost
ExtensionSet
A subset of known extensions
Extent2Df
See XrExtent2Df
Extent2Di
See XrExtent2Di
Extent3Df
See XrExtent3Df
ExternalCameraAttachedToDeviceOCULUS
See XrExternalCameraAttachedToDeviceOCULUS
ExternalCameraExtrinsicsOCULUS
See XrExternalCameraExtrinsicsOCULUS - defined by XR_OCULUS_external_camera
ExternalCameraIntrinsicsOCULUS
See XrExternalCameraIntrinsicsOCULUS - defined by XR_OCULUS_external_camera
ExternalCameraStatusFlagsOCULUS
See XrExternalCameraStatusFlagsOCULUS
EyeCalibrationChangedML
EyeCalibrationStatusML
See XrEyeCalibrationStatusML
EyeExpressionHTC
See XrEyeExpressionHTC
EyePositionFB
See XrEyePositionFB
EyeVisibility
eye visibility selector - see XrEyeVisibility
FaceConfidence2FB
See XrFaceConfidence2FB
FaceConfidenceFB
See XrFaceConfidenceFB
FaceConfidenceRegionsANDROID
See XrFaceConfidenceRegionsANDROID
FaceExpression2FB
See XrFaceExpression2FB
FaceExpressionBD
See XrFaceExpressionBD
FaceExpressionFB
See XrFaceExpressionFB
FaceExpressionSet2FB
See XrFaceExpressionSet2FB
FaceExpressionSetFB
See XrFaceExpressionSetFB
FaceParameterIndicesANDROID
See XrFaceParameterIndicesANDROID
FaceTrackingDataSource2FB
See XrFaceTrackingDataSource2FB
FaceTrackingStateANDROID
See XrFaceTrackingStateANDROID
FacialBlendShapeML
Each facial blend shape describes an area/region of a face. - see XrFacialBlendShapeML
FacialExpressionBlendShapePropertiesFlagsML
See XrFacialExpressionBlendShapePropertiesFlagsML
FacialSimulationModeBD
See XrFacialSimulationModeBD
FacialTrackingTypeHTC
See XrFacialTrackingTypeHTC
ForceFeedbackCurlApplyLocationMNDX
See XrForceFeedbackCurlApplyLocationMNDX - defined by XR_MNDX_force_feedback_curl
ForceFeedbackCurlLocationMNDX
See XrForceFeedbackCurlLocationMNDX
FormFactor
See XrFormFactor
FoveationConfigurationHTC
See XrFoveationConfigurationHTC - defined by XR_HTC_foveation
FoveationDynamicFB
See XrFoveationDynamicFB
FoveationDynamicFlagsHTC
See XrFoveationDynamicFlagsHTC
FoveationEyeTrackedProfileCreateFlagsMETA
See XrFoveationEyeTrackedProfileCreateFlagsMETA
FoveationEyeTrackedStateFlagsMETA
See XrFoveationEyeTrackedStateFlagsMETA
FoveationLevelFB
See XrFoveationLevelFB
FoveationLevelHTC
See XrFoveationLevelHTC
FoveationLevelProfile
FoveationModeHTC
See XrFoveationModeHTC
FoveationProfileFB
Fovf
See XrFovf
FrameEndInfoFlagsML
See XrFrameEndInfoFlagsML
FrameState
Result of method calls on FrameWaiter
FrameStream
Handle for managing frame presentation
FrameSynthesisInfoFlagsEXT
See XrFrameSynthesisInfoFlagsEXT
FrameWaiter
Handle for waiting to render a frame
Frustumf
See XrFrustumf
FullBodyJointMETA
See XrFullBodyJointMETA
FutureStateEXT
See XrFutureStateEXT
GlobalDimmerFrameEndInfoFlagsML
See XrGlobalDimmerFrameEndInfoFlagsML
Hand
See XrHandEXT
HandEXT
See XrHandEXT
HandForearmJointULTRALEAP
See XrHandForearmJointULTRALEAP
HandJoint
See XrHandJointEXT
HandJointEXT
See XrHandJointEXT
HandJointLocation
See XrHandJointLocationEXT - defined by XR_EXT_hand_tracking
HandJointLocationEXT
See XrHandJointLocationEXT - defined by XR_EXT_hand_tracking
HandJointSetEXT
See XrHandJointSetEXT
HandJointVelocity
See XrHandJointVelocityEXT - defined by XR_EXT_hand_tracking
HandJointVelocityEXT
See XrHandJointVelocityEXT - defined by XR_EXT_hand_tracking
HandJointsMotionRangeEXT
See XrHandJointsMotionRangeEXT
HandMeshVertexMSFT
See XrHandMeshVertexMSFT - defined by XR_MSFT_hand_tracking_mesh
HandPoseTypeMSFT
See XrHandPoseTypeMSFT
HandTracker
HandTrackingAimFlagsFB
See XrHandTrackingAimFlagsFB
HandTrackingDataSourceEXT
See XrHandTrackingDataSourceEXT
Haptic
Tag for haptic output actions
HapticBase
HapticPcmVibrationFB
HapticVibration
HeadsetFitChangedML
HeadsetFitStatusML
See XrHeadsetFitStatusML
InputSourceLocalizedNameFlags
See XrInputSourceLocalizedNameFlagBits
Instance
Root object mediating an application’s interaction with OpenXR
InstanceCreateFlags
See XrInstanceCreateFlagBits
InstanceExtensions
Extensions used internally by the bindings
InstanceLossPending
InstanceProperties
InteractionProfileChanged
InteractionRenderModelsChangedEXT
KeyboardTrackingFlagsFB
See XrKeyboardTrackingFlagsFB
KeyboardTrackingQueryFlagsFB
See XrKeyboardTrackingQueryFlagsFB
LipExpressionBD
See XrLipExpressionBD
LipExpressionHTC
See XrLipExpressionHTC
LoadError
An error encountered while loading entry points from a dynamic library at run time
LoaderInterfaceStructs
See XrLoaderInterfaceStructs
LocalDimmingModeMETA
See XrLocalDimmingModeMETA
LocalizationChangedML
LocalizationMapConfidenceML
See XrLocalizationMapConfidenceML
LocalizationMapErrorFlagsML
See XrLocalizationMapErrorFlagsML
LocalizationMapML
LocalizationMapStateML
See XrLocalizationMapStateML
LocalizationMapTypeML
See XrLocalizationMapTypeML
MainSessionVisibilityChangedEXTX
MarkerAprilTagDictML
See XrMarkerAprilTagDictML
MarkerArucoDictML
See XrMarkerArucoDictML
MarkerDetectorCameraML
See XrMarkerDetectorCameraML
MarkerDetectorCornerRefineMethodML
See XrMarkerDetectorCornerRefineMethodML
MarkerDetectorFpsML
See XrMarkerDetectorFpsML
MarkerDetectorFullAnalysisIntervalML
See XrMarkerDetectorFullAnalysisIntervalML
MarkerDetectorProfileML
See XrMarkerDetectorProfileML
MarkerDetectorResolutionML
See XrMarkerDetectorResolutionML
MarkerDetectorStatusML
See XrMarkerDetectorStatusML
MarkerTrackingUpdateVARJO
MarkerTypeML
See XrMarkerTypeML
MeshComputeLodMSFT
See XrMeshComputeLodMSFT
NegotiateApiLayerRequest
See XrNegotiateApiLayerRequest
NegotiateLoaderInfo
See XrNegotiateLoaderInfo
NegotiateRuntimeRequest
See XrNegotiateRuntimeRequest
ObjectLabelANDROID
See XrObjectLabelANDROID
ObjectType
Enums to track objects of various types - see XrObjectType
Offset2Df
See XrOffset2Df
Offset2Di
See XrOffset2Di
Offset3DfFB
See XrOffset3DfFB - defined by XR_FB_scene
OverlayMainSessionFlagsEXTX
See XrOverlayMainSessionFlagsEXTX
OverlaySessionCreateFlagsEXTX
See XrOverlaySessionCreateFlagsEXTX
Passthrough
A passthrough feature.
PassthroughCameraStateANDROID
See XrPassthroughCameraStateANDROID
PassthroughCapabilityFlagsFB
See XrPassthroughCapabilityFlagsFB
PassthroughColorLutChannelsMETA
See XrPassthroughColorLutChannelsMETA
PassthroughFlagsFB
See XrPassthroughFlagsFB
PassthroughFormHTC
See XrPassthroughFormHTC
PassthroughLayerFB
A passthrough layer.
PassthroughLayerPurposeFB
See XrPassthroughLayerPurposeFB
PassthroughLayerResumedMETA
PassthroughPreferenceFlagsMETA
See XrPassthroughPreferenceFlagsMETA
PassthroughStateChangedFB
PassthroughStateChangedFlagsFB
See XrPassthroughStateChangedFlagsFB
Path
PerfSettingsDomainEXT
See XrPerfSettingsDomainEXT
PerfSettingsEXT
PerfSettingsLevelEXT
See XrPerfSettingsLevelEXT
PerfSettingsNotificationLevelEXT
See XrPerfSettingsNotificationLevelEXT
PerfSettingsSubDomainEXT
See XrPerfSettingsSubDomainEXT
PerformanceMetricsCounterFlagsMETA
See XrPerformanceMetricsCounterFlagsMETA
PerformanceMetricsCounterUnitMETA
See XrPerformanceMetricsCounterUnitMETA
PersistenceLocationBD
See XrPersistenceLocationBD
PlaneDetectionCapabilityFlagsEXT
See XrPlaneDetectionCapabilityFlagsEXT
PlaneDetectionStateEXT
See XrPlaneDetectionStateEXT
PlaneDetectorFlagsEXT
See XrPlaneDetectorFlagsEXT
PlaneDetectorOrientationEXT
See XrPlaneDetectorOrientationEXT
PlaneDetectorSemanticTypeEXT
See XrPlaneDetectorSemanticTypeEXT
PlaneLabelANDROID
See XrPlaneLabelANDROID
PlaneOrientationBD
See XrPlaneOrientationBD
PlaneTypeANDROID
See XrPlaneTypeANDROID
Posef
See XrPosef
Quaternionf
See XrQuaternionf
RawEntry
Rect2Df
See XrRect2Df
Rect2Di
See XrRect2Di
Rect3DfFB
See XrRect3DfFB - defined by XR_FB_scene
ReferenceSpaceChangePending
ReferenceSpaceType
See XrReferenceSpaceType
RenderModelFlagsFB
See XrRenderModelFlagsFB
RenderModelKeyFB
RenderModelLoadInfoFB
See XrRenderModelLoadInfoFB - defined by XR_FB_render_model
RenderModelPropertiesFB
Render model properties obtained from Session::get_render_model_properties_fb
ReprojectionModeMSFT
See XrReprojectionModeMSFT
SceneCaptureCompleteFB
SceneComponentTypeMSFT
See XrSceneComponentTypeMSFT
SceneComputeConsistencyMSFT
See XrSceneComputeConsistencyMSFT
SceneComputeFeatureMSFT
See XrSceneComputeFeatureMSFT
SceneComputeStateMSFT
See XrSceneComputeStateMSFT
SceneMarkerQRCodeSymbolTypeMSFT
See XrSceneMarkerQRCodeSymbolTypeMSFT
SceneMarkerTypeMSFT
See XrSceneMarkerTypeMSFT
SceneObjectTypeMSFT
See XrSceneObjectTypeMSFT
ScenePlaneAlignmentTypeMSFT
See XrScenePlaneAlignmentTypeMSFT
SecondaryEndInfo
SecondaryViewState
SemanticLabelBD
See XrSemanticLabelBD
SemanticLabelsSupportFlagsFB
See XrSemanticLabelsSupportFlagsFB
SenseDataProviderStateBD
See XrSenseDataProviderStateBD
SenseDataProviderStateChangedBD
SenseDataProviderTypeBD
See XrSenseDataProviderTypeBD
SenseDataUpdatedBD
Session
A rendering session using a particular graphics API G
SessionCreateFlags
See XrSessionCreateFlagBits
SessionState
See XrSessionState
SessionStateChanged
ShareSpacesCompleteMETA
Space
SpaceComponentTypeFB
See XrSpaceComponentTypeFB
SpaceDiscoveryCompleteMETA
SpaceDiscoveryResultsAvailableMETA
SpaceEraseCompleteFB
SpaceListSaveCompleteFB
SpaceLocation
SpaceLocationData
See XrSpaceLocationData
SpaceLocationFlags
See XrSpaceLocationFlagBits
SpacePersistenceModeFB
See XrSpacePersistenceModeFB
SpaceQueryActionFB
See XrSpaceQueryActionFB
SpaceQueryCompleteFB
SpaceQueryResultsAvailableFB
SpaceSaveCompleteFB
SpaceSetStatusCompleteFB
SpaceShareCompleteFB
SpaceStorageLocationFB
See XrSpaceStorageLocationFB
SpaceVelocity
SpaceVelocityData
See XrSpaceVelocityData
SpaceVelocityFlags
See XrSpaceVelocityFlagBits
SpacesEraseResultMETA
SpacesSaveResultMETA
SpatialAnchorCompletionResultML
See XrSpatialAnchorCompletionResultML - defined by XR_ML_spatial_anchors_storage
SpatialAnchorConfidenceML
See XrSpatialAnchorConfidenceML
SpatialAnchorCreateCompleteFB
SpatialBounded2DDataEXT
See XrSpatialBounded2DDataEXT - defined by XR_EXT_spatial_entity
SpatialBufferEXT
See XrSpatialBufferEXT - defined by XR_EXT_spatial_entity
SpatialBufferTypeEXT
See XrSpatialBufferTypeEXT
SpatialCapabilityEXT
See XrSpatialCapabilityEXT
SpatialCapabilityFeatureEXT
See XrSpatialCapabilityFeatureEXT
SpatialComponentTypeEXT
See XrSpatialComponentTypeEXT
SpatialDiscoveryRecommendedEXT
SpatialEntityComponentTypeBD
See XrSpatialEntityComponentTypeBD
SpatialEntityTrackingStateEXT
See XrSpatialEntityTrackingStateEXT
SpatialGraphNodeTypeMSFT
See XrSpatialGraphNodeTypeMSFT
SpatialMarkerAprilTagDictEXT
See XrSpatialMarkerAprilTagDictEXT
SpatialMarkerArucoDictEXT
See XrSpatialMarkerArucoDictEXT
SpatialMarkerDataEXT
See XrSpatialMarkerDataEXT - defined by XR_EXT_spatial_marker_tracking
SpatialMeshConfigFlagsBD
See XrSpatialMeshConfigFlagsBD
SpatialMeshDataEXT
See XrSpatialMeshDataEXT - defined by XR_EXT_spatial_entity
SpatialMeshLodBD
See XrSpatialMeshLodBD
SpatialPersistenceContextResultEXT
See XrSpatialPersistenceContextResultEXT
SpatialPersistenceScopeEXT
See XrSpatialPersistenceScopeEXT
SpatialPersistenceStateEXT
See XrSpatialPersistenceStateEXT
SpatialPlaneAlignmentEXT
See XrSpatialPlaneAlignmentEXT
SpatialPlaneSemanticLabelEXT
See XrSpatialPlaneSemanticLabelEXT
SpatialPolygon2DDataEXT
See XrSpatialPolygon2DDataEXT - defined by XR_EXT_spatial_plane_tracking
Spheref
See XrSpheref
StartColocationAdvertisementCompleteMETA
StartColocationDiscoveryCompleteMETA
StopColocationAdvertisementCompleteMETA
StopColocationDiscoveryCompleteMETA
StructureType
Structure type enumerant - see XrStructureType
Swapchain
A set of images to be rendered to using a particular graphics API G
SwapchainCreateFlags
See XrSwapchainCreateFlagBits
SwapchainCreateFoveationFlagsFB
See XrSwapchainCreateFoveationFlagsFB
SwapchainCreateInfo
SwapchainStateFoveationFlagsFB
See XrSwapchainStateFoveationFlagsFB
SwapchainSubImage
SwapchainUsageFlags
See XrSwapchainUsageFlagBits
SystemGraphicsProperties
See XrSystemGraphicsProperties
SystemId
SystemProperties
SystemTrackingProperties
Time
TrackableMarkerDictionaryANDROID
See XrTrackableMarkerDictionaryANDROID
TrackableMarkerTrackingModeANDROID
See XrTrackableMarkerTrackingModeANDROID
TrackableTypeANDROID
See XrTrackableTypeANDROID
TrackingOptimizationSettingsDomainQCOM
See XrTrackingOptimizationSettingsDomainQCOM
TrackingOptimizationSettingsHintQCOM
See XrTrackingOptimizationSettingsHintQCOM
TrackingStateANDROID
See XrTrackingStateANDROID
TriangleMeshFlagsFB
See XrTriangleMeshFlagsFB
UserPresenceChangedEXT
Uuid
See XrUuid
Vector2f
See XrVector2f
Vector3f
See XrVector3f
Vector4f
See XrVector4f
Vector4sFB
See XrVector4sFB - defined by XR_FB_hand_tracking_mesh
Version
View
ViewConfigurationProperties
ViewConfigurationType
See XrViewConfigurationType
ViewConfigurationView
ViewStateFlags
See XrViewStateFlagBits
VirtualKeyboardBackspaceMETA
VirtualKeyboardCommitTextMETA
VirtualKeyboardEnterMETA
VirtualKeyboardHiddenMETA
VirtualKeyboardInputSourceMETA
See XrVirtualKeyboardInputSourceMETA
VirtualKeyboardInputStateFlagsMETA
See XrVirtualKeyboardInputStateFlagsMETA
VirtualKeyboardLocationTypeMETA
See XrVirtualKeyboardLocationTypeMETA
VirtualKeyboardShownMETA
VisibilityMask
Mesh obtained from Session::get_visibility_mask
VisibilityMaskChangedKHR
VisibilityMaskTypeKHR
See XrVisibilityMaskTypeKHR
ViveTrackerConnectedHTCX
ViveTrackerPathsHTCX
VulkanDeviceCreateFlagsKHR
See XrVulkanDeviceCreateFlagsKHR
VulkanInstanceCreateFlagsKHR
See XrVulkanInstanceCreateFlagsKHR
WindingOrderFB
See XrWindingOrderFB
WorldMeshBlockResultML
See XrWorldMeshBlockResultML
WorldMeshBlockStatusML
See XrWorldMeshBlockStatusML
WorldMeshDetectorFlagsML
See XrWorldMeshDetectorFlagsML
WorldMeshDetectorLodML
See XrWorldMeshDetectorLodML

Enums§

AnyGraphics
Type parameter for graphics API agnostic Sessions
Event
Headless
Used to create a session without graphics.
OpenGL
The OpenGL graphics API
OpenGlEs
The OpenGL ES graphics API
Vulkan
The Vulkan graphics API

Constants§

CURRENT_API_VERSION
FREQUENCY_UNSPECIFIED
HAND_JOINT_COUNT
MAX_COLOCATION_DISCOVERY_BUFFER_SIZE_META
MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META
USER_GAMEPAD
USER_HAND_LEFT
USER_HAND_RIGHT
USER_HEAD
USER_TREADMILL

Traits§

ActionInput
ActionTy
AsHandle
Graphics
Static dispatch for OpenXR graphics bindings

Type Aliases§

EGLenum
HandJointLocations
An array of HandJointLocations, one for each HandJoint.
HandJointVelocities
An array of HandJointVelocitys, one for each HandJoint.
Result
UuidEXT
VkComponentSwizzle
VkFilter
VkSamplerAddressMode
VkSamplerMipmapMode