.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/webxr/doc_classes/WebXRInterface.xml. .. _class_WebXRInterface: WebXRInterface ============== **Inherits:** :ref:`XRInterface` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`enabled_features` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`optional_features` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reference_space_type` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`requested_reference_space_types` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`required_features` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`session_mode` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`visibility_state` | +-----------------------------+-------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_available_display_refresh_rates` **(** **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_display_refresh_rate` **(** **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TargetRayMode` | :ref:`get_input_source_target_ray_mode` **(** :ref:`int` input_source_id **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`XRControllerTracker` | :ref:`get_input_source_tracker` **(** :ref:`int` input_source_id **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_input_source_active` **(** :ref:`int` input_source_id **)** |const| | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`is_session_supported` **(** :ref:`String` session_mode **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_display_refresh_rate` **(** :ref:`float` refresh_rate **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_WebXRInterface_signal_display_refresh_rate_changed: .. rst-class:: classref-signal **display_refresh_rate_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_reference_space_reset: .. rst-class:: classref-signal **reference_space_reset** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_select: .. rst-class:: classref-signal **select** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_selectend: .. rst-class:: classref-signal **selectend** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_selectstart: .. rst-class:: classref-signal **selectstart** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_session_ended: .. rst-class:: classref-signal **session_ended** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_session_failed: .. rst-class:: classref-signal **session_failed** **(** :ref:`String` message **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_session_started: .. rst-class:: classref-signal **session_started** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_session_supported: .. rst-class:: classref-signal **session_supported** **(** :ref:`String` session_mode, :ref:`bool` supported **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_squeeze: .. rst-class:: classref-signal **squeeze** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_squeezeend: .. rst-class:: classref-signal **squeezeend** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_squeezestart: .. rst-class:: classref-signal **squeezestart** **(** :ref:`int` input_source_id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_signal_visibility_state_changed: .. rst-class:: classref-signal **visibility_state_changed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_WebXRInterface_TargetRayMode: .. rst-class:: classref-enumeration enum **TargetRayMode**: .. _class_WebXRInterface_constant_TARGET_RAY_MODE_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`TargetRayMode` **TARGET_RAY_MODE_UNKNOWN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebXRInterface_constant_TARGET_RAY_MODE_GAZE: .. rst-class:: classref-enumeration-constant :ref:`TargetRayMode` **TARGET_RAY_MODE_GAZE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebXRInterface_constant_TARGET_RAY_MODE_TRACKED_POINTER: .. rst-class:: classref-enumeration-constant :ref:`TargetRayMode` **TARGET_RAY_MODE_TRACKED_POINTER** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebXRInterface_constant_TARGET_RAY_MODE_SCREEN: .. rst-class:: classref-enumeration-constant :ref:`TargetRayMode` **TARGET_RAY_MODE_SCREEN** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_WebXRInterface_property_enabled_features: .. rst-class:: classref-property :ref:`String` **enabled_features** .. rst-class:: classref-property-setget - :ref:`String` **get_enabled_features** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_optional_features: .. rst-class:: classref-property :ref:`String` **optional_features** .. rst-class:: classref-property-setget - void **set_optional_features** **(** :ref:`String` value **)** - :ref:`String` **get_optional_features** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_reference_space_type: .. rst-class:: classref-property :ref:`String` **reference_space_type** .. rst-class:: classref-property-setget - :ref:`String` **get_reference_space_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_requested_reference_space_types: .. rst-class:: classref-property :ref:`String` **requested_reference_space_types** .. rst-class:: classref-property-setget - void **set_requested_reference_space_types** **(** :ref:`String` value **)** - :ref:`String` **get_requested_reference_space_types** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_required_features: .. rst-class:: classref-property :ref:`String` **required_features** .. rst-class:: classref-property-setget - void **set_required_features** **(** :ref:`String` value **)** - :ref:`String` **get_required_features** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_session_mode: .. rst-class:: classref-property :ref:`String` **session_mode** .. rst-class:: classref-property-setget - void **set_session_mode** **(** :ref:`String` value **)** - :ref:`String` **get_session_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_property_visibility_state: .. rst-class:: classref-property :ref:`String` **visibility_state** .. rst-class:: classref-property-setget - :ref:`String` **get_visibility_state** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_WebXRInterface_method_get_available_display_refresh_rates: .. rst-class:: classref-method :ref:`Array` **get_available_display_refresh_rates** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_get_display_refresh_rate: .. rst-class:: classref-method :ref:`float` **get_display_refresh_rate** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_get_input_source_target_ray_mode: .. rst-class:: classref-method :ref:`TargetRayMode` **get_input_source_target_ray_mode** **(** :ref:`int` input_source_id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_get_input_source_tracker: .. rst-class:: classref-method :ref:`XRControllerTracker` **get_input_source_tracker** **(** :ref:`int` input_source_id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_is_input_source_active: .. rst-class:: classref-method :ref:`bool` **is_input_source_active** **(** :ref:`int` input_source_id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_is_session_supported: .. rst-class:: classref-method void **is_session_supported** **(** :ref:`String` session_mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebXRInterface_method_set_display_refresh_rate: .. rst-class:: classref-method void **set_display_refresh_rate** **(** :ref:`float` refresh_rate **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`