XRInterface #

func get_camera_feed_id() -> int#

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

const func get_capabilities() -> int#

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

const func get_name() -> StringName#

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

const func get_play_area() -> PackedVector3Array#

Returns an array of vectors that represent the physical play area mapped to the virtual space around the XROrigin3D 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.

func get_projection_for_view(far: float) -> Projection#

Returns the projection matrix for a view/eye.

func get_render_target_size() -> Vector2#

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

func get_supported_environment_blend_modes() -> Array#

Returns the an array of supported environment blend modes, see XRInterface.EnvironmentBlendMode.

func get_system_info() -> Dictionary#

Returns a Dictionary with extra system info. Interfaces are expected to return XRRuntimeName and XRRuntimeVersion providing info about the used XR runtime. Additional entries may be provided specific to an interface.

Note:This information may only be available after initialize was successfully called.

const func get_tracking_status() -> intXRInterface.TrackingStatus#

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.

func get_transform_for_view(cam_transform: Transform3D) -> 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 the Node3D.global_transform of the current XROrigin3D.

func get_view_count() -> int#

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

func initialize() -> bool#

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.

const func is_initialized() -> bool#

Returns true if this interface has been initialized.

func is_passthrough_enabled() -> bool#

Returns true if passthrough is enabled.

func is_passthrough_supported() -> bool#

Returns true if this interface supports passthrough.

func set_environment_blend_mode(mode: int enumXRInterface.EnvironmentBlendMode) -> bool#

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():
    var xr_interface = XRServer.find_interface("OpenXR")
    if xr_interface and xr_interface.is_initialized():
        var vp = get_viewport()
        vp.use_xr = true
        var acceptable_modes = [XRInterface.XR_ENV_BLEND_MODE_OPAQUE, XRInterface.XR_ENV_BLEND_MODE_ADDITIVE]
        var modes = xr_interface.get_supported_environment_blend_modes()
        for mode in acceptable_modes:
            if mode in modes:
                xr_interface.set_environment_blend_mode(mode)
                break

func set_play_area_mode(mode: int enumXRInterface.PlayAreaMode) -> bool#

Sets the active play area mode, will return false 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 with XRServer.center_on_hmd (if switching to XRInterface.XR_PLAY_AREA_STAGE) or make the switch during a scene change.

func start_passthrough() -> bool#

Starts passthrough, will return false if passthrough couldn't be started.

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

func stop_passthrough() -> void#

Stops passthrough.

func supports_play_area_mode(mode: int enumXRInterface.PlayAreaMode) -> bool#

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

func trigger_haptic_pulse(delay_sec: float) -> void#

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 to 0.0 to have the system use a default frequency.

amplitude is the amplitude of the pulse between 0.0 and 1.0.

duration_sec is the duration of the pulse in seconds.

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

func uninitialize() -> void#

Turns the interface off.