Description

This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDExtension modules. Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.

Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces throughXRServer.

Tutorials

• XR documentation index

Properties

Methods

Signals

play_area_changed(mode:int)🔗

Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation.

Enumerations

enumCapabilities:🔗

CapabilitiesXR_NONE =0

No XR capabilities.

CapabilitiesXR_MONO =1

This interface can work with normal rendering output (non-HMD based AR).

CapabilitiesXR_STEREO =2

This interface supports stereoscopic rendering.

CapabilitiesXR_QUAD =4

This interface supports quad rendering (not yet supported by Godot).

CapabilitiesXR_VR =8

This interface supports VR.

CapabilitiesXR_AR =16

This interface supports AR (video background and real world tracking).

CapabilitiesXR_EXTERNAL =32

This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio ofget_render_target_size()). Using a separate viewport node frees up the main viewport for other purposes.

enumTrackingStatus:🔗

TrackingStatusXR_NORMAL_TRACKING =0

Tracking is behaving as expected.

TrackingStatusXR_EXCESSIVE_MOTION =1

Tracking is hindered by excessive motion (the player is moving faster than tracking can keep up).

TrackingStatusXR_INSUFFICIENT_FEATURES =2

Tracking is hindered by insufficient features, it's too dark (for camera-based tracking), player is blocked, etc.

TrackingStatusXR_UNKNOWN_TRACKING =3

We don't know the status of the tracking or this interface does not provide feedback.

TrackingStatusXR_NOT_TRACKING =4

Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.).

enumPlayAreaMode:🔗

PlayAreaModeXR_PLAY_AREA_UNKNOWN =0

Play area mode not set or not available.

PlayAreaModeXR_PLAY_AREA_3DOF =1

Play area only supports orientation tracking, no positional tracking, area will center around player.

PlayAreaModeXR_PLAY_AREA_SITTING =2

Player is in seated position, limited positional tracking, fixed guardian around player.

PlayAreaModeXR_PLAY_AREA_ROOMSCALE =3

Player is free to move around, full positional tracking.

PlayAreaModeXR_PLAY_AREA_STAGE =4

Same asXR_PLAY_AREA_ROOMSCALE but origin point is fixed to the center of the physical space. In this mode, system-level recentering may be disabled, requiring the use ofXRServer.center_on_hmd().

enumEnvironmentBlendMode:🔗

EnvironmentBlendModeXR_ENV_BLEND_MODE_OPAQUE =0

Opaque blend mode. This is typically used for VR devices.

EnvironmentBlendModeXR_ENV_BLEND_MODE_ADDITIVE =1

Additive blend mode. This is typically used for AR devices or VR devices with passthrough.

EnvironmentBlendModeXR_ENV_BLEND_MODE_ALPHA_BLEND =2

Alpha blend mode. This is typically used for AR or VR devices with passthrough capabilities. The alpha channel controls how much of the passthrough is visible. Alpha of 0.0 means the passthrough is visible and this pixel works in ADDITIVE mode. Alpha of 1.0 means that the passthrough is not visible and this pixel works in OPAQUE mode.

Property Descriptions

boolar_is_anchor_detection_enabled =false🔗

• voidset_anchor_detection_is_enabled(value:bool)

• boolget_anchor_detection_is_enabled()

On an AR interface,true if anchor detection is enabled.

EnvironmentBlendModeenvironment_blend_mode =0🔗

• boolset_environment_blend_mode(mode:EnvironmentBlendMode)

• EnvironmentBlendModeget_environment_blend_mode()

Specify how XR should blend in the environment. This is specific to certain AR and passthrough devices where camera images are blended in by the XR compositor.

boolinterface_is_primary =false🔗

• voidset_primary(value:bool)

• boolis_primary()

true if this is the primary interface.

PlayAreaModexr_play_area_mode =0🔗

• boolset_play_area_mode(mode:PlayAreaMode)

• PlayAreaModeget_play_area_mode()

The play area mode for this interface.

Method Descriptions

intget_camera_feed_id()🔗

If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in theCameraServer for this interface.

intget_capabilities()const🔗

Returns a combination ofCapabilities flags providing information about the capabilities of this interface.

StringNameget_name()const🔗

Returns the name of this interface ("OpenXR","OpenVR","OpenHMD","ARKit", etc.).

PackedVector3Arrayget_play_area()const🔗

Returns an array of vectors that represent the physical play area mapped to the virtual space around theXROrigin3D point. The points form a convex polygon that can be used to react to or visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available.

Projectionget_projection_for_view(view:int, aspect:float, near:float, far:float)🔗

Returns the projection matrix for a view/eye.

Vector2get_render_target_size()🔗

Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.

Arrayget_supported_environment_blend_modes()🔗

Returns the an array of supported environment blend modes, seeEnvironmentBlendMode.

Dictionaryget_system_info()🔗

Returns aDictionary with extra system info. Interfaces are expected to returnXRRuntimeName andXRRuntimeVersion providing info about the used XR runtime. Additional entries may be provided specific to an interface.

Note:This information may only be available afterinitialize() was successfully called.

TrackingStatusget_tracking_status()const🔗

If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.

Transform3Dget_transform_for_view(view:int, cam_transform:Transform3D)🔗

Returns the transform for a view/eye.

view is the view/eye index.

cam_transform is the transform that maps device coordinates to scene coordinates, typically theNode3D.global_transform of the current XROrigin3D.

intget_view_count()🔗

Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic.

boolinitialize()🔗

Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.

After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.

Note: You must enable the XR mode on the main viewport for any device that uses the main output of Godot, such as for mobile VR.

If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively, you can add a separate viewport node to your scene and enable AR/VR on that viewport. It will be used to output to the HMD, leaving you free to do anything you like in the main window, such as using a separate camera as a spectator camera or rendering something completely different.

While currently not used, you can activate additional interfaces. You may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD.

boolis_initialized()const🔗

Returnstrue if this interface has been initialized.

boolis_passthrough_enabled()🔗

Deprecated: Check ifenvironment_blend_mode isXR_ENV_BLEND_MODE_ALPHA_BLEND, instead.

Returnstrue if passthrough is enabled.

boolis_passthrough_supported()🔗

Deprecated: Check thatXR_ENV_BLEND_MODE_ALPHA_BLEND is supported usingget_supported_environment_blend_modes(), instead.

Returnstrue if this interface supports passthrough.

boolset_environment_blend_mode(mode:EnvironmentBlendMode)🔗

Sets the active environment blend mode.

mode is the environment blend mode starting with the next frame.

Note: Not all runtimes support all environment blend modes, so it is important to check this at startup. For example:

func_ready():varxr_interface=XRServer.find_interface("OpenXR")ifxr_interfaceandxr_interface.is_initialized():varvp=get_viewport()vp.use_xr=truevaracceptable_modes=[XRInterface.XR_ENV_BLEND_MODE_OPAQUE,XRInterface.XR_ENV_BLEND_MODE_ADDITIVE]varmodes=xr_interface.get_supported_environment_blend_modes()formodeinacceptable_modes:ifmodeinmodes:xr_interface.set_environment_blend_mode(mode)break

boolset_play_area_mode(mode:PlayAreaMode)🔗

Sets the active play area mode, will returnfalse if the mode can't be used with this interface.

Note: Changing this after the interface has already been initialized can be jarring for the player, so it's recommended to recenter on the HMD withXRServer.center_on_hmd() (if switching toXR_PLAY_AREA_STAGE) or make the switch during a scene change.

boolstart_passthrough()🔗

Deprecated: Set theenvironment_blend_mode toXR_ENV_BLEND_MODE_ALPHA_BLEND, instead.

Starts passthrough, will returnfalse if passthrough couldn't be started.

Note: The viewport used for XR must have a transparent background, otherwise passthrough may not properly render.

voidstop_passthrough()🔗

Deprecated: Set theenvironment_blend_mode toXR_ENV_BLEND_MODE_OPAQUE, instead.

Stops passthrough.

boolsupports_play_area_mode(mode:PlayAreaMode)🔗

Call this to find out if a given play area mode is supported by this interface.

voidtrigger_haptic_pulse(action_name:String, tracker_name:StringName, frequency:float, amplitude:float, duration_sec:float, delay_sec:float)🔗

Triggers a haptic pulse on a device associated with this interface.

action_name is the name of the action for this pulse.

tracker_name is optional and can be used to direct the pulse to a specific device provided that device is bound to this haptic.

frequency is the frequency of the pulse, set to0.0 to have the system use a default frequency.

amplitude is the amplitude of the pulse between0.0 and1.0.

duration_sec is the duration of the pulse in seconds.

delay_sec is a delay in seconds before the pulse is given.

voiduninitialize()🔗

Turns the interface off.