Godot OpenXR Vendors Plugin

https://godotvr.github.io/godot_openxr_vendors
Admin
A GDExtension for Godot 4 that adds support for OpenXR vendor extensions, including Meta's scene...
Tokens:122,884
Snippets:1,440
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### start_environment_depth() -> bool

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidenvironmentdepthextension.html

Starts environment depth.

```APIDOC
## start_environment_depth() -> bool

### Description
Starts environment depth capture.

### Method
None

### Parameters
None

### Returns
- **bool** - true if environment depth started successfully; otherwise false.
```

--------------------------------

### Start Environment Depth

Source: https://godotvr.github.io/godot_openxr_vendors/manual/androidxr/environment_depth.html

Checks if environment depth is supported and starts it. Requires an active OpenXR session; connect to the session_begun signal to run this code when the session starts.

```gdscript
if OpenXRAndroidEnvironmentDepthExtension.is_environment_depth_supported():
        OpenXRAndroidEnvironmentDepthExtension.start_environment_depth()

```

--------------------------------

### start_light_estimation

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimationextension.html

Starts light estimation.

```APIDOC
## start_light_estimation

### Description
Starts light estimation.

### Method
POST

### Endpoint
OpenXRAndroidLightEstimationExtension.start_light_estimation()

### Parameters
None

### Response
#### Success Response
- **bool** - True if started successfully, false otherwise.

#### Response Example
```
true
```
```

--------------------------------

### Start Android XR Light Estimation

Source: https://godotvr.github.io/godot_openxr_vendors/manual/androidxr/light_estimation.html

Checks if light estimation is supported and starts it. Requires an active OpenXR session; connect to the OpenXRInterface.session_begun signal to run at session start. Only start when needed due to performance cost.

```GDScript
if OpenXRAndroidLightEstimationExtension.is_light_estimation_supported():
        OpenXRAndroidLightEstimationExtension.start_light_estimation()

```

--------------------------------

### Check support and start advertisement/discovery

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Checks if colocation discovery is supported, then starts advertising a session or discovering nearby sessions. Connects to the discovery result signal and handles the result by parsing the session data.

```gdscript
# Check if colocation discovery is supported
if OpenXRMetaColocationDiscoveryExtension.is_colocation_discovery_supported():
    # Start advertising your session
    var session_data = JSON.stringify({"session_id": "my_session", "host": "Player1"}).to_utf8_buffer()
    OpenXRMetaColocationDiscoveryExtension.start_advertisement(session_data)

    # Or start discovering nearby sessions
    OpenXRMetaColocationDiscoveryExtension.start_discovery()

# Connect to signals
OpenXRMetaColocationDiscoveryExtension.openxr_meta_colocation_discovery_discovery_result.connect(_on_discovery_result)

func _on_discovery_result(advertisement_uuid: String, data: PackedByteArray):
    var session_info = JSON.parse_string(data.get_string_from_utf8())
    print("Found session: ", session_info)

```

--------------------------------

### start_discovery()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts discovery of nearby advertised colocation sessions.

```APIDOC
## start_discovery()

### Description
Starts discovery of nearby advertised colocation sessions.

### Method
bool start_discovery()

### Parameters
None

### Returns
- **bool** - true if discovery started successfully, false otherwise.
```

--------------------------------

### start_discovery

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts discovering nearby devices that are advertising their sessions.

```APIDOC
## start_discovery

### Description
Starts discovering nearby devices that are advertising their sessions. When a device is found, the `openxr_meta_colocation_discovery_discovery_result` signal is emitted.

### Method
start_discovery

### Parameters
None

### Returns
- **bool** - True if discovery started successfully, false otherwise.

### Example
```gdscript
OpenXRMetaColocationDiscoveryExtension.start_discovery()
```
```

--------------------------------

### is_light_estimation_started

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimationextension.html

Checks if light estimation is currently started.

```APIDOC
## is_light_estimation_started

### Description
Checks if light estimation is currently started.

### Method
GET

### Endpoint
OpenXRAndroidLightEstimationExtension.is_light_estimation_started()

### Parameters
None

### Response
#### Success Response
- **bool** - True if started, false otherwise.

#### Response Example
```
true
```
```

--------------------------------

### start_advertisement(PackedByteArray buffer)

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts advertising a colocation session with the provided custom data buffer.

```APIDOC
## start_advertisement(PackedByteArray buffer)

### Description
Starts advertising a colocation session with the given custom data. The buffer is typically a JSON string containing session information such as session ID, host name, and available player slots.

### Method
bool start_advertisement(PackedByteArray buffer)

### Parameters
- **buffer** (PackedByteArray) - Required - Custom data to advertise, typically a JSON string.

### Returns
- **bool** - true if the advertisement started successfully, false otherwise.
```

--------------------------------

### is_passthrough_started()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrhtcpassthroughextension.html

Checks if passthrough has been started.

```APIDOC
## is_passthrough_started()

### Description
Checks if passthrough has been started.

### Method
is_passthrough_started

### Parameters
None

### Returns
- **bool** - True if passthrough has been started, false otherwise.
```

--------------------------------

### start_advertisement

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts advertising the current session so other devices can discover it. The provided data is broadcast to nearby devices.

```APIDOC
## start_advertisement

### Description
Starts advertising the current session so other devices running the same application can discover it. The provided data is broadcast to nearby devices.

### Method
start_advertisement

### Parameters
- **data** (PackedByteArray) - Required - The data to advertise, typically a JSON-encoded string containing session information.

### Returns
- **bool** - True if the advertisement started successfully, false otherwise.

### Example
```gdscript
var session_data = JSON.stringify({"session_id": "my_session", "host": "Player1"}).to_utf8_buffer()
OpenXRMetaColocationDiscoveryExtension.start_advertisement(session_data)
```
```

--------------------------------

### get_launch_data

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrhybridapp.html

Gets the data string that was passed to switch_mode.

```APIDOC
## get_launch_data

### Description
Gets the `data` string that was passed to switch_mode.

### Method
`String get_launch_data() const`

### Parameters
None

### Returns
- **String** - The launch data string.
```

--------------------------------

### is_environment_depth_started()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidenvironmentdepthextension.html

Returns true if environment depth has been started; otherwise false.

```APIDOC
## is_environment_depth_started()

### Description
Checks if environment depth is currently started.

### Method
None

### Parameters
None

### Returns
- **bool** - true if environment depth has been started; otherwise false
```

--------------------------------

### get_default_object_context

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidtrackablesobjectextension.html

Gets the default object context used to automatically discover objects with no additional setup. Returns an invalid RID if set_default_object_context_enabled was previously called with false.

```APIDOC
## get_default_object_context

### Description
Gets the default object context used to automatically discover objects with no additional setup. Returns an invalid RID if set_default_object_context_enabled was previously called with false.

### Method
get_default_object_context

### Parameters
None

### Returns
- **RID** - The default object context.
```

--------------------------------

### initialize

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidscenemeshing.html

Initialize this OpenXRAndroidSceneMeshing instance. Only one is needed, but multiple are okay.

```APIDOC
## initialize

### Description
Initialize this OpenXRAndroidSceneMeshing instance. Only one is needed, but multiple are okay.

### Method
bool initialize(SemanticLabelSet semantic_label_set, bool enable_normals)

### Parameters
#### Parameters
- **semantic_label_set** (SemanticLabelSet) - Required - One of the SemanticLabelSets returned by OpenXRAndroidSceneMeshingExtension.get_supported_semantic_label_sets.
- **enable_normals** (bool) - Required - When true, the Mesh.ARRAY_NORMAL index in OpenXRAndroidSceneSubmeshData.get_arrays will be populated.

### Returns
- **bool** - True if initialization was successful, false otherwise.
```

--------------------------------

### Connect to permission request result signal

Source: https://godotvr.github.io/godot_openxr_vendors/manual/androidxr/light_estimation.html

Example of connecting to the SceneTree.on_request_permissions_result signal to handle the SCENE_UNDERSTANDING_COARSE permission grant. The _on_request_permissions_result function checks if the permission is granted and retries starting light estimation.

```GDScript
func _ready() -> void:
        get_tree().on_request_permissions_result.connect(_on_request_permissions_result)

func _on_request_permissions_result(p_permission: String, p_granted: bool) -> void:
        if p_permission == "android.permission.SCENE_UNDERSTANDING_COARSE" and p_granted:
                # Retry starting light estimation...
                pass

```

--------------------------------

### Convenience function to get persist state

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroiddeviceanchorpersistenceextension.html

Shows the manual way to get the persist state of an anchor tracker, which is replaced by the convenience function get_anchor_tracker_persist_state.

```gdscript
var persist_state := OpenXRAndroidTracker.PERSIST_STATE_NOT_REQUESTED
if anchor_tracker:
    persist_state = OpenXRAndroidDeviceAnchorPersistenceExtension.get_anchor_tracker_persist_state_uuid(anchor_tracker.get_persist_uuid(), update)
    # or: persist_state = anchor_tracker.get_persist_state(update)

```

--------------------------------

### Initialize OpenXRAndroidSceneMeshing

Source: https://godotvr.github.io/godot_openxr_vendors/manual/androidxr/scene_meshing.html

Creates an OpenXRAndroidSceneMeshing instance, checks for supported semantic label sets, and initializes with a chosen label set. Prints an error if initialization fails.

```GDScript
var scene_meshing_ext = Engine.get_singleton("OpenXRAndroidSceneMeshingExtension")
var supported_semantic_label_sets = scene_meshing_ext.get_supported_semantic_label_sets()

var semantic_label_set = OpenXRAndroidSceneMeshing.SEMANTIC_LABEL_SET_NONE
if supported_semantic_label_sets.has(OpenXRAndroidSceneMeshing.SEMANTIC_LABEL_SET_DEFAULT):
    semantic_label_set = OpenXRAndroidSceneMeshing.SEMANTIC_LABEL_SET_DEFAULT

var scene_meshing = OpenXRAndroidSceneMeshing.new()
if not scene_meshing.initialize(semantic_label_set, true):
    printerr("Failed to initialize OpenXRAndroidSceneMeshing")

```

--------------------------------

### Initialize godot-cpp submodule

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run this command in the project root directory after cloning to initialize the godot-cpp submodule.

```bash
git submodule update --init

```

--------------------------------

### show

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialanchormanager.html

Shows all instantiated scenes for the anchors.

```APIDOC
## show

### Description
Shows all scenes that have been instantiated for the spatial anchors. The anchors must be tracked.

### Method
void

### Parameters
None.

### Request Example
```
manager.show()
```

### Response
No return value.
```

--------------------------------

### track

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Starts tracking this spatial entity.

```APIDOC
## track

### Description
Starts tracking this spatial entity.

### Method
track

### Parameters
None

### Returns
void
```

--------------------------------

### start_advertisement(PackedByteArray buffer)

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts advertising the local session to nearby devices. The buffer contains custom session data (max 1024 bytes) that will be transmitted to discovering devices.

```APIDOC
## bool start_advertisement(PackedByteArray buffer)

### Description
Starts advertising the local session to nearby devices. The `buffer` contains custom session data (max 1024 bytes) that will be transmitted to discovering devices. Typically this data contains session information encoded as JSON, such as session ID, host name, and max players. Returns `true` if the advertisement request was successfully initiated, `false` otherwise. Listen to the `openxr_meta_colocation_discovery_advertisement_started` signal to know when advertising actually begins, or `openxr_meta_colocation_discovery_advertisement_failed` if it fails. **Note:** Only one advertisement can be active at a time. Call `stop_advertisement` first if already advertising.

### Method
POST

### Endpoint
/start_advertisement

### Parameters
#### Request Body
- **buffer** (PackedByteArray) - Required - Custom session data (max 1024 bytes) to be transmitted to discovering devices.

### Request Example
```json
{
  "buffer": "<base64-encoded-bytes>"
}
```

### Response
#### Success Response (200)
- **bool** (boolean) - Returns `true` if the advertisement request was successfully initiated, `false` otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### Build plugin artifacts on Windows

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run this command from the root directory to build the plugin artifacts on Windows.

```batch
gradlew.bat buildPlugin

```

--------------------------------

### get_uuid

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the UUID of the spatial entity.

```APIDOC
## get_uuid

### Description
Gets the UUID of the spatial entity.

### Method
get_uuid

### Parameters
None

### Returns
StringName
```

--------------------------------

### get_storage_location()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentityquery.html

Gets the storage location that is being queried.

```APIDOC
## get_storage_location()

### Description
The storage location that is being queried.

### Method
`StorageLocation get_storage_location()`

### Parameters
None

### Returns
- **StorageLocation** - The storage location being queried.
```

--------------------------------

### start_discovery()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmetacolocationdiscoveryextension.html

Starts discovering nearby advertised sessions. Returns true if the discovery request was successfully initiated, false otherwise.

```APIDOC
## bool start_discovery()

### Description
Starts discovering nearby advertised sessions. Returns `true` if the discovery request was successfully initiated, `false` otherwise. Listen to the `openxr_meta_colocation_discovery_discovery_started` signal to know when discovery actually begins, and `openxr_meta_colocation_discovery_discovery_result` for each discovered session. **Note:** Only one discovery operation can be active at a time. Call `stop_discovery` first if already discovering.

### Method
POST

### Endpoint
/start_discovery

### Parameters
None

### Request Example
{}

### Response
#### Success Response (200)
- **bool** (boolean) - Returns `true` if the discovery request was successfully initiated, `false` otherwise.

#### Response Example
```json
true
```
```

--------------------------------

### get_query_type()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentityquery.html

Gets the type of query that will be performed.

```APIDOC
## get_query_type()

### Description
Gets the type of query that will be performed. Set by using query_all, query_by_component or query_by_uuid.

### Method
`QueryType get_query_type()`

### Parameters
None

### Returns
- **QueryType** - The type of query that will be performed.
```

--------------------------------

### get_world_environment

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimation.html

Gets the current WorldEnvironment node.

```APIDOC
## get_world_environment

### Description
Returns the WorldEnvironment node that the light estimation data is applied to.

### Method
WorldEnvironment get_world_environment()

### Parameters
None

### Returns
WorldEnvironment - The current world environment node.
```

--------------------------------

### get_directional_light

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimation.html

Gets the current DirectionalLight3D node.

```APIDOC
## get_directional_light

### Description
Returns the DirectionalLight3D node that the light estimation data is applied to.

### Method
DirectionalLight3D get_directional_light()

### Parameters
None

### Returns
DirectionalLight3D - The current directional light node.
```

--------------------------------

### Create new OpenXR extension wrapper

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Generate boilerplate header and source files for a new OpenXR extension wrapper. Supports interactive mode (prompts for extension name) and CLI mode (provide extension name as argument). Examples: XR_ANDROID_light_estimation and XR_FB_color_space.

```bash
# Interactive mode: it'll prompt you for the extension name.
./scripts/create_new_extension.py

# CLI mode: provide the extension name as an argument.
# For example:
./scripts/create_new_extension.py XR_ANDROID_light_estimation
./scripts/create_new_extension.py XR_FB_color_space

```

--------------------------------

### Build the plugin gdextension

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run these commands from the root directory to generate the editor gdextension plugin for template_debug and template_release targets.

```bash
scons target=template_debug custom_api_file=thirdparty/godot_cpp_gdextension_api/extension_api.json
scons target=template_release custom_api_file=thirdparty/godot_cpp_gdextension_api/extension_api.json

```

--------------------------------

### get_boundary_2d

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the 2D boundary of the spatial entity.

```APIDOC
## get_boundary_2d

### Description
Gets the 2D boundary of the spatial entity.

### Method
get_boundary_2d

### Parameters
None

### Returns
PackedVector2Array - The 2D boundary points.
```

--------------------------------

### get_anchor_uuids

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialanchormanager.html

Gets the UUIDs of all spatial anchors that have been created.

```APIDOC
## get_anchor_uuids

### Description
Gets the UUIDs of all spatial anchors that have been created. Note: All anchors will be created asynchronously via create_anchor, load_anchor, load_anchors, or track_anchor.

### Method
Array

### Parameters
None

### Request Example
```
get_anchor_uuids()
```

### Response
#### Success Response
- **uuids** (Array) - An array of UUIDs (StringName) for all created anchors.

```

--------------------------------

### Build plugin artifacts on Linux/macOS

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run this command from the root directory to build the plugin artifacts on Linux or macOS.

```bash
./gradlew buildPlugin

```

--------------------------------

### get_mode

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrhybridapp.html

Gets the current hybrid app mode.

```APIDOC
## get_mode

### Description
Gets the current hybrid app mode.

### Method
`HybridMode get_mode() const`

### Parameters
None

### Returns
- **HybridMode** - The current hybrid app mode (HYBRID_MODE_NONE, HYBRID_MODE_IMMERSIVE, or HYBRID_MODE_PANEL).
```

--------------------------------

### query_all()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentityquery.html

Sets up the query to retrieve all spatial entities in local storage.

```APIDOC
## query_all()

### Description
Sets up the query to get all spatial entities in local storage (up to the limit of max_results). Note: It's not possible to query all spatial entities stored in the cloud.

### Method
`void query_all()`

### Parameters
None

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### start_geospatial

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidgeospatialextension.html

Creates the geospatial tracker, which tracks the device's position and orientation relative to the Earth.

```APIDOC
## start_geospatial

### Description
Creates the geospatial tracker, which tracks the device's position and orientation relative to the Earth. You must call is_geospatial_supported first to verify that the extension is supported. The tracker initially enters the GEOSPATIAL_STATE_STOPPED state, and the application must wait for the openxr_android_geospatial_state_changed signal to indicate GEOSPATIAL_STATE_RUNNING before using pose conversion methods.

### Method
start_geospatial

### Parameters
None

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### get_uuids()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentityquery.html

Gets the UUIDs being searched for when querying by UUID.

```APIDOC
## get_uuids()

### Description
Gets the UUIDs being searched for when querying by UUID. See query_by_uuid.

### Method
`Array get_uuids()`

### Parameters
None

### Returns
- **Array** - The UUIDs being searched for.
```

--------------------------------

### get_hand_capsule_count

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbhandtrackingcapsulesextension.html

Gets the total number of hand capsules.

```APIDOC
## get_hand_capsule_count

### Description
Gets the total number of hand capsules.

### Method
int get_hand_capsule_count() const

### Parameters
None

### Returns
- **int** - The total number of hand capsules.
```

--------------------------------

### OpenXRAndroidSceneMeshingExtension

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidscenemeshingextension.html

Reference documentation for the OpenXRAndroidSceneMeshingExtension class, covering its description, methods, and method descriptions.

```APIDOC
## OpenXRAndroidSceneMeshingExtension

### Description
[Description of the OpenXRAndroidSceneMeshingExtension class]

### Methods
- [Method 1]
- [Method 2]
- ...

### Method Descriptions
#### [Method 1]
[Description of method 1]

#### [Method 2]
[Description of method 2]

...

```

--------------------------------

### Build vendors AAR Android binaries on Windows

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run this command from the root directory to build the vendors AAR Android binaries on Windows.

```batch
gradlew.bat build

```

--------------------------------

### get_directional_light_mode

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimation.html

Gets the current directional light mode.

```APIDOC
## get_directional_light_mode

### Description
Returns the current mode that controls how directional light data is applied to the DirectionalLight3D.

### Method
DirectionalLightMode get_directional_light_mode()

### Parameters
None

### Returns
DirectionalLightMode - The current directional light mode.
```

--------------------------------

### get_ambient_light_mode

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimation.html

Gets the current ambient light mode.

```APIDOC
## get_ambient_light_mode

### Description
Returns the current mode that controls how ambient light data is applied to the WorldEnvironment.

### Method
AmbientLightMode get_ambient_light_mode()

### Parameters
None

### Returns
AmbientLightMode - The current ambient light mode.
```

--------------------------------

### OpenXRAndroidLightEstimation

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrandroidlightestimation.html

Class reference for OpenXRAndroidLightEstimation, including its properties, enumerations, and property descriptions.

```APIDOC
## OpenXRAndroidLightEstimation

### Description
[Description of the OpenXRAndroidLightEstimation class]

### Properties
- [List of properties with types and default values]

### Enumerations
- [List of enumerations with values]

### Property Descriptions
- [Detailed descriptions for each property]
```

--------------------------------

### show()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrmlmarkerunderstandingmanager.html

Shows all markers tracked by this manager.

```APIDOC
## show()

### Description
Shows all markers tracked by this manager.

### Method
void show ( )

### Parameters
None

### Returns
void
```

--------------------------------

### show

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbscenemanager.html

Shows the scene manager node.

```APIDOC
## show

### Description
Shows the scene manager node.

### Method
show

### Parameters
None

### Returns
- **void** - No return value.
```

--------------------------------

### get_bounding_box_3d

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the 3D boundary of the spatial entity as an AABB.

```APIDOC
## get_bounding_box_3d

### Description
Gets the 3D boundary of the spatial entity as an AABB.

### Method
get_bounding_box_3d

### Parameters
None

### Returns
AABB
```

--------------------------------

### is_passthrough_preferred()

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbpassthroughextension.html

Returns `true` if the OpenXR runtime recommends that the app start in passthrough mode (if supported); otherwise `false`.

```APIDOC
## is_passthrough_preferred

### Description
Returns `true` if the OpenXR runtime recommends that the app start in passthrough mode (if supported); otherwise `false`. While this recommendation is platform dependent, it may, for example, return `true` if the user was already in passthrough when they opened the app, in order to prevent the user switching from passthrough, to full VR, and back to passthrough again.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **bool** - `true` if passthrough is preferred, otherwise `false`.

#### Response Example
N/A
```

--------------------------------

### get_custom_data

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the game or application-specific data about the spatial entity.

```APIDOC
## get_custom_data

### Description
Gets the game or application-specific data about the spatial entity.

### Method
get_custom_data

### Parameters
None

### Returns
Dictionary
```

--------------------------------

### Connect to OpenXR session_begun signal

Source: https://godotvr.github.io/godot_openxr_vendors/manual/meta/spatial_anchors.html

Connects the OpenXR session_begun signal to a handler that calls load_spatial_anchors_from_file. This should be set up in _ready after the OpenXR interface is initialized. The handler is only connected if the interface exists and is initialized.

```GDScript
func _ready():
    var xr_interface: OpenXRInterface = XRServer.find_interface("OpenXR")
    if xr_interface and xr_interface.is_initialized():
        xr_interface.session_begun.connect(_on_openxr_session_begun)

func _on_openxr_session_begun() -> void:
    load_spatial_anchors_from_file()

```

--------------------------------

### get_triangle_mesh

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the triangle mesh data for this spatial entity.

```APIDOC
## get_triangle_mesh

### Description
Gets the triangle mesh data for this spatial entity.

### Method
get_triangle_mesh

### Parameters
None

### Returns
Array - An array of triangle mesh data.
```

--------------------------------

### get_supported_components

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the list of supported components for this spatial entity.

```APIDOC
## get_supported_components

### Description
Gets the list of supported components for this spatial entity.

### Method
get_supported_components

### Parameters
None

### Returns
Array - An array of supported component types.
```

--------------------------------

### Spatial Entity Script for StaticBody3D

Source: https://godotvr.github.io/godot_openxr_vendors/manual/meta/scene_manager.html

Attach this script to a StaticBody3D scene with a Label3D child. The setup_scene() method is called by the Scene Manager when the entity is created, setting the label text from semantic labels, and adding collision and mesh nodes. Use get_triangle_mesh() for custom mesh creation and get_semantic_labels() for labels.

```GDScript
extends StaticBody3D

@onready var label: Label3D = $Label3D

func setup_scene(entity: OpenXRFbSpatialEntity) -> void:
    var semantic_labels: PackedStringArray = entity.get_semantic_labels()

    label.text = semantic_labels[0]

    var collision_shape = entity.create_collision_shape()
    if collision_shape:
        add_child(collision_shape)

    var mesh_instance = entity.create_mesh_instance()
    if mesh_instance:
        add_child(mesh_instance)

```

--------------------------------

### Build vendors AAR Android binaries on Linux/macOS

Source: https://godotvr.github.io/godot_openxr_vendors/getting-started/building.html

Run this command from the root directory to build the vendors AAR Android binaries on Linux or macOS.

```bash
./gradlew build

```

--------------------------------

### get_semantic_labels

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the semantic labels associated with this spatial entity.

```APIDOC
## get_semantic_labels

### Description
Gets the semantic labels associated with this spatial entity.

### Method
get_semantic_labels

### Parameters
None

### Returns
PackedStringArray - An array of semantic label strings.
```

--------------------------------

### Apply custom data in setup_scene method

Source: https://godotvr.github.io/godot_openxr_vendors/manual/meta/spatial_anchors.html

Attach this script to the root node of spatial_anchor.tscn. The setup_scene method reads the custom data and applies the color to the mesh material.

```GDScript
extends Node3D

@onready var mesh_instance_3d: MeshInstance3D = $MeshInstance3D

func setup_scene(spatial_entity: OpenXRFbSpatialEntity) -> void:
    var data := spatial_entity.custom_data
    var color := Color(data.get('color', '#FFFFFF'))

    var material := StandardMaterial3D.new()
    material.albedo_color = color
    mesh_instance_3d.set_surface_override_material(0, material)

```

--------------------------------

### get_room_layout

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the room layout information for this spatial entity.

```APIDOC
## get_room_layout

### Description
Gets the room layout information for this spatial entity.

### Method
get_room_layout

### Parameters
None

### Returns
Dictionary - The room layout data.
```

--------------------------------

### OpenXRFbAndroidSurfaceSwapchainCreateExtension

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbandroidsurfaceswapchaincreateextension.html

Documentation for the OpenXRFbAndroidSurfaceSwapchainCreateExtension class, including its methods and method descriptions.

```APIDOC
## OpenXRFbAndroidSurfaceSwapchainCreateExtension

### Description
[Description of the OpenXRFbAndroidSurfaceSwapchainCreateExtension class]

### Methods
- [Method Name]
- [Method Name]

### Method Descriptions
#### [Method Name]
[Description of the method]

```

--------------------------------

### get_bounding_box_3d

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the 3D bounding box of the spatial entity.

```APIDOC
## get_bounding_box_3d

### Description
Gets the 3D bounding box of the spatial entity.

### Method
get_bounding_box_3d

### Parameters
None

### Returns
AABB - The 3D bounding box.
```

--------------------------------

### OpenXRFbBodyTrackingExtension Methods

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbbodytrackingextension.html

Methods for managing body tracking in the OpenXR framework.

```APIDOC
## OpenXRFbBodyTrackingExtension

### Description
Provides body tracking functionality for the OpenXR framework.

### Methods
- **enable_body_tracking**() -> void
  - Enables body tracking.
- **disable_body_tracking**() -> void
  - Disables body tracking.
- **get_body_tracking_data**() -> Dictionary
  - Returns the current body tracking data.

```

--------------------------------

### get_bounding_box_2d

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbspatialentity.html

Gets the 2D bounding box of the spatial entity.

```APIDOC
## get_bounding_box_2d

### Description
Gets the 2D bounding box of the spatial entity.

### Method
get_bounding_box_2d

### Parameters
None

### Returns
Rect2 - The 2D bounding box.
```

--------------------------------

### OpenXRSessionHelperExtension

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrsessionhelperextension.html

The OpenXRSessionHelperExtension class provides methods to manage OpenXR sessions, such as creating and destroying sessions and retrieving session state.

```APIDOC
## OpenXRSessionHelperExtension

### Description
The OpenXRSessionHelperExtension class provides methods to manage OpenXR sessions, including creating and destroying sessions and retrieving session state.

### Methods
- `create_session()` - Creates an OpenXR session.
- `destroy_session()` - Destroys the current OpenXR session.
- `get_session_state()` - Returns the current session state.

### Method Descriptions
#### create_session()
Creates an OpenXR session. Returns `true` if successful, `false` otherwise.

#### destroy_session()
Destroys the current OpenXR session. Returns `true` if successful, `false` otherwise.

#### get_session_state()
Returns the current session state as an integer value corresponding to the OpenXR session state enum.
```

--------------------------------

### get_spatial_entity

Source: https://godotvr.github.io/godot_openxr_vendors/api/class_openxrfbscenemanager.html

Gets the spatial entity identified by the given UUID.

```APIDOC
## get_spatial_entity

### Description
Gets the spatial entity identified by the given UUID. Note: Only works for spatial entities that were loaded as a result of calling `create_scene_anchors` or when the OpenXR session begins if `auto_create` is set to `true`.

### Method
get_spatial_entity

### Parameters
- **uuid** (StringName) - The UUID of the spatial entity.

### Returns
- **OpenXRFbSpatialEntity** - The spatial entity associated with the given UUID.
```
Tokens:
Raw