.. 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/doc/classes/XRInterface.xml. .. _class_XRInterface: XRInterface =========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`MobileVRInterface`, :ref:`OpenXRInterface`, :ref:`WebXRInterface`, :ref:`XRInterfaceExtension` .. 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:`bool` | :ref:`ar_is_anchor_detection_enabled` | ``false`` | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ | :ref:`EnvironmentBlendMode` | :ref:`environment_blend_mode` | ``0`` | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`interface_is_primary` | ``false`` | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ | :ref:`PlayAreaMode` | :ref:`xr_play_area_mode` | ``0`` | +--------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_camera_feed_id` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_capabilities` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_name` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`get_play_area` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Projection` | :ref:`get_projection_for_view` **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` near, :ref:`float` far **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_render_target_size` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_supported_environment_blend_modes` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_system_info` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingStatus` | :ref:`get_tracking_status` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`get_transform_for_view` **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_view_count` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`initialize` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_initialized` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_passthrough_enabled` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_passthrough_supported` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`set_environment_blend_mode` **(** :ref:`EnvironmentBlendMode` mode **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`set_play_area_mode` **(** :ref:`PlayAreaMode` mode **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`start_passthrough` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop_passthrough` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`supports_play_area_mode` **(** :ref:`PlayAreaMode` mode **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`trigger_haptic_pulse` **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`uninitialize` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_XRInterface_signal_play_area_changed: .. rst-class:: classref-signal **play_area_changed** **(** :ref:`int` mode **)** .. 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_XRInterface_Capabilities: .. rst-class:: classref-enumeration enum **Capabilities**: .. _class_XRInterface_constant_XR_NONE: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_NONE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_MONO: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_MONO** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_STEREO: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_STEREO** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_QUAD: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_QUAD** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_VR: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_VR** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_AR: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_AR** = ``16`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_EXTERNAL: .. rst-class:: classref-enumeration-constant :ref:`Capabilities` **XR_EXTERNAL** = ``32`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRInterface_TrackingStatus: .. rst-class:: classref-enumeration enum **TrackingStatus**: .. _class_XRInterface_constant_XR_NORMAL_TRACKING: .. rst-class:: classref-enumeration-constant :ref:`TrackingStatus` **XR_NORMAL_TRACKING** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_EXCESSIVE_MOTION: .. rst-class:: classref-enumeration-constant :ref:`TrackingStatus` **XR_EXCESSIVE_MOTION** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_INSUFFICIENT_FEATURES: .. rst-class:: classref-enumeration-constant :ref:`TrackingStatus` **XR_INSUFFICIENT_FEATURES** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_UNKNOWN_TRACKING: .. rst-class:: classref-enumeration-constant :ref:`TrackingStatus` **XR_UNKNOWN_TRACKING** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_NOT_TRACKING: .. rst-class:: classref-enumeration-constant :ref:`TrackingStatus` **XR_NOT_TRACKING** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRInterface_PlayAreaMode: .. rst-class:: classref-enumeration enum **PlayAreaMode**: .. _class_XRInterface_constant_XR_PLAY_AREA_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`PlayAreaMode` **XR_PLAY_AREA_UNKNOWN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_PLAY_AREA_3DOF: .. rst-class:: classref-enumeration-constant :ref:`PlayAreaMode` **XR_PLAY_AREA_3DOF** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_PLAY_AREA_SITTING: .. rst-class:: classref-enumeration-constant :ref:`PlayAreaMode` **XR_PLAY_AREA_SITTING** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_PLAY_AREA_ROOMSCALE: .. rst-class:: classref-enumeration-constant :ref:`PlayAreaMode` **XR_PLAY_AREA_ROOMSCALE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_PLAY_AREA_STAGE: .. rst-class:: classref-enumeration-constant :ref:`PlayAreaMode` **XR_PLAY_AREA_STAGE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_XRInterface_EnvironmentBlendMode: .. rst-class:: classref-enumeration enum **EnvironmentBlendMode**: .. _class_XRInterface_constant_XR_ENV_BLEND_MODE_OPAQUE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBlendMode` **XR_ENV_BLEND_MODE_OPAQUE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_ENV_BLEND_MODE_ADDITIVE: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBlendMode` **XR_ENV_BLEND_MODE_ADDITIVE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_XRInterface_constant_XR_ENV_BLEND_MODE_ALPHA_BLEND: .. rst-class:: classref-enumeration-constant :ref:`EnvironmentBlendMode` **XR_ENV_BLEND_MODE_ALPHA_BLEND** = ``2`` .. 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_XRInterface_property_ar_is_anchor_detection_enabled: .. rst-class:: classref-property :ref:`bool` **ar_is_anchor_detection_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_anchor_detection_is_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **get_anchor_detection_is_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_property_environment_blend_mode: .. rst-class:: classref-property :ref:`EnvironmentBlendMode` **environment_blend_mode** = ``0`` .. rst-class:: classref-property-setget - :ref:`bool` **set_environment_blend_mode** **(** :ref:`EnvironmentBlendMode` mode **)** - :ref:`EnvironmentBlendMode` **get_environment_blend_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_property_interface_is_primary: .. rst-class:: classref-property :ref:`bool` **interface_is_primary** = ``false`` .. rst-class:: classref-property-setget - void **set_primary** **(** :ref:`bool` value **)** - :ref:`bool` **is_primary** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_property_xr_play_area_mode: .. rst-class:: classref-property :ref:`PlayAreaMode` **xr_play_area_mode** = ``0`` .. rst-class:: classref-property-setget - :ref:`bool` **set_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** - :ref:`PlayAreaMode` **get_play_area_mode** **(** **)** .. 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_XRInterface_method_get_camera_feed_id: .. rst-class:: classref-method :ref:`int` **get_camera_feed_id** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_capabilities: .. rst-class:: classref-method :ref:`int` **get_capabilities** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_name: .. rst-class:: classref-method :ref:`StringName` **get_name** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_play_area: .. rst-class:: classref-method :ref:`PackedVector3Array` **get_play_area** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_projection_for_view: .. rst-class:: classref-method :ref:`Projection` **get_projection_for_view** **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` near, :ref:`float` far **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_render_target_size: .. rst-class:: classref-method :ref:`Vector2` **get_render_target_size** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_supported_environment_blend_modes: .. rst-class:: classref-method :ref:`Array` **get_supported_environment_blend_modes** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_system_info: .. rst-class:: classref-method :ref:`Dictionary` **get_system_info** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_tracking_status: .. rst-class:: classref-method :ref:`TrackingStatus` **get_tracking_status** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_transform_for_view: .. rst-class:: classref-method :ref:`Transform3D` **get_transform_for_view** **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_get_view_count: .. rst-class:: classref-method :ref:`int` **get_view_count** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_initialize: .. rst-class:: classref-method :ref:`bool` **initialize** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_is_initialized: .. rst-class:: classref-method :ref:`bool` **is_initialized** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_is_passthrough_enabled: .. rst-class:: classref-method :ref:`bool` **is_passthrough_enabled** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_is_passthrough_supported: .. rst-class:: classref-method :ref:`bool` **is_passthrough_supported** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_set_environment_blend_mode: .. rst-class:: classref-method :ref:`bool` **set_environment_blend_mode** **(** :ref:`EnvironmentBlendMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_set_play_area_mode: .. rst-class:: classref-method :ref:`bool` **set_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_start_passthrough: .. rst-class:: classref-method :ref:`bool` **start_passthrough** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_stop_passthrough: .. rst-class:: classref-method void **stop_passthrough** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_supports_play_area_mode: .. rst-class:: classref-method :ref:`bool` **supports_play_area_mode** **(** :ref:`PlayAreaMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_trigger_haptic_pulse: .. rst-class:: classref-method void **trigger_haptic_pulse** **(** :ref:`String` action_name, :ref:`StringName` tracker_name, :ref:`float` frequency, :ref:`float` amplitude, :ref:`float` duration_sec, :ref:`float` delay_sec **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterface_method_uninitialize: .. rst-class:: classref-method void **uninitialize** **(** **)** .. 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.)`