Godot OpenXR Vendors plugin

Getting Started

  • Getting Started
    • Obtaining the plugin
      • Installing from the asset store (Godot 4.7 & newer)
      • Installing from the asset library (Godot 4.6 & older)
      • Downloading from the releases page
      • Building from source
      • Updating the vendors plugin
    • Installation
      • Installing Android build templates
      • Copying the plugin into place
      • Configuring your export
    • Building
      • Short build instructions
        • Linux / MacOS
        • Windows
      • Expanded build instructions
        • Building the Godot-CPP bindings
        • Building the Plugin
      • Creating a new OpenXR extension wrapper
      • Hooks

Features

  • Features
    • Hybrid Apps
      • Project Settings
      • Switching Modes
    • Body and Face Tracking
      • Project Settings
      • Body Tracking Setup
      • Face Tracking Setup
      • Additional Meta Extensions
        • Lower Body Tracking
        • Manual Height Override
        • Body Tracking Fidelity
      • Additional Android XR Extensions
        • Eye Tracking
    • Performance Metrics
      • Project Settings
      • Debug Monitors
      • Manually Querying Metrics
    • Meta
      • Meta Application Space Warp
        • Project Settings
      • Meta Color Space
        • Project Settings
      • Meta Composition Layers
        • Secure Content
        • Filter Settings
        • Alpha Blend
      • Meta Dynamic Resolution
        • Project Settings
      • Meta Environment Depth
        • Project Settings
        • Starting and stopping
        • Occlusion
        • Accessing the depth map on the CPU
      • Meta Hand Tracking
        • Project Settings
        • Hand Mesh
        • Hand Capsules
        • Hand Tracking Aim
      • Meta Passthrough
        • Project Settings
        • Reconstruction Passthrough
        • Projected Passthrough
        • Passthrough Loading Screen
        • Passthrough Filters
        • Color Map Filter
        • Mono Map Filter
        • Brightness Contrast Saturation Filter
        • Color LUT Filter
        • Interpolated Color LUT Filter
        • Boundary visibility
      • Meta Scene Manager
        • Project Settings
        • Adding the Scene Manager Node
        • Creating Spatial Entities
        • Global Mesh
        • Requesting a Scene Capture
      • Meta Spatial Anchors
        • Project Settings
        • Creating Spatial Anchors
        • Scene Setup Method
        • Removing Spatial Anchors
        • Saving Spatial Anchors
        • Loading Spatial Anchors
    • Android XR
      • Android XR Dynamic Resolution
        • Project Settings
      • Android XR Environment Depth
        • Project Settings
        • Starting and stopping
        • Smooth data
        • Occlusion
      • Android XR Light Estimation
        • Project Settings
        • Starting and stopping
        • Permissions
        • Using the OpenXRAndroidLightEstimation node
        • Using a custom shader
      • Android XR Passthrough Camera State
        • Project Settings
        • Querying Passthrough Camera State
      • Android XR Scene Meshing
        • Project Settings
        • Requesting Permissions
        • Initialize Scene Meshing
        • Using Submesh Data
      • Android XR Trackables
        • Project Settings
        • Permissions
        • XRTracker and XRAnchor3D
        • Plane Detection
        • Object Detection
        • Persistent Anchors
        • Ray Casting
        • Sample
    • OpenXR Validation Layers for Android

API Reference

  • All classes
    • OpenXRAndroidAnchorTracker
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidDeviceAnchorPersistenceExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidEnvironmentDepth
      • Description
      • Properties
      • Property Descriptions
    • OpenXRAndroidEnvironmentDepthExtension
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidEyeTrackingExtension
      • Description
    • OpenXRAndroidFaceTrackingExtension
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidHitResult
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidLightEstimation
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRAndroidLightEstimationExtension
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRAndroidMouseInteractionExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidPassthroughCameraStateExtension
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidPerformanceMetricsExtension
      • Description
    • OpenXRAndroidRaycastExtension
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidRecommendedResolutionExtension
      • Description
    • OpenXRAndroidSceneMeshing
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidSceneMeshingExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidSceneSubmeshData
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidTrackableObjectTracker
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidTrackablePlaneTracker
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidTrackablesExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidTrackablesObjectExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRAndroidTrackableTracker
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • OpenXRAndroidUnboundedReferenceSpaceExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbAndroidSurfaceSwapchainCreateExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbBodyTrackingExtension
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRFbColorSpaceExtension
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRFbCompositionLayerAlphaBlendExtension
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbCompositionLayerDepthTestExtension
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbCompositionLayerImageLayoutExtension
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbCompositionLayerSecureContentExtension
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbCompositionLayerSettingsExtension
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbFaceTrackingExtension
      • Description
    • OpenXRFbHandTrackingAimExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbHandTrackingCapsulesExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbHandTrackingMesh
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbHandTrackingMeshExtension
      • Description
    • OpenXRFbPassthroughExtension
      • Description
      • Methods
      • Signals
      • Enumerations
      • Method Descriptions
    • OpenXRFbPassthroughGeometry
      • Description
      • Properties
      • Property Descriptions
    • OpenXRFbRenderModel
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbRenderModelExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSceneCaptureExtension
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRFbSceneExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSceneManager
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpaceWarpExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialAnchorManager
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpatialEntity
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpatialEntityBatch
      • Description
      • Properties
      • Methods
      • Signals
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpatialEntityContainerExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntityExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntityQuery
      • Description
      • Properties
      • Methods
      • Signals
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpatialEntityQueryExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntitySharingExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntityStorageBatchExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntityStorageExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRFbSpatialEntityUser
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRFbSpatialEntityUserExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRHtcFacialTrackingExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRHtcPassthroughExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRHybridApp
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRMetaBoundaryVisibilityExtension
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRMetaColocationDiscoveryExtension
      • Description
      • Tutorials
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRMetaEnvironmentDepth
      • Description
      • Properties
      • Property Descriptions
    • OpenXRMetaEnvironmentDepthExtension
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRMetaHeadsetIDExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRMetaPassthroughColorLut
      • Description
      • Methods
      • Enumerations
      • Method Descriptions
    • OpenXRMetaPerformanceMetricsExtension
      • Description
    • OpenXRMetaRecommendedLayerResolutionExtension
      • Description
    • OpenXRMetaSimultaneousHandsAndControllersExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRMetaSpatialEntityMeshExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRMlMarkerDetector
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRMlMarkerDetectorAprilTagSettings
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRMlMarkerDetectorArucoSettings
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRMlMarkerDetectorCode128Settings
      • Description
    • OpenXRMlMarkerDetectorEan13Settings
      • Description
    • OpenXRMlMarkerDetectorProfileSettings
      • Description
      • Properties
      • Enumerations
      • Property Descriptions
    • OpenXRMlMarkerDetectorQrSettings
      • Description
      • Properties
      • Property Descriptions
    • OpenXRMlMarkerDetectorSettings
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRMlMarkerDetectorUpcASettings
      • Description
    • OpenXRMlMarkerTracker
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRMlMarkerUnderstandingExtension
      • Description
      • Methods
      • Signals
      • Method Descriptions
    • OpenXRMlMarkerUnderstandingManager
      • Description
      • Properties
      • Methods
      • Property Descriptions
      • Method Descriptions
    • OpenXRStationaryReferenceSpaceExtension
      • Description
      • Methods
      • Method Descriptions
    • OpenXRVendorPerformanceMetrics
      • Description
      • Properties
      • Methods
      • Enumerations
      • Property Descriptions
      • Method Descriptions
    • OpenXRVendorPerformanceMetricsProvider
      • Description
Godot OpenXR Vendors plugin
  • Search

© Copyright 2022-present Godot XR contributors.

Built with Sphinx using a theme provided by Read the Docs.