Expand description
To get started, construct an Entry
object.
Re-exports§
pub use sys;
Modules§
Structs§
- Action
- Action
Set - Action
State - Action
Type - See XrActionType
- Active
Action Set - Android
Surface Swapchain FlagsFB - See XrAndroidSurfaceSwapchainFlagsFB
- Android
Thread TypeKHR - Android Thread Types - see XrAndroidThreadTypeKHR
- ApiLayer
Properties - See XrApiLayerProperties
- Application
Info - Async
Request IdFB - Binding
- Blend
FactorFB - See XrBlendFactorFB
- Body
JointFB - See XrBodyJointFB
- Body
Joint LocationFB - See XrBodyJointLocationFB - defined by XR_FB_body_tracking
- Body
Joint SetFB - Describes the set of body joints to track when creating an XrBodyTrackerFB. - see XrBodyJointSetFB
- Body
Skeleton JointFB - See XrBodySkeletonJointFB - defined by XR_FB_body_tracking
- Boxf
- See XrBoxf
- Color3f
- See XrColor3f
- Color4f
- See XrColor4f
- Color
SpaceFB - See XrColorSpaceFB
- Compare
OpFB - See XrCompareOpFB
- Composition
Layer Base - Composition
Layer CubeKHR - Composition
Layer CylinderKHR - Composition
Layer Equirect2KHR - Composition
Layer EquirectKHR - Composition
Layer Flags - See XrCompositionLayerFlagBits
- Composition
Layer Image Layout FlagsFB - See XrCompositionLayerImageLayoutFlagsFB
- Composition
Layer Projection - Composition
Layer Projection View - Composition
Layer Quad - Composition
Layer Secure Content FlagsFB - See XrCompositionLayerSecureContentFlagsFB
- Composition
Layer Settings FlagsFB - See XrCompositionLayerSettingsFlagsFB
- Composition
Layer Space Warp Info FlagsFB - See XrCompositionLayerSpaceWarpInfoFlagsFB
- Debug
Utils Message Severity FlagsEXT - See XrDebugUtilsMessageSeverityFlagsEXT
- Debug
Utils Message Type FlagsEXT - See XrDebugUtilsMessageTypeFlagsEXT
- Digital
Lens Control FlagsALMALENCE - See XrDigitalLensControlFlagsALMALENCE
- Display
Refresh Rate ChangedFB - Duration
- Entry
- Entry point to the API. Start here.
- Environment
Blend Mode - See XrEnvironmentBlendMode
- Environment
Depth Provider Create FlagsMETA - See XrEnvironmentDepthProviderCreateFlagsMETA
- Environment
Depth Swapchain Create FlagsMETA - See XrEnvironmentDepthSwapchainCreateFlagsMETA
- Event
Data Buffer - Events
Lost - Extension
Set - A subset of known extensions
- Extent2
Df - See XrExtent2Df
- Extent2
Di - See XrExtent2Di
- Extent3
Df - See XrExtent3Df
- External
Camera Attached ToDeviceOCULUS - See XrExternalCameraAttachedToDeviceOCULUS
- External
Camera ExtrinsicsOCULUS - See XrExternalCameraExtrinsicsOCULUS - defined by XR_OCULUS_external_camera
- External
Camera IntrinsicsOCULUS - See XrExternalCameraIntrinsicsOCULUS - defined by XR_OCULUS_external_camera
- External
Camera Status FlagsOCULUS - See XrExternalCameraStatusFlagsOCULUS
- EyeCalibration
ChangedML - EyeCalibration
StatusML - See XrEyeCalibrationStatusML
- EyeExpressionHTC
- See XrEyeExpressionHTC
- EyePositionFB
- See XrEyePositionFB
- EyeVisibility
- eye visibility selector - see XrEyeVisibility
- Face
Confidence2FB - See XrFaceConfidence2FB
- Face
ConfidenceFB - See XrFaceConfidenceFB
- Face
Expression2FB - See XrFaceExpression2FB
- Face
ExpressionFB - See XrFaceExpressionFB
- Face
Expression Set2FB - See XrFaceExpressionSet2FB
- Face
Expression SetFB - See XrFaceExpressionSetFB
- Face
Tracking Data Source2FB - See XrFaceTrackingDataSource2FB
- Facial
Tracking TypeHTC - See XrFacialTrackingTypeHTC
- Force
Feedback Curl Apply LocationMNDX - See XrForceFeedbackCurlApplyLocationMNDX - defined by XR_MNDX_force_feedback_curl
- Force
Feedback Curl LocationMNDX - See XrForceFeedbackCurlLocationMNDX
- Form
Factor - See XrFormFactor
- Foveation
ConfigurationHTC - See XrFoveationConfigurationHTC - defined by XR_HTC_foveation
- Foveation
DynamicFB - See XrFoveationDynamicFB
- Foveation
Dynamic FlagsHTC - See XrFoveationDynamicFlagsHTC
- Foveation
EyeTracked Profile Create FlagsMETA - See XrFoveationEyeTrackedProfileCreateFlagsMETA
- Foveation
EyeTracked State FlagsMETA - See XrFoveationEyeTrackedStateFlagsMETA
- Foveation
LevelFB - See XrFoveationLevelFB
- Foveation
LevelHTC - See XrFoveationLevelHTC
- Foveation
Level Profile - Foveation
ModeHTC - See XrFoveationModeHTC
- Foveation
ProfileFB - Fovf
- See XrFovf
- Frame
EndInfo FlagsML - See XrFrameEndInfoFlagsML
- Frame
State - Result of method calls on
FrameWaiter
- Frame
Stream - Handle for managing frame presentation
- Frame
Waiter - Handle for waiting to render a frame
- Frustumf
- See XrFrustumf
- Future
StateEXT - See XrFutureStateEXT
- Global
Dimmer Frame EndInfo FlagsML - See XrGlobalDimmerFrameEndInfoFlagsML
- Hand
- See XrHandEXT
- HandEXT
- See XrHandEXT
- Hand
Forearm JointULTRALEAP - See XrHandForearmJointULTRALEAP
- Hand
Joint - See XrHandJointEXT
- Hand
JointEXT - See XrHandJointEXT
- Hand
Joint Location - See XrHandJointLocationEXT - defined by XR_EXT_hand_tracking
- Hand
Joint LocationEXT - See XrHandJointLocationEXT - defined by XR_EXT_hand_tracking
- Hand
Joint SetEXT - See XrHandJointSetEXT
- Hand
Joint Velocity - See XrHandJointVelocityEXT - defined by XR_EXT_hand_tracking
- Hand
Joint VelocityEXT - See XrHandJointVelocityEXT - defined by XR_EXT_hand_tracking
- Hand
Joints Motion RangeEXT - See XrHandJointsMotionRangeEXT
- Hand
Mesh VertexMSFT - See XrHandMeshVertexMSFT - defined by XR_MSFT_hand_tracking_mesh
- Hand
Pose TypeMSFT - See XrHandPoseTypeMSFT
- Hand
Tracker - Hand
Tracking AimFlagsFB - See XrHandTrackingAimFlagsFB
- Hand
Tracking Data SourceEXT - See XrHandTrackingDataSourceEXT
- Haptic
- Tag for haptic output actions
- Haptic
Base - Haptic
PcmVibrationFB - Haptic
Vibration - Headset
FitChangedML - Headset
FitStatusML - See XrHeadsetFitStatusML
- Input
Source Localized Name Flags - See XrInputSourceLocalizedNameFlagBits
- Instance
- Root object mediating an application’s interaction with OpenXR
- Instance
Create Flags - See XrInstanceCreateFlagBits
- Instance
Extensions - Extensions used internally by the bindings
- Instance
Loss Pending - Instance
Properties - Interaction
Profile Changed - Keyboard
Tracking FlagsFB - See XrKeyboardTrackingFlagsFB
- Keyboard
Tracking Query FlagsFB - See XrKeyboardTrackingQueryFlagsFB
- LipExpressionHTC
- See XrLipExpressionHTC
- Load
Error - An error encountered while loading entry points from a dynamic library at run time
- Loader
Interface Structs - See XrLoaderInterfaceStructs
- Local
Dimming ModeMETA - See XrLocalDimmingModeMETA
- Localization
ChangedML - Localization
MapConfidenceML - See XrLocalizationMapConfidenceML
- Localization
MapError FlagsML - See XrLocalizationMapErrorFlagsML
- Localization
MapML - Localization
MapStateML - See XrLocalizationMapStateML
- Localization
MapTypeML - See XrLocalizationMapTypeML
- Main
Session Visibility ChangedEXTX - Marker
April TagDictML - See XrMarkerAprilTagDictML
- Marker
Aruco DictML - See XrMarkerArucoDictML
- Marker
Detector CameraML - See XrMarkerDetectorCameraML
- Marker
Detector Corner Refine MethodML - See XrMarkerDetectorCornerRefineMethodML
- Marker
Detector FpsML - See XrMarkerDetectorFpsML
- Marker
Detector Full Analysis IntervalML - See XrMarkerDetectorFullAnalysisIntervalML
- Marker
Detector ProfileML - See XrMarkerDetectorProfileML
- Marker
Detector ResolutionML - See XrMarkerDetectorResolutionML
- Marker
Detector StatusML - See XrMarkerDetectorStatusML
- Marker
Tracking UpdateVARJO - Marker
TypeML - See XrMarkerTypeML
- Mesh
Compute LodMSFT - See XrMeshComputeLodMSFT
- Negotiate
ApiLayer Request - See XrNegotiateApiLayerRequest
- Negotiate
Loader Info - See XrNegotiateLoaderInfo
- Negotiate
Runtime Request - See XrNegotiateRuntimeRequest
- Object
Type - Enums to track objects of various types - see XrObjectType
- Offset2
Df - See XrOffset2Df
- Offset2
Di - See XrOffset2Di
- Offset3
DfFB - See XrOffset3DfFB - defined by XR_FB_scene
- Overlay
Main Session FlagsEXTX - See XrOverlayMainSessionFlagsEXTX
- Overlay
Session Create FlagsEXTX - See XrOverlaySessionCreateFlagsEXTX
- Passthrough
- A passthrough feature.
- Passthrough
Capability FlagsFB - See XrPassthroughCapabilityFlagsFB
- Passthrough
Color LutChannelsMETA - See XrPassthroughColorLutChannelsMETA
- Passthrough
FlagsFB - See XrPassthroughFlagsFB
- Passthrough
FormHTC - See XrPassthroughFormHTC
- Passthrough
Layer - A passthrough layer.
- Passthrough
Layer PurposeFB - See XrPassthroughLayerPurposeFB
- Passthrough
Preference FlagsMETA - See XrPassthroughPreferenceFlagsMETA
- Passthrough
State ChangedFB - Passthrough
State Changed FlagsFB - See XrPassthroughStateChangedFlagsFB
- Path
- Perf
Settings DomainEXT - See XrPerfSettingsDomainEXT
- Perf
SettingsEXT - Perf
Settings LevelEXT - See XrPerfSettingsLevelEXT
- Perf
Settings Notification LevelEXT - See XrPerfSettingsNotificationLevelEXT
- Perf
Settings SubDomainEXT - See XrPerfSettingsSubDomainEXT
- Performance
Metrics Counter FlagsMETA - See XrPerformanceMetricsCounterFlagsMETA
- Performance
Metrics Counter UnitMETA - See XrPerformanceMetricsCounterUnitMETA
- Plane
Detection Capability FlagsEXT - See XrPlaneDetectionCapabilityFlagsEXT
- Plane
Detection StateEXT - See XrPlaneDetectionStateEXT
- Plane
Detector FlagsEXT - See XrPlaneDetectorFlagsEXT
- Plane
Detector OrientationEXT - See XrPlaneDetectorOrientationEXT
- Plane
Detector Semantic TypeEXT - See XrPlaneDetectorSemanticTypeEXT
- Posef
- See XrPosef
- Quaternionf
- See XrQuaternionf
- RawEntry
- Rect2Df
- See XrRect2Df
- Rect2Di
- See XrRect2Di
- Rect3
DfFB - See XrRect3DfFB - defined by XR_FB_scene
- Reference
Space Change Pending - Reference
Space Type - See XrReferenceSpaceType
- Render
Model FlagsFB - See XrRenderModelFlagsFB
- Render
Model KeyFB - Render
Model Load InfoFB - See XrRenderModelLoadInfoFB - defined by XR_FB_render_model
- Render
Model PropertiesFB - Render model properties obtained from
Session::get_render_model_properties_fb
- Reprojection
ModeMSFT - See XrReprojectionModeMSFT
- Scene
Capture CompleteFB - Scene
Component TypeMSFT - See XrSceneComponentTypeMSFT
- Scene
Compute ConsistencyMSFT - See XrSceneComputeConsistencyMSFT
- Scene
Compute FeatureMSFT - See XrSceneComputeFeatureMSFT
- Scene
Compute StateMSFT - See XrSceneComputeStateMSFT
- Scene
MarkerQR Code Symbol TypeMSFT - See XrSceneMarkerQRCodeSymbolTypeMSFT
- Scene
Marker TypeMSFT - See XrSceneMarkerTypeMSFT
- Scene
Object TypeMSFT - See XrSceneObjectTypeMSFT
- Scene
Plane Alignment TypeMSFT - See XrScenePlaneAlignmentTypeMSFT
- Secondary
EndInfo - Secondary
View State - Semantic
Labels Support FlagsFB - See XrSemanticLabelsSupportFlagsFB
- Session
- A rendering session using a particular graphics API
G
- Session
Create Flags - See XrSessionCreateFlagBits
- Session
State - See XrSessionState
- Session
State Changed - Space
- Space
Component TypeFB - See XrSpaceComponentTypeFB
- Space
Erase CompleteFB - Space
List Save CompleteFB - Space
Location - Space
Location Data - See XrSpaceLocationData
- Space
Location Flags - See XrSpaceLocationFlagBits
- Space
Persistence ModeFB - See XrSpacePersistenceModeFB
- Space
Query ActionFB - See XrSpaceQueryActionFB
- Space
Query CompleteFB - Space
Query Results AvailableFB - Space
Save CompleteFB - Space
SetStatus CompleteFB - Space
Share CompleteFB - Space
Storage LocationFB - See XrSpaceStorageLocationFB
- Space
Velocity - Space
Velocity Data - See XrSpaceVelocityData
- Space
Velocity Flags - See XrSpaceVelocityFlagBits
- Spatial
Anchor Create CompleteFB - Spatial
Graph Node TypeMSFT - See XrSpatialGraphNodeTypeMSFT
- Spheref
- See XrSpheref
- Structure
Type - Structure type enumerant - see XrStructureType
- Swapchain
- A set of images to be rendered to using a particular graphics API
G
- Swapchain
Create Flags - See XrSwapchainCreateFlagBits
- Swapchain
Create Foveation FlagsFB - See XrSwapchainCreateFoveationFlagsFB
- Swapchain
Create Info - Swapchain
State Foveation FlagsFB - See XrSwapchainStateFoveationFlagsFB
- Swapchain
SubImage - Swapchain
Usage Flags - See XrSwapchainUsageFlagBits
- System
Graphics Properties - See XrSystemGraphicsProperties
- System
Id - System
Properties - System
Tracking Properties - Time
- Tracking
Optimization Settings DomainQCOM - See XrTrackingOptimizationSettingsDomainQCOM
- Tracking
Optimization Settings HintQCOM - See XrTrackingOptimizationSettingsHintQCOM
- Triangle
Mesh FlagsFB - See XrTriangleMeshFlagsFB
- User
Presence ChangedEXT - Vector2f
- See XrVector2f
- Vector3f
- See XrVector3f
- Vector4f
- See XrVector4f
- Vector4sFB
- See XrVector4sFB - defined by XR_FB_hand_tracking_mesh
- Version
- View
- View
Configuration Properties - View
Configuration Type - See XrViewConfigurationType
- View
Configuration View - View
State Flags - See XrViewStateFlagBits
- Virtual
Keyboard BackspaceMETA - Virtual
Keyboard Commit TextMETA - Virtual
Keyboard EnterMETA - Virtual
Keyboard HiddenMETA - Virtual
Keyboard Input SourceMETA - See XrVirtualKeyboardInputSourceMETA
- Virtual
Keyboard Input State FlagsMETA - See XrVirtualKeyboardInputStateFlagsMETA
- Virtual
Keyboard Location TypeMETA - See XrVirtualKeyboardLocationTypeMETA
- Virtual
Keyboard ShownMETA - Visibility
Mask - Mesh obtained from
Session::get_visibility_mask
- Visibility
Mask ChangedKHR - Visibility
Mask TypeKHR - See XrVisibilityMaskTypeKHR
- Vive
Tracker ConnectedHTCX - Vive
Tracker PathsHTCX - Vulkan
Device Create FlagsKHR - See XrVulkanDeviceCreateFlagsKHR
- Vulkan
Instance Create FlagsKHR - See XrVulkanInstanceCreateFlagsKHR
- Winding
OrderFB - See XrWindingOrderFB
Enums§
- AnyGraphics
- Type parameter for graphics API agnostic
Session
s - Event
- OpenGL
- The OpenGL graphics API
- Open
GlEs - The OpenGL ES graphics API
- Vulkan
- The Vulkan graphics API
Constants§
- CURRENT_
API_ VERSION - FREQUENCY_
UNSPECIFIED - HAND_
JOINT_ COUNT - MAX_
VIRTUAL_ KEYBOARD_ COMMIT_ TEXT_ SIZE_ META - USER_
GAMEPAD - USER_
HAND_ LEFT - USER_
HAND_ RIGHT - USER_
HEAD - USER_
TREADMILL
Traits§
- Action
Input - Action
Ty - Graphics
- Static dispatch for OpenXR graphics bindings
Type Aliases§
- EGLenum
- Hand
Joint Locations - An array of
HandJointLocation
s, one for eachHandJoint
. - Hand
Joint Velocities - An array of
HandJointVelocity
s, one for eachHandJoint
. - Result
- UuidEXT
- VkComponent
Swizzle - VkFilter
- VkSampler
Address Mode - VkSampler
Mipmap Mode