---
generated_by: gdlink-build
generated_at: 2026-06-23T12:34:28Z
do_not_edit: true
title: XR Session
brick_type: executor
tier: Pro
generated: true
---

# XR Session

**Category:** Executor
**Tier:** Pro

## Purpose

Manages the XR session lifecycle and global system parameters.

## Visual Reference

```{raw} html
<div class="illustration-container"><div class="illustration-box"><div class="box-header">As added to your scene</div><img src="https://gdlink.solventech.ca/guide/assets/images/bricks/xr_session_executor.png" alt="XR Session brick as it appears in the GDLink editor" loading="lazy" style="max-width:100%;height:auto;display:block;margin:0 auto;border-radius:8px;" /></div></div>
```

## Runtime Behavior

**Inputs**
- **Activate** (Boolean): Triggers the selected action.

**Outputs**
- **Session State** (Metadata): Exposes current session state (`IDLE`, `READY`, `SYNCHRONIZED`, `VISIBLE`, `FOCUSED`, `STOPPING`, `LOSS_PENDING`, `EXITING`) as runtime metadata for downstream logic.

**Properties**

**Core (always visible)**
- **action** (Enum, default `"Initialize"`): `Initialize`, `Shutdown`, `World Scale`, `Reset Orientation`, `Set World Origin`, `Toggle Interface`, `Set Refresh Rate`, `Toggle Foveated Rendering`, `Set Tracking Mode`, `Custom Command`
- **interface_name** (String, default `"OpenXR"`)

**Initialize/Shutdown**
No additional properties. `Initialize` calls `XRInterface::initialize()` and sets the viewport to use XR. `Shutdown` calls `uninitialize()`.

**World Scale (`visible_if: {action: "World Scale"}`)**
- **scale_factor** (Float, default `1.0`): Multiplier applied to `XROrigin3D.world_scale`.

**Toggle Interface (`visible_if: {action: "Toggle Interface"}`)**
- **target_interface** (String, default `"OpenXR"`): Interface to activate/deactivate.

**Set Refresh Rate (`visible_if: {action: "Set Refresh Rate"}`)**
- **refresh_rate** (Float, default `90.0`): Target display refresh rate in Hz.

**Toggle Foveated Rendering (`visible_if: {action: "Toggle Foveated Rendering"}`)**
- **foveated_level** (Int, default `0`): 0=off, 1=low, 2=medium, 3=high.

**Set Tracking Mode (`visible_if: {action: "Set Tracking Mode"}`)**
- **tracking_mode** (Enum): `3DOF`, `6DOF`

**Custom Command (`visible_if: {action: "Custom Command"}`)**

...

```{raw} html
<div class="illustration-container">
        <div class="illustration-box">
            <div class="box-header">Generated UI Mockup — showing expanded properties</div>
            <div class="real-node brick-executor">
                <div class="real-header">
                    <div class="real-title"><span class="brick-icon-fallback"></span> <span>XR Session</span></div>
                    <div class="real-controls"><div class="real-checkbox"></div><div class="real-btn">-</div><div class="real-btn">x</div></div>
                </div>
                <div class="real-inner-panel"><div class="real-row name-row" style="position:relative;"><span class="real-label">Name:</span><div class="real-input" style="color:#666; font-style:italic;">Label this brick...</div><div class="real-port" style="left:-15px;"></div></div><div class="real-row"><span class="real-label">Action:</span><div class="real-input-dropdown">Initialize</div></div><div class="real-row"><span class="real-label" style="width: auto; padding-right:8px;">Interface:</span><div class="real-input" style="justify-content:space-between; padding:4px 8px;"><span>OpenXR</span><div class="real-input-dropdown-btn" style="padding:2px 6px;">v</div></div></div><div class="real-row"><span class="real-label">Scale:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>1.0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-row"><span class="real-label" style="width: auto; padding-right:8px;">Target:</span><div class="real-input" style="justify-content:space-between; padding:4px 8px;"><span>OpenXR</span><div class="real-input-dropdown-btn" style="padding:2px 6px;">v</div></div></div><div class="real-row"><span class="real-label">Hz:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>90.0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-row"><span class="real-label">Level:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-row"><span class="real-label">Mode:</span><div class="real-input-dropdown">6DOF</div></div><div class="real-row"><span class="real-label" style="width: auto; padding-right:8px;">Command:</span><div class="real-input" style="justify-content:space-between; padding:4px 8px;"><span></span><div class="real-input-dropdown-btn" style="padding:2px 6px;">v</div></div></div></div>
            </div>
        </div>
    </div>
```

## Properties

| Property | Type | Default | Notes |
|---|---|---|---|
| Action | option | Initialize | XR session operation |
| Interface | string | OpenXR | XR interface name (OpenXR, WebXR, etc.) |
| Scale | float | 1.0 | Multiplier for XROrigin3D.world_scale |
| Target | string | OpenXR | Interface to activate/deactivate |
| Hz | float | 90.0 | Target display refresh rate |
| Level | int | 0 | 0=off, 1=low, 2=medium, 3=high |
| Mode | option | 6DOF | Tracking degrees of freedom |
| Command | string |  | Vendor-specific command string |