openxr_api.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. /**************************************************************************/
  2. /* openxr_api.h */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef OPENXR_API_H
  31. #define OPENXR_API_H
  32. #include "action_map/openxr_action.h"
  33. #include "extensions/openxr_composition_layer_provider.h"
  34. #include "extensions/openxr_extension_wrapper.h"
  35. #include "util.h"
  36. #include "core/error/error_macros.h"
  37. #include "core/math/projection.h"
  38. #include "core/math/transform_3d.h"
  39. #include "core/math/vector2.h"
  40. #include "core/os/memory.h"
  41. #include "core/string/print_string.h"
  42. #include "core/string/ustring.h"
  43. #include "core/templates/rb_map.h"
  44. #include "core/templates/rid_owner.h"
  45. #include "core/templates/vector.h"
  46. #include "servers/xr/xr_pose.h"
  47. #include <openxr/openxr.h>
  48. // Note, OpenXR code that we wrote for our plugin makes use of C++20 notation for initializing structs which ensures zeroing out unspecified members.
  49. // Godot is currently restricted to C++17 which doesn't allow this notation. Make sure critical fields are set.
  50. // forward declarations, we don't want to include these fully
  51. class OpenXRInterface;
  52. class OpenXRAPI {
  53. private:
  54. // our singleton
  55. static OpenXRAPI *singleton;
  56. // Registered extension wrappers
  57. static Vector<OpenXRExtensionWrapper *> registered_extension_wrappers;
  58. // linked XR interface
  59. OpenXRInterface *xr_interface = nullptr;
  60. // layers
  61. uint32_t num_layer_properties = 0;
  62. XrApiLayerProperties *layer_properties = nullptr;
  63. // extensions
  64. uint32_t num_supported_extensions = 0;
  65. XrExtensionProperties *supported_extensions = nullptr;
  66. Vector<CharString> enabled_extensions;
  67. // composition layer providers
  68. Vector<OpenXRCompositionLayerProvider *> composition_layer_providers;
  69. // view configuration
  70. uint32_t num_view_configuration_types = 0;
  71. XrViewConfigurationType *supported_view_configuration_types = nullptr;
  72. // reference spaces
  73. uint32_t num_reference_spaces = 0;
  74. XrReferenceSpaceType *supported_reference_spaces = nullptr;
  75. // swapchains (note these are platform dependent)
  76. uint32_t num_swapchain_formats = 0;
  77. int64_t *supported_swapchain_formats = nullptr;
  78. // system info
  79. String runtime_name;
  80. String runtime_version;
  81. // configuration
  82. XrFormFactor form_factor = XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY;
  83. XrViewConfigurationType view_configuration = XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO;
  84. XrReferenceSpaceType reference_space = XR_REFERENCE_SPACE_TYPE_STAGE;
  85. bool submit_depth_buffer = false; // if set to true we submit depth buffers to OpenXR if a suitable extension is enabled.
  86. // blend mode
  87. XrEnvironmentBlendMode environment_blend_mode = XR_ENVIRONMENT_BLEND_MODE_OPAQUE;
  88. uint32_t num_supported_environment_blend_modes = 0;
  89. XrEnvironmentBlendMode *supported_environment_blend_modes = nullptr;
  90. // state
  91. XrInstance instance = XR_NULL_HANDLE;
  92. XrSystemId system_id = 0;
  93. String system_name;
  94. uint32_t vendor_id = 0;
  95. XrSystemTrackingProperties tracking_properties;
  96. XrSession session = XR_NULL_HANDLE;
  97. XrSessionState session_state = XR_SESSION_STATE_UNKNOWN;
  98. bool running = false;
  99. XrFrameState frame_state = { XR_TYPE_FRAME_STATE, NULL, 0, 0, false };
  100. double render_target_size_multiplier = 1.0;
  101. OpenXRGraphicsExtensionWrapper *graphics_extension = nullptr;
  102. XrSystemGraphicsProperties graphics_properties;
  103. uint32_t view_count = 0;
  104. XrViewConfigurationView *view_configuration_views = nullptr;
  105. XrView *views = nullptr;
  106. XrCompositionLayerProjectionView *projection_views = nullptr;
  107. XrCompositionLayerDepthInfoKHR *depth_views = nullptr; // Only used by Composition Layer Depth Extension if available
  108. enum OpenXRSwapChainTypes {
  109. OPENXR_SWAPCHAIN_COLOR,
  110. OPENXR_SWAPCHAIN_DEPTH,
  111. // OPENXR_SWAPCHAIN_VELOCITY,
  112. OPENXR_SWAPCHAIN_MAX
  113. };
  114. struct OpenXRSwapChainInfo {
  115. XrSwapchain swapchain = XR_NULL_HANDLE;
  116. void *swapchain_graphics_data = nullptr;
  117. uint32_t image_index = 0;
  118. bool image_acquired = false;
  119. bool skip_acquire_swapchain = false;
  120. };
  121. OpenXRSwapChainInfo swapchains[OPENXR_SWAPCHAIN_MAX];
  122. XrSpace play_space = XR_NULL_HANDLE;
  123. XrSpace view_space = XR_NULL_HANDLE;
  124. bool view_pose_valid = false;
  125. XRPose::TrackingConfidence head_pose_confidence = XRPose::XR_TRACKING_CONFIDENCE_NONE;
  126. bool load_layer_properties();
  127. bool load_supported_extensions();
  128. bool is_extension_supported(const String &p_extension) const;
  129. bool is_extension_enabled(const String &p_extension) const;
  130. bool openxr_loader_init();
  131. bool resolve_instance_openxr_symbols();
  132. #ifdef ANDROID_ENABLED
  133. // On Android we keep tracker of our external OpenXR loader
  134. void *openxr_loader_library_handle = nullptr;
  135. #endif
  136. // function pointers
  137. #ifdef ANDROID_ENABLED
  138. // On non-Android platforms we use the OpenXR symbol linked into the engine binary.
  139. PFN_xrGetInstanceProcAddr xrGetInstanceProcAddr = nullptr;
  140. #endif
  141. EXT_PROTO_XRRESULT_FUNC3(xrAcquireSwapchainImage, (XrSwapchain), swapchain, (const XrSwapchainImageAcquireInfo *), acquireInfo, (uint32_t *), index)
  142. EXT_PROTO_XRRESULT_FUNC3(xrApplyHapticFeedback, (XrSession), session, (const XrHapticActionInfo *), hapticActionInfo, (const XrHapticBaseHeader *), hapticFeedback)
  143. EXT_PROTO_XRRESULT_FUNC2(xrAttachSessionActionSets, (XrSession), session, (const XrSessionActionSetsAttachInfo *), attachInfo)
  144. EXT_PROTO_XRRESULT_FUNC2(xrBeginFrame, (XrSession), session, (const XrFrameBeginInfo *), frameBeginInfo)
  145. EXT_PROTO_XRRESULT_FUNC2(xrBeginSession, (XrSession), session, (const XrSessionBeginInfo *), beginInfo)
  146. EXT_PROTO_XRRESULT_FUNC3(xrCreateAction, (XrActionSet), actionSet, (const XrActionCreateInfo *), createInfo, (XrAction *), action)
  147. EXT_PROTO_XRRESULT_FUNC3(xrCreateActionSet, (XrInstance), instance, (const XrActionSetCreateInfo *), createInfo, (XrActionSet *), actionSet)
  148. EXT_PROTO_XRRESULT_FUNC3(xrCreateActionSpace, (XrSession), session, (const XrActionSpaceCreateInfo *), createInfo, (XrSpace *), space)
  149. EXT_PROTO_XRRESULT_FUNC2(xrCreateInstance, (const XrInstanceCreateInfo *), createInfo, (XrInstance *), instance)
  150. EXT_PROTO_XRRESULT_FUNC3(xrCreateReferenceSpace, (XrSession), session, (const XrReferenceSpaceCreateInfo *), createInfo, (XrSpace *), space)
  151. EXT_PROTO_XRRESULT_FUNC3(xrCreateSession, (XrInstance), instance, (const XrSessionCreateInfo *), createInfo, (XrSession *), session)
  152. EXT_PROTO_XRRESULT_FUNC3(xrCreateSwapchain, (XrSession), session, (const XrSwapchainCreateInfo *), createInfo, (XrSwapchain *), swapchain)
  153. EXT_PROTO_XRRESULT_FUNC1(xrDestroyAction, (XrAction), action)
  154. EXT_PROTO_XRRESULT_FUNC1(xrDestroyActionSet, (XrActionSet), actionSet)
  155. EXT_PROTO_XRRESULT_FUNC1(xrDestroyInstance, (XrInstance), instance)
  156. EXT_PROTO_XRRESULT_FUNC1(xrDestroySession, (XrSession), session)
  157. EXT_PROTO_XRRESULT_FUNC1(xrDestroySpace, (XrSpace), space)
  158. EXT_PROTO_XRRESULT_FUNC1(xrDestroySwapchain, (XrSwapchain), swapchain)
  159. EXT_PROTO_XRRESULT_FUNC2(xrEndFrame, (XrSession), session, (const XrFrameEndInfo *), frameEndInfo)
  160. EXT_PROTO_XRRESULT_FUNC1(xrEndSession, (XrSession), session)
  161. EXT_PROTO_XRRESULT_FUNC3(xrEnumerateApiLayerProperties, (uint32_t), propertyCapacityInput, (uint32_t *), propertyCountOutput, (XrApiLayerProperties *), properties)
  162. EXT_PROTO_XRRESULT_FUNC6(xrEnumerateEnvironmentBlendModes, (XrInstance), instance, (XrSystemId), systemId, (XrViewConfigurationType), viewConfigurationType, (uint32_t), environmentBlendModeCapacityInput, (uint32_t *), environmentBlendModeCountOutput, (XrEnvironmentBlendMode *), environmentBlendModes)
  163. EXT_PROTO_XRRESULT_FUNC4(xrEnumerateInstanceExtensionProperties, (const char *), layerName, (uint32_t), propertyCapacityInput, (uint32_t *), propertyCountOutput, (XrExtensionProperties *), properties)
  164. EXT_PROTO_XRRESULT_FUNC4(xrEnumerateReferenceSpaces, (XrSession), session, (uint32_t), spaceCapacityInput, (uint32_t *), spaceCountOutput, (XrReferenceSpaceType *), spaces)
  165. EXT_PROTO_XRRESULT_FUNC4(xrEnumerateSwapchainFormats, (XrSession), session, (uint32_t), formatCapacityInput, (uint32_t *), formatCountOutput, (int64_t *), formats)
  166. EXT_PROTO_XRRESULT_FUNC5(xrEnumerateViewConfigurations, (XrInstance), instance, (XrSystemId), systemId, (uint32_t), viewConfigurationTypeCapacityInput, (uint32_t *), viewConfigurationTypeCountOutput, (XrViewConfigurationType *), viewConfigurationTypes)
  167. EXT_PROTO_XRRESULT_FUNC6(xrEnumerateViewConfigurationViews, (XrInstance), instance, (XrSystemId), systemId, (XrViewConfigurationType), viewConfigurationType, (uint32_t), viewCapacityInput, (uint32_t *), viewCountOutput, (XrViewConfigurationView *), views)
  168. EXT_PROTO_XRRESULT_FUNC3(xrGetActionStateBoolean, (XrSession), session, (const XrActionStateGetInfo *), getInfo, (XrActionStateBoolean *), state)
  169. EXT_PROTO_XRRESULT_FUNC3(xrGetActionStateFloat, (XrSession), session, (const XrActionStateGetInfo *), getInfo, (XrActionStateFloat *), state)
  170. EXT_PROTO_XRRESULT_FUNC3(xrGetActionStateVector2f, (XrSession), session, (const XrActionStateGetInfo *), getInfo, (XrActionStateVector2f *), state)
  171. EXT_PROTO_XRRESULT_FUNC3(xrGetCurrentInteractionProfile, (XrSession), session, (XrPath), topLevelUserPath, (XrInteractionProfileState *), interactionProfile)
  172. EXT_PROTO_XRRESULT_FUNC2(xrGetInstanceProperties, (XrInstance), instance, (XrInstanceProperties *), instanceProperties)
  173. EXT_PROTO_XRRESULT_FUNC3(xrGetSystem, (XrInstance), instance, (const XrSystemGetInfo *), getInfo, (XrSystemId *), systemId)
  174. EXT_PROTO_XRRESULT_FUNC3(xrGetSystemProperties, (XrInstance), instance, (XrSystemId), systemId, (XrSystemProperties *), properties)
  175. EXT_PROTO_XRRESULT_FUNC4(xrLocateSpace, (XrSpace), space, (XrSpace), baseSpace, (XrTime), time, (XrSpaceLocation *), location)
  176. EXT_PROTO_XRRESULT_FUNC6(xrLocateViews, (XrSession), session, (const XrViewLocateInfo *), viewLocateInfo, (XrViewState *), viewState, (uint32_t), viewCapacityInput, (uint32_t *), viewCountOutput, (XrView *), views)
  177. EXT_PROTO_XRRESULT_FUNC5(xrPathToString, (XrInstance), instance, (XrPath), path, (uint32_t), bufferCapacityInput, (uint32_t *), bufferCountOutput, (char *), buffer)
  178. EXT_PROTO_XRRESULT_FUNC2(xrPollEvent, (XrInstance), instance, (XrEventDataBuffer *), eventData)
  179. EXT_PROTO_XRRESULT_FUNC2(xrReleaseSwapchainImage, (XrSwapchain), swapchain, (const XrSwapchainImageReleaseInfo *), releaseInfo)
  180. EXT_PROTO_XRRESULT_FUNC3(xrResultToString, (XrInstance), instance, (XrResult), value, (char *), buffer)
  181. EXT_PROTO_XRRESULT_FUNC3(xrStringToPath, (XrInstance), instance, (const char *), pathString, (XrPath *), path)
  182. EXT_PROTO_XRRESULT_FUNC2(xrSuggestInteractionProfileBindings, (XrInstance), instance, (const XrInteractionProfileSuggestedBinding *), suggestedBindings)
  183. EXT_PROTO_XRRESULT_FUNC2(xrSyncActions, (XrSession), session, (const XrActionsSyncInfo *), syncInfo)
  184. EXT_PROTO_XRRESULT_FUNC3(xrWaitFrame, (XrSession), session, (const XrFrameWaitInfo *), frameWaitInfo, (XrFrameState *), frameState)
  185. EXT_PROTO_XRRESULT_FUNC2(xrWaitSwapchainImage, (XrSwapchain), swapchain, (const XrSwapchainImageWaitInfo *), waitInfo)
  186. // instance
  187. bool create_instance();
  188. bool get_system_info();
  189. bool load_supported_view_configuration_types();
  190. bool load_supported_environmental_blend_modes();
  191. bool is_view_configuration_supported(XrViewConfigurationType p_configuration_type) const;
  192. bool load_supported_view_configuration_views(XrViewConfigurationType p_configuration_type);
  193. void destroy_instance();
  194. // session
  195. bool create_session();
  196. bool load_supported_reference_spaces();
  197. bool is_reference_space_supported(XrReferenceSpaceType p_reference_space);
  198. bool setup_spaces();
  199. bool load_supported_swapchain_formats();
  200. bool is_swapchain_format_supported(int64_t p_swapchain_format);
  201. bool create_swapchains();
  202. void destroy_session();
  203. // swapchains
  204. bool create_swapchain(XrSwapchainUsageFlags p_usage_flags, int64_t p_swapchain_format, uint32_t p_width, uint32_t p_height, uint32_t p_sample_count, uint32_t p_array_size, XrSwapchain &r_swapchain, void **r_swapchain_graphics_data);
  205. bool acquire_image(OpenXRSwapChainInfo &p_swapchain);
  206. bool release_image(OpenXRSwapChainInfo &p_swapchain);
  207. // action map
  208. struct Tracker { // Trackers represent tracked physical objects such as controllers, pucks, etc.
  209. String name; // Name for this tracker (i.e. "/user/hand/left")
  210. XrPath toplevel_path; // OpenXR XrPath for this tracker
  211. RID active_profile_rid; // RID of the active profile for this tracker
  212. };
  213. RID_Owner<Tracker, true> tracker_owner;
  214. RID get_tracker_rid(XrPath p_path);
  215. struct ActionSet { // Action sets define a set of actions that can be enabled together
  216. String name; // Name for this action set (i.e. "godot_action_set")
  217. bool is_attached; // If true our action set has been attached to the session and can no longer be modified
  218. XrActionSet handle; // OpenXR handle for this action set
  219. };
  220. RID_Owner<ActionSet, true> action_set_owner;
  221. struct ActionTracker { // Links and action to a tracker
  222. RID tracker_rid; // RID of the tracker
  223. XrSpace space; // Optional space for pose actions
  224. bool was_location_valid; // If true the last position we obtained was valid
  225. };
  226. struct Action { // Actions define the inputs and outputs in OpenXR
  227. RID action_set_rid; // RID of the action set this action belongs to
  228. String name; // Name for this action (i.e. "aim_pose")
  229. XrActionType action_type; // Type of action (bool, float, etc.)
  230. Vector<ActionTracker> trackers; // The trackers this action can be used with
  231. XrAction handle; // OpenXR handle for this action
  232. };
  233. RID_Owner<Action, true> action_owner;
  234. RID get_action_rid(XrAction p_action);
  235. struct InteractionProfile { // Interaction profiles define suggested bindings between the physical inputs on controller types and our actions
  236. String name; // Name of the interaction profile (i.e. "/interaction_profiles/valve/index_controller")
  237. XrPath path; // OpenXR path for this profile
  238. Vector<XrActionSuggestedBinding> bindings; // OpenXR action bindings
  239. };
  240. RID_Owner<InteractionProfile, true> interaction_profile_owner;
  241. RID get_interaction_profile_rid(XrPath p_path);
  242. XrPath get_interaction_profile_path(RID p_interaction_profile);
  243. // state changes
  244. bool poll_events();
  245. bool on_state_idle();
  246. bool on_state_ready();
  247. bool on_state_synchronized();
  248. bool on_state_visible();
  249. bool on_state_focused();
  250. bool on_state_stopping();
  251. bool on_state_loss_pending();
  252. bool on_state_exiting();
  253. // convenience
  254. void copy_string_to_char_buffer(const String p_string, char *p_buffer, int p_buffer_len);
  255. public:
  256. XrInstance get_instance() const { return instance; };
  257. XrSystemId get_system_id() const { return system_id; };
  258. XrSession get_session() const { return session; };
  259. String get_runtime_name() const { return runtime_name; };
  260. String get_runtime_version() const { return runtime_version; };
  261. // helper method to convert an XrPosef to a Transform3D
  262. Transform3D transform_from_pose(const XrPosef &p_pose);
  263. // helper method to get a valid Transform3D from an openxr space location
  264. XRPose::TrackingConfidence transform_from_location(const XrSpaceLocation &p_location, Transform3D &r_transform);
  265. XRPose::TrackingConfidence transform_from_location(const XrHandJointLocationEXT &p_location, Transform3D &r_transform);
  266. void parse_velocities(const XrSpaceVelocity &p_velocity, Vector3 &r_linear_velocity, Vector3 &r_angular_velocity);
  267. bool xr_result(XrResult result, const char *format, Array args = Array()) const;
  268. bool is_top_level_path_supported(const String &p_toplevel_path);
  269. bool is_interaction_profile_supported(const String &p_ip_path);
  270. bool interaction_profile_supports_io_path(const String &p_ip_path, const String &p_io_path);
  271. static bool openxr_is_enabled(bool p_check_run_in_editor = true);
  272. _FORCE_INLINE_ static OpenXRAPI *get_singleton() { return singleton; }
  273. XrResult try_get_instance_proc_addr(const char *p_name, PFN_xrVoidFunction *p_addr);
  274. XrResult get_instance_proc_addr(const char *p_name, PFN_xrVoidFunction *p_addr);
  275. String get_error_string(XrResult result);
  276. String get_swapchain_format_name(int64_t p_swapchain_format) const;
  277. void set_xr_interface(OpenXRInterface *p_xr_interface);
  278. static void register_extension_wrapper(OpenXRExtensionWrapper *p_extension_wrapper);
  279. static void unregister_extension_wrapper(OpenXRExtensionWrapper *p_extension_wrapper);
  280. static void register_extension_metadata();
  281. static void cleanup_extension_wrappers();
  282. void set_form_factor(XrFormFactor p_form_factor);
  283. XrFormFactor get_form_factor() const { return form_factor; }
  284. void set_view_configuration(XrViewConfigurationType p_view_configuration);
  285. XrViewConfigurationType get_view_configuration() const { return view_configuration; }
  286. void set_reference_space(XrReferenceSpaceType p_reference_space);
  287. XrReferenceSpaceType get_reference_space() const { return reference_space; }
  288. void set_submit_depth_buffer(bool p_submit_depth_buffer);
  289. bool get_submit_depth_buffer() const { return submit_depth_buffer; }
  290. bool is_initialized();
  291. bool is_running();
  292. bool initialize(const String &p_rendering_driver);
  293. bool initialize_session();
  294. void finish();
  295. XrSpace get_play_space() const { return play_space; }
  296. XrTime get_next_frame_time() { return frame_state.predictedDisplayTime + frame_state.predictedDisplayPeriod; }
  297. bool can_render() { return instance != XR_NULL_HANDLE && session != XR_NULL_HANDLE && running && view_pose_valid && frame_state.shouldRender; }
  298. Size2 get_recommended_target_size();
  299. XRPose::TrackingConfidence get_head_center(Transform3D &r_transform, Vector3 &r_linear_velocity, Vector3 &r_angular_velocity);
  300. bool get_view_transform(uint32_t p_view, Transform3D &r_transform);
  301. bool get_view_projection(uint32_t p_view, double p_z_near, double p_z_far, Projection &p_camera_matrix);
  302. bool process();
  303. void pre_render();
  304. bool pre_draw_viewport(RID p_render_target);
  305. XrSwapchain get_color_swapchain();
  306. RID get_color_texture();
  307. RID get_depth_texture();
  308. void post_draw_viewport(RID p_render_target);
  309. void end_frame();
  310. // Display refresh rate
  311. float get_display_refresh_rate() const;
  312. void set_display_refresh_rate(float p_refresh_rate);
  313. Array get_available_display_refresh_rates() const;
  314. // Render Target size multiplier
  315. double get_render_target_size_multiplier() const;
  316. void set_render_target_size_multiplier(double multiplier);
  317. // Foveation settings
  318. bool is_foveation_supported() const;
  319. int get_foveation_level() const;
  320. void set_foveation_level(int p_foveation_level);
  321. bool get_foveation_dynamic() const;
  322. void set_foveation_dynamic(bool p_foveation_dynamic);
  323. // action map
  324. String get_default_action_map_resource_name();
  325. RID tracker_create(const String p_name);
  326. String tracker_get_name(RID p_tracker);
  327. void tracker_check_profile(RID p_tracker, XrSession p_session = XR_NULL_HANDLE);
  328. void tracker_free(RID p_tracker);
  329. RID action_set_create(const String p_name, const String p_localized_name, const int p_priority);
  330. String action_set_get_name(RID p_action_set);
  331. bool attach_action_sets(const Vector<RID> &p_action_sets);
  332. void action_set_free(RID p_action_set);
  333. RID action_create(RID p_action_set, const String p_name, const String p_localized_name, OpenXRAction::ActionType p_action_type, const Vector<RID> &p_trackers);
  334. String action_get_name(RID p_action);
  335. void action_free(RID p_action);
  336. RID interaction_profile_create(const String p_name);
  337. String interaction_profile_get_name(RID p_interaction_profile);
  338. void interaction_profile_clear_bindings(RID p_interaction_profile);
  339. bool interaction_profile_add_binding(RID p_interaction_profile, RID p_action, const String p_path);
  340. bool interaction_profile_suggest_bindings(RID p_interaction_profile);
  341. void interaction_profile_free(RID p_interaction_profile);
  342. bool sync_action_sets(const Vector<RID> p_active_sets);
  343. bool get_action_bool(RID p_action, RID p_tracker);
  344. float get_action_float(RID p_action, RID p_tracker);
  345. Vector2 get_action_vector2(RID p_action, RID p_tracker);
  346. XRPose::TrackingConfidence get_action_pose(RID p_action, RID p_tracker, Transform3D &r_transform, Vector3 &r_linear_velocity, Vector3 &r_angular_velocity);
  347. bool trigger_haptic_pulse(RID p_action, RID p_tracker, float p_frequency, float p_amplitude, XrDuration p_duration_ns);
  348. void register_composition_layer_provider(OpenXRCompositionLayerProvider *provider);
  349. void unregister_composition_layer_provider(OpenXRCompositionLayerProvider *provider);
  350. const XrEnvironmentBlendMode *get_supported_environment_blend_modes(uint32_t &count);
  351. bool is_environment_blend_mode_supported(XrEnvironmentBlendMode p_blend_mode) const;
  352. bool set_environment_blend_mode(XrEnvironmentBlendMode p_blend_mode);
  353. XrEnvironmentBlendMode get_environment_blend_mode() const { return environment_blend_mode; }
  354. OpenXRAPI();
  355. ~OpenXRAPI();
  356. };
  357. #endif // OPENXR_API_H