Monado OpenXR Runtime
oxr_objects.h
Go to the documentation of this file.
1// Copyright 2018-2024, Collabora, Ltd.
2// Copyright 2023, NVIDIA CORPORATION.
3// SPDX-License-Identifier: BSL-1.0
4/*!
5 * @file
6 * @brief The objects representing OpenXR handles, and prototypes for internal functions used in the state tracker.
7 * @author Jakob Bornecrantz <jakob@collabora.com>
8 * @author Korcan Hussein <korcan.hussein@collabora.com>
9 * @ingroup oxr_main
10 */
11
12#pragma once
13
14#include "xrt/xrt_space.h"
15#include "xrt/xrt_limits.h"
16#include "xrt/xrt_system.h"
17#include "xrt/xrt_device.h"
18#include "xrt/xrt_tracking.h"
19#include "xrt/xrt_compositor.h"
22#include "xrt/xrt_config_os.h"
23#include "xrt/xrt_config_have.h"
24
25#include "os/os_threading.h"
26
27#include "util/u_index_fifo.h"
28#include "util/u_hashset.h"
29#include "util/u_hashmap.h"
30#include "util/u_device.h"
31
33#include "oxr_subaction.h"
34#include "oxr_defines.h"
35#include "oxr_frame_sync.h"
36
37#if defined(XRT_HAVE_D3D11) || defined(XRT_HAVE_D3D12)
38#include <dxgi.h>
39#include <d3dcommon.h>
40#endif
41
42#ifdef XRT_FEATURE_RENDERDOC
43#include "renderdoc_app.h"
44#ifndef XRT_OS_WINDOWS
45#include <dlfcn.h>
46#endif // !XRT_OS_WINDOWS
47#endif // XRT_FEATURE_RENDERDOC
48
49#ifdef XRT_OS_ANDROID
50#include "xrt/xrt_android.h"
51#endif // #ifdef XRT_OS_ANDROID
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57
58/*!
59 * @defgroup oxr OpenXR state tracker
60 *
61 * Client application facing code.
62 *
63 * @ingroup xrt
64 */
65
66/*!
67 * @brief Cast a pointer to an OpenXR handle in such a way as to avoid warnings.
68 *
69 * Avoids -Wpointer-to-int-cast by first casting to the same size int, then
70 * promoting to the 64-bit int, then casting to the handle type. That's a lot of
71 * no-ops on 64-bit, but a widening conversion on 32-bit.
72 *
73 * @ingroup oxr
74 */
75#define XRT_CAST_PTR_TO_OXR_HANDLE(HANDLE_TYPE, PTR) ((HANDLE_TYPE)(uint64_t)(uintptr_t)(PTR))
76
77/*!
78 * @brief Cast an OpenXR handle to a pointer in such a way as to avoid warnings.
79 *
80 * Avoids -Wint-to-pointer-cast by first casting to a 64-bit int, then to a
81 * pointer-sized int, then to the desired pointer type. That's a lot of no-ops
82 * on 64-bit, but a narrowing (!) conversion on 32-bit.
83 *
84 * @ingroup oxr
85 */
86#define XRT_CAST_OXR_HANDLE_TO_PTR(PTR_TYPE, HANDLE) ((PTR_TYPE)(uintptr_t)(uint64_t)(HANDLE))
87
88/*!
89 * @defgroup oxr_main OpenXR main code
90 *
91 * Gets called from @ref oxr_api functions and talks to devices and
92 * @ref comp using @ref xrt_iface.
93 *
94 * @ingroup oxr
95 * @{
96 */
97
98
99/*
100 *
101 * Forward declare structs.
102 *
103 */
104
105struct xrt_instance;
106struct oxr_logger;
108struct oxr_instance;
109struct oxr_system;
110struct oxr_session;
111struct oxr_event;
112struct oxr_swapchain;
113struct oxr_space;
114struct oxr_action_set;
115struct oxr_action;
117struct oxr_handle_base;
121struct oxr_action_input;
122struct oxr_action_output;
123struct oxr_dpad_state;
124struct oxr_binding;
126struct oxr_action_set_ref;
127struct oxr_action_ref;
128struct oxr_hand_tracker;
129struct oxr_facial_tracker_htc;
130struct oxr_face_tracker2_fb;
131struct oxr_body_tracker_fb;
132struct oxr_xdev_list;
133struct oxr_plane_detector_ext;
134
135#define XRT_MAX_HANDLE_CHILDREN 256
136#define OXR_MAX_BINDINGS_PER_ACTION 32
137
138struct time_state;
139
140/*!
141 * Function pointer type for a handle destruction function.
142 *
143 * @relates oxr_handle_base
144 */
145typedef XrResult (*oxr_handle_destroyer)(struct oxr_logger *log, struct oxr_handle_base *hb);
146
147
148
149/*
150 *
151 * Helpers
152 *
153 */
154
155/*!
156 * Safely copy an xrt_pose to an XrPosef.
157 */
158#define OXR_XRT_POSE_TO_XRPOSEF(FROM, TO) \
159 do { \
160 union { \
161 struct xrt_pose xrt; \
162 XrPosef oxr; \
163 } safe_copy = {FROM}; \
164 TO = safe_copy.oxr; \
165 } while (false)
166
167/*!
168 * Safely copy an xrt_fov to an XrFovf.
169 */
170#define OXR_XRT_FOV_TO_XRFOVF(FROM, TO) \
171 do { \
172 union { \
173 struct xrt_fov xrt; \
174 XrFovf oxr; \
175 } safe_copy = {FROM}; \
176 TO = safe_copy.oxr; \
177 } while (false)
178
179
180static inline const char *
181xr_action_type_to_str(XrActionType type)
182{
183 // clang-format off
184 switch (type) {
185 #define PRINT(name, value) \
186 case name: return #name;
187 XR_LIST_ENUM_XrActionType(PRINT)
188 #undef PRINT
189 default: return "XR_ACTION_TYPE_UNKNOWN";
190 }
191 // clang-format on
192}
193
194/*
195 *
196 * oxr_handle_base.c
197 *
198 */
199
200/*!
201 * Destroy the handle's object, as well as all child handles recursively.
202 *
203 * This should be how all handle-associated objects are destroyed.
204 *
205 * @public @memberof oxr_handle_base
206 */
207XrResult
208oxr_handle_destroy(struct oxr_logger *log, struct oxr_handle_base *hb);
209
210/*!
211 * Returns a human-readable label for a handle state.
212 *
213 * @relates oxr_handle_base
214 */
215const char *
217
218/*!
219 *
220 * @name oxr_instance.c
221 * @{
222 *
223 */
224
225/*!
226 * To go back to a OpenXR object.
227 *
228 * @relates oxr_instance
229 */
230static inline XrInstance
232{
233 return XRT_CAST_PTR_TO_OXR_HANDLE(XrInstance, inst);
234}
235
236/*!
237 * Creates a instance, does minimal validation of @p createInfo.
238 *
239 * @param[in] log Logger
240 * @param[in] createInfo OpenXR creation info.
241 * @param[in] extensions Parsed extension list to be enabled.
242 * @param[out] out_inst Pointer to pointer to a instance, returned instance.
243 *
244 * @public @static @memberof oxr_instance
245 */
246XrResult
248 const XrInstanceCreateInfo *createInfo,
249 XrVersion major_minor,
250 const struct oxr_extension_status *extensions,
251 struct oxr_instance **out_inst);
252
253/*!
254 * @public @memberof oxr_instance
255 */
256XrResult
257oxr_instance_get_properties(struct oxr_logger *log,
258 struct oxr_instance *inst,
259 XrInstanceProperties *instanceProperties);
260
261#if XR_USE_TIMESPEC
262
263/*!
264 * @public @memberof oxr_instance
265 */
266XrResult
267oxr_instance_convert_time_to_timespec(struct oxr_logger *log,
268 struct oxr_instance *inst,
269 XrTime time,
270 struct timespec *timespecTime);
271
272/*!
273 * @public @memberof oxr_instance
274 */
275XrResult
276oxr_instance_convert_timespec_to_time(struct oxr_logger *log,
277 struct oxr_instance *inst,
278 const struct timespec *timespecTime,
279 XrTime *time);
280#endif // XR_USE_TIMESPEC
281
282#ifdef XR_USE_PLATFORM_WIN32
283
284/*!
285 * @public @memberof oxr_instance
286 */
287XrResult
288oxr_instance_convert_time_to_win32perfcounter(struct oxr_logger *log,
289 struct oxr_instance *inst,
290 XrTime time,
291 LARGE_INTEGER *win32perfcounterTime);
292
293/*!
294 * @public @memberof oxr_instance
295 */
296XrResult
297oxr_instance_convert_win32perfcounter_to_time(struct oxr_logger *log,
298 struct oxr_instance *inst,
299 const LARGE_INTEGER *win32perfcounterTime,
300 XrTime *time);
301
302#endif // XR_USE_PLATFORM_WIN32
303
304/*!
305 * @}
306 */
307
308/*!
309 *
310 * @name oxr_path.c
311 * @{
312 *
313 */
314
315/*!
316 * Initialize the path system.
317 * @private @memberof oxr_instance
318 */
319XrResult
320oxr_path_init(struct oxr_logger *log, struct oxr_instance *inst);
321
322/*!
323 * @public @memberof oxr_instance
324 */
325bool
326oxr_path_is_valid(struct oxr_logger *log, struct oxr_instance *inst, XrPath path);
327
328/*!
329 * @public @memberof oxr_instance
330 */
331void *
332oxr_path_get_attached(struct oxr_logger *log, struct oxr_instance *inst, XrPath path);
333
334/*!
335 * Get the path for the given string if it exists, or create it if it does not.
336 *
337 * @public @memberof oxr_instance
338 */
339XrResult
341 struct oxr_logger *log, struct oxr_instance *inst, const char *str, size_t length, XrPath *out_path);
342
343/*!
344 * Only get the path for the given string if it exists.
345 *
346 * @public @memberof oxr_instance
347 */
348XrResult
349oxr_path_only_get(struct oxr_logger *log, struct oxr_instance *inst, const char *str, size_t length, XrPath *out_path);
350
351/*!
352 * Get a pointer and length of the internal string.
353 *
354 * The pointer has the same life time as the instance. The length is the number
355 * of valid characters, not including the null termination character (but an
356 * extra null byte is always reserved at the end so can strings can be given
357 * to functions expecting null terminated strings).
358 *
359 * @public @memberof oxr_instance
360 */
361XrResult
363 struct oxr_logger *log, const struct oxr_instance *inst, XrPath path, const char **out_str, size_t *out_length);
364
365/*!
366 * Destroy the path system and all paths that the instance has created.
367 *
368 * @private @memberof oxr_instance
369 */
370void
371oxr_path_destroy(struct oxr_logger *log, struct oxr_instance *inst);
372
373/*!
374 * @}
375 */
376
377/*!
378 * To go back to a OpenXR object.
379 *
380 * @relates oxr_action_set
381 */
382static inline XrActionSet
384{
385 return XRT_CAST_PTR_TO_OXR_HANDLE(XrActionSet, act_set);
386}
387
388/*!
389 * To go back to a OpenXR object.
390 *
391 * @relates oxr_hand_tracker
392 */
393static inline XrHandTrackerEXT
395{
396 return XRT_CAST_PTR_TO_OXR_HANDLE(XrHandTrackerEXT, hand_tracker);
397}
398
399#ifdef OXR_HAVE_EXT_plane_detection
400/*!
401 * To go back to a OpenXR object.
402 *
403 * @relates oxr_plane_detector
404 */
405static inline XrPlaneDetectorEXT
406oxr_plane_detector_to_openxr(struct oxr_plane_detector_ext *plane_detector)
407{
408 return XRT_CAST_PTR_TO_OXR_HANDLE(XrPlaneDetectorEXT, plane_detector);
409}
410#endif // OXR_HAVE_EXT_plane_detection
411
412/*!
413 * To go back to a OpenXR object.
414 *
415 * @relates oxr_action
416 */
417static inline XrAction
419{
420 return XRT_CAST_PTR_TO_OXR_HANDLE(XrAction, act);
421}
422
423#ifdef OXR_HAVE_HTC_facial_tracking
424/*!
425 * To go back to a OpenXR object.
426 *
427 * @relates oxr_facial_tracker_htc
428 */
429static inline XrFacialTrackerHTC
430oxr_facial_tracker_htc_to_openxr(struct oxr_facial_tracker_htc *face_tracker_htc)
431{
432 return XRT_CAST_PTR_TO_OXR_HANDLE(XrFacialTrackerHTC, face_tracker_htc);
433}
434#endif
435
436#ifdef OXR_HAVE_FB_body_tracking
437/*!
438 * To go back to a OpenXR object.
439 *
440 * @relates oxr_facial_tracker_htc
441 */
442static inline XrBodyTrackerFB
443oxr_body_tracker_fb_to_openxr(struct oxr_body_tracker_fb *body_tracker_fb)
444{
445 return XRT_CAST_PTR_TO_OXR_HANDLE(XrBodyTrackerFB, body_tracker_fb);
446}
447#endif
448
449#ifdef OXR_HAVE_FB_face_tracking2
450/*!
451 * To go back to a OpenXR object.
452 *
453 * @relates oxr_face_tracker2_fb
454 */
455static inline XrFaceTracker2FB
456oxr_face_tracker2_fb_to_openxr(struct oxr_face_tracker2_fb *face_tracker2_fb)
457{
458 return XRT_CAST_PTR_TO_OXR_HANDLE(XrFaceTracker2FB, face_tracker2_fb);
459}
460#endif
461/*!
462 *
463 * @name oxr_input.c
464 * @{
465 *
466 */
467
468/*!
469 * Helper function to classify subaction_paths.
470 *
471 * Sets all members of @p subaction_paths ( @ref oxr_subaction_paths ) as
472 * appropriate based on the subaction paths found in the list.
473 *
474 * If no paths are provided, @p subaction_paths->any will be true.
475 *
476 * @return false if an invalid subaction path is provided.
477 *
478 * @public @memberof oxr_instance
479 * @see oxr_subaction_paths
480 */
481bool
483 const struct oxr_instance *inst,
484 uint32_t subaction_path_count,
485 const XrPath *subaction_paths,
486 struct oxr_subaction_paths *subaction_paths_out);
487
488/*!
489 * Find the pose input for the set of subaction_paths
490 *
491 * @public @memberof oxr_session
492 */
493XrResult
495 uint32_t act_key,
496 const struct oxr_subaction_paths *subaction_paths_ptr,
497 struct oxr_action_input **out_input);
498
499/*!
500 * @public @memberof oxr_instance
501 */
502XrResult
503oxr_action_set_create(struct oxr_logger *log,
504 struct oxr_instance *inst,
505 const XrActionSetCreateInfo *createInfo,
506 struct oxr_action_set **out_act_set);
507
508/*!
509 * @public @memberof oxr_action
510 */
511XrResult
512oxr_action_create(struct oxr_logger *log,
513 struct oxr_action_set *act_set,
514 const XrActionCreateInfo *createInfo,
515 struct oxr_action **out_act);
516
517/*!
518 * @public @memberof oxr_session
519 * @see oxr_action_set
520 */
521XrResult
523 struct oxr_session *sess,
524 const XrSessionActionSetsAttachInfo *bindInfo);
525
526
527XrResult
528oxr_session_update_action_bindings(struct oxr_logger *log, struct oxr_session *sess);
529
530/*!
531 * Given an action act_key, look up the @ref oxr_action_attachment of
532 * the associated action in the given Session.
533 *
534 * @private @memberof oxr_session
535 */
536void
537oxr_session_get_action_attachment(struct oxr_session *sess,
538 uint32_t act_key,
539 struct oxr_action_attachment **out_act_attached);
540
541/*!
542 * @public @memberof oxr_session
543 */
544XrResult
546 struct oxr_session *sess,
547 uint32_t countActionSets,
548 const XrActiveActionSet *actionSets,
549 const XrActiveActionSetPrioritiesEXT *activePriorities);
550
551/*!
552 * @public @memberof oxr_session
553 */
554XrResult
555oxr_action_enumerate_bound_sources(struct oxr_logger *log,
556 struct oxr_session *sess,
557 uint32_t act_key,
558 uint32_t sourceCapacityInput,
559 uint32_t *sourceCountOutput,
560 XrPath *sources);
561
562/*!
563 * @public @memberof oxr_session
564 */
565XrResult
566oxr_action_get_boolean(struct oxr_logger *log,
567 struct oxr_session *sess,
568 uint32_t act_key,
569 struct oxr_subaction_paths subaction_paths,
570 XrActionStateBoolean *data);
571
572/*!
573 * @public @memberof oxr_session
574 */
575XrResult
576oxr_action_get_vector1f(struct oxr_logger *log,
577 struct oxr_session *sess,
578 uint32_t act_key,
579 struct oxr_subaction_paths subaction_paths,
580 XrActionStateFloat *data);
581
582/*!
583 * @public @memberof oxr_session
584 */
585XrResult
586oxr_action_get_vector2f(struct oxr_logger *log,
587 struct oxr_session *sess,
588 uint32_t act_key,
589 struct oxr_subaction_paths subaction_paths,
590 XrActionStateVector2f *data);
591/*!
592 * @public @memberof oxr_session
593 */
594XrResult
595oxr_action_get_pose(struct oxr_logger *log,
596 struct oxr_session *sess,
597 uint32_t act_key,
598 struct oxr_subaction_paths subaction_paths,
599 XrActionStatePose *data);
600/*!
601 * @public @memberof oxr_session
602 */
603XrResult
604oxr_action_apply_haptic_feedback(struct oxr_logger *log,
605 struct oxr_session *sess,
606 uint32_t act_key,
607 struct oxr_subaction_paths subaction_paths,
608 const XrHapticBaseHeader *hapticEvent);
609/*!
610 * @public @memberof oxr_session
611 */
612XrResult
613oxr_action_stop_haptic_feedback(struct oxr_logger *log,
614 struct oxr_session *sess,
615 uint32_t act_key,
616 struct oxr_subaction_paths subaction_paths);
617
618/*!
619 * @public @memberof oxr_instance
620 */
621XrResult
622oxr_hand_tracker_create(struct oxr_logger *log,
623 struct oxr_session *sess,
624 const XrHandTrackerCreateInfoEXT *createInfo,
625 struct oxr_hand_tracker **out_hand_tracker);
626
627/*!
628 * @}
629 */
630
631/*!
632 *
633 * @name oxr_binding.c
634 * @{
635 *
636 */
637
638/*!
639 * Find the best matching profile for the given @ref xrt_device.
640 *
641 * @param log Logger.
642 * @param sess Session.
643 * @param xdev Can be null.
644 * @param[out] out_p Returned interaction profile.
645 *
646 * @public @memberof oxr_session
647 */
648void
650 struct oxr_session *sess,
651 struct xrt_device *xdev,
652 struct oxr_interaction_profile **out_p);
653
654void
655oxr_get_profile_for_device_name(struct oxr_logger *log,
656 struct oxr_session *sess,
657 enum xrt_device_name name,
658 struct oxr_interaction_profile **out_p);
659
661oxr_clone_profile(const struct oxr_interaction_profile *src_profile);
662
663/*!
664 * Free all memory allocated by the binding system.
665 *
666 * @public @memberof oxr_instance
667 */
668void
669oxr_binding_destroy_all(struct oxr_logger *log, struct oxr_instance *inst);
670
671/*!
672 * Free all memory allocated by the binding system.
673 *
674 * @public @memberof oxr_instance
675 */
676void
678
679/*!
680 * Find all bindings that is the given action key is bound to.
681 * @public @memberof oxr_interaction_profile
682 */
683void
685 struct oxr_interaction_profile *profile,
686 uint32_t key,
687 size_t max_binding_count,
688 struct oxr_binding **out_bindings,
689 size_t *out_binding_count);
690
691/*!
692 * @public @memberof oxr_instance
693 */
694XrResult
695oxr_action_suggest_interaction_profile_bindings(struct oxr_logger *log,
696 struct oxr_instance *inst,
697 const XrInteractionProfileSuggestedBinding *suggestedBindings,
698 struct oxr_dpad_state *state);
699
700/*!
701 * @public @memberof oxr_instance
702 */
703XrResult
704oxr_action_get_current_interaction_profile(struct oxr_logger *log,
705 struct oxr_session *sess,
706 XrPath topLevelUserPath,
707 XrInteractionProfileState *interactionProfile);
708
709/*!
710 * @public @memberof oxr_session
711 */
712XrResult
714 struct oxr_session *sess,
715 const XrInputSourceLocalizedNameGetInfo *getInfo,
716 uint32_t bufferCapacityInput,
717 uint32_t *bufferCountOutput,
718 char *buffer);
719
720/*!
721 * @}
722 */
723
724
725/*!
726 *
727 * @name oxr_dpad.c
728 * @{
729 *
730 */
731
732/*!
733 * Initialises a dpad state, has to be zero init before a call to this function.
734 *
735 * @public @memberof oxr_dpad_state_get
736 */
737bool
738oxr_dpad_state_init(struct oxr_dpad_state *state);
739
740/*!
741 * Look for a entry in the state for the given action set key,
742 * returns NULL if no entry has been made for that action set.
743 *
744 * @public @memberof oxr_dpad_state_get
745 */
746struct oxr_dpad_entry *
747oxr_dpad_state_get(struct oxr_dpad_state *state, uint64_t key);
748
749/*!
750 * Look for a entry in the state for the given action set key,
751 * allocates a new entry if none was found.
752 *
753 * @public @memberof oxr_dpad_state_get
754 */
755struct oxr_dpad_entry *
756oxr_dpad_state_get_or_add(struct oxr_dpad_state *state, uint64_t key);
757
758/*!
759 * Frees all state and entries attached to this dpad state.
760 *
761 * @public @memberof oxr_dpad_state_get
762 */
763void
764oxr_dpad_state_deinit(struct oxr_dpad_state *state);
765
766/*!
767 * Clones all oxr_dpad_state
768 * @param dst_dpad_state destination of cloning
769 * @param src_dpad_state source of cloning
770 * @public @memberof oxr_dpad_state_clone
771 */
772bool
773oxr_dpad_state_clone(struct oxr_dpad_state *dst_dpad_state, const struct oxr_dpad_state *src_dpad_state);
774
775
776/*!
777 * @}
778 */
779
780
781/*!
782 *
783 * @name oxr_session.c
784 * @{
785 *
786 */
787
788/*!
789 * To go back to a OpenXR object.
790 *
791 * @relates oxr_session
792 */
793static inline XrSession
795{
796 return XRT_CAST_PTR_TO_OXR_HANDLE(XrSession, sess);
797}
798
799XrResult
800oxr_session_create(struct oxr_logger *log,
801 struct oxr_system *sys,
802 const XrSessionCreateInfo *createInfo,
803 struct oxr_session **out_session);
804
805XrResult
806oxr_session_enumerate_formats(struct oxr_logger *log,
807 struct oxr_session *sess,
808 uint32_t formatCapacityInput,
809 uint32_t *formatCountOutput,
810 int64_t *formats);
811
812/*!
813 * Change the state of the session, queues a event.
814 */
815void
816oxr_session_change_state(struct oxr_logger *log, struct oxr_session *sess, XrSessionState state, XrTime time);
817
818XrResult
819oxr_session_begin(struct oxr_logger *log, struct oxr_session *sess, const XrSessionBeginInfo *beginInfo);
820
821XrResult
822oxr_session_end(struct oxr_logger *log, struct oxr_session *sess);
823
824XrResult
825oxr_session_request_exit(struct oxr_logger *log, struct oxr_session *sess);
826
827XRT_CHECK_RESULT XrResult
828oxr_session_poll(struct oxr_logger *log, struct oxr_session *sess);
829
830XrResult
831oxr_session_locate_views(struct oxr_logger *log,
832 struct oxr_session *sess,
833 const XrViewLocateInfo *viewLocateInfo,
834 XrViewState *viewState,
835 uint32_t viewCapacityInput,
836 uint32_t *viewCountOutput,
837 XrView *views);
838
839XrResult
840oxr_session_frame_wait(struct oxr_logger *log, struct oxr_session *sess, XrFrameState *frameState);
841
842XrResult
843oxr_session_frame_begin(struct oxr_logger *log, struct oxr_session *sess);
844
845XrResult
846oxr_session_frame_end(struct oxr_logger *log, struct oxr_session *sess, const XrFrameEndInfo *frameEndInfo);
847
848XrResult
850 struct oxr_hand_tracker *hand_tracker,
851 const XrHandJointsLocateInfoEXT *locateInfo,
852 XrHandJointLocationsEXT *locations);
853
854/*
855 * Gets the body pose in the base space.
856 */
857XrResult
858oxr_get_base_body_pose(struct oxr_logger *log,
859 const struct xrt_body_joint_set *body_joint_set,
860 struct oxr_space *base_spc,
861 struct xrt_device *body_xdev,
862 XrTime at_time,
863 struct xrt_space_relation *out_base_body);
864
865XrResult
866oxr_session_apply_force_feedback(struct oxr_logger *log,
867 struct oxr_hand_tracker *hand_tracker,
868 const XrForceFeedbackCurlApplyLocationsMNDX *locations);
869
870#ifdef OXR_HAVE_KHR_android_thread_settings
871XrResult
872oxr_session_android_thread_settings(struct oxr_logger *log,
873 struct oxr_session *sess,
874 XrAndroidThreadTypeKHR threadType,
875 uint32_t threadId);
876#endif // OXR_HAVE_KHR_android_thread_settings
877
878#ifdef OXR_HAVE_KHR_visibility_mask
879XrResult
880oxr_session_get_visibility_mask(struct oxr_logger *log,
881 struct oxr_session *session,
882 XrVisibilityMaskTypeKHR visibilityMaskType,
883 uint32_t viewIndex,
884 XrVisibilityMaskKHR *visibilityMask);
885
886XrResult
887oxr_event_push_XrEventDataVisibilityMaskChangedKHR(struct oxr_logger *log,
888 struct oxr_session *sess,
889 XrViewConfigurationType viewConfigurationType,
890 uint32_t viewIndex);
891#endif // OXR_HAVE_KHR_visibility_mask
892
893#ifdef OXR_HAVE_EXT_performance_settings
894XrResult
895oxr_session_set_perf_level(struct oxr_logger *log,
896 struct oxr_session *sess,
897 XrPerfSettingsDomainEXT domain,
898 XrPerfSettingsLevelEXT level);
899#endif // OXR_HAVE_EXT_performance_settings
900
901/*
902 *
903 * oxr_space.c
904 *
905 */
906
907/*!
908 * To go back to a OpenXR object.
909 */
910static inline XrSpace
912{
913 return XRT_CAST_PTR_TO_OXR_HANDLE(XrSpace, spc);
914}
915
916XrResult
917oxr_space_action_create(struct oxr_logger *log,
918 struct oxr_session *sess,
919 uint32_t key,
920 const XrActionSpaceCreateInfo *createInfo,
921 struct oxr_space **out_space);
922
923XrResult
924oxr_space_get_reference_bounds_rect(struct oxr_logger *log,
925 struct oxr_session *sess,
926 XrReferenceSpaceType referenceSpaceType,
927 XrExtent2Df *bounds);
928
929XrResult
930oxr_space_reference_create(struct oxr_logger *log,
931 struct oxr_session *sess,
932 const XrReferenceSpaceCreateInfo *createInfo,
933 struct oxr_space **out_space);
934
935/*!
936 * Monado special space that always points to a specific @ref xrt_device and
937 * pose, useful when you want to bypass the action binding system for instance.
938 */
939XrResult
941 struct oxr_session *sess,
942 struct xrt_device *xdev,
943 enum xrt_input_name name,
944 const struct xrt_pose *pose,
945 struct oxr_space **out_space);
946
947XrResult
949 struct oxr_logger *log, struct oxr_space *spc, struct oxr_space *baseSpc, XrTime time, XrSpaceLocation *location);
950
951XrResult
952oxr_spaces_locate(struct oxr_logger *log,
953 struct oxr_space **spcs,
954 uint32_t spc_count,
955 struct oxr_space *baseSpc,
956 XrTime time,
957 XrSpaceLocations *locations);
958
959/*!
960 * Locate the @ref xrt_device in the given base space, useful for implementing
961 * hand tracking location look ups and the like.
962 *
963 * @param log Logging struct.
964 * @param xdev Device to locate in the base space.
965 * @param baseSpc Base space where the device is to be located.
966 * @param[in] time Time in OpenXR domain.
967 * @param[out] out_relation Returns T_base_xdev, aka xdev in base space.
968 *
969 * @return Any errors, XR_SUCCESS, pose might not be valid on XR_SUCCESS.
970 */
971XRT_CHECK_RESULT XrResult
973 struct xrt_device *xdev,
974 struct oxr_space *baseSpc,
975 XrTime time,
976 struct xrt_space_relation *out_relation);
977
978
979/*
980 *
981 * oxr_swapchain.c
982 *
983 */
984
985/*!
986 * To go back to a OpenXR object.
987 */
988static inline XrSwapchain
990{
991 return XRT_CAST_PTR_TO_OXR_HANDLE(XrSwapchain, sc);
992}
993
994
995/*
996 *
997 * oxr_messenger.c
998 *
999 */
1000
1001/*!
1002 * To go back to a OpenXR object.
1003 */
1004static inline XrDebugUtilsMessengerEXT
1006{
1007 return XRT_CAST_PTR_TO_OXR_HANDLE(XrDebugUtilsMessengerEXT, mssngr);
1008}
1009
1010XrResult
1012 struct oxr_instance *inst,
1013 const XrDebugUtilsMessengerCreateInfoEXT *,
1014 struct oxr_debug_messenger **out_mssngr);
1015XrResult
1016oxr_destroy_messenger(struct oxr_logger *log, struct oxr_debug_messenger *mssngr);
1017
1018
1019/*
1020 *
1021 * oxr_system.c
1022 *
1023 */
1024
1025XrResult
1026oxr_system_select(struct oxr_logger *log,
1027 struct oxr_system **systems,
1028 uint32_t system_count,
1029 XrFormFactor form_factor,
1030 struct oxr_system **out_selected);
1031
1032XrResult
1033oxr_system_fill_in(struct oxr_logger *log,
1034 struct oxr_instance *inst,
1035 XrSystemId systemId,
1036 uint32_t view_count,
1037 struct oxr_system *sys);
1038
1039XrResult
1040oxr_system_verify_id(struct oxr_logger *log, const struct oxr_instance *inst, XrSystemId systemId);
1041
1042XrResult
1043oxr_system_get_by_id(struct oxr_logger *log,
1044 struct oxr_instance *inst,
1045 XrSystemId systemId,
1046 struct oxr_system **system);
1047
1048XrResult
1049oxr_system_get_properties(struct oxr_logger *log, struct oxr_system *sys, XrSystemProperties *properties);
1050
1051XrResult
1052oxr_system_enumerate_view_confs(struct oxr_logger *log,
1053 struct oxr_system *sys,
1054 uint32_t viewConfigurationTypeCapacityInput,
1055 uint32_t *viewConfigurationTypeCountOutput,
1056 XrViewConfigurationType *viewConfigurationTypes);
1057
1058XrResult
1060 struct oxr_system *sys,
1061 XrViewConfigurationType viewConfigurationType,
1062 uint32_t environmentBlendModeCapacityInput,
1063 uint32_t *environmentBlendModeCountOutput,
1064 XrEnvironmentBlendMode *environmentBlendModes);
1065
1066XrResult
1067oxr_system_get_view_conf_properties(struct oxr_logger *log,
1068 struct oxr_system *sys,
1069 XrViewConfigurationType viewConfigurationType,
1070 XrViewConfigurationProperties *configurationProperties);
1071
1072XrResult
1073oxr_system_enumerate_view_conf_views(struct oxr_logger *log,
1074 struct oxr_system *sys,
1075 XrViewConfigurationType viewConfigurationType,
1076 uint32_t viewCapacityInput,
1077 uint32_t *viewCountOutput,
1078 XrViewConfigurationView *views);
1079
1080bool
1081oxr_system_get_hand_tracking_support(struct oxr_logger *log, struct oxr_instance *inst);
1082
1083bool
1084oxr_system_get_eye_gaze_support(struct oxr_logger *log, struct oxr_instance *inst);
1085
1086bool
1087oxr_system_get_force_feedback_support(struct oxr_logger *log, struct oxr_instance *inst);
1088
1089void
1090oxr_system_get_face_tracking_htc_support(struct oxr_logger *log,
1091 struct oxr_instance *inst,
1092 bool *supports_eye,
1093 bool *supports_lip);
1094
1095void
1096oxr_system_get_face_tracking2_fb_support(struct oxr_logger *log,
1097 struct oxr_instance *inst,
1098 bool *supports_audio,
1099 bool *supports_visual);
1100
1101bool
1102oxr_system_get_body_tracking_fb_support(struct oxr_logger *log, struct oxr_instance *inst);
1103
1104bool
1105oxr_system_get_full_body_tracking_meta_support(struct oxr_logger *log, struct oxr_instance *inst);
1106
1107/*
1108 *
1109 * oxr_event.cpp
1110 *
1111 */
1112
1113XrResult
1114oxr_event_push_XrEventDataSessionStateChanged(struct oxr_logger *log,
1115 struct oxr_session *sess,
1116 XrSessionState state,
1117 XrTime time);
1118
1119XrResult
1120oxr_event_push_XrEventDataInteractionProfileChanged(struct oxr_logger *log, struct oxr_session *sess);
1121
1122XrResult
1123oxr_event_push_XrEventDataReferenceSpaceChangePending(struct oxr_logger *log,
1124 struct oxr_session *sess,
1125 XrReferenceSpaceType referenceSpaceType,
1126 XrTime changeTime,
1127 XrBool32 poseValid,
1128 const XrPosef *poseInPreviousSpace);
1129
1130#ifdef OXR_HAVE_FB_display_refresh_rate
1131XrResult
1132oxr_event_push_XrEventDataDisplayRefreshRateChangedFB(struct oxr_logger *log,
1133 struct oxr_session *sess,
1134 float fromDisplayRefreshRate,
1135 float toDisplayRefreshRate);
1136#endif // OXR_HAVE_FB_display_refresh_rate
1137
1138#ifdef OXR_HAVE_EXTX_overlay
1139XrResult
1140oxr_event_push_XrEventDataMainSessionVisibilityChangedEXTX(struct oxr_logger *log,
1141 struct oxr_session *sess,
1142 bool visible);
1143#endif // OXR_HAVE_EXTX_overlay
1144
1145#ifdef OXR_HAVE_EXT_performance_settings
1146XrResult
1147oxr_event_push_XrEventDataPerfSettingsEXTX(struct oxr_logger *log,
1148 struct oxr_session *sess,
1149 enum xrt_perf_domain domain,
1150 enum xrt_perf_sub_domain subDomain,
1151 enum xrt_perf_notify_level fromLevel,
1152 enum xrt_perf_notify_level toLevel);
1153#endif // OXR_HAVE_EXT_performance_settings
1154/*!
1155 * This clears all pending events refers to the given session.
1156 */
1157XrResult
1158oxr_event_remove_session_events(struct oxr_logger *log, struct oxr_session *sess);
1159
1160/*!
1161 * Will return one event if available, also drain the sessions event queues.
1162 */
1163XrResult
1164oxr_poll_event(struct oxr_logger *log, struct oxr_instance *inst, XrEventDataBuffer *eventData);
1165
1166
1167/*
1168 *
1169 * oxr_xdev.c
1170 *
1171 */
1172
1173void
1174oxr_xdev_destroy(struct xrt_device **xdev_ptr);
1175
1176/*!
1177 * Return true if it finds an input of that name on this device.
1178 */
1179bool
1180oxr_xdev_find_input(struct xrt_device *xdev, enum xrt_input_name name, struct xrt_input **out_input);
1181
1182/*!
1183 * Return true if it finds an output of that name on this device.
1184 */
1185bool
1186oxr_xdev_find_output(struct xrt_device *xdev, enum xrt_output_name name, struct xrt_output **out_output);
1187
1188#ifdef OXR_HAVE_MNDX_xdev_space
1189static inline XrXDevListMNDX
1190oxr_xdev_list_to_openxr(struct oxr_xdev_list *sc)
1191{
1192 return XRT_CAST_PTR_TO_OXR_HANDLE(XrXDevListMNDX, sc);
1193}
1194
1195XrResult
1196oxr_xdev_list_create(struct oxr_logger *log,
1197 struct oxr_session *sess,
1198 const XrCreateXDevListInfoMNDX *createInfo,
1199 struct oxr_xdev_list **out_xdl);
1200
1201XrResult
1202oxr_xdev_list_get_properties(struct oxr_logger *log,
1203 struct oxr_xdev_list *xdl,
1204 uint32_t index,
1205 XrXDevPropertiesMNDX *properties);
1206
1207XrResult
1208oxr_xdev_list_space_create(struct oxr_logger *log,
1209 struct oxr_xdev_list *xdl,
1210 const XrCreateXDevSpaceInfoMNDX *createInfo,
1211 uint32_t index,
1212 struct oxr_space **out_space);
1213
1214#endif // OXR_HAVE_MNDX_xdev_space
1215
1216
1217/*
1218 *
1219 * OpenGL, located in various files.
1220 *
1221 */
1222
1223#ifdef XR_USE_GRAPHICS_API_OPENGL
1224#ifdef XR_USE_PLATFORM_XLIB
1225
1226XrResult
1227oxr_session_populate_gl_xlib(struct oxr_logger *log,
1228 struct oxr_system *sys,
1229 XrGraphicsBindingOpenGLXlibKHR const *next,
1230 struct oxr_session *sess);
1231#endif // XR_USE_PLATFORM_XLIB
1232
1233#ifdef XR_USE_PLATFORM_WIN32
1234XrResult
1235oxr_session_populate_gl_win32(struct oxr_logger *log,
1236 struct oxr_system *sys,
1237 XrGraphicsBindingOpenGLWin32KHR const *next,
1238 struct oxr_session *sess);
1239#endif // XR_USE_PLATFORM_WIN32
1240#endif // XR_USE_GRAPHICS_API_OPENGL
1241
1242#if defined(XR_USE_GRAPHICS_API_OPENGL) || defined(XR_USE_GRAPHICS_API_OPENGL_ES)
1243XrResult
1244oxr_swapchain_gl_create(struct oxr_logger * /*log*/,
1245 struct oxr_session *sess,
1246 const XrSwapchainCreateInfo * /*createInfo*/,
1247 struct oxr_swapchain **out_swapchain);
1248
1249#endif // XR_USE_GRAPHICS_API_OPENGL || XR_USE_GRAPHICS_API_OPENGL_ES
1250
1251#if defined(XR_USE_GRAPHICS_API_OPENGL_ES)
1252#if defined(XR_USE_PLATFORM_ANDROID)
1253XrResult
1254oxr_session_populate_gles_android(struct oxr_logger *log,
1255 struct oxr_system *sys,
1256 XrGraphicsBindingOpenGLESAndroidKHR const *next,
1257 struct oxr_session *sess);
1258#endif // XR_USE_PLATFORM_ANDROID
1259#endif // XR_USE_GRAPHICS_API_OPENGL_ES
1260
1261
1262/*
1263 *
1264 * Vulkan, located in various files.
1265 *
1266 */
1267
1268#ifdef XR_USE_GRAPHICS_API_VULKAN
1269
1270XrResult
1271oxr_vk_get_instance_exts(struct oxr_logger *log,
1272 struct oxr_system *sys,
1273 uint32_t namesCapacityInput,
1274 uint32_t *namesCountOutput,
1275 char *namesString);
1276
1277XrResult
1278oxr_vk_get_device_exts(struct oxr_logger *log,
1279 struct oxr_system *sys,
1280 uint32_t namesCapacityInput,
1281 uint32_t *namesCountOutput,
1282 char *namesString);
1283
1284XrResult
1285oxr_vk_get_requirements(struct oxr_logger *log,
1286 struct oxr_system *sys,
1287 XrGraphicsRequirementsVulkanKHR *graphicsRequirements);
1288
1289XrResult
1291 struct oxr_system *sys,
1292 const XrVulkanInstanceCreateInfoKHR *createInfo,
1293 VkInstance *vulkanInstance,
1294 VkResult *vulkanResult);
1295
1296XrResult
1298 struct oxr_system *sys,
1299 const XrVulkanDeviceCreateInfoKHR *createInfo,
1300 VkDevice *vulkanDevice,
1301 VkResult *vulkanResult);
1302
1303XrResult
1304oxr_vk_get_physical_device(struct oxr_logger *log,
1305 struct oxr_instance *inst,
1306 struct oxr_system *sys,
1307 VkInstance vkInstance,
1308 PFN_vkGetInstanceProcAddr getProc,
1309 VkPhysicalDevice *vkPhysicalDevice);
1310
1311XrResult
1312oxr_session_populate_vk(struct oxr_logger *log,
1313 struct oxr_system *sys,
1314 XrGraphicsBindingVulkanKHR const *next,
1315 struct oxr_session *sess);
1316
1317XrResult
1318oxr_swapchain_vk_create(struct oxr_logger * /*log*/,
1319 struct oxr_session *sess,
1320 const XrSwapchainCreateInfo * /*createInfo*/,
1321 struct oxr_swapchain **out_swapchain);
1322
1323#endif
1324
1325
1326/*
1327 *
1328 * EGL, located in various files.
1329 *
1330 */
1331
1332#ifdef XR_USE_PLATFORM_EGL
1333
1334XrResult
1335oxr_session_populate_egl(struct oxr_logger *log,
1336 struct oxr_system *sys,
1337 XrGraphicsBindingEGLMNDX const *next,
1338 struct oxr_session *sess);
1339
1340#endif
1341
1342/*
1343 *
1344 * D3D version independent routines, located in oxr_d3d.cpp
1345 *
1346 */
1347
1348#if defined(XRT_HAVE_D3D11) || defined(XRT_HAVE_D3D12) || defined(XRT_DOXYGEN)
1349/// Common GetRequirements call for D3D11 and D3D12
1350XrResult
1352 struct oxr_system *sys,
1353 LUID *adapter_luid,
1354 D3D_FEATURE_LEVEL *min_feature_level);
1355
1356/// Verify the provided LUID matches the expected one in @p sys
1357XrResult
1358oxr_d3d_check_luid(struct oxr_logger *log, struct oxr_system *sys, LUID *adapter_luid);
1359#endif
1360
1361/*
1362 *
1363 * D3D11, located in various files.
1364 *
1365 */
1366
1367#ifdef XR_USE_GRAPHICS_API_D3D11
1368
1369XrResult
1370oxr_d3d11_get_requirements(struct oxr_logger *log,
1371 struct oxr_system *sys,
1372 XrGraphicsRequirementsD3D11KHR *graphicsRequirements);
1373
1374/**
1375 * @brief Check to ensure the device provided at session create matches the LUID we returned earlier.
1376 *
1377 * @return XR_SUCCESS if the device matches the LUID
1378 */
1379XrResult
1380oxr_d3d11_check_device(struct oxr_logger *log, struct oxr_system *sys, ID3D11Device *device);
1381
1382
1383XrResult
1384oxr_session_populate_d3d11(struct oxr_logger *log,
1385 struct oxr_system *sys,
1386 XrGraphicsBindingD3D11KHR const *next,
1387 struct oxr_session *sess);
1388
1389XrResult
1390oxr_swapchain_d3d11_create(struct oxr_logger *,
1391 struct oxr_session *sess,
1392 const XrSwapchainCreateInfo *,
1393 struct oxr_swapchain **out_swapchain);
1394
1395#endif
1396
1397/*
1398 *
1399 * D3D12, located in various files.
1400 *
1401 */
1402
1403#ifdef XR_USE_GRAPHICS_API_D3D12
1404
1405XrResult
1406oxr_d3d12_get_requirements(struct oxr_logger *log,
1407 struct oxr_system *sys,
1408 XrGraphicsRequirementsD3D12KHR *graphicsRequirements);
1409
1410/**
1411 * @brief Check to ensure the device provided at session create matches the LUID we returned earlier.
1412 *
1413 * @return XR_SUCCESS if the device matches the LUID
1414 */
1415XrResult
1416oxr_d3d12_check_device(struct oxr_logger *log, struct oxr_system *sys, ID3D12Device *device);
1417
1418
1419XrResult
1420oxr_session_populate_d3d12(struct oxr_logger *log,
1421 struct oxr_system *sys,
1422 XrGraphicsBindingD3D12KHR const *next,
1423 struct oxr_session *sess);
1424
1425XrResult
1426oxr_swapchain_d3d12_create(struct oxr_logger *,
1427 struct oxr_session *sess,
1428 const XrSwapchainCreateInfo *,
1429 struct oxr_swapchain **out_swapchain);
1430
1431#endif
1432
1433/*
1434 *
1435 * Structs
1436 *
1437 */
1438
1439
1440/*!
1441 * Used to hold diverse child handles and ensure orderly destruction.
1442 *
1443 * Each object referenced by an OpenXR handle should have one of these as its
1444 * first element, thus "extending" this class.
1445 */
1447{
1448 //! Magic (per-handle-type) value for debugging.
1449 uint64_t debug;
1450
1451 /*!
1452 * Pointer to this object's parent handle holder, if any.
1453 */
1455
1456 /*!
1457 * Array of children, if any.
1458 */
1459 struct oxr_handle_base *children[XRT_MAX_HANDLE_CHILDREN];
1460
1461 /*!
1462 * Current handle state.
1463 */
1465
1466 /*!
1467 * Destroy the object this handle refers to.
1468 */
1470};
1471
1472/*!
1473 * Single or multiple devices grouped together to form a system that sessions
1474 * can be created from. Might need to open devices to get all
1475 * properties from it, but shouldn't.
1476 *
1477 * Not strictly an object, but an atom.
1478 *
1479 * Valid only within an XrInstance (@ref oxr_instance)
1480 *
1481 * @obj{XrSystemId}
1482 */
1484{
1485 struct oxr_instance *inst;
1486
1487 //! The @ref xrt_iface level system.
1489
1490 //! System devices used in all session types.
1492
1493 //! Space overseer used in all session types.
1495
1496 //! System compositor, used to create session compositors.
1498
1499 XrSystemId systemId;
1500
1501 //! Have the client application called the gfx api requirements func?
1503
1504 XrFormFactor form_factor;
1505 XrViewConfigurationType view_config_type;
1506 XrViewConfigurationView views[2];
1507 uint32_t blend_mode_count;
1508 XrEnvironmentBlendMode blend_modes[3];
1509
1510 XrReferenceSpaceType reference_spaces[5];
1511 uint32_t reference_space_count;
1512
1513 //! Cache of the last known system roles, see @ref xrt_system_roles::generation_id
1515 struct os_mutex sync_actions_mutex;
1516
1517 struct xrt_visibility_mask *visibility_mask[2];
1518
1519#ifdef OXR_HAVE_MNDX_xdev_space
1520 bool supports_xdev_space;
1521#endif
1522
1523#ifdef XR_USE_GRAPHICS_API_VULKAN
1524 //! The instance/device we create when vulkan_enable2 is used
1526 //! The device returned with the last xrGetVulkanGraphicsDeviceKHR or xrGetVulkanGraphicsDevice2KHR call.
1527 //! XR_NULL_HANDLE if neither has been called.
1529
1530 struct
1531 {
1532 // No better place to keep this state.
1533 bool external_fence_fd_enabled;
1534 bool external_semaphore_fd_enabled;
1535 bool timeline_semaphore_enabled;
1536 bool debug_utils_enabled;
1537 bool image_format_list_enabled;
1538 } vk;
1539
1540#endif
1541
1542#if defined(XR_USE_GRAPHICS_API_D3D11) || defined(XR_USE_GRAPHICS_API_D3D12)
1543 LUID suggested_d3d_luid;
1544 bool suggested_d3d_luid_valid;
1545#endif
1546};
1547
1548
1549/*
1550 * Device roles helpers.
1551 */
1552
1553// static roles
1554// clang-format off
1555static inline struct xrt_device *get_role_head(struct oxr_system *sys) {return sys->xsysd->static_roles.head; }
1556static inline struct xrt_device *get_role_eyes(struct oxr_system *sys) {return sys->xsysd->static_roles.eyes; }
1557static inline struct xrt_device *get_role_face(struct oxr_system* sys) { return sys->xsysd->static_roles.face; }
1558static inline struct xrt_device *get_role_body(struct oxr_system* sys) { return sys->xsysd->static_roles.body; }
1559static inline struct xrt_device *get_role_hand_tracking_left(struct oxr_system* sys) { return sys->xsysd->static_roles.hand_tracking.left; }
1560static inline struct xrt_device *get_role_hand_tracking_right(struct oxr_system* sys) { return sys->xsysd->static_roles.hand_tracking.right; }
1561// clang-format on
1562
1563// dynamic roles
1564#define MAKE_GET_DYN_ROLES_FN(ROLE) \
1565 static inline struct xrt_device *get_role_##ROLE(struct oxr_system *sys) \
1566 { \
1567 const bool is_locked = 0 == os_mutex_trylock(&sys->sync_actions_mutex); \
1568 const int32_t xdev_idx = sys->dynamic_roles_cache.ROLE; \
1569 if (is_locked) { \
1570 os_mutex_unlock(&sys->sync_actions_mutex); \
1571 } \
1572 if (xdev_idx < 0 || xdev_idx >= (int32_t)ARRAY_SIZE(sys->xsysd->xdevs)) \
1573 return NULL; \
1574 return sys->xsysd->xdevs[xdev_idx]; \
1575 }
1576MAKE_GET_DYN_ROLES_FN(left)
1577MAKE_GET_DYN_ROLES_FN(right)
1578MAKE_GET_DYN_ROLES_FN(gamepad)
1579#undef MAKE_GET_DYN_ROLES_FN
1580
1581#define GET_XDEV_BY_ROLE(SYS, ROLE) (get_role_##ROLE((SYS)))
1582
1583
1584static inline enum xrt_device_name
1585get_role_profile_head(struct oxr_system *sys)
1586{
1587 return XRT_DEVICE_INVALID;
1588}
1589static inline enum xrt_device_name
1590get_role_profile_eyes(struct oxr_system *sys)
1591{
1592 return XRT_DEVICE_INVALID;
1593}
1594static inline enum xrt_device_name
1595get_role_profile_face(struct oxr_system *sys)
1596{
1597 return XRT_DEVICE_INVALID;
1598}
1599static inline enum xrt_device_name
1600get_role_profile_body(struct oxr_system *sys)
1601{
1602 return XRT_DEVICE_INVALID;
1603}
1604static inline enum xrt_device_name
1605get_role_profile_hand_tracking_left(struct oxr_system *sys)
1606{
1607 return XRT_DEVICE_INVALID;
1608}
1609static inline enum xrt_device_name
1610get_role_profile_hand_tracking_right(struct oxr_system *sys)
1611{
1612 return XRT_DEVICE_INVALID;
1613}
1614
1615#define MAKE_GET_DYN_ROLE_PROFILE_FN(ROLE) \
1616 static inline enum xrt_device_name get_role_profile_##ROLE(struct oxr_system *sys) \
1617 { \
1618 const bool is_locked = 0 == os_mutex_trylock(&sys->sync_actions_mutex); \
1619 const enum xrt_device_name profile_name = sys->dynamic_roles_cache.ROLE##_profile; \
1620 if (is_locked) { \
1621 os_mutex_unlock(&sys->sync_actions_mutex); \
1622 } \
1623 return profile_name; \
1624 }
1625MAKE_GET_DYN_ROLE_PROFILE_FN(left)
1626MAKE_GET_DYN_ROLE_PROFILE_FN(right)
1627MAKE_GET_DYN_ROLE_PROFILE_FN(gamepad)
1628#undef MAKE_GET_DYN_ROLES_FN
1629
1630#define GET_PROFILE_NAME_BY_ROLE(SYS, ROLE) (get_role_profile_##ROLE((SYS)))
1631
1632/*
1633 * Extensions helpers.
1634 */
1635
1636#define MAKE_EXT_STATUS(mixed_case, all_caps) bool mixed_case;
1637/*!
1638 * Structure tracking which extensions are enabled for a given instance.
1639 *
1640 * Names are systematic: the extension name with the XR_ prefix removed.
1641 */
1643{
1644 OXR_EXTENSION_SUPPORT_GENERATE(MAKE_EXT_STATUS)
1645};
1646#undef MAKE_EXT_STATUS
1647
1648/*!
1649 * Main object that ties everything together.
1650 *
1651 * No parent type/handle: this is the root handle.
1652 *
1653 * @obj{XrInstance}
1654 * @extends oxr_handle_base
1656struct oxr_instance
1657{
1658 //! Common structure for things referred to by OpenXR handles.
1659 struct oxr_handle_base handle;
1660
1661 struct u_debug_gui *debug_ui;
1662
1663 struct xrt_instance *xinst;
1664
1665 //! Enabled extensions
1667
1668 //! The OpenXR version requested in the app info. It determines the instance's OpenXR version.
1669 struct
1670 {
1671 //! Stores only major.minor version. Simplifies comparisons for e.g. "at least OpenXR 1.1".
1672 XrVersion major_minor;
1674
1675 // Hardcoded single system.
1676 struct oxr_system system;
1677
1678 struct time_state *timekeeping;
1679
1680 struct
1681 {
1682 struct u_hashset *name_store;
1683 struct u_hashset *loc_store;
1684 } action_sets;
1685
1686 //! Path store, for looking up paths.
1687 struct u_hashset *path_store;
1688 //! Mapping from ID to path.
1689 struct oxr_path **path_array;
1690 //! Total length of path array.
1691 size_t path_array_length;
1692 //! Number of paths in the array (0 is always null).
1693 size_t path_num;
1694
1695 // Event queue.
1696 struct
1697 {
1698 struct os_mutex mutex;
1699 struct oxr_event *last;
1700 struct oxr_event *next;
1701 } event;
1702
1703 //! Interaction profile bindings that have been suggested by the client.
1705 size_t profile_count;
1706
1707 struct oxr_session *sessions;
1708
1709 struct
1710 {
1711
1712#define SUBACTION_PATH_MEMBER(X) XrPath X;
1713 OXR_FOR_EACH_SUBACTION_PATH(SUBACTION_PATH_MEMBER)
1714
1715#undef SUBACTION_PATH_MEMBER
1716 } path_cache;
1717
1718 struct
1719 {
1720 struct
1721 {
1722 struct
1723 {
1724 uint32_t major;
1725 uint32_t minor;
1726 uint32_t patch;
1727 const char *name; //< Engine name, not freed.
1728 } engine;
1729 } detected;
1730 } appinfo;
1731
1732 struct
1733 {
1734 //! Unreal has a bug in the VulkanRHI backend.
1736 //! Unreal 4 has a bug calling xrEndSession; the function should just exit
1737 bool skip_end_session;
1738
1739 /*!
1740 * Return XR_ERROR_REFERENCE_SPACE_UNSUPPORTED instead of
1741 * XR_ERROR_VALIDATION_FAILURE in xrCreateReferenceSpace.
1742 */
1744
1745 //! For applications that rely on views being parallel, notably some OpenVR games with OpenComposite.
1746 bool parallel_views;
1747 } quirks;
1748
1749 //! Debug messengers
1750 struct oxr_debug_messenger *messengers[XRT_MAX_HANDLE_CHILDREN];
1751
1752 bool lifecycle_verbose;
1753 bool debug_views;
1754 bool debug_spaces;
1755 bool debug_bindings;
1756
1757#ifdef XRT_FEATURE_RENDERDOC
1758 RENDERDOC_API_1_4_1 *rdoc_api;
1759#endif
1760
1761#ifdef XRT_OS_ANDROID
1762 enum xrt_android_lifecycle_event activity_state;
1763#endif // XRT_OS_ANDROID
1764};
1765
1766/*!
1767 * Object that client program interact with.
1768 *
1769 * Parent type/handle is @ref oxr_instance
1770 *
1771 * @obj{XrSession}
1772 * @extends oxr_handle_base
1773 */
1775{
1776 //! Common structure for things referred to by OpenXR handles.
1777 struct oxr_handle_base handle;
1778 struct oxr_system *sys;
1779
1780 //! What graphics type was this session created with.
1782
1783 //! The @ref xrt_session backing this session.
1785
1786 //! Native compositor that is wrapped by client compositors.
1787 struct xrt_compositor_native *xcn;
1788
1789 struct xrt_compositor *compositor;
1790
1791 struct oxr_session *next;
1792
1793 XrSessionState state;
1794
1795 /*!
1796 * There is a extra state between xrBeginSession has been called and
1797 * the first xrEndFrame has been called. These are to track this.
1798 */
1799 bool has_ended_once;
1800
1801 bool compositor_visible;
1802 bool compositor_focused;
1803
1804 // the number of xrWaitFrame calls that did not yet have a corresponding
1805 // xrEndFrame or xrBeginFrame (discarded frame) call
1806 int active_wait_frames;
1807 struct os_mutex active_wait_frames_lock;
1808
1809 bool frame_started;
1810 bool exiting;
1811
1812 struct
1813 {
1814 int64_t waited;
1815 int64_t begun;
1816 } frame_id;
1817
1818 struct oxr_frame_sync frame_sync;
1819
1820 /*!
1821 * Used to implement precise extra sleeping in wait frame.
1822 */
1824
1825 /*!
1826 * An array of action set attachments that this session owns.
1827 *
1828 * If non-null, this means action sets have been attached to this
1829 * session.
1830 */
1832
1833 /*!
1834 * Length of @ref oxr_session::act_set_attachments.
1835 */
1837
1838 /*!
1839 * A map of action set key to action set attachments.
1840 *
1841 * If non-null, this means action sets have been attached to this
1842 * session, since this map points to elements of
1843 * oxr_session::act_set_attachments
1844 */
1846
1847 /*!
1848 * A map of action key to action attachment.
1849 *
1850 * The action attachments are actually owned by the action set
1851 * attachments, but we own the action set attachments, so this is OK.
1852 *
1853 * If non-null, this means action sets have been attached to this
1854 * session, since this map points to @p oxr_action_attachment members of
1855 * @ref oxr_session::act_set_attachments elements.
1856 */
1858
1859 /*!
1860 * Clone of all suggested binding profiles at the point of action set/session attachment.
1861 * @ref oxr_session_attach_action_sets
1862 */
1864 struct oxr_interaction_profile **profiles_on_attachment;
1865
1866 /*!
1867 * Currently bound interaction profile.
1868 * @{
1869 */
1870
1871#define OXR_PATH_MEMBER(X) XrPath X;
1872
1874#undef OXR_PATH_MEMBER
1875 /*!
1876 * @}
1877 */
1879 /*!
1880 * IPD, to be expanded to a proper 3D relation.
1881 */
1882 float ipd_meters;
1884 /*!
1885 * Frame timing debug output.
1887 bool frame_timing_spew;
1888
1889 //! Extra sleep in wait frame.
1892 /*!
1893 * To pipe swapchain creation to right code.
1894 */
1895 XrResult (*create_swapchain)(struct oxr_logger *,
1896 struct oxr_session *sess,
1897 const XrSwapchainCreateInfo *,
1898 struct oxr_swapchain **);
1899
1900 /*! initial relation of head in "global" space.
1901 * Used as reference for local space. */
1903
1904 bool has_lost;
1905};
1906
1907/*!
1908 * Returns XR_SUCCESS or XR_SESSION_LOSS_PENDING as appropriate.
1910 * @public @memberof oxr_session
1911 */
1912static inline XrResult
1914{
1915 switch (session->state) {
1916 case XR_SESSION_STATE_LOSS_PENDING: return XR_SESSION_LOSS_PENDING;
1917 default: return XR_SUCCESS;
1918 }
1919}
1920
1921/*!
1922 * Returns XR_SUCCESS, XR_SESSION_LOSS_PENDING, or XR_SESSION_NOT_FOCUSED, as
1923 * appropriate.
1925 * @public @memberof oxr_session
1926 */
1927static inline XrResult
1929{
1930 switch (session->state) {
1931 case XR_SESSION_STATE_LOSS_PENDING: return XR_SESSION_LOSS_PENDING;
1932 case XR_SESSION_STATE_FOCUSED: return XR_SUCCESS;
1933 default: return XR_SESSION_NOT_FOCUSED;
1934 }
1935}
1936
1937#ifdef OXR_HAVE_FB_display_refresh_rate
1938XrResult
1939oxr_session_get_display_refresh_rate(struct oxr_logger *log, struct oxr_session *sess, float *displayRefreshRate);
1940
1941XrResult
1942oxr_session_request_display_refresh_rate(struct oxr_logger *log, struct oxr_session *sess, float displayRefreshRate);
1943#endif // OXR_HAVE_FB_display_refresh_rate
1944
1945/*!
1946 * dpad settings we need extracted from XrInteractionProfileDpadBindingEXT
1947 *
1948 * @ingroup oxr_input
1949 */
1950struct oxr_dpad_settings
1951{
1952 float forceThreshold;
1953 float forceThresholdReleased;
1954 float centerRegion;
1955 float wedgeAngle;
1956 bool isSticky;
1957};
1959/*!
1960 * dpad binding extracted from XrInteractionProfileDpadBindingEXT
1961 */
1963{
1964 XrPath binding;
1965 struct oxr_dpad_settings settings;
1966};
1967
1968/*!
1969 * A entry in the dpad state for one action set.
1970 *
1971 * @ingroup oxr_input
1972 */
1973struct oxr_dpad_entry
1974{
1975#ifdef XR_EXT_dpad_binding
1976 struct oxr_dpad_binding_modification dpads[4];
1977 uint32_t dpad_count;
1978#endif
1979
1980 uint64_t key;
1981};
1982
1983/*!
1984 * Holds dpad binding state for a single interaction profile.
1985 *
1986 * @ingroup oxr_input
1987 */
1988struct oxr_dpad_state
1989{
1990 struct u_hashmap_int *uhi;
1991};
1993/*!
1994 * dpad emulation settings from oxr_interaction_profile
1995 */
1996struct oxr_dpad_emulation
1997{
1998 enum oxr_subaction_path subaction_path;
1999 XrPath *paths;
2000 uint32_t path_count;
2001 enum xrt_input_name position;
2002 enum xrt_input_name activate; // Can be zero
2003};
2005/*!
2006 * A single interaction profile.
2007 */
2010 XrPath path;
2011
2012 //! Used to lookup @ref xrt_binding_profile for fallback.
2014
2015 //! Name presented to the user.
2016 const char *localized_name;
2017
2018 struct oxr_binding *bindings;
2019 size_t binding_count;
2020
2021 struct oxr_dpad_emulation *dpads;
2022 size_t dpad_count;
2023
2024 struct oxr_dpad_state dpad_state;
2025};
2027/*!
2028 * Interaction profile binding state.
2029 */
2030struct oxr_binding
2031{
2032 XrPath *paths;
2033 uint32_t path_count;
2034
2035 //! Name presented to the user.
2036 const char *localized_name;
2037
2038 enum oxr_subaction_path subaction_path;
2040 uint32_t act_key_count;
2041 uint32_t *act_keys;
2042 //! store which entry in paths was suggested, for each action key
2044
2045 enum xrt_input_name input;
2046 enum xrt_input_name dpad_activate;
2047
2048 enum xrt_output_name output;
2049};
2050
2051/*!
2052 * @defgroup oxr_input OpenXR input
2053 * @ingroup oxr_main
2054 *
2055 * @brief The action-set/action-based input subsystem of OpenXR.
2056 *
2057 *
2058 * Action sets are created as children of the Instance, but are primarily used
2059 * with one or more Sessions. They may be used with multiple sessions at a time,
2060 * so we can't just put the per-session information directly in the action set
2061 * or action. Instead, we have the `_attachment `structures, which mirror the
2062 * action sets and actions but are rooted under the Session:
2063 *
2064 * - For every action set attached to a session, that session owns a @ref
2065 * oxr_action_set_attachment.
2066 * - For each action in those attached action sets, the action set attachment
2067 * owns an @ref oxr_action_attachment.
2068 *
2069 * We go from the public handle to the `_attachment` structure by using a `key`
2070 * value and a hash map: specifically, we look up the
2071 * oxr_action_set::act_set_key and oxr_action::act_key in the session.
2072 *
2073 * ![](monado-input-class-relationships.drawio.svg)
2074 */
2075
2076/*!
2077 * A parsed equivalent of a list of sub-action paths.
2078 *
2079 * If @p any is true, then no paths were provided, which typically means any
2080 * input is acceptable.
2082 * @ingroup oxr_main
2083 * @ingroup oxr_input
2084 */
2086{
2087 bool any;
2088#define OXR_SUBPATH_MEMBER(X) bool X;
2089 OXR_FOR_EACH_SUBACTION_PATH(OXR_SUBPATH_MEMBER)
2090#undef OXR_SUBPATH_MEMBER
2091};
2092
2093/*!
2094 * Helper function to determine if the set of paths in @p a is a subset of the
2095 * paths in @p b.
2096 *
2097 * @public @memberof oxr_subaction_paths
2098 */
2099static inline bool
2101{
2102#define OXR_CHECK_SUBACTION_PATHS(X) \
2103 if (a->X && !b->X) { \
2104 return false; \
2105 }
2106 OXR_FOR_EACH_SUBACTION_PATH(OXR_CHECK_SUBACTION_PATHS)
2107#undef OXR_CHECK_SUBACTION_PATHS
2108 return true;
2109}
2110
2111/*!
2112 * The data associated with the attachment of an Action Set (@ref
2113 * oxr_action_set) to as Session (@ref oxr_session).
2114 *
2115 * This structure has no pointer to the @ref oxr_action_set that created it
2116 * because the application is allowed to destroy an action before the session,
2117 * which should change nothing except not allow the application to use the
2118 * corresponding data anymore.
2119 *
2120 * @ingroup oxr_input
2122 * @see oxr_action_set
2123 */
2125{
2126 //! Owning session.
2128
2129 //! Action set refcounted data
2131
2132 //! Unique key for the session hashmap.
2133 uint32_t act_set_key;
2134
2135 //! Which sub-action paths are requested on the latest sync.
2137
2138 //! An array of action attachments we own.
2140
2141 /*!
2142 * Length of @ref oxr_action_set_attachment::act_attachments.
2143 */
2145};
2146
2147/*!
2148 * De-initialize an action set attachment and its action attachments.
2149 *
2150 * Frees the action attachments, but does not de-allocate the action set
2151 * attachment.
2152 *
2153 * @public @memberof oxr_action_set_attachment
2154 */
2155void
2157
2158
2159/*!
2160 * The state of a action input.
2161 *
2162 * @ingroup oxr_input
2163 *
2164 * @see oxr_action_attachment
2166struct oxr_action_state
2167{
2168 /*!
2169 * The actual value - must interpret using action type
2170 */
2171 union xrt_input_value value;
2172
2173 //! Is this active (bound and providing input)?
2175
2176 // Was this changed.
2177 bool changed;
2178
2179 //! When was this last changed.
2180 XrTime timestamp;
2181};
2182
2183/*!
2184 * A input action pair of a @ref xrt_input and a @ref xrt_device, along with the
2185 * required transform.
2187 * @ingroup oxr_input
2188 *
2189 * @see xrt_device
2190 * @see xrt_input
2191 */
2192struct oxr_action_input
2193{
2194 struct xrt_device *xdev; // Used for poses and transform is null.
2195 struct xrt_input *input; // Ditto
2196 enum xrt_input_name dpad_activate_name; // used to activate dpad emulation if present
2197 struct xrt_input *dpad_activate; // used to activate dpad emulation if present
2198 struct oxr_input_transform *transforms;
2199 size_t transform_count;
2200 XrPath bound_path;
2201};
2202
2203/*!
2204 * A output action pair of a @ref xrt_output_name and a @ref xrt_device.
2206 * @ingroup oxr_input
2207 *
2208 * @see xrt_device
2209 * @see xrt_output_name
2210 */
2211struct oxr_action_output
2212{
2213 struct xrt_device *xdev;
2214 enum xrt_output_name name;
2215 XrPath bound_path;
2216};
2217
2218
2219/*!
2220 * The set of inputs/outputs for a single sub-action path for an action.
2221 *
2222 * Each @ref oxr_action_attachment has one of these for every known sub-action
2223 * path in the spec. Many, or even most, will be "empty".
2224 *
2225 * A single action will either be input or output, not both.
2226 *
2227 * @ingroup oxr_input
2228 *
2229 * @see oxr_action_attachment
2230 */
2231struct oxr_action_cache
2232{
2233 struct oxr_action_state current;
2234
2235 size_t input_count;
2236 struct oxr_action_input *inputs;
2237
2238 int64_t stop_output_time;
2239 size_t output_count;
2240 struct oxr_action_output *outputs;
2241};
2242
2243/*!
2244 * Data associated with an Action that has been attached to a Session.
2245 *
2246 * More information on the action vs action attachment and action set vs action
2247 * set attachment parallel is in the docs for @ref oxr_input
2248 *
2249 * @ingroup oxr_input
2251 * @see oxr_action
2252 */
2254{
2255 //! The owning action set attachment
2257
2258 //! This action's refcounted data
2259 struct oxr_action_ref *act_ref;
2260
2261 /*!
2262 * The corresponding session.
2263 *
2264 * This will always be valid: the session outlives this object because
2265 * it owns act_set_attached.
2266 */
2267 struct oxr_session *sess;
2268
2269 //! Unique key for the session hashmap.
2270 uint32_t act_key;
2271
2273 /*!
2274 * For pose actions any subaction paths are special treated, at bind
2275 * time we pick one subaction path and stick to it as long as the action
2276 * lives.
2277 */
2279
2280 struct oxr_action_state any_state;
2281
2282#define OXR_CACHE_MEMBER(X) struct oxr_action_cache X;
2283 OXR_FOR_EACH_SUBACTION_PATH(OXR_CACHE_MEMBER)
2284#undef OXR_CACHE_MEMBER
2285};
2286
2287/*!
2288 * @}
2289 */
2290
2291
2292static inline bool
2293oxr_space_type_is_reference(enum oxr_space_type space_type)
2294{
2295 switch (space_type) {
2296 case OXR_SPACE_TYPE_REFERENCE_VIEW:
2297 case OXR_SPACE_TYPE_REFERENCE_LOCAL:
2298 case OXR_SPACE_TYPE_REFERENCE_LOCAL_FLOOR:
2299 case OXR_SPACE_TYPE_REFERENCE_STAGE:
2300 case OXR_SPACE_TYPE_REFERENCE_UNBOUNDED_MSFT:
2301 case OXR_SPACE_TYPE_REFERENCE_COMBINED_EYE_VARJO:
2302 case OXR_SPACE_TYPE_REFERENCE_LOCALIZATION_MAP_ML:
2303 // These are reference spaces.
2304 return true;
2305
2306 case OXR_SPACE_TYPE_ACTION:
2307 case OXR_SPACE_TYPE_XDEV_POSE:
2308 // These are not reference spaces.
2309 return false;
2310 }
2311
2312 // Handles invalid value.
2313 return false;
2314}
2315
2316
2317/*!
2318 * Can be one of several reference space types, or a space that is bound to an
2319 * action.
2320 *
2321 * Parent type/handle is @ref oxr_session
2323 * @obj{XrSpace}
2324 * @extends oxr_handle_base
2326struct oxr_space
2327{
2328 //! Common structure for things referred to by OpenXR handles.
2329 struct oxr_handle_base handle;
2330
2331 //! Owner of this space.
2332 struct oxr_session *sess;
2333
2334 //! Pose that was given during creation.
2335 struct xrt_pose pose;
2336
2337 //! Action key from which action this space was created from.
2338 uint32_t act_key;
2339
2340 //! What kind of space is this?
2342
2343 //! Which sub action path is this?
2345
2346 struct
2347 {
2348 struct xrt_space *xs;
2349 struct xrt_device *xdev;
2350 enum xrt_input_name name;
2351 } action;
2352
2353 struct
2354 {
2355 struct xrt_space *xs;
2356 } xdev_pose;
2357};
2358
2359/*!
2360 * A set of images used for rendering.
2361 *
2362 * Parent type/handle is @ref oxr_session
2364 * @obj{XrSwapchain}
2365 * @extends oxr_handle_base
2367struct oxr_swapchain
2368{
2369 //! Common structure for things referred to by OpenXR handles.
2370 struct oxr_handle_base handle;
2371
2372 //! Owner of this swapchain.
2373 struct oxr_session *sess;
2374
2375 //! Compositor swapchain.
2376 struct xrt_swapchain *swapchain;
2377
2378 //! Swapchain size.
2379 uint32_t width, height;
2380
2381 //! For 1 is 2D texture, greater then 1 2D array texture.
2382 uint32_t array_layer_count;
2383
2384 //! The number of cubemap faces. 6 for cubemaps, 1 otherwise.
2385 uint32_t face_count;
2386
2387 struct
2388 {
2389 enum oxr_image_state state;
2390 } images[XRT_MAX_SWAPCHAIN_IMAGES];
2391
2392 struct
2393 {
2394 size_t num;
2395 struct u_index_fifo fifo;
2396 } acquired;
2397
2398 struct
2399 {
2400 bool yes;
2401 int index;
2402 } inflight; // This is the image that the app is working on.
2403
2404 struct
2405 {
2406 bool yes;
2407 int index;
2408 } released;
2409
2410 // Is this a static swapchain, needed for acquire semantics.
2411 bool is_static;
2412
2413
2414 XrResult (*destroy)(struct oxr_logger *, struct oxr_swapchain *);
2415
2416 XrResult (*enumerate_images)(struct oxr_logger *,
2417 struct oxr_swapchain *,
2418 uint32_t,
2419 XrSwapchainImageBaseHeader *);
2420
2421 XrResult (*acquire_image)(struct oxr_logger *,
2422 struct oxr_swapchain *,
2423 const XrSwapchainImageAcquireInfo *,
2424 uint32_t *);
2425
2426 XrResult (*wait_image)(struct oxr_logger *, struct oxr_swapchain *, const XrSwapchainImageWaitInfo *);
2427
2428 XrResult (*release_image)(struct oxr_logger *, struct oxr_swapchain *, const XrSwapchainImageReleaseInfo *);
2429};
2430
2431struct oxr_refcounted
2432{
2433 struct xrt_reference base;
2434 //! Destruction callback
2435 void (*destroy)(struct oxr_refcounted *);
2436};
2437
2438/*!
2439 * Increase the reference count of @p orc.
2440 */
2441static inline void
2443{
2445}
2446
2447/*!
2448 * Decrease the reference count of @p orc, destroying it if it reaches 0.
2449 */
2450static inline void
2452{
2453 if (xrt_reference_dec_and_is_zero(&orc->base)) {
2454 orc->destroy(orc);
2455 }
2456}
2457
2458/*!
2459 * The reference-counted data of an action set.
2460 *
2461 * One or more sessions may still need this data after the application destroys
2462 * its XrActionSet handle, so this data is refcounted.
2463 *
2464 * @ingroup oxr_input
2465 *
2466 * @see oxr_action_set
2467 * @extends oxr_refcounted
2468 */
2469struct oxr_action_set_ref
2470{
2471 struct oxr_refcounted base;
2472
2473 //! Application supplied name of this action.
2474 char name[XR_MAX_ACTION_SET_NAME_SIZE];
2475
2476 /*!
2477 * Has this action set even been attached to any session, marking it as
2478 * immutable.
2480 bool ever_attached;
2481
2482 //! Unique key for the session hashmap.
2483 uint32_t act_set_key;
2484
2485 //! Application supplied action set priority.
2486 uint32_t priority;
2487
2488 struct
2489 {
2490 struct u_hashset *name_store;
2491 struct u_hashset *loc_store;
2492 } actions;
2493
2494 struct oxr_subaction_paths permitted_subaction_paths;
2495};
2496
2497/*!
2498 * A group of actions.
2499 *
2500 * Parent type/handle is @ref oxr_instance
2501 *
2502 * Note, however, that an action set must be "attached" to a session
2503 * ( @ref oxr_session ) to be used and not just configured.
2504 * The corresponding data is in @ref oxr_action_set_attachment.
2505 *
2506 * @ingroup oxr_input
2508 * @obj{XrActionSet}
2509 * @extends oxr_handle_base
2511struct oxr_action_set
2512{
2513 //! Common structure for things referred to by OpenXR handles.
2514 struct oxr_handle_base handle;
2515
2516 //! Owner of this action set.
2517 struct oxr_instance *inst;
2518
2519 /*!
2520 * The data for this action set that must live as long as any session we
2521 * are attached to.
2522 */
2523 struct oxr_action_set_ref *data;
2525
2526 /*!
2527 * Unique key for the session hashmap.
2528 *
2529 * Duplicated from oxr_action_set_ref::act_set_key for efficiency.
2531 uint32_t act_set_key;
2532
2533 //! The item in the name hashset.
2534 struct u_hashset_item *name_item;
2535
2536 //! The item in the localized hashset.
2537 struct u_hashset_item *loc_item;
2538};
2539
2540/*!
2541 * The reference-counted data of an action.
2542 *
2543 * One or more sessions may still need this data after the application destroys
2544 * its XrAction handle, so this data is refcounted.
2545 *
2546 * @ingroup oxr_input
2547 *
2548 * @see oxr_action
2549 * @extends oxr_refcounted
2550 */
2551struct oxr_action_ref
2553 struct oxr_refcounted base;
2554
2555 //! Application supplied name of this action.
2556 char name[XR_MAX_ACTION_NAME_SIZE];
2557
2558 //! Unique key for the session hashmap.
2559 uint32_t act_key;
2560
2561 //! Type this action was created with.
2562 XrActionType action_type;
2563
2564 //! Which sub action paths that this action was created with.
2566};
2567
2568/*!
2569 * A single action.
2570 *
2571 * Parent type/handle is @ref oxr_action_set
2572 *
2573 * For actual usage, an action is attached to a session: the corresponding data
2574 * is in @ref oxr_action_attachment
2575 *
2576 * @ingroup oxr_input
2578 * @obj{XrAction}
2579 * @extends oxr_handle_base
2581struct oxr_action
2582{
2583 //! Common structure for things referred to by OpenXR handles.
2585
2586 //! Owner of this action.
2587 struct oxr_action_set *act_set;
2588
2589 //! The data for this action that must live as long as any session we
2590 //! are attached to.
2592
2593 /*!
2594 * Unique key for the session hashmap.
2595 *
2596 * Duplicated from oxr_action_ref::act_key for efficiency.
2598 uint32_t act_key;
2599
2600 //! The item in the name hashset.
2601 struct u_hashset_item *name_item;
2602
2603 //! The item in the localized hashset.
2604 struct u_hashset_item *loc_item;
2605};
2606
2608 * Debug object created by the client program.
2609 *
2610 * Parent type/handle is @ref oxr_instance
2611 *
2612 * @obj{XrDebugUtilsMessengerEXT}
2615{
2616 //! Common structure for things referred to by OpenXR handles.
2617 struct oxr_handle_base handle;
2618
2619 //! Owner of this messenger.
2620 struct oxr_instance *inst;
2621
2622 //! Severities to submit to this messenger
2623 XrDebugUtilsMessageSeverityFlagsEXT message_severities;
2624
2625 //! Types to submit to this messenger
2626 XrDebugUtilsMessageTypeFlagsEXT message_types;
2627
2628 //! Callback function
2629 PFN_xrDebugUtilsMessengerCallbackEXT user_callback;
2630
2631 //! Opaque user data
2632 void *XR_MAY_ALIAS user_data;
2633};
2634
2635/*!
2636 * A hand tracker.
2638 * Parent type/handle is @ref oxr_instance
2639 *
2641 * @obj{XrHandTrackerEXT}
2642 * @extends oxr_handle_base
2644struct oxr_hand_tracker
2645{
2646 //! Common structure for things referred to by OpenXR handles.
2647 struct oxr_handle_base handle;
2648
2649 //! Owner of this hand tracker.
2650 struct oxr_session *sess;
2651
2652 //! xrt_device backing this hand tracker
2653 struct xrt_device *xdev;
2654
2655 //! the input name associated with this hand tracker
2657
2658 XrHandEXT hand;
2659 XrHandJointSetEXT hand_joint_set;
2660};
2661
2662#ifdef OXR_HAVE_FB_passthrough
2663
2664struct oxr_passthrough
2665{
2666 struct oxr_handle_base handle;
2667
2668 struct oxr_session *sess;
2669
2670 XrPassthroughFlagsFB flags;
2671
2672 bool paused;
2673};
2674
2675struct oxr_passthrough_layer
2676{
2677 struct oxr_handle_base handle;
2678
2679 struct oxr_session *sess;
2680
2681 XrPassthroughFB passthrough;
2682
2683 XrPassthroughFlagsFB flags;
2684
2685 XrPassthroughLayerPurposeFB purpose;
2686
2687 bool paused;
2688
2689 XrPassthroughStyleFB style;
2690 XrPassthroughColorMapMonoToRgbaFB monoToRgba;
2691 XrPassthroughColorMapMonoToMonoFB monoToMono;
2692 XrPassthroughBrightnessContrastSaturationFB brightnessContrastSaturation;
2693};
2694
2695XrResult
2696oxr_passthrough_create(struct oxr_logger *log,
2697 struct oxr_session *sess,
2698 const XrPassthroughCreateInfoFB *createInfo,
2699 struct oxr_passthrough **out_passthrough);
2700
2701XrResult
2702oxr_passthrough_layer_create(struct oxr_logger *log,
2703 struct oxr_session *sess,
2704 const XrPassthroughLayerCreateInfoFB *createInfo,
2705 struct oxr_passthrough_layer **out_layer);
2706
2707static inline XrPassthroughFB
2708oxr_passthrough_to_openxr(struct oxr_passthrough *passthrough)
2709{
2710 return XRT_CAST_PTR_TO_OXR_HANDLE(XrPassthroughFB, passthrough);
2711}
2712
2713static inline XrPassthroughLayerFB
2714oxr_passthrough_layer_to_openxr(struct oxr_passthrough_layer *passthroughLayer)
2715{
2716 return XRT_CAST_PTR_TO_OXR_HANDLE(XrPassthroughLayerFB, passthroughLayer);
2717}
2718
2719XrResult
2720oxr_event_push_XrEventDataPassthroughStateChangedFB(struct oxr_logger *log,
2721 struct oxr_session *sess,
2722 XrPassthroughStateChangedFlagsFB flags);
2723
2724#endif // OXR_HAVE_FB_passthrough
2725
2726#ifdef OXR_HAVE_HTC_facial_tracking
2727/*!
2728 * HTC specific Facial tracker.
2729 *
2730 * Parent type/handle is @ref oxr_instance
2731 *
2732 *
2733 * @obj{XrFacialTrackerHTC}
2734 * @extends oxr_handle_base
2735 */
2736struct oxr_facial_tracker_htc
2737{
2738 //! Common structure for things referred to by OpenXR handles.
2739 struct oxr_handle_base handle;
2740
2741 //! Owner of this face tracker.
2742 struct oxr_session *sess;
2743
2744 //! xrt_device backing this face tracker
2745 struct xrt_device *xdev;
2746
2747 //! Type of facial tracking, eyes or lips
2748 enum xrt_facial_tracking_type_htc facial_tracking_type;
2749};
2750
2751XrResult
2752oxr_facial_tracker_htc_create(struct oxr_logger *log,
2753 struct oxr_session *sess,
2754 const XrFacialTrackerCreateInfoHTC *createInfo,
2755 struct oxr_facial_tracker_htc **out_face_tracker_htc);
2756
2757XrResult
2758oxr_get_facial_expressions_htc(struct oxr_logger *log,
2759 struct oxr_facial_tracker_htc *facial_tracker_htc,
2760 XrFacialExpressionsHTC *facialExpressions);
2761#endif
2762
2763#ifdef OXR_HAVE_FB_body_tracking
2764/*!
2765 * FB specific Body tracker.
2766 *
2767 * Parent type/handle is @ref oxr_instance
2768 *
2769 * @obj{XrBodyTrackerFB}
2770 * @extends oxr_handle_base
2771 */
2772struct oxr_body_tracker_fb
2773{
2774 //! Common structure for things referred to by OpenXR handles.
2775 struct oxr_handle_base handle;
2776
2777 //! Owner of this face tracker.
2778 struct oxr_session *sess;
2779
2780 //! xrt_device backing this face tracker
2781 struct xrt_device *xdev;
2782
2783 //! Type of the body joint set e.g. XR_FB_body_tracking or XR_META_body_tracking_full_body
2784 enum xrt_body_joint_set_type_fb joint_set_type;
2785};
2786
2787XrResult
2788oxr_create_body_tracker_fb(struct oxr_logger *log,
2789 struct oxr_session *sess,
2790 const XrBodyTrackerCreateInfoFB *createInfo,
2791 struct oxr_body_tracker_fb **out_body_tracker_fb);
2792
2793XrResult
2794oxr_get_body_skeleton_fb(struct oxr_logger *log,
2795 struct oxr_body_tracker_fb *body_tracker_fb,
2796 XrBodySkeletonFB *skeleton);
2797
2798XrResult
2799oxr_locate_body_joints_fb(struct oxr_logger *log,
2800 struct oxr_body_tracker_fb *body_tracker_fb,
2801 struct oxr_space *base_spc,
2802 const XrBodyJointsLocateInfoFB *locateInfo,
2803 XrBodyJointLocationsFB *locations);
2804#endif
2805
2806#ifdef OXR_HAVE_FB_face_tracking2
2807/*!
2808 * FB specific Face tracker2.
2809 *
2810 * Parent type/handle is @ref oxr_instance
2811 *
2812 * @obj{XrFaceTracker2FB}
2813 * @extends oxr_handle_base
2814 */
2815struct oxr_face_tracker2_fb
2816{
2817 //! Common structure for things referred to by OpenXR handles.
2818 struct oxr_handle_base handle;
2819
2820 //! Owner of this face tracker.
2821 struct oxr_session *sess;
2822
2823 //! xrt_device backing this face tracker
2824 struct xrt_device *xdev;
2825
2826 bool audio_enabled;
2827 bool visual_enabled;
2828};
2829
2830XrResult
2831oxr_face_tracker2_fb_create(struct oxr_logger *log,
2832 struct oxr_session *sess,
2833 const XrFaceTrackerCreateInfo2FB *createInfo,
2834 struct oxr_face_tracker2_fb **out_face_tracker2_fb);
2835
2836XrResult
2837oxr_get_face_expression_weights2_fb(struct oxr_logger *log,
2838 struct oxr_face_tracker2_fb *face_tracker2_fb,
2839 const XrFaceExpressionInfo2FB *expression_info,
2840 XrFaceExpressionWeights2FB *expression_weights);
2841#endif
2842
2843#ifdef OXR_HAVE_MNDX_xdev_space
2844/*!
2845 * Object that holds a list of the current @ref xrt_devices.
2846 *
2847 * Parent type/handle is @ref oxr_session
2848 *
2849 * @obj{XrXDevList}
2850 * @extends oxr_handle_base
2851 */
2852struct oxr_xdev_list
2853{
2854 //! Common structure for things referred to by OpenXR handles.
2855 struct oxr_handle_base handle;
2856
2857 //! Owner of this @ref xrt_device list.
2858 struct oxr_session *sess;
2859
2860 //! Monotonically increasing number.
2861 uint64_t generation_number;
2862
2863 uint64_t ids[XRT_SYSTEM_MAX_DEVICES];
2864 struct xrt_device *xdevs[XRT_SYSTEM_MAX_DEVICES];
2866
2867 //! Counts ids, names and xdevs.
2868 uint32_t device_count;
2869};
2870#endif // OXR_HAVE_MNDX_xdev_space
2871
2872#ifdef OXR_HAVE_EXT_plane_detection
2873/*!
2874 * A Plane Detector.
2875 *
2876 * Parent type/handle is @ref oxr_session
2877 *
2878 *
2879 * @obj{XrPlaneDetectorEXT}
2880 * @extends oxr_handle_base
2881 */
2882struct oxr_plane_detector_ext
2883{
2884 //! Common structure for things referred to by OpenXR handles.
2885 struct oxr_handle_base handle;
2886
2887 //! Owner of this anchor.
2888 struct oxr_session *sess;
2889
2890 //! Plane detector flags.
2892
2893 //! The last known state of this plane detector.
2894 XrPlaneDetectionStateEXT state;
2895
2896 //! Whether the last DONE plane detection has been retrieved from the xdev.
2897 bool retrieved;
2898
2899 //! The device that this plane detector belongs to.
2900 struct xrt_device *xdev;
2901
2902 //! Detected planes. xrt_plane_detector_locations_ext::relation is kept in xdev space and not updated.
2903 struct xrt_plane_detections_ext detections;
2904
2905 //! Corresponds to xrt_plane_detections_ext::locations, but with OpenXR types and transformed into target space.
2906 //! Enables two call idiom.
2907 XrPlaneDetectorLocationEXT *xr_locations;
2908
2909 //! A globally unique id for the current plane detection or 0, generated by the xrt_device.
2910 uint64_t detection_id;
2911};
2912#endif // OXR_HAVE_EXT_plane_detection
2913
2914/*!
2915 * @}
2916 */
2917
2918
2919#ifdef __cplusplus
2920}
2921#endif
void oxr_action_set_attachment_teardown(struct oxr_action_set_attachment *act_set_attached)
De-initialize an action set attachment and its action attachments.
Definition: oxr_input.c:223
static void oxr_refcounted_unref(struct oxr_refcounted *orc)
Decrease the reference count of orc, destroying it if it reaches 0.
Definition: oxr_objects.h:2444
XrResult oxr_poll_event(struct oxr_logger *log, struct oxr_instance *inst, XrEventDataBuffer *eventData)
Will return one event if available, also drain the sessions event queues.
Definition: oxr_event.c:379
XrResult oxr_spaces_locate(struct oxr_logger *log, struct oxr_space **spcs, uint32_t spc_count, struct oxr_space *baseSpc, XrTime time, XrSpaceLocations *locations)
Definition: oxr_space.c:291
XrResult oxr_session_begin(struct oxr_logger *log, struct oxr_session *sess, const XrSessionBeginInfo *beginInfo)
Definition: oxr_session.c:207
static XrSwapchain oxr_swapchain_to_openxr(struct oxr_swapchain *sc)
To go back to a OpenXR object.
Definition: oxr_objects.h:989
oxr_image_state
Tracks the state of a image that belongs to a oxr_swapchain.
Definition: oxr_defines.h:92
XrResult oxr_path_get_or_create(struct oxr_logger *log, struct oxr_instance *inst, const char *str, size_t length, XrPath *out_path)
Get the path for the given string if it exists, or create it if it does not.
Definition: oxr_path.c:172
XrResult oxr_d3d_check_luid(struct oxr_logger *log, struct oxr_system *sys, LUID *adapter_luid)
Verify the provided LUID matches the expected one in sys.
Definition: oxr_d3d.cpp:80
XrResult oxr_system_enumerate_blend_modes(struct oxr_logger *log, struct oxr_system *sys, XrViewConfigurationType viewConfigurationType, uint32_t environmentBlendModeCapacityInput, uint32_t *environmentBlendModeCountOutput, XrEnvironmentBlendMode *environmentBlendModes)
Definition: oxr_system.c:560
XrResult oxr_session_hand_joints(struct oxr_logger *log, struct oxr_hand_tracker *hand_tracker, const XrHandJointsLocateInfoEXT *locateInfo, XrHandJointLocationsEXT *locations)
Definition: oxr_session.c:1288
void oxr_binding_find_bindings_from_act_key(struct oxr_logger *log, struct oxr_interaction_profile *profile, uint32_t key, size_t max_binding_count, struct oxr_binding **out_bindings, size_t *out_binding_count)
Find all bindings that is the given action key is bound to.
Definition: oxr_binding.c:507
XrResult oxr_handle_destroy(struct oxr_logger *log, struct oxr_handle_base *hb)
Destroy the handle's object, as well as all child handles recursively.
Definition: oxr_handle_base.c:197
XrResult oxr_event_remove_session_events(struct oxr_logger *log, struct oxr_session *sess)
This clears all pending events refers to the given session.
Definition: oxr_event.c:347
static XrResult oxr_session_success_result(struct oxr_session *session)
Returns XR_SUCCESS or XR_SESSION_LOSS_PENDING as appropriate.
Definition: oxr_objects.h:1909
XrResult oxr_action_get_pose_input(struct oxr_session *sess, uint32_t act_key, const struct oxr_subaction_paths *subaction_paths_ptr, struct oxr_action_input **out_input)
Find the pose input for the set of subaction_paths.
Definition: oxr_input.c:474
static XrResult oxr_session_success_focused_result(struct oxr_session *session)
Returns XR_SUCCESS, XR_SESSION_LOSS_PENDING, or XR_SESSION_NOT_FOCUSED, as appropriate.
Definition: oxr_objects.h:1924
XrResult oxr_path_only_get(struct oxr_logger *log, struct oxr_instance *inst, const char *str, size_t length, XrPath *out_path)
Only get the path for the given string if it exists.
Definition: oxr_path.c:199
XrResult oxr_space_xdev_pose_create(struct oxr_logger *log, struct oxr_session *sess, struct xrt_device *xdev, enum xrt_input_name name, const struct xrt_pose *pose, struct oxr_space **out_space)
Monado special space that always points to a specific xrt_device and pose, useful when you want to by...
Definition: oxr_space.c:238
void oxr_find_profile_for_device(struct oxr_logger *log, struct oxr_session *sess, struct xrt_device *xdev, struct oxr_interaction_profile **out_p)
Find the best matching profile for the given xrt_device.
Definition: oxr_binding.c:481
XrResult oxr_session_attach_action_sets(struct oxr_logger *log, struct oxr_session *sess, const XrSessionActionSetsAttachInfo *bindInfo)
Definition: oxr_input.c:1754
XRT_CHECK_RESULT XrResult oxr_space_locate_device(struct oxr_logger *log, struct xrt_device *xdev, struct oxr_space *baseSpc, XrTime time, struct xrt_space_relation *out_relation)
Locate the xrt_device in the given base space, useful for implementing hand tracking location look up...
Definition: oxr_space.c:581
static XrDebugUtilsMessengerEXT oxr_messenger_to_openxr(struct oxr_debug_messenger *mssngr)
To go back to a OpenXR object.
Definition: oxr_objects.h:1005
XrResult oxr_space_locate(struct oxr_logger *log, struct oxr_space *spc, struct oxr_space *baseSpc, XrTime time, XrSpaceLocation *location)
Definition: oxr_space.c:448
XrResult oxr_session_frame_end(struct oxr_logger *log, struct oxr_session *sess, const XrFrameEndInfo *frameEndInfo)
Definition: oxr_session_frame_end.c:1644
static XrInstance oxr_instance_to_openxr(struct oxr_instance *inst)
To go back to a OpenXR object.
Definition: oxr_objects.h:231
static XrHandTrackerEXT oxr_hand_tracker_to_openxr(struct oxr_hand_tracker *hand_tracker)
To go back to a OpenXR object.
Definition: oxr_objects.h:394
static XrActionSet oxr_action_set_to_openxr(struct oxr_action_set *act_set)
To go back to a OpenXR object.
Definition: oxr_objects.h:383
bool oxr_classify_subaction_paths(struct oxr_logger *log, const struct oxr_instance *inst, uint32_t subaction_path_count, const XrPath *subaction_paths, struct oxr_subaction_paths *subaction_paths_out)
Helper function to classify subaction_paths.
Definition: oxr_input.c:430
static bool oxr_subaction_paths_is_subset_of(const struct oxr_subaction_paths *a, const struct oxr_subaction_paths *b)
Helper function to determine if the set of paths in a is a subset of the paths in b.
Definition: oxr_objects.h:2095
static XrSession oxr_session_to_openxr(struct oxr_session *sess)
To go back to a OpenXR object.
Definition: oxr_objects.h:794
oxr_session_graphics_ext
What graphics API was this session created with.
Definition: oxr_defines.h:123
static XrAction oxr_action_to_openxr(struct oxr_action *act)
To go back to a OpenXR object.
Definition: oxr_objects.h:418
XrResult oxr_d3d_get_requirements(struct oxr_logger *log, struct oxr_system *sys, LUID *adapter_luid, D3D_FEATURE_LEVEL *min_feature_level)
Common GetRequirements call for D3D11 and D3D12.
Definition: oxr_d3d.cpp:42
bool oxr_xdev_find_input(struct xrt_device *xdev, enum xrt_input_name name, struct xrt_input **out_input)
Return true if it finds an input of that name on this device.
Definition: oxr_xdev.c:90
oxr_space_type
Internal enum for the type of space, lets us reason about action spaces.
Definition: oxr_defines.h:104
XrResult oxr_vk_create_vulkan_instance(struct oxr_logger *log, struct oxr_system *sys, const XrVulkanInstanceCreateInfoKHR *createInfo, VkInstance *vulkanInstance, VkResult *vulkanResult)
Definition: oxr_vulkan.c:231
static void oxr_refcounted_ref(struct oxr_refcounted *orc)
Increase the reference count of orc.
Definition: oxr_objects.h:2435
void oxr_binding_destroy_all(struct oxr_logger *log, struct oxr_instance *inst)
Free all memory allocated by the binding system.
Definition: oxr_binding.c:670
XrResult oxr_session_request_exit(struct oxr_logger *log, struct oxr_session *sess)
Definition: oxr_session.c:346
XrResult(* oxr_handle_destroyer)(struct oxr_logger *log, struct oxr_handle_base *hb)
Function pointer type for a handle destruction function.
Definition: oxr_objects.h:145
void oxr_session_change_state(struct oxr_logger *log, struct oxr_session *sess, XrSessionState state, XrTime time)
Change the state of the session, queues a event.
Definition: oxr_session.c:164
XrResult oxr_system_fill_in(struct oxr_logger *log, struct oxr_instance *inst, XrSystemId systemId, uint32_t view_count, struct oxr_system *sys)
Definition: oxr_system.c:110
XrResult oxr_create_messenger(struct oxr_logger *, struct oxr_instance *inst, const XrDebugUtilsMessengerCreateInfoEXT *, struct oxr_debug_messenger **out_mssngr)
Definition: oxr_messenger.c:41
void oxr_session_binding_destroy_all(struct oxr_logger *log, struct oxr_session *sess)
Free all memory allocated by the binding system.
Definition: oxr_binding.c:678
XrResult oxr_path_get_string(struct oxr_logger *log, const struct oxr_instance *inst, XrPath path, const char **out_str, size_t *out_length)
Get a pointer and length of the internal string.
Definition: oxr_path.c:216
XrResult oxr_session_frame_wait(struct oxr_logger *log, struct oxr_session *sess, XrFrameState *frameState)
Definition: oxr_session.c:782
oxr_handle_state
State of a handle base, to reduce likelihood of going "boom" on out-of-order destruction or other uns...
Definition: oxr_defines.h:46
XrResult oxr_instance_create(struct oxr_logger *log, const XrInstanceCreateInfo *createInfo, XrVersion major_minor, const struct oxr_extension_status *extensions, struct oxr_instance **out_inst)
Creates a instance, does minimal validation of createInfo.
Definition: oxr_instance.c:220
static XrSpace oxr_space_to_openxr(struct oxr_space *spc)
To go back to a OpenXR object.
Definition: oxr_objects.h:911
oxr_subaction_path
Sub action paths.
Definition: oxr_defines.h:63
XrResult oxr_vk_create_vulkan_device(struct oxr_logger *log, struct oxr_system *sys, const XrVulkanDeviceCreateInfoKHR *createInfo, VkDevice *vulkanDevice, VkResult *vulkanResult)
Definition: oxr_vulkan.c:390
const char * oxr_handle_state_to_string(enum oxr_handle_state state)
Returns a human-readable label for a handle state.
Definition: oxr_handle_base.c:42
bool oxr_xdev_find_output(struct xrt_device *xdev, enum xrt_output_name name, struct xrt_output **out_output)
Return true if it finds an output of that name on this device.
Definition: oxr_xdev.c:109
#define XRT_CAST_PTR_TO_OXR_HANDLE(HANDLE_TYPE, PTR)
Cast a pointer to an OpenXR handle in such a way as to avoid warnings.
Definition: oxr_objects.h:75
static XRT_CHECK_RESULT bool xrt_reference_dec_and_is_zero(struct xrt_reference *xref)
Decrement the reference and return true if the value is now zero.
Definition: xrt_defines.h:2176
#define XRT_SYSTEM_MAX_DEVICES
Maximum number of devices simultaneously usable by an implementation of xrt_system_devices.
Definition: xrt_system.h:140
#define XRT_MAX_SWAPCHAIN_IMAGES
Max swapchain images, artificial limit.
Definition: xrt_limits.h:34
xrt_input_name
Every internal input source known to monado with a baked in type.
Definition: xrt_defines.h:1317
static void xrt_reference_inc(struct xrt_reference *xref)
Increment the reference, probably want xrt_reference_inc_and_was_zero.
Definition: xrt_defines.h:2139
xrt_output_name
Name of a output with a baked in type.
Definition: xrt_defines.h:1930
xrt_plane_detector_flags_ext
Flags used when running plane detection.
Definition: xrt_plane_detector.h:46
Wrapper around OS threading native functions.
XrResult oxr_action_get_input_source_localized_name(struct oxr_logger *log, struct oxr_session *sess, const XrInputSourceLocalizedNameGetInfo *getInfo, uint32_t bufferCapacityInput, uint32_t *bufferCountOutput, char *buffer)
Definition: oxr_binding.c:758
Shared internal defines and enums in the state tracker.
Macros for generating extension-related tables and code and inspecting Monado's extension support.
#define OXR_EXTENSION_SUPPORT_GENERATE(_)
Call this, passing a macro taking two parameters, to generate tables, code, etc.
Definition: oxr_extension_support.h:830
The objects that handle session running status and blocking of xrWaitFrame.
XrResult oxr_action_sync_data(struct oxr_logger *log, struct oxr_session *sess, uint32_t countActionSets, const XrActiveActionSet *actionSets, const XrActiveActionSetPrioritiesEXT *activePriorities)
Definition: oxr_input.c:1836
#define OXR_PATH_MEMBER(X)
Currently bound interaction profile.
Definition: oxr_objects.h:1868
Provides a utility macro for dealing with subaction paths.
#define OXR_FOR_EACH_SUBACTION_PATH(_)
Expansion macro (x-macro) that calls the macro you pass with the shorthand name of each subaction pat...
Definition: oxr_subaction.h:39
#define OXR_FOR_EACH_VALID_SUBACTION_PATH(_)
Expansion macro (x-macro) that calls the macro you pass with the shorthand name of each valid subacti...
Definition: oxr_subaction.h:23
Definition: m_space.cpp:87
A wrapper around a native mutex.
Definition: os_threading.h:55
Definition: os_time.h:208
Data associated with an Action that has been attached to a Session.
Definition: oxr_objects.h:2248
struct oxr_subaction_paths any_pose_subaction_path
For pose actions any subaction paths are special treated, at bind time we pick one subaction path and...
Definition: oxr_objects.h:2272
struct oxr_action_ref * act_ref
This action's refcounted data.
Definition: oxr_objects.h:2253
struct oxr_action_set_attachment * act_set_attached
The owning action set attachment.
Definition: oxr_objects.h:2250
uint32_t act_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2264
struct oxr_session * sess
The corresponding session.
Definition: oxr_objects.h:2261
The set of inputs/outputs for a single sub-action path for an action.
Definition: oxr_objects.h:2226
A input action pair of a xrt_input and a xrt_device, along with the required transform.
Definition: oxr_objects.h:2187
A output action pair of a xrt_output_name and a xrt_device.
Definition: oxr_objects.h:2206
The reference-counted data of an action.
Definition: oxr_objects.h:2545
char name[XR_MAX_ACTION_NAME_SIZE]
Application supplied name of this action.
Definition: oxr_objects.h:2549
struct oxr_subaction_paths subaction_paths
Which sub action paths that this action was created with.
Definition: oxr_objects.h:2558
XrActionType action_type
Type this action was created with.
Definition: oxr_objects.h:2555
uint32_t act_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2552
The data associated with the attachment of an Action Set (oxr_action_set) to as Session (oxr_session)...
Definition: oxr_objects.h:2119
struct oxr_action_attachment * act_attachments
An array of action attachments we own.
Definition: oxr_objects.h:2133
struct oxr_session * sess
Owning session.
Definition: oxr_objects.h:2121
struct oxr_action_set_ref * act_set_ref
Action set refcounted data.
Definition: oxr_objects.h:2124
uint32_t act_set_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2127
size_t action_attachment_count
Length of oxr_action_set_attachment::act_attachments.
Definition: oxr_objects.h:2138
struct oxr_subaction_paths requested_subaction_paths
Which sub-action paths are requested on the latest sync.
Definition: oxr_objects.h:2130
The reference-counted data of an action set.
Definition: oxr_objects.h:2463
uint32_t act_set_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2476
char name[XR_MAX_ACTION_SET_NAME_SIZE]
Application supplied name of this action.
Definition: oxr_objects.h:2467
bool ever_attached
Has this action set even been attached to any session, marking it as immutable.
Definition: oxr_objects.h:2473
uint32_t priority
Application supplied action set priority.
Definition: oxr_objects.h:2479
A group of actions.
Definition: oxr_objects.h:2505
struct u_hashset_item * name_item
The item in the name hashset.
Definition: oxr_objects.h:2527
struct u_hashset_item * loc_item
The item in the localized hashset.
Definition: oxr_objects.h:2530
struct oxr_action_set_ref * data
The data for this action set that must live as long as any session we are attached to.
Definition: oxr_objects.h:2516
uint32_t act_set_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2524
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2507
struct oxr_instance * inst
Owner of this action set.
Definition: oxr_objects.h:2510
The state of a action input.
Definition: oxr_objects.h:2161
bool active
Is this active (bound and providing input)?
Definition: oxr_objects.h:2168
XrTime timestamp
When was this last changed.
Definition: oxr_objects.h:2174
A single action.
Definition: oxr_objects.h:2575
struct oxr_action_set * act_set
Owner of this action.
Definition: oxr_objects.h:2580
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2577
struct u_hashset_item * loc_item
The item in the localized hashset.
Definition: oxr_objects.h:2597
uint32_t act_key
Unique key for the session hashmap.
Definition: oxr_objects.h:2591
struct u_hashset_item * name_item
The item in the name hashset.
Definition: oxr_objects.h:2594
struct oxr_action_ref * data
The data for this action that must live as long as any session we are attached to.
Definition: oxr_objects.h:2584
Interaction profile binding state.
Definition: oxr_objects.h:2027
uint32_t * preferred_binding_path_index
store which entry in paths was suggested, for each action key
Definition: oxr_objects.h:2039
const char * localized_name
Name presented to the user.
Definition: oxr_objects.h:2032
Debug object created by the client program.
Definition: oxr_objects.h:2608
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2610
XrDebugUtilsMessageTypeFlagsEXT message_types
Types to submit to this messenger.
Definition: oxr_objects.h:2619
PFN_xrDebugUtilsMessengerCallbackEXT user_callback
Callback function.
Definition: oxr_objects.h:2622
struct oxr_instance * inst
Owner of this messenger.
Definition: oxr_objects.h:2613
void *XR_MAY_ALIAS user_data
Opaque user data.
Definition: oxr_objects.h:2625
XrDebugUtilsMessageSeverityFlagsEXT message_severities
Severities to submit to this messenger.
Definition: oxr_objects.h:2616
dpad binding extracted from XrInteractionProfileDpadBindingEXT
Definition: oxr_objects.h:1959
dpad emulation settings from oxr_interaction_profile
Definition: oxr_objects.h:1993
A entry in the dpad state for one action set.
Definition: oxr_objects.h:1970
dpad settings we need extracted from XrInteractionProfileDpadBindingEXT
Definition: oxr_objects.h:1947
Holds dpad binding state for a single interaction profile.
Definition: oxr_objects.h:1985
Definition: oxr_event.c:30
Structure tracking which extensions are enabled for a given instance.
Definition: oxr_objects.h:1643
Helper that handles synchronizing the xr{Wait,Begin,End}Frame calls.
Definition: oxr_frame_sync.h:36
A hand tracker.
Definition: oxr_objects.h:2638
enum xrt_input_name input_name
the input name associated with this hand tracker
Definition: oxr_objects.h:2649
struct xrt_device * xdev
xrt_device backing this hand tracker
Definition: oxr_objects.h:2646
struct oxr_session * sess
Owner of this hand tracker.
Definition: oxr_objects.h:2643
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2640
Used to hold diverse child handles and ensure orderly destruction.
Definition: oxr_objects.h:1447
struct oxr_handle_base * parent
Pointer to this object's parent handle holder, if any.
Definition: oxr_objects.h:1454
uint64_t debug
Magic (per-handle-type) value for debugging.
Definition: oxr_objects.h:1449
struct oxr_handle_base * children[256]
Array of children, if any.
Definition: oxr_objects.h:1459
enum oxr_handle_state state
Current handle state.
Definition: oxr_objects.h:1464
oxr_handle_destroyer destroy
Destroy the object this handle refers to.
Definition: oxr_objects.h:1469
Variant type for input transforms.
Definition: oxr_input_transform.h:144
Main object that ties everything together.
Definition: oxr_objects.h:1656
bool parallel_views
For applications that rely on views being parallel, notably some OpenVR games with OpenComposite.
Definition: oxr_objects.h:1743
size_t path_num
Number of paths in the array (0 is always null).
Definition: oxr_objects.h:1692
bool disable_vulkan_format_depth_stencil
Unreal has a bug in the VulkanRHI backend.
Definition: oxr_objects.h:1732
XrVersion major_minor
Stores only major.minor version. Simplifies comparisons for e.g. "at least OpenXR 1....
Definition: oxr_objects.h:1671
bool skip_end_session
Unreal 4 has a bug calling xrEndSession; the function should just exit.
Definition: oxr_objects.h:1734
struct oxr_path ** path_array
Mapping from ID to path.
Definition: oxr_objects.h:1688
bool no_validation_error_in_create_ref_space
Return XR_ERROR_REFERENCE_SPACE_UNSUPPORTED instead of XR_ERROR_VALIDATION_FAILURE in xrCreateReferen...
Definition: oxr_objects.h:1740
size_t path_array_length
Total length of path array.
Definition: oxr_objects.h:1690
struct oxr_extension_status extensions
Enabled extensions.
Definition: oxr_objects.h:1665
struct oxr_debug_messenger * messengers[256]
Debug messengers.
Definition: oxr_objects.h:1747
struct u_hashset * path_store
Path store, for looking up paths.
Definition: oxr_objects.h:1686
struct oxr_instance::@267 openxr_version
The OpenXR version requested in the app info. It determines the instance's OpenXR version.
struct oxr_interaction_profile ** profiles
Interaction profile bindings that have been suggested by the client.
Definition: oxr_objects.h:1703
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:1658
A single interaction profile.
Definition: oxr_objects.h:2005
enum xrt_device_name xname
Used to lookup xrt_binding_profile for fallback.
Definition: oxr_objects.h:2009
const char * localized_name
Name presented to the user.
Definition: oxr_objects.h:2012
Logger struct that lives on the stack, one for each call client call.
Definition: oxr_logger.h:40
Internal representation of a path, item follows this struct in memory and that in turn is followed by...
Definition: oxr_path.c:28
Definition: oxr_objects.h:2425
void(* destroy)(struct oxr_refcounted *)
Destruction callback.
Definition: oxr_objects.h:2428
Object that client program interact with.
Definition: oxr_objects.h:1772
struct u_hashmap_int * act_attachments_by_key
A map of action key to action attachment.
Definition: oxr_objects.h:1854
XrResult(* create_swapchain)(struct oxr_logger *, struct oxr_session *sess, const XrSwapchainCreateInfo *, struct oxr_swapchain **)
To pipe swapchain creation to right code.
Definition: oxr_objects.h:1891
struct xrt_compositor_native * xcn
Native compositor that is wrapped by client compositors.
Definition: oxr_objects.h:1784
struct xrt_space_relation local_space_pure_relation
initial relation of head in "global" space.
Definition: oxr_objects.h:1898
struct xrt_session * xs
The xrt_session backing this session.
Definition: oxr_objects.h:1781
struct oxr_action_set_attachment * act_set_attachments
An array of action set attachments that this session owns.
Definition: oxr_objects.h:1828
uint32_t frame_timing_wait_sleep_ms
Extra sleep in wait frame.
Definition: oxr_objects.h:1886
struct os_precise_sleeper sleeper
Used to implement precise extra sleeping in wait frame.
Definition: oxr_objects.h:1820
enum oxr_session_graphics_ext gfx_ext
What graphics type was this session created with.
Definition: oxr_objects.h:1778
size_t profiles_on_attachment_size
Clone of all suggested binding profiles at the point of action set/session attachment.
Definition: oxr_objects.h:1860
bool has_ended_once
There is a extra state between xrBeginSession has been called and the first xrEndFrame has been calle...
Definition: oxr_objects.h:1796
struct u_hashmap_int * act_sets_attachments_by_key
A map of action set key to action set attachments.
Definition: oxr_objects.h:1842
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:1774
float ipd_meters
IPD, to be expanded to a proper 3D relation.
Definition: oxr_objects.h:1878
size_t action_set_attachment_count
Length of oxr_session::act_set_attachments.
Definition: oxr_objects.h:1833
bool frame_timing_spew
Frame timing debug output.
Definition: oxr_objects.h:1883
Can be one of several reference space types, or a space that is bound to an action.
Definition: oxr_objects.h:2320
struct oxr_subaction_paths subaction_paths
Which sub action path is this?
Definition: oxr_objects.h:2337
enum oxr_space_type space_type
What kind of space is this?
Definition: oxr_objects.h:2334
uint32_t act_key
Action key from which action this space was created from.
Definition: oxr_objects.h:2331
struct xrt_pose pose
Pose that was given during creation.
Definition: oxr_objects.h:2328
struct oxr_session * sess
Owner of this space.
Definition: oxr_objects.h:2325
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2322
A parsed equivalent of a list of sub-action paths.
Definition: oxr_objects.h:2082
A set of images used for rendering.
Definition: oxr_objects.h:2361
struct oxr_session * sess
Owner of this swapchain.
Definition: oxr_objects.h:2366
uint32_t face_count
The number of cubemap faces. 6 for cubemaps, 1 otherwise.
Definition: oxr_objects.h:2378
struct xrt_swapchain * swapchain
Compositor swapchain.
Definition: oxr_objects.h:2369
struct oxr_handle_base handle
Common structure for things referred to by OpenXR handles.
Definition: oxr_objects.h:2363
uint32_t width
Swapchain size.
Definition: oxr_objects.h:2372
uint32_t array_layer_count
For 1 is 2D texture, greater then 1 2D array texture.
Definition: oxr_objects.h:2375
Single or multiple devices grouped together to form a system that sessions can be created from.
Definition: oxr_objects.h:1484
struct xrt_system * xsys
The XRT interfaces level system.
Definition: oxr_objects.h:1488
VkPhysicalDevice suggested_vulkan_physical_device
The device returned with the last xrGetVulkanGraphicsDeviceKHR or xrGetVulkanGraphicsDevice2KHR call.
Definition: oxr_objects.h:1528
struct xrt_system_devices * xsysd
System devices used in all session types.
Definition: oxr_objects.h:1491
struct xrt_space_overseer * xso
Space overseer used in all session types.
Definition: oxr_objects.h:1494
VkInstance vulkan_enable2_instance
The instance/device we create when vulkan_enable2 is used.
Definition: oxr_objects.h:1525
bool gotten_requirements
Have the client application called the gfx api requirements func?
Definition: oxr_objects.h:1502
struct xrt_system_compositor * xsysc
System compositor, used to create session compositors.
Definition: oxr_objects.h:1497
struct xrt_system_roles dynamic_roles_cache
Cache of the last known system roles, see xrt_system_roles::generation_id.
Definition: oxr_objects.h:1514
Time-keeping state structure.
Definition: u_time.cpp:30
A simple uint64_t key to a void pointer hashmap.
Definition: u_hashmap.cpp:24
A embeddable hashset item, note that the string directly follows the u_hashset_item.
Definition: u_hashset.h:37
Kind of bespoke hashset implementation, where the user is responsible for allocating and freeing the ...
Definition: u_hashset.cpp:26
Definition: u_index_fifo.h:21
Definition: xrt_defines.h:1913
Main compositor server interface.
Definition: xrt_compositor.h:2232
Common compositor client interface/base.
Definition: xrt_compositor.h:996
A single HMD or input device.
Definition: xrt_device.h:279
enum xrt_device_name name
Enum identifier of the device.
Definition: xrt_device.h:281
A single named input, that sits on a xrt_device.
Definition: xrt_device.h:163
This interface acts as a root object for Monado.
Definition: xrt_instance.h:115
A single named output, that sits on a xrt_device.
Definition: xrt_device.h:181
Each plane has n polygons; ultimately plane metadata from locations and vetices is reconstructed.
Definition: xrt_plane_detector.h:171
A pose composed of a position and orientation.
Definition: xrt_defines.h:467
A base class for reference counted objects.
Definition: xrt_defines.h:96
The XRT representation of XrSession, this object does not have all of the functionality of a session,...
Definition: xrt_session.h:246
Object that oversees and manages spaces, one created for each XR system.
Definition: xrt_space.h:96
A relation with two spaces, includes velocity and acceleration.
Definition: xrt_defines.h:659
A space very similar to a OpenXR XrSpace but not a full one-to-one mapping, but used to power XrSpace...
Definition: xrt_space.h:31
Common swapchain interface/base.
Definition: xrt_compositor.h:539
The system compositor handles composition for a system.
Definition: xrt_compositor.h:2422
A collection of xrt_device, and an interface for identifying the roles they have been assigned.
Definition: xrt_system.h:220
struct xrt_system_devices::@246::@247 hand_tracking
Devices providing optical (or otherwise more directly measured than from controller estimation) hand ...
struct xrt_device * head
An observing pointer to the device serving as the "head" (and HMD).
Definition: xrt_system.h:249
struct xrt_device * face
An observing pointer to the device providing face tracking (optional).
Definition: xrt_system.h:261
struct xrt_device * eyes
An observing pointer to the device providing eye tracking (optional).
Definition: xrt_system.h:255
struct xrt_device * left
An observing pointer to the device providing hand tracking for the left hand (optional).
Definition: xrt_system.h:283
struct xrt_system_devices::@246 static_roles
Observing pointers for devices in some static (unchangeable) roles.
struct xrt_device * right
An observing pointer to the device providing hand tracking for the right hand (optional).
Definition: xrt_system.h:292
struct xrt_device * body
An observing pointer to the device providing body tracking (optional).
Definition: xrt_system.h:267
Data associating a device index (in xrt_system_devices::xdevs) with a given "role" for dynamic role s...
Definition: xrt_system.h:160
A system is a collection of devices, policies and optionally a compositor that is organised into a ch...
Definition: xrt_system.h:61
Visibility mask helper, the indices and vertices are tightly packed after this struct.
Definition: xrt_visibility_mask.h:25
Misc helpers for device drivers.
Hashmap for integer values header.
Hashset struct header.
A FIFO for indices.
A union of all input types.
Definition: xrt_defines.h:1432
Header holding Android-specific details.
xrt_android_lifecycle_event
Distinguishes the possible Android lifecycle events from each other.
Definition: xrt_android.h:32
Header declaring XRT graphics interfaces.
Auto detect OS and certain features.
xrt_perf_notify_level
Performance level.
Definition: xrt_defines.h:2107
xrt_device_name
A enum that is used to name devices so that the state trackers can reason about the devices easier.
Definition: xrt_defines.h:714
xrt_perf_domain
Domain type.
Definition: xrt_defines.h:2080
Header defining an xrt display or controller device.
Header for limits of the XRT interfaces.
Include all of the openxr headers in one place.
Header defining xrt space and space overseer.
Header for system objects.
Header defining the tracking system integration in Monado.
Include all of the Vulkan headers in one place, and cope with any "messy" includes implied by it.