godot-docs/classes/class_webxrinterface.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WebXRInterface.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_WebXRInterface:

WebXRInterface
==============

**Inherits:** :ref:`ARVRInterface<class_ARVRInterface>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

AR/VR interface using WebXR.

Description
-----------

WebXR is an open standard that allows creating VR and AR applications that run in the web browser.

As such, this interface is only available when running in an HTML5 export.

WebXR supports a wide range of devices, from the very capable (like Valve Index, HTC Vive, Oculus Rift and Quest) down to the much less capable (like Google Cardboard, Oculus Go, GearVR, or plain smartphones).

Since WebXR is based on Javascript, it makes extensive use of callbacks, which means that ``WebXRInterface`` is forced to use signals, where other AR/VR interfaces would instead use functions that return a result immediately. This makes ``WebXRInterface`` quite a bit more complicated to initialize than other AR/VR interfaces.

Here's the minimum code required to start an immersive VR session:

::

    extends Spatial
    
    var webxr_interface
    var vr_supported = false
    
    func _ready():
        # We assume this node has a button as a child.
        # This button is for the user to consent to entering immersive VR mode.
        $Button.connect("pressed", self, "_on_Button_pressed")
    
        webxr_interface = ARVRServer.find_interface("WebXR")
        if webxr_interface:
            # WebXR uses a lot of asynchronous callbacks, so we connect to various
            # signals in order to receive them.
            webxr_interface.connect("session_supported", self, "_webxr_session_supported")
            webxr_interface.connect("session_started", self, "_webxr_session_started")
            webxr_interface.connect("session_ended", self, "_webxr_session_ended")
            webxr_interface.connect("session_failed", self, "_webxr_session_failed")
    
            # This returns immediately - our _webxr_session_supported() method
            # (which we connected to the "session_supported" signal above) will
            # be called sometime later to let us know if it's supported or not.
            webxr_interface.is_session_supported("immersive-vr")
    
    func _webxr_session_supported(session_mode, supported):
        if session_mode == 'immersive-vr':
            vr_supported = supported
    
    func _on_Button_pressed():
        if not vr_supported:
            OS.alert("Your browser doesn't support VR")
            return
    
        # We want an immersive VR session, as opposed to AR ('immersive-ar') or a
        # simple 3DoF viewer ('viewer').
        webxr_interface.session_mode = 'immersive-vr'
        # 'bounded-floor' is room scale, 'local-floor' is a standing or sitting
        # experience (it puts you 1.6m above the ground if you have 3DoF headset),
        # whereas as 'local' puts you down at the ARVROrigin.
        # This list means it'll first try to request 'bounded-floor', then
        # fallback on 'local-floor' and ultimately 'local', if nothing else is
        # supported.
        webxr_interface.requested_reference_space_types = 'bounded-floor, local-floor, local'
        # In order to use 'local-floor' or 'bounded-floor' we must also
        # mark the features as required or optional.
        webxr_interface.required_features = 'local-floor'
        webxr_interface.optional_features = 'bounded-floor'
    
        # This will return false if we're unable to even request the session,
        # however, it can still fail asynchronously later in the process, so we
        # only know if it's really succeeded or failed when our
        # _webxr_session_started() or _webxr_session_failed() methods are called.
        if not webxr_interface.initialize():
            OS.alert("Failed to initialize")
            return
    
    func _webxr_session_started():
        $Button.visible = false
        # This tells Godot to start rendering to the headset.
        get_viewport().arvr = true
        # This will be the reference space type you ultimately got, out of the
        # types that you requested above. This is useful if you want the game to
        # work a little differently in 'bounded-floor' versus 'local-floor'.
        print ("Reference space type: " + webxr_interface.reference_space_type)
    
    func _webxr_session_ended():
        $Button.visible = true
        # If the user exits immersive mode, then we tell Godot to render to the web
        # page again.
        get_viewport().arvr = false
    
    func _webxr_session_failed(message):
        OS.alert("Failed to initialize: " + message)

There are several ways to handle "controller" input:

- Using :ref:`ARVRController<class_ARVRController>` nodes and their :ref:`ARVRController.button_pressed<class_ARVRController_signal_button_pressed>` and :ref:`ARVRController.button_release<class_ARVRController_signal_button_release>` signals. This is how controllers are typically handled in AR/VR apps in Godot, however, this will only work with advanced VR controllers like the Oculus Touch or Index controllers, for example. The buttons codes are defined by `Section 3.3 of the WebXR Gamepads Module <https://immersive-web.github.io/webxr-gamepads-module/#xr-standard-gamepad-mapping>`__.

- Using :ref:`Node._unhandled_input<class_Node_method__unhandled_input>` and :ref:`InputEventJoypadButton<class_InputEventJoypadButton>` or :ref:`InputEventJoypadMotion<class_InputEventJoypadMotion>`. This works the same as normal joypads, except the :ref:`InputEvent.device<class_InputEvent_property_device>` starts at 100, so the left controller is 100 and the right controller is 101, and the button codes are also defined by `Section 3.3 of the WebXR Gamepads Module <https://immersive-web.github.io/webxr-gamepads-module/#xr-standard-gamepad-mapping>`__.

- Using the :ref:`select<class_WebXRInterface_signal_select>`, :ref:`squeeze<class_WebXRInterface_signal_squeeze>` and related signals. This method will work for both advanced VR controllers, and non-traditional "controllers" like a tap on the screen, a spoken voice command or a button press on the device itself. The ``controller_id`` passed to these signals is the same id as used in :ref:`ARVRController.controller_id<class_ARVRController_property_controller_id>`.

You can use one or all of these methods to allow your game or app to support a wider or narrower set of devices and input methods, or to allow more advanced interations with more advanced devices.

Tutorials
---------

- `How to make a VR game for WebXR with Godot <https://www.snopekgames.com/blog/2020/how-make-vr-game-webxr-godot>`__

Properties
----------

+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`bounds_geometry<class_WebXRInterface_property_bounds_geometry>`                                 |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`optional_features<class_WebXRInterface_property_optional_features>`                             |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`reference_space_type<class_WebXRInterface_property_reference_space_type>`                       |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`requested_reference_space_types<class_WebXRInterface_property_requested_reference_space_types>` |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`required_features<class_WebXRInterface_property_required_features>`                             |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`session_mode<class_WebXRInterface_property_session_mode>`                                       |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                     | :ref:`visibility_state<class_WebXRInterface_property_visibility_state>`                               |
+-------------------------------------------------+-------------------------------------------------------------------------------------------------------+

Methods
-------

+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` | :ref:`get_controller<class_WebXRInterface_method_get_controller>` **(** :ref:`int<class_int>` controller_id **)** |const|          |
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void                                                      | :ref:`is_session_supported<class_WebXRInterface_method_is_session_supported>` **(** :ref:`String<class_String>` session_mode **)** |
+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_WebXRInterface_signal_reference_space_reset:

- **reference_space_reset** **(** **)**

Emitted to indicate that the reference space has been reset or reconfigured.

When (or whether) this is emitted depends on the user's browser or device, but may include when the user has changed the dimensions of their play space (which you may be able to access via :ref:`bounds_geometry<class_WebXRInterface_property_bounds_geometry>`) or pressed/held a button to recenter their position.

See `WebXR's XRReferenceSpace reset event <https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpace/reset_event>`__ for more information.

----

.. _class_WebXRInterface_signal_select:

- **select** **(** :ref:`int<class_int>` controller_id **)**

Emitted after one of the "controllers" has finished its "primary action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_selectend:

- **selectend** **(** :ref:`int<class_int>` controller_id **)**

Emitted when one of the "controllers" has finished its "primary action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_selectstart:

- **selectstart** **(** :ref:`int<class_int>` controller_id **)**

Emitted when one of the "controllers" has started its "primary action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_session_ended:

- **session_ended** **(** **)**

Emitted when the user ends the WebXR session (which can be done using UI from the browser or device).

At this point, you should do ``get_viewport().arvr = false`` to instruct Godot to resume rendering to the screen.

----

.. _class_WebXRInterface_signal_session_failed:

- **session_failed** **(** :ref:`String<class_String>` message **)**

Emitted by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` if the session fails to start.

``message`` may optionally contain an error message from WebXR, or an empty string if no message is available.

----

.. _class_WebXRInterface_signal_session_started:

- **session_started** **(** **)**

Emitted by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` if the session is successfully started.

At this point, it's safe to do ``get_viewport().arvr = true`` to instruct Godot to start rendering to the AR/VR device.

----

.. _class_WebXRInterface_signal_session_supported:

- **session_supported** **(** :ref:`String<class_String>` session_mode, :ref:`bool<class_bool>` supported **)**

Emitted by :ref:`is_session_supported<class_WebXRInterface_method_is_session_supported>` to indicate if the given ``session_mode`` is supported or not.

----

.. _class_WebXRInterface_signal_squeeze:

- **squeeze** **(** :ref:`int<class_int>` controller_id **)**

Emitted after one of the "controllers" has finished its "primary squeeze action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_squeezeend:

- **squeezeend** **(** :ref:`int<class_int>` controller_id **)**

Emitted when one of the "controllers" has finished its "primary squeeze action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_squeezestart:

- **squeezestart** **(** :ref:`int<class_int>` controller_id **)**

Emitted when one of the "controllers" has started its "primary squeeze action".

Use :ref:`get_controller<class_WebXRInterface_method_get_controller>` to get more information about the controller.

----

.. _class_WebXRInterface_signal_visibility_state_changed:

- **visibility_state_changed** **(** **)**

Emitted when :ref:`visibility_state<class_WebXRInterface_property_visibility_state>` has changed.

Property Descriptions
---------------------

.. _class_WebXRInterface_property_bounds_geometry:

- :ref:`PoolVector3Array<class_PoolVector3Array>` **bounds_geometry**

+----------+-----------------------+
| *Getter* | get_bounds_geometry() |
+----------+-----------------------+

The vertices of a polygon which defines the boundaries of the user's play area.

This will only be available if :ref:`reference_space_type<class_WebXRInterface_property_reference_space_type>` is ``"bounded-floor"`` and only on certain browsers and devices that support it.

The :ref:`reference_space_reset<class_WebXRInterface_signal_reference_space_reset>` signal may indicate when this changes.

----

.. _class_WebXRInterface_property_optional_features:

- :ref:`String<class_String>` **optional_features**

+----------+------------------------------+
| *Setter* | set_optional_features(value) |
+----------+------------------------------+
| *Getter* | get_optional_features()      |
+----------+------------------------------+

A comma-seperated list of optional features used by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` when setting up the WebXR session.

If a user's browser or device doesn't support one of the given features, initialization will continue, but you won't be able to use the requested feature.

This doesn't have any effect on the interface when already initialized.

Possible values come from `WebXR's XRReferenceSpaceType <https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType>`__. If you want to use a particular reference space type, it must be listed in either :ref:`required_features<class_WebXRInterface_property_required_features>` or :ref:`optional_features<class_WebXRInterface_property_optional_features>`.

----

.. _class_WebXRInterface_property_reference_space_type:

- :ref:`String<class_String>` **reference_space_type**

+----------+----------------------------+
| *Getter* | get_reference_space_type() |
+----------+----------------------------+

The reference space type (from the list of requested types set in the :ref:`requested_reference_space_types<class_WebXRInterface_property_requested_reference_space_types>` property), that was ultimately used by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` when setting up the WebXR session.

Possible values come from `WebXR's XRReferenceSpaceType <https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType>`__. If you want to use a particular reference space type, it must be listed in either :ref:`required_features<class_WebXRInterface_property_required_features>` or :ref:`optional_features<class_WebXRInterface_property_optional_features>`.

----

.. _class_WebXRInterface_property_requested_reference_space_types:

- :ref:`String<class_String>` **requested_reference_space_types**

+----------+--------------------------------------------+
| *Setter* | set_requested_reference_space_types(value) |
+----------+--------------------------------------------+
| *Getter* | get_requested_reference_space_types()      |
+----------+--------------------------------------------+

A comma-seperated list of reference space types used by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` when setting up the WebXR session.

The reference space types are requested in order, and the first on supported by the users device or browser will be used. The :ref:`reference_space_type<class_WebXRInterface_property_reference_space_type>` property contains the reference space type that was ultimately used.

This doesn't have any effect on the interface when already initialized.

Possible values come from `WebXR's XRReferenceSpaceType <https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType>`__. If you want to use a particular reference space type, it must be listed in either :ref:`required_features<class_WebXRInterface_property_required_features>` or :ref:`optional_features<class_WebXRInterface_property_optional_features>`.

----

.. _class_WebXRInterface_property_required_features:

- :ref:`String<class_String>` **required_features**

+----------+------------------------------+
| *Setter* | set_required_features(value) |
+----------+------------------------------+
| *Getter* | get_required_features()      |
+----------+------------------------------+

A comma-seperated list of required features used by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` when setting up the WebXR session.

If a user's browser or device doesn't support one of the given features, initialization will fail and :ref:`session_failed<class_WebXRInterface_signal_session_failed>` will be emitted.

This doesn't have any effect on the interface when already initialized.

Possible values come from `WebXR's XRReferenceSpaceType <https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType>`__. If you want to use a particular reference space type, it must be listed in either :ref:`required_features<class_WebXRInterface_property_required_features>` or :ref:`optional_features<class_WebXRInterface_property_optional_features>`.

----

.. _class_WebXRInterface_property_session_mode:

- :ref:`String<class_String>` **session_mode**

+----------+-------------------------+
| *Setter* | set_session_mode(value) |
+----------+-------------------------+
| *Getter* | get_session_mode()      |
+----------+-------------------------+

The session mode used by :ref:`ARVRInterface.initialize<class_ARVRInterface_method_initialize>` when setting up the WebXR session.

This doesn't have any effect on the interface when already initialized.

Possible values come from `WebXR's XRSessionMode <https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode>`__, including: ``"immersive-vr"``, ``"immersive-ar"``, and ``"inline"``.

----

.. _class_WebXRInterface_property_visibility_state:

- :ref:`String<class_String>` **visibility_state**

+----------+------------------------+
| *Getter* | get_visibility_state() |
+----------+------------------------+

Indicates if the WebXR session's imagery is visible to the user.

Possible values come from `WebXR's XRVisibilityState <https://developer.mozilla.org/en-US/docs/Web/API/XRVisibilityState>`__, including ``"hidden"``, ``"visible"``, and ``"visible-blurred"``.

Method Descriptions
-------------------

.. _class_WebXRInterface_method_get_controller:

- :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` **get_controller** **(** :ref:`int<class_int>` controller_id **)** |const|

Gets an :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` for the given ``controller_id``.

In the context of WebXR, a "controller" can be an advanced VR controller like the Oculus Touch or Index controllers, or even a tap on the screen, a spoken voice command or a button press on the device itself. When a non-traditional controller is used, interpret the position and orientation of the :ref:`ARVRPositionalTracker<class_ARVRPositionalTracker>` as a ray pointing at the object the user wishes to interact with.

Use this method to get information about the controller that triggered one of these signals:

- :ref:`selectstart<class_WebXRInterface_signal_selectstart>`

- :ref:`select<class_WebXRInterface_signal_select>`

- :ref:`selectend<class_WebXRInterface_signal_selectend>`

- :ref:`squeezestart<class_WebXRInterface_signal_squeezestart>`

- :ref:`squeeze<class_WebXRInterface_signal_squeeze>`

- :ref:`squeezestart<class_WebXRInterface_signal_squeezestart>`

----

.. _class_WebXRInterface_method_is_session_supported:

- void **is_session_supported** **(** :ref:`String<class_String>` session_mode **)**

Checks if the given ``session_mode`` is supported by the user's browser.

Possible values come from `WebXR's XRSessionMode <https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode>`__, including: ``"immersive-vr"``, ``"immersive-ar"``, and ``"inline"``.

This method returns nothing, instead it emits the :ref:`session_supported<class_WebXRInterface_signal_session_supported>` signal with the result.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`