:github_url: hide .. 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/modules/openxr/doc_classes/OpenXRAPIExtension.xml. .. _class_OpenXRAPIExtension: OpenXRAPIExtension ================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Makes the OpenXR API available for GDExtension. .. rst-class:: classref-introduction-group Description ----------- **OpenXRAPIExtension** makes OpenXR available for GDExtension. It provides the OpenXR API to GDExtension through the :ref:`get_instance_proc_addr` method, and the OpenXR instance through :ref:`get_instance`. It also provides methods for querying the status of OpenXR initialization, and helper methods for ease of use of the API with GDExtension. .. rst-class:: classref-introduction-group Tutorials --------- - `XrResult documentation `__ - `XrInstance documentation `__ - `XrSpace documentation `__ - `XrSession documentation `__ - `XrSystemId documentation `__ - `xrBeginSession documentation `__ - `XrPosef documentation `__ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`begin_debug_label_region`\ (\ label_name\: :ref:`String`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`can_render`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`end_debug_label_region`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_error_string`\ (\ result\: :ref:`int`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_hand_tracker`\ (\ hand_index\: :ref:`int`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_instance`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_instance_proc_addr`\ (\ name\: :ref:`String`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_next_frame_time`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_play_space`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_predicted_display_time`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_session`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_swapchain_format_name`\ (\ swapchain_format\: :ref:`int`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_system_id`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`insert_debug_label`\ (\ label_name\: :ref:`String`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OpenXRAlphaBlendModeSupport` | :ref:`is_environment_blend_mode_alpha_supported`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_initialized`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_running`\ (\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`openxr_is_enabled`\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`register_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_emulate_environment_blend_mode_alpha_blend`\ (\ enabled\: :ref:`bool`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_object_name`\ (\ object_type\: :ref:`int`, object_handle\: :ref:`int`, object_name\: :ref:`String`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`transform_from_pose`\ (\ pose\: ``const void*``\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unregister_composition_layer_provider`\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`xr_result`\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) | +-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_OpenXRAPIExtension_OpenXRAlphaBlendModeSupport: .. rst-class:: classref-enumeration enum **OpenXRAlphaBlendModeSupport**: :ref:`🔗` .. _class_OpenXRAPIExtension_constant_OPENXR_ALPHA_BLEND_MODE_SUPPORT_NONE: .. rst-class:: classref-enumeration-constant :ref:`OpenXRAlphaBlendModeSupport` **OPENXR_ALPHA_BLEND_MODE_SUPPORT_NONE** = ``0`` Means that :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` isn't supported at all. .. _class_OpenXRAPIExtension_constant_OPENXR_ALPHA_BLEND_MODE_SUPPORT_REAL: .. rst-class:: classref-enumeration-constant :ref:`OpenXRAlphaBlendModeSupport` **OPENXR_ALPHA_BLEND_MODE_SUPPORT_REAL** = ``1`` Means that :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` is really supported. .. _class_OpenXRAPIExtension_constant_OPENXR_ALPHA_BLEND_MODE_SUPPORT_EMULATING: .. rst-class:: classref-enumeration-constant :ref:`OpenXRAlphaBlendModeSupport` **OPENXR_ALPHA_BLEND_MODE_SUPPORT_EMULATING** = ``2`` Means that :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` is emulated. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_OpenXRAPIExtension_method_begin_debug_label_region: .. rst-class:: classref-method |void| **begin_debug_label_region**\ (\ label_name\: :ref:`String`\ ) :ref:`🔗` Begins a new debug label region, this label will be reported in debug messages for any calls following this until :ref:`end_debug_label_region` is called. Debug labels can be stacked. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_can_render: .. rst-class:: classref-method :ref:`bool` **can_render**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is initialized for rendering with an XR viewport. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_end_debug_label_region: .. rst-class:: classref-method |void| **end_debug_label_region**\ (\ ) :ref:`🔗` Marks the end of a debug label region. Removes the latest debug label region added by calling :ref:`begin_debug_label_region`. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_error_string: .. rst-class:: classref-method :ref:`String` **get_error_string**\ (\ result\: :ref:`int`\ ) :ref:`🔗` Returns an error string for the given `XrResult `__. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_hand_tracker: .. rst-class:: classref-method :ref:`int` **get_hand_tracker**\ (\ hand_index\: :ref:`int`\ ) :ref:`🔗` Returns the corresponding ``XRHandTrackerEXT`` handle for the given hand index value. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_instance: .. rst-class:: classref-method :ref:`int` **get_instance**\ (\ ) :ref:`🔗` Returns the `XrInstance `__ created during the initialization of the OpenXR API. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_instance_proc_addr: .. rst-class:: classref-method :ref:`int` **get_instance_proc_addr**\ (\ name\: :ref:`String`\ ) :ref:`🔗` Returns the function pointer of the OpenXR function with the specified name, cast to an integer. If the function with the given name does not exist, the method returns ``0``. \ **Note:** ``openxr/util.h`` contains utility macros for acquiring OpenXR functions, e.g. ``GDEXTENSION_INIT_XR_FUNC_V(xrCreateAction)``. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_next_frame_time: .. rst-class:: classref-method :ref:`int` **get_next_frame_time**\ (\ ) :ref:`🔗` Returns the predicted display timing for the next frame. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_play_space: .. rst-class:: classref-method :ref:`int` **get_play_space**\ (\ ) :ref:`🔗` Returns the play space, which is an `XrSpace `__ cast to an integer. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_predicted_display_time: .. rst-class:: classref-method :ref:`int` **get_predicted_display_time**\ (\ ) :ref:`🔗` Returns the predicted display timing for the current frame. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_session: .. rst-class:: classref-method :ref:`int` **get_session**\ (\ ) :ref:`🔗` Returns the OpenXR session, which is an `XrSession `__ cast to an integer. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_swapchain_format_name: .. rst-class:: classref-method :ref:`String` **get_swapchain_format_name**\ (\ swapchain_format\: :ref:`int`\ ) :ref:`🔗` Returns the name of the specified swapchain format. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_get_system_id: .. rst-class:: classref-method :ref:`int` **get_system_id**\ (\ ) :ref:`🔗` Returns the id of the system, which is a `XrSystemId `__ cast to an integer. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_insert_debug_label: .. rst-class:: classref-method |void| **insert_debug_label**\ (\ label_name\: :ref:`String`\ ) :ref:`🔗` Inserts a debug label, this label is reported in any debug message resulting from the OpenXR calls that follows, until any of :ref:`begin_debug_label_region`, :ref:`end_debug_label_region`, or :ref:`insert_debug_label` is called. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_is_environment_blend_mode_alpha_supported: .. rst-class:: classref-method :ref:`OpenXRAlphaBlendModeSupport` **is_environment_blend_mode_alpha_supported**\ (\ ) :ref:`🔗` Returns :ref:`OpenXRAlphaBlendModeSupport` denoting if :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` is really supported, emulated or not supported at all. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_is_initialized: .. rst-class:: classref-method :ref:`bool` **is_initialized**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is initialized. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_is_running: .. rst-class:: classref-method :ref:`bool` **is_running**\ (\ ) :ref:`🔗` Returns ``true`` if OpenXR is running (`xrBeginSession `__ was successfully called and the swapchains were created). .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_openxr_is_enabled: .. rst-class:: classref-method :ref:`bool` **openxr_is_enabled**\ (\ check_run_in_editor\: :ref:`bool`\ ) |static| :ref:`🔗` Returns ``true`` if OpenXR is enabled. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_register_composition_layer_provider: .. rst-class:: classref-method |void| **register_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` Registers the given extension as a composition layer provider. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_set_emulate_environment_blend_mode_alpha_blend: .. rst-class:: classref-method |void| **set_emulate_environment_blend_mode_alpha_blend**\ (\ enabled\: :ref:`bool`\ ) :ref:`🔗` If set to ``true``, an OpenXR extension is loaded which is capable of emulating the :ref:`XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND` blend mode. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_set_object_name: .. rst-class:: classref-method |void| **set_object_name**\ (\ object_type\: :ref:`int`, object_handle\: :ref:`int`, object_name\: :ref:`String`\ ) :ref:`🔗` Set the object name of an OpenXR object, used for debug output. ``object_type`` must be a valid OpenXR ``XrObjectType`` enum and ``object_handle`` must be a valid OpenXR object handle. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_transform_from_pose: .. rst-class:: classref-method :ref:`Transform3D` **transform_from_pose**\ (\ pose\: ``const void*``\ ) :ref:`🔗` Creates a :ref:`Transform3D` from an `XrPosef `__. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_unregister_composition_layer_provider: .. rst-class:: classref-method |void| **unregister_composition_layer_provider**\ (\ extension\: :ref:`OpenXRExtensionWrapperExtension`\ ) :ref:`🔗` Unregisters the given extension as a composition layer provider. .. rst-class:: classref-item-separator ---- .. _class_OpenXRAPIExtension_method_xr_result: .. rst-class:: classref-method :ref:`bool` **xr_result**\ (\ result\: :ref:`int`, format\: :ref:`String`, args\: :ref:`Array`\ ) :ref:`🔗` Returns ``true`` if the provided `XrResult `__ (cast to an integer) is successful. Otherwise returns ``false`` and prints the `XrResult `__ converted to a string, with the specified additional information. .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`