Monado OpenXR Runtime
Loading...
Searching...
No Matches
xrt_defines.h
Go to the documentation of this file.
1// Copyright 2019-2024, Collabora, Ltd.
2// Copyright 2024-2026, NVIDIA CORPORATION.
3// SPDX-License-Identifier: BSL-1.0
4/*!
5 * @file
6 * @brief Common defines and enums for XRT.
7 * @author Jakob Bornecrantz <jakob@collabora.com>
8 * @author Moshi Turner <moshiturner@protonmail.com>
9 * @author Nis Madsen <nima_zero_one@protonmail.com>
10 * @author Korcan Hussein <korcan.hussein@collabora.com>
11 * @ingroup xrt_iface
12 */
13
14#pragma once
15
16#include "xrt/xrt_compiler.h"
17#include "xrt/xrt_results.h"
18
19#include <assert.h>
20#include <stdio.h>
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26/*!
27 * Internal define for VK_UUID_SIZE and XR_UUID_SIZE_EXT.
28 *
29 * @ingroup xrt_iface
30 */
31#define XRT_UUID_SIZE 16
32
33/*!
34 * To transport UUIDs between different APIs.
35 *
36 * @ingroup xrt_iface
37 */
39{
40 uint8_t data[XRT_UUID_SIZE];
41};
42
43/*!
44 * Typedef for @ref xrt_uuid.
45 *
46 * @ingroup xrt_iface
47 */
48typedef struct xrt_uuid xrt_uuid_t;
49
50/*!
51 * Internal define for VK_LUID_SIZE.
52 *
53 * @ingroup xrt_iface
54 */
55#define XRT_LUID_SIZE 8
56
57/*!
58 * To transport LUIDs between different APIs.
59 *
60 * @ingroup xrt_iface
61 */
63{
64 uint8_t data[XRT_LUID_SIZE];
65};
66
67/*!
68 * Typedef for @ref xrt_luid.
69 *
70 * @ingroup xrt_iface
71 */
72typedef struct xrt_luid xrt_luid_t;
73
74/*!
75 * A limited unique id, it is only unique for the process it is in, so must not be
76 * used or synchronized across process boundaries. A value of zero is invalid
77 * and means it has not be properly initialised.
78 *
79 * @ingroup xrt_iface
80 */
82{
83 uint64_t data;
84};
85
86/*!
87 * Typedef for @ref xrt_limited_unique_id.
88 *
89 * @ingroup xrt_iface
90 */
92
93/*!
94 * A base class for reference counted objects.
95 *
96 * @ingroup xrt_iface
97 */
99{
100 xrt_atomic_s32_t count;
101};
102
103/*!
104 * Blend mode that the device supports, exact mirror of XrEnvironmentBlendMode.
105 *
106 * This is not a bitmask because we want to be able to express a preference order
107 * that may vary by device, etc.
108 *
109 * @ingroup xrt_iface
110 */
112{
113 XRT_BLEND_MODE_OPAQUE = 1,
114 XRT_BLEND_MODE_ADDITIVE = 2,
115 XRT_BLEND_MODE_ALPHA_BLEND = 3,
116 XRT_BLEND_MODE_MAX_ENUM,
117};
118
119#define XRT_MAX_DEVICE_BLEND_MODES 3
120
121/*!
122 * Special flags for creating passthrough.
123 */
125{
126 //! Start the passthrough on creation
128 //! Our compositor just ignores this bit.
130};
131
132/*!
133 * Specify additional state change behavior.
134 */
136{
137 //! Passthrough system requires reinitialization.
139 //! Non-recoverable error has occurred.
141 //! A recoverable error has occurred.
143 //! The runtime has recovered from a previous error and is functioning normally.
145};
146
147/*!
148 * Specify the kind of passthrough behavior the layer provides.
149 */
151{
152 //! Fullscreen layer
154 //! Projected layer.
156 //! Provided by XR_FB_passthrough_keyboard_hands
158 //! Provided by XR_FB_passthrough_keyboard_hands
160};
161
162/*!
163 * Which distortion model does the device expose,
164 * used both as a bitfield and value.
165 */
167{
168 // clang-format off
169 XRT_DISTORTION_MODEL_NONE = 1u << 0u,
170 XRT_DISTORTION_MODEL_COMPUTE = 1u << 1u,
171 XRT_DISTORTION_MODEL_MESHUV = 1u << 2u,
172 // clang-format on
173};
174
175/*!
176 * The type of panel refresh the device has.
177 */
179{
180 //! entire panel refreshes simultaneously
182 //! panel refreshes progressively along scanout direction, e.g. OLED panels
184};
185
186/*!
187 * Screen scanout direction
188 */
190{
191 // clang-format off
192 XRT_SCANOUT_DIRECTION_NONE = 0,
193 XRT_SCANOUT_DIRECTION_TOP_TO_BOTTOM,
194 XRT_SCANOUT_DIRECTION_BOTTOM_TO_TOP,
195 XRT_SCANOUT_DIRECTION_LEFT_TO_RIGHT,
196 XRT_SCANOUT_DIRECTION_RIGHT_TO_LEFT,
197 // clang-format on
198};
199
200/*!
201 * Common formats, use `u_format_*` functions to reason about them.
202 */
204{
205 XRT_FORMAT_R8G8B8X8,
206 XRT_FORMAT_R8G8B8A8,
207 XRT_FORMAT_R8G8B8,
208 XRT_FORMAT_R8G8,
209 XRT_FORMAT_R8,
210
211 XRT_FORMAT_BAYER_GR8,
212
213 XRT_FORMAT_L8, // Luminence, R = L, G = L, B = L.
214
215 XRT_FORMAT_BITMAP_8X1, // One bit format tiled in 8x1 blocks.
216 XRT_FORMAT_BITMAP_8X8, // One bit format tiled in 8X8 blocks.
217
218 XRT_FORMAT_YUV888,
219 XRT_FORMAT_YUYV422,
220 XRT_FORMAT_UYVY422,
221
222 XRT_FORMAT_MJPEG,
223
224 XRT_FORMAT_BC4,
225};
226
227/*!
228 * What type of stereo format a frame has.
229 *
230 * @ingroup xrt_iface
231 */
233{
234 XRT_STEREO_FORMAT_NONE,
235 XRT_STEREO_FORMAT_SBS, //!< Side by side.
236 XRT_STEREO_FORMAT_INTERLEAVED, //!< Interleaved pixels.
237 XRT_STEREO_FORMAT_OAU, //!< Over & Under.
238};
239
240/*!
241 * A quaternion with single floats.
242 *
243 * @ingroup xrt_iface math
244 */
246{
247 float x;
248 float y;
249 float z;
250 float w;
251};
252
253/*!
254 * Identity value for @ref xrt_quat
255 *
256 * @ingroup xrt_iface math
257 * @relates xrt_quat
258 */
259// clang-format off
260#define XRT_QUAT_IDENTITY {0.f, 0.f, 0.f, 1.f}
261// clang-format on
262
263/*!
264 * A 1 element vector with single floats.
265 *
266 * @ingroup xrt_iface math
267 */
269{
270 float x;
271};
272
273/*!
274 * A 2 element vector with single floats.
275 *
276 * @ingroup xrt_iface math
277 */
279{
280 float x;
281 float y;
282};
283
284/*!
285 * All-zero value for @ref xrt_vec2
286 *
287 * @ingroup xrt_iface math
288 * @relates xrt_vec2
289 */
290// clang-format off
291#define XRT_VEC2_ZERO {0.f, 0.f}
292// clang-format on
293
294/*!
295 * Represents a uv triplet for distortion, basically just three xrt_vec2.
296 *
297 * @ingroup xrt_iface_math
298 */
300{
301 struct xrt_vec2 r, g, b;
302};
303
304/*!
305 * A 3 element vector with single floats.
306 *
307 * @ingroup xrt_iface math
308 */
310{
311 float x;
312 float y;
313 float z;
314};
315
316/*!
317 * A 3 element vector with single doubles.
318 *
319 * @ingroup xrt_iface math
320 */
322{
323 double x;
324 double y;
325 double z;
326};
327
328/*!
329 * All-zero value for @ref xrt_vec3
330 *
331 * @ingroup xrt_iface math
332 * @relates xrt_vec3
333 */
334// clang-format off
335#define XRT_VEC3_ZERO {0.f, 0.f, 0.f}
336// clang-format on
337/*!
338 * Value for @ref xrt_vec3 with 1 in the @p x coordinate.
339 *
340 * @ingroup xrt_iface math
341 * @relates xrt_vec3
342 */
343// clang-format off
344#define XRT_VEC3_UNIT_X {1.f, 0.f, 0.f}
345// clang-format on
346/*!
347 * Value for @ref xrt_vec3 with 1 in the @p y coordinate.
348 *
349 * @ingroup xrt_iface math
350 * @relates xrt_vec3
351 */
352// clang-format off
353#define XRT_VEC3_UNIT_Y {0.f, 1.f, 0.f}
354// clang-format on
355/*!
356 * Value for @ref xrt_vec3 with 1 in the @p z coordinate.
357 *
358 * @ingroup xrt_iface math
359 * @relates xrt_vec3
360 */
361// clang-format off
362#define XRT_VEC3_UNIT_Z {0.f, 0.f, 1.f}
363// clang-format on
364
365/*!
366 * A 3 element vector with 32 bit integers.
367 *
368 * @ingroup xrt_iface math
369 */
371{
372 int32_t x;
373 int32_t y;
374 int32_t z;
375};
376
377/*!
378 * A 2 element vector with 32 bit integers.
379 *
380 * @ingroup xrt_iface math
381 */
383{
384 int32_t x;
385 int32_t y;
386};
387
388/*!
389 * A 3 element colour with 8 bits per channel.
390 *
391 * @ingroup xrt_iface math
392 */
394{
395 uint8_t r;
396 uint8_t g;
397 uint8_t b;
398};
399
400/*!
401 * A 4 element colour with 8 bits per channel.
402 *
403 * @ingroup xrt_iface math
404 */
406{
407 uint8_t r;
408 uint8_t g;
409 uint8_t b;
410 uint8_t a;
411};
412
413/*!
414 * A 3 element colour with floating point channels.
415 *
416 * @ingroup xrt_iface math
417 */
419{
420 float r;
421 float g;
422 float b;
423};
424
425/*!
426 * A 3 element HSV colour with floating point channels.
427 * All values are in [0, 1] range, with hue wrapping at 1.
428 *
429 * @ingroup xrt_iface math
430 */
432{
433 float h;
434 float s;
435 float v;
436};
437
438/*!
439 * A 4 element colour with floating point channels.
440 *
441 * @ingroup xrt_iface math
442 */
444{
445 float r;
446 float g;
447 float b;
448 float a;
449};
450
451/*!
452 * Image size.
453 *
454 * @ingroup xrt_iface math
455 */
457{
458 int w;
459 int h;
460};
461
462/*!
463 * Image offset.
464 *
465 * @ingroup xrt_iface math
466 */
468{
469 int w, h;
470};
471
472/*!
473 * Image rectangle.
474 *
475 * @ingroup xrt_iface math
476 */
478{
479 struct xrt_offset offset;
480 struct xrt_size extent;
481};
482
483/*!
484 * Image rectangle
485 *
486 * @todo Unify xrt_rect and xrt_rect_f32 field names
487 *
488 * @ingroup xrt_iface math
489 */
491{
492 float x, y, w, h;
493};
494
495/*!
496 * Normalized image rectangle, coordinates and size in 0 .. 1 range.
497 *
498 * @ingroup xrt_iface math
499 */
501{
502 float x, y, w, h;
503};
504
505/*!
506 * A pose composed of a position and orientation.
507 *
508 * @see xrt_quat
509 * @see xrt_vec3
510 * @ingroup xrt_iface math
511 */
513{
514 struct xrt_quat orientation;
515 struct xrt_vec3 position;
516};
517/*!
518 * Identity value for @ref xrt_pose
519 *
520 * @ingroup xrt_iface math
521 * @relates xrt_pose
522 */
523// clang-format off
524#define XRT_POSE_IDENTITY {XRT_QUAT_IDENTITY, XRT_VEC3_ZERO}
525// clang-format on
526
527/*!
528 * Describes a projection matrix fov.
529 *
530 * @ingroup xrt_iface math
531 */
533{
534 float angle_left;
535 float angle_right;
536 float angle_up;
537 float angle_down;
538};
539
540/*!
541 * The number of values in @ref xrt_matrix_2x2
542 *
543 * @ingroup xrt_iface math
544 */
545#define XRT_MATRIX_2X2_ELEMENTS 4
546
547/*!
548 * The number of 2d vectors in @ref xrt_matrix_2x2
549 *
550 * @ingroup xrt_iface math
551 */
552#define XRT_MATRIX_2X2_VECS 2
553
554/*!
555 * A tightly packed 2x2 matrix of floats.
556 *
557 * @ingroup xrt_iface math
558 */
560{
561 union {
563 struct xrt_vec2 vecs[XRT_MATRIX_2X2_VECS];
564 };
565};
566
567/*!
568 * The number of values in @ref xrt_matrix_3x3
569 *
570 * @ingroup xrt_iface math
571 */
572#define XRT_MATRIX_3X3_ELEMENTS 9
573
574/*!
575 * A tightly packed 3x3 matrix of floats.
576 *
577 * @ingroup xrt_iface math
578 */
580{
582};
583
584/*!
585 * A tightly packed 3x3 matrix of doubles.
586 *
587 * @ingroup xrt_iface math
588 */
590{
591 double v[XRT_MATRIX_3X3_ELEMENTS];
592};
593
594/*!
595 * The number of values in a 4x4 matrix like @ref xrt_matrix_4x4 and @ref xrt_matrix_4x4_f64
596 *
597 * @ingroup xrt_iface math
598 */
599#define XRT_MATRIX_4X4_ELEMENTS 16
600
601/*!
602 * A tightly packed 4x4 matrix of floats.
603 *
604 * @ingroup xrt_iface math
605 */
607{
609};
610
611/*!
612 * A tightly packed 4x4 matrix of double.
613 *
614 * @ingroup xrt_iface math
615 */
617{
618 double v[XRT_MATRIX_4X4_ELEMENTS];
619};
620
621/*!
622 * A range of API versions supported.
623 *
624 * @ingroup xrt_iface math
625 */
627{
628 uint32_t min_major;
629 uint32_t min_minor;
630 uint32_t min_patch;
631
632 uint32_t max_major;
633 uint32_t max_minor;
634 uint32_t max_patch;
635};
636
637/*!
638 * Type of a OpenXR mapped reference space, maps to the semantic spaces on the
639 * @ref xrt_space_overseer struct. This is used to refer to indirectly for
640 * instance when letting the overseer know that an application is using a
641 * particular reference space.
642 *
643 * @ingroup xrt_iface
644 */
646{
647 XRT_SPACE_REFERENCE_TYPE_VIEW,
648 XRT_SPACE_REFERENCE_TYPE_LOCAL,
649 XRT_SPACE_REFERENCE_TYPE_LOCAL_FLOOR,
650 XRT_SPACE_REFERENCE_TYPE_STAGE,
651 XRT_SPACE_REFERENCE_TYPE_UNBOUNDED,
652};
653
654/*!
655 * The number of enumerations in @ref xrt_reference_space_type.
656 *
657 * @ingroup xrt_iface
658 */
659#define XRT_SPACE_REFERENCE_TYPE_COUNT (XRT_SPACE_REFERENCE_TYPE_UNBOUNDED + 1)
660
661/*!
662 * An invalid @ref xrt_reference_space_type, since it's invalid it's not listed
663 * in the enum.
664 *
665 * @ingroup xrt_iface
666 */
667#define XRT_SPACE_REFERENCE_TYPE_INVALID ((enum xrt_reference_space_type)(-1))
668
669/*!
670 * Flags of which components of a @ref xrt_space_relation is valid.
671 *
672 * @see xrt_space_relation
673 * @ingroup xrt_iface math
674 */
676{
677 // clang-format off
678 XRT_SPACE_RELATION_ORIENTATION_VALID_BIT = (1u << 0u),
679 XRT_SPACE_RELATION_POSITION_VALID_BIT = (1u << 1u),
680 XRT_SPACE_RELATION_LINEAR_VELOCITY_VALID_BIT = (1u << 2u),
681 XRT_SPACE_RELATION_ANGULAR_VELOCITY_VALID_BIT = (1u << 3u),
682 XRT_SPACE_RELATION_ORIENTATION_TRACKED_BIT = (1u << 4u),
683 XRT_SPACE_RELATION_POSITION_TRACKED_BIT = (1u << 5u),
684 // clang-format on
685 XRT_SPACE_RELATION_BITMASK_ALL = (uint32_t)XRT_SPACE_RELATION_ORIENTATION_VALID_BIT | //
686 (uint32_t)XRT_SPACE_RELATION_POSITION_VALID_BIT | //
687 (uint32_t)XRT_SPACE_RELATION_LINEAR_VELOCITY_VALID_BIT | //
688 (uint32_t)XRT_SPACE_RELATION_ANGULAR_VELOCITY_VALID_BIT | //
689 (uint32_t)XRT_SPACE_RELATION_ORIENTATION_TRACKED_BIT | //
690 (uint32_t)XRT_SPACE_RELATION_POSITION_TRACKED_BIT,
691 XRT_SPACE_RELATION_BITMASK_NONE = 0,
692};
693
694/*!
695 * A relation with two spaces, includes velocity and acceleration.
696 *
697 * @see xrt_quat
698 * @see xrt_vec3
699 * @see xrt_pose
700 * @see xrt_space_relation_flags
701 * @ingroup xrt_iface math
702 */
704{
705 enum xrt_space_relation_flags relation_flags;
706 struct xrt_pose pose;
707 struct xrt_vec3 linear_velocity;
708 struct xrt_vec3 angular_velocity;
709};
710
711/*!
712 * A zero/identity value for @ref xrt_space_relation
713 *
714 * @note Despite this initializing all members (to zero or identity), this sets the xrt_space_relation::relation_flags
715 * to XRT_SPACE_RELATION_BITMASK_NONE - so this is safe to assign before an error return, etc.
716 *
717 * @ingroup xrt_iface math
718 * @relates xrt_space_relation
719 */
720// clang-format off
721#define XRT_SPACE_RELATION_ZERO {XRT_SPACE_RELATION_BITMASK_NONE, XRT_POSE_IDENTITY, XRT_VEC3_ZERO, XRT_VEC3_ZERO}
722// clang-format on
723
724/*!
725 * The maximum number of steps that can be in a relation chain.
726 *
727 * @see xrt_relation_chain::steps
728 * @relates xrt_relation_chain
729 * @ingroup xrt_iface math
730 */
731#define XRT_RELATION_CHAIN_CAPACITY 8
732
733/*!
734 * A chain of space relations and their associated validity flags.
735 * Functions for manipulating this are available in `math/m_space.h`.
736 *
737 * @see xrt_space_relation
738 * @ingroup xrt_iface math
739 */
741{
743 uint32_t step_count;
744};
745
746
747/*
748 *
749 * Input related enums and structs.
750 *
751 */
752
753/*!
754 * A enum that is used to name devices so that the
755 * state trackers can reason about the devices easier.
756 */
758{
759 XRT_DEVICE_INVALID,
760
761 XRT_DEVICE_GENERIC_HMD,
762
763 // Vive stuff.
764 XRT_DEVICE_VIVE_PRO,
765 XRT_DEVICE_VIVE_WAND,
766 XRT_DEVICE_VIVE_TRACKER, // Generic, only used for bindings.
767 XRT_DEVICE_VIVE_TRACKER_GEN1,
768 XRT_DEVICE_VIVE_TRACKER_GEN2,
769 XRT_DEVICE_VIVE_TRACKER_GEN3,
770 XRT_DEVICE_VIVE_TRACKER_TUNDRA,
771
772 // "Controllers" somewhat sorted as listed in spec.
773 XRT_DEVICE_SIMPLE_CONTROLLER,
774 XRT_DEVICE_DAYDREAM,
775 XRT_DEVICE_WMR_CONTROLLER,
776 XRT_DEVICE_XBOX_CONTROLLER,
777 XRT_DEVICE_GO_CONTROLLER,
778 XRT_DEVICE_TOUCH_CONTROLLER,
779 XRT_DEVICE_INDEX_CONTROLLER,
780
781 XRT_DEVICE_HP_REVERB_G2_CONTROLLER,
782 XRT_DEVICE_SAMSUNG_ODYSSEY_CONTROLLER,
783 XRT_DEVICE_LOGITECH_MX_INK_CONTROLLER,
784 XRT_DEVICE_ML2_CONTROLLER,
785 XRT_DEVICE_OPPO_MR_CONTROLLER,
786
787 XRT_DEVICE_HAND_INTERACTION,
788
789 XRT_DEVICE_EYE_GAZE_INTERACTION,
790
791 XRT_DEVICE_PSMV,
792 XRT_DEVICE_PSSENSE,
793 XRT_DEVICE_HYDRA,
794 XRT_DEVICE_RIFT_REMOTE,
795 XRT_DEVICE_BLUBUR_S1,
796 XRT_DEVICE_PSVR2,
797 XRT_DEVICE_FLIPVR,
798 XRT_DEVICE_CONTACTGLOVE2,
799 XRT_DEVICE_CONTACTGLOVE2_WITH_MAGNETRA2,
800
801 // Other misc stuff.
802 XRT_DEVICE_HAND_TRACKER,
803 XRT_DEVICE_REALSENSE,
804 XRT_DEVICE_DEPTHAI,
805
806 //! XR_EXT_hand_interaction
808
809 //! XR_ANDROID_face_tracking
811
812 //! XR_HTC_facial_tracking
814
815 //! XR_FB_body_tracking
817
818 //! XR_FB_face_tracking2
820
821 // added in OpenXR 1.1
822 XRT_DEVICE_PICO_NEO3_CONTROLLER,
823 XRT_DEVICE_PICO4_CONTROLLER,
824 XRT_DEVICE_PICO_G3_CONTROLLER,
825
826 XRT_DEVICE_VIVE_COSMOS_CONTROLLER,
827 XRT_DEVICE_VIVE_FOCUS3_CONTROLLER,
828
829 XRT_DEVICE_TOUCH_PRO_CONTROLLER,
830 XRT_DEVICE_TOUCH_PLUS_CONTROLLER,
831 XRT_DEVICE_TOUCH_CONTROLLER_RIFT_CV1,
832 XRT_DEVICE_TOUCH_CONTROLLER_QUEST_1_RIFT_S,
833 XRT_DEVICE_TOUCH_CONTROLLER_QUEST_2,
834
835 // XR_KHR_generic_controller
836 XRT_DEVICE_GENERIC_CONTROLLER,
837
838 // Hand based controller emulation.
839 XRT_DEVICE_HAND_CTRL_EMU,
840};
841
842/*!
843 * How an xrt_device can be used.
844 *
845 * @ingroup xrt_iface
846 */
848{
849 XRT_DEVICE_TYPE_UNKNOWN = 0,
850 XRT_DEVICE_TYPE_HMD,
851 XRT_DEVICE_TYPE_RIGHT_HAND_CONTROLLER,
852 XRT_DEVICE_TYPE_LEFT_HAND_CONTROLLER,
853 XRT_DEVICE_TYPE_ANY_HAND_CONTROLLER,
854 XRT_DEVICE_TYPE_GAMEPAD,
855 XRT_DEVICE_TYPE_GENERIC_TRACKER,
856 XRT_DEVICE_TYPE_HAND_TRACKER,
857 XRT_DEVICE_TYPE_EYE_TRACKER,
858 XRT_DEVICE_TYPE_FACE_TRACKER,
859 XRT_DEVICE_TYPE_BODY_TRACKER,
860};
861
862/*!
863 * Base type of this inputs.
864 *
865 * @ingroup xrt_iface
866 */
868{
869 // clang-format off
870 //! Float input in [0, 1]
872 //! Float input in [-1, 1]
874 //! Vec2 input, components in [-1, 1]
876 //! Vec3 input, components in [-1, 1]
878 //! Boolean (digital, binary) input
880 //! A tracked pose
882 //! A tracked hand
884 //! A tracked face
886 //! A tracked body
888 // clang-format on
889};
890
891/*!
892 * The number of bits reserved for the input type in @ref xrt_input_name
893 *
894 * @see xrt_input_name
895 * @ingroup xrt_iface
896 */
897#define XRT_INPUT_TYPE_BITWIDTH 8u
898
899/*!
900 * The mask associated with @ref XRT_INPUT_TYPE_BITWIDTH
901 *
902 * @see xrt_input_name
903 * @ingroup xrt_iface
904 */
905
906#define XRT_INPUT_TYPE_BITMASK 0xffu
907
908/*!
909 * @brief Create an enum value for xrt_input_name that packs an ID and input
910 * type.
911 *
912 * @param id an integer
913 * @param type The suffix of an xrt_input_type value name: `XRT_INPUT_TYPE_` is
914 * prepended automatically.
915 *
916 * @see xrt_input_name
917 * @ingroup xrt_iface
918 */
919#define XRT_INPUT_NAME(id, type) ((UINT32_C(id) << XRT_INPUT_TYPE_BITWIDTH) | (uint32_t)XRT_INPUT_TYPE_##type)
920
921/*!
922 * @brief Extract the xrt_input_type from an xrt_input_name.
923 *
924 * @param name An xrt_input_name value
925 *
926 * @relates xrt_input_name
927 * @returns @ref xrt_input_type
928 * @ingroup xrt_iface
929 */
930#define XRT_GET_INPUT_TYPE(name) ((enum xrt_input_type)(name & XRT_INPUT_TYPE_BITMASK))
931
932/*!
933 * @brief Extract the xrt_input_name id from an xrt_input_name.
934 *
935 * @param name An xrt_input_name value
936 *
937 * @relates xrt_input_name
938 * @returns @ref xrt_input_type
939 * @ingroup xrt_iface
940 */
941#define XRT_GET_INPUT_ID(name) ((uint32_t)(name >> XRT_INPUT_TYPE_BITWIDTH))
942
943/*!
944 * Every internal input source known to monado with a baked in type.
945 * Values are maintained in XRT_INPUT_LIST.
946 *
947 * @see xrt_input_type
948 * @ingroup xrt_iface
949 */
951{
952 // clang-format off
953 //! Standard pose used for rendering
955 XRT_INPUT_GENERIC_HEAD_DETECT = XRT_INPUT_NAME(0x0001, BOOLEAN),
956 XRT_INPUT_HT_UNOBSTRUCTED_LEFT = XRT_INPUT_NAME(0x0002, HAND_TRACKING),
957 XRT_INPUT_HT_UNOBSTRUCTED_RIGHT = XRT_INPUT_NAME(0x0003, HAND_TRACKING),
958 XRT_INPUT_HT_CONFORMING_LEFT = XRT_INPUT_NAME(0x0004, HAND_TRACKING),
959 XRT_INPUT_HT_CONFORMING_RIGHT = XRT_INPUT_NAME(0x0005, HAND_TRACKING),
960 XRT_INPUT_GENERIC_TRACKER_POSE = XRT_INPUT_NAME(0x0006, POSE),
961 //! XR_EXT_palm_pose
963
964 //! XR_EXT_eye_gaze_interaction
966 // Standard non-view reference spaces
967 XRT_INPUT_GENERIC_LOCAL_SPACE_POSE = XRT_INPUT_NAME(0x0009, POSE),
968 XRT_INPUT_GENERIC_LOCAL_FLOOR_SPACE_POSE = XRT_INPUT_NAME(0x000A, POSE),
969 XRT_INPUT_GENERIC_STAGE_SPACE_POSE = XRT_INPUT_NAME(0x000B, POSE),
970 XRT_INPUT_GENERIC_UNBOUNDED_SPACE_POSE = XRT_INPUT_NAME(0x000C, POSE),
971
972 XRT_INPUT_SIMPLE_SELECT_CLICK = XRT_INPUT_NAME(0x0010, BOOLEAN),
973 XRT_INPUT_SIMPLE_MENU_CLICK = XRT_INPUT_NAME(0x0011, BOOLEAN),
974 XRT_INPUT_SIMPLE_GRIP_POSE = XRT_INPUT_NAME(0x0012, POSE),
975 XRT_INPUT_SIMPLE_AIM_POSE = XRT_INPUT_NAME(0x0013, POSE),
976
977 // XR_KHR_generic_controller
978 XRT_INPUT_GENERIC_PRIMARY_CLICK = XRT_INPUT_NAME(0x0014, BOOLEAN),
979 XRT_INPUT_GENERIC_SECONDARY_CLICK = XRT_INPUT_NAME(0x0015, BOOLEAN),
980 XRT_INPUT_GENERIC_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0016, BOOLEAN),
981 XRT_INPUT_GENERIC_THUMBSTICK = XRT_INPUT_NAME(0x0017, VEC2_MINUS_ONE_TO_ONE),
982 XRT_INPUT_GENERIC_SQUEEZE_VALUE = XRT_INPUT_NAME(0x0018, VEC1_ZERO_TO_ONE),
983 XRT_INPUT_GENERIC_TRIGGER_VALUE = XRT_INPUT_NAME(0x0019, VEC1_ZERO_TO_ONE),
984 XRT_INPUT_GENERIC_GRIP_POSE = XRT_INPUT_NAME(0x001A, POSE),
985 XRT_INPUT_GENERIC_GRIP_SURFACE_POSE = XRT_INPUT_NAME(0x001B, POSE),
986 XRT_INPUT_GENERIC_AIM_POSE = XRT_INPUT_NAME(0x001C, POSE),
987
988 XRT_INPUT_PSMV_PS_CLICK = XRT_INPUT_NAME(0x0020, BOOLEAN),
989 XRT_INPUT_PSMV_MOVE_CLICK = XRT_INPUT_NAME(0x0021, BOOLEAN),
990 XRT_INPUT_PSMV_START_CLICK = XRT_INPUT_NAME(0x0022, BOOLEAN),
991 XRT_INPUT_PSMV_SELECT_CLICK = XRT_INPUT_NAME(0x0023, BOOLEAN),
992 XRT_INPUT_PSMV_SQUARE_CLICK = XRT_INPUT_NAME(0x0024, BOOLEAN),
993 XRT_INPUT_PSMV_CROSS_CLICK = XRT_INPUT_NAME(0x0025, BOOLEAN),
994 XRT_INPUT_PSMV_CIRCLE_CLICK = XRT_INPUT_NAME(0x0026, BOOLEAN),
995 XRT_INPUT_PSMV_TRIANGLE_CLICK = XRT_INPUT_NAME(0x0027, BOOLEAN),
996 XRT_INPUT_PSMV_TRIGGER_VALUE = XRT_INPUT_NAME(0x0028, VEC1_ZERO_TO_ONE),
997 XRT_INPUT_PSMV_GRIP_POSE = XRT_INPUT_NAME(0x0029, POSE),
998 XRT_INPUT_PSMV_AIM_POSE = XRT_INPUT_NAME(0x002A, POSE),
999 XRT_INPUT_PSMV_BODY_CENTER_POSE = XRT_INPUT_NAME(0x002B, POSE),
1000 XRT_INPUT_PSMV_BALL_CENTER_POSE = XRT_INPUT_NAME(0x002C, POSE),
1001
1002 XRT_INPUT_HYDRA_1_CLICK = XRT_INPUT_NAME(0x0030, BOOLEAN),
1003 XRT_INPUT_HYDRA_2_CLICK = XRT_INPUT_NAME(0x0031, BOOLEAN),
1004 XRT_INPUT_HYDRA_3_CLICK = XRT_INPUT_NAME(0x0032, BOOLEAN),
1005 XRT_INPUT_HYDRA_4_CLICK = XRT_INPUT_NAME(0x0033, BOOLEAN),
1006 XRT_INPUT_HYDRA_MIDDLE_CLICK = XRT_INPUT_NAME(0x0034, BOOLEAN),
1007 XRT_INPUT_HYDRA_BUMPER_CLICK = XRT_INPUT_NAME(0x0035, BOOLEAN),
1008 XRT_INPUT_HYDRA_JOYSTICK_CLICK = XRT_INPUT_NAME(0x0036, BOOLEAN),
1009 XRT_INPUT_HYDRA_JOYSTICK_VALUE = XRT_INPUT_NAME(0x0037, VEC2_MINUS_ONE_TO_ONE),
1010 XRT_INPUT_HYDRA_TRIGGER_VALUE = XRT_INPUT_NAME(0x0038, VEC1_ZERO_TO_ONE),
1011 XRT_INPUT_HYDRA_AIM_POSE = XRT_INPUT_NAME(0x0039, POSE),
1012 XRT_INPUT_HYDRA_GRIP_POSE = XRT_INPUT_NAME(0x0040, POSE),
1013
1014 XRT_INPUT_DAYDREAM_TOUCHPAD_CLICK = XRT_INPUT_NAME(0x0040, BOOLEAN),
1015 XRT_INPUT_DAYDREAM_BAR_CLICK = XRT_INPUT_NAME(0x0041, BOOLEAN),
1016 XRT_INPUT_DAYDREAM_CIRCLE_CLICK = XRT_INPUT_NAME(0x0042, BOOLEAN),
1017 XRT_INPUT_DAYDREAM_VOLUP_CLICK = XRT_INPUT_NAME(0x0043, BOOLEAN),
1018 XRT_INPUT_DAYDREAM_VOLDN_CLICK = XRT_INPUT_NAME(0x0044, BOOLEAN),
1019 XRT_INPUT_DAYDREAM_TOUCHPAD = XRT_INPUT_NAME(0x0045, VEC2_MINUS_ONE_TO_ONE),
1020 XRT_INPUT_DAYDREAM_POSE = XRT_INPUT_NAME(0x0046, POSE),
1021 XRT_INPUT_DAYDREAM_TOUCHPAD_TOUCH = XRT_INPUT_NAME(0x0047, BOOLEAN),
1022
1023 XRT_INPUT_INDEX_SYSTEM_CLICK = XRT_INPUT_NAME(0x0050, BOOLEAN),
1024 XRT_INPUT_INDEX_SYSTEM_TOUCH = XRT_INPUT_NAME(0x0051, BOOLEAN),
1025 XRT_INPUT_INDEX_A_CLICK = XRT_INPUT_NAME(0x0052, BOOLEAN),
1026 XRT_INPUT_INDEX_A_TOUCH = XRT_INPUT_NAME(0x0053, BOOLEAN),
1027 XRT_INPUT_INDEX_B_CLICK = XRT_INPUT_NAME(0x0054, BOOLEAN),
1028 XRT_INPUT_INDEX_B_TOUCH = XRT_INPUT_NAME(0x0055, BOOLEAN),
1029 XRT_INPUT_INDEX_SQUEEZE_VALUE = XRT_INPUT_NAME(0x0056, VEC1_ZERO_TO_ONE),
1030 XRT_INPUT_INDEX_SQUEEZE_FORCE = XRT_INPUT_NAME(0x0057, VEC1_ZERO_TO_ONE),
1031 XRT_INPUT_INDEX_TRIGGER_CLICK = XRT_INPUT_NAME(0x0058, BOOLEAN),
1032 XRT_INPUT_INDEX_TRIGGER_VALUE = XRT_INPUT_NAME(0x0059, VEC1_ZERO_TO_ONE),
1033 XRT_INPUT_INDEX_TRIGGER_TOUCH = XRT_INPUT_NAME(0x005A, BOOLEAN),
1034 XRT_INPUT_INDEX_THUMBSTICK = XRT_INPUT_NAME(0x005B, VEC2_MINUS_ONE_TO_ONE),
1035 XRT_INPUT_INDEX_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x005D, BOOLEAN),
1036 XRT_INPUT_INDEX_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x005E, BOOLEAN),
1037 XRT_INPUT_INDEX_TRACKPAD = XRT_INPUT_NAME(0x005F, VEC2_MINUS_ONE_TO_ONE),
1038 XRT_INPUT_INDEX_TRACKPAD_FORCE = XRT_INPUT_NAME(0x0061, VEC1_ZERO_TO_ONE),
1039 XRT_INPUT_INDEX_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0062, BOOLEAN),
1040 XRT_INPUT_INDEX_GRIP_POSE = XRT_INPUT_NAME(0x0063, POSE),
1041 XRT_INPUT_INDEX_AIM_POSE = XRT_INPUT_NAME(0x0064, POSE),
1042
1043 XRT_INPUT_VIVE_SYSTEM_CLICK = XRT_INPUT_NAME(0x0070, BOOLEAN),
1044 XRT_INPUT_VIVE_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0071, BOOLEAN),
1045 XRT_INPUT_VIVE_MENU_CLICK = XRT_INPUT_NAME(0x0072, BOOLEAN),
1046 XRT_INPUT_VIVE_TRIGGER_CLICK = XRT_INPUT_NAME(0x0073, BOOLEAN),
1047 XRT_INPUT_VIVE_TRIGGER_VALUE = XRT_INPUT_NAME(0x0074, VEC1_ZERO_TO_ONE),
1048 XRT_INPUT_VIVE_TRACKPAD = XRT_INPUT_NAME(0x0075, VEC2_MINUS_ONE_TO_ONE),
1049 XRT_INPUT_VIVE_TRACKPAD_CLICK = XRT_INPUT_NAME(0x0076, BOOLEAN),
1050 XRT_INPUT_VIVE_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0077, BOOLEAN),
1051 XRT_INPUT_VIVE_GRIP_POSE = XRT_INPUT_NAME(0x0078, POSE),
1052 XRT_INPUT_VIVE_AIM_POSE = XRT_INPUT_NAME(0x0079, POSE),
1053
1054 XRT_INPUT_VIVEPRO_SYSTEM_CLICK = XRT_INPUT_NAME(0x0080, BOOLEAN),
1055 XRT_INPUT_VIVEPRO_VOLUP_CLICK = XRT_INPUT_NAME(0x0081, BOOLEAN),
1056 XRT_INPUT_VIVEPRO_VOLDN_CLICK = XRT_INPUT_NAME(0x0082, BOOLEAN),
1057 XRT_INPUT_VIVEPRO_MUTE_MIC_CLICK = XRT_INPUT_NAME(0x0083, BOOLEAN),
1058
1059 XRT_INPUT_WMR_MENU_CLICK = XRT_INPUT_NAME(0x0090, BOOLEAN),
1060 XRT_INPUT_WMR_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0091, BOOLEAN),
1061 XRT_INPUT_WMR_TRIGGER_VALUE = XRT_INPUT_NAME(0x0092, VEC1_ZERO_TO_ONE),
1062 XRT_INPUT_WMR_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0093, BOOLEAN),
1063 XRT_INPUT_WMR_THUMBSTICK = XRT_INPUT_NAME(0x0094, VEC2_MINUS_ONE_TO_ONE),
1064 XRT_INPUT_WMR_TRACKPAD_CLICK = XRT_INPUT_NAME(0x0095, BOOLEAN),
1065 XRT_INPUT_WMR_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0096, BOOLEAN),
1066 XRT_INPUT_WMR_TRACKPAD = XRT_INPUT_NAME(0x0097, VEC2_MINUS_ONE_TO_ONE),
1067 XRT_INPUT_WMR_GRIP_POSE = XRT_INPUT_NAME(0x0098, POSE),
1068 XRT_INPUT_WMR_AIM_POSE = XRT_INPUT_NAME(0x0099, POSE),
1069 XRT_INPUT_WMR_HOME_CLICK = XRT_INPUT_NAME(0x009A, BOOLEAN),
1070
1071 XRT_INPUT_XBOX_MENU_CLICK = XRT_INPUT_NAME(0x00A0, BOOLEAN),
1072 XRT_INPUT_XBOX_VIEW_CLICK = XRT_INPUT_NAME(0x00A1, BOOLEAN),
1073 XRT_INPUT_XBOX_A_CLICK = XRT_INPUT_NAME(0x00A2, BOOLEAN),
1074 XRT_INPUT_XBOX_B_CLICK = XRT_INPUT_NAME(0x00A3, BOOLEAN),
1075 XRT_INPUT_XBOX_X_CLICK = XRT_INPUT_NAME(0x00A4, BOOLEAN),
1076 XRT_INPUT_XBOX_Y_CLICK = XRT_INPUT_NAME(0x00A5, BOOLEAN),
1077 XRT_INPUT_XBOX_DPAD_DOWN_CLICK = XRT_INPUT_NAME(0x00A6, BOOLEAN),
1078 XRT_INPUT_XBOX_DPAD_RIGHT_CLICK = XRT_INPUT_NAME(0x00A7, BOOLEAN),
1079 XRT_INPUT_XBOX_DPAD_UP_CLICK = XRT_INPUT_NAME(0x00A8, BOOLEAN),
1080 XRT_INPUT_XBOX_DPAD_LEFT_CLICK = XRT_INPUT_NAME(0x00A9, BOOLEAN),
1081 XRT_INPUT_XBOX_SHOULDER_LEFT_CLICK = XRT_INPUT_NAME(0x00AA, BOOLEAN),
1082 XRT_INPUT_XBOX_SHOULDER_RIGHT_CLICK = XRT_INPUT_NAME(0x00AB, BOOLEAN),
1083 XRT_INPUT_XBOX_THUMBSTICK_LEFT_CLICK = XRT_INPUT_NAME(0x00AC, BOOLEAN),
1084 XRT_INPUT_XBOX_THUMBSTICK_LEFT = XRT_INPUT_NAME(0x00AD, VEC2_MINUS_ONE_TO_ONE),
1085 XRT_INPUT_XBOX_THUMBSTICK_RIGHT_CLICK = XRT_INPUT_NAME(0x00AE, BOOLEAN),
1086 XRT_INPUT_XBOX_THUMBSTICK_RIGHT = XRT_INPUT_NAME(0x00AF, VEC2_MINUS_ONE_TO_ONE),
1087 XRT_INPUT_XBOX_LEFT_TRIGGER_VALUE = XRT_INPUT_NAME(0x00B0, VEC1_ZERO_TO_ONE),
1088 XRT_INPUT_XBOX_RIGHT_TRIGGER_VALUE = XRT_INPUT_NAME(0x00B1, VEC1_ZERO_TO_ONE),
1089
1090 XRT_INPUT_GO_SYSTEM_CLICK = XRT_INPUT_NAME(0x00B0, BOOLEAN),
1091 XRT_INPUT_GO_TRIGGER_CLICK = XRT_INPUT_NAME(0x00B1, BOOLEAN),
1092 XRT_INPUT_GO_BACK_CLICK = XRT_INPUT_NAME(0x00B2, BOOLEAN),
1093 XRT_INPUT_GO_TRACKPAD_CLICK = XRT_INPUT_NAME(0x00B3, BOOLEAN),
1094 XRT_INPUT_GO_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x00B4, BOOLEAN),
1095 XRT_INPUT_GO_TRACKPAD = XRT_INPUT_NAME(0x00B5, VEC2_MINUS_ONE_TO_ONE),
1096 XRT_INPUT_GO_GRIP_POSE = XRT_INPUT_NAME(0x00B6, POSE),
1097 XRT_INPUT_GO_AIM_POSE = XRT_INPUT_NAME(0x00B7, POSE),
1098
1099 XRT_INPUT_TOUCH_X_CLICK = XRT_INPUT_NAME(0x00C0, BOOLEAN),
1100 XRT_INPUT_TOUCH_X_TOUCH = XRT_INPUT_NAME(0x00C1, BOOLEAN),
1101 XRT_INPUT_TOUCH_Y_CLICK = XRT_INPUT_NAME(0x00C2, BOOLEAN),
1102 XRT_INPUT_TOUCH_Y_TOUCH = XRT_INPUT_NAME(0x00C3, BOOLEAN),
1103 XRT_INPUT_TOUCH_MENU_CLICK = XRT_INPUT_NAME(0x00C4, BOOLEAN),
1104 XRT_INPUT_TOUCH_A_CLICK = XRT_INPUT_NAME(0x00C5, BOOLEAN),
1105 XRT_INPUT_TOUCH_A_TOUCH = XRT_INPUT_NAME(0x00C6, BOOLEAN),
1106 XRT_INPUT_TOUCH_B_CLICK = XRT_INPUT_NAME(0x00C7, BOOLEAN),
1107 XRT_INPUT_TOUCH_B_TOUCH = XRT_INPUT_NAME(0x00C8, BOOLEAN),
1108 XRT_INPUT_TOUCH_SYSTEM_CLICK = XRT_INPUT_NAME(0x00C9, BOOLEAN),
1109 XRT_INPUT_TOUCH_SQUEEZE_VALUE = XRT_INPUT_NAME(0x00CA, VEC1_ZERO_TO_ONE),
1110 XRT_INPUT_TOUCH_TRIGGER_TOUCH = XRT_INPUT_NAME(0x00CB, BOOLEAN),
1111 XRT_INPUT_TOUCH_TRIGGER_VALUE = XRT_INPUT_NAME(0x00CC, VEC1_ZERO_TO_ONE),
1112 XRT_INPUT_TOUCH_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x00CD, BOOLEAN),
1113 XRT_INPUT_TOUCH_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x00CE, BOOLEAN),
1114 XRT_INPUT_TOUCH_THUMBSTICK = XRT_INPUT_NAME(0x00CF, VEC2_MINUS_ONE_TO_ONE),
1115 XRT_INPUT_TOUCH_THUMBREST_TOUCH = XRT_INPUT_NAME(0x00D0, BOOLEAN),
1116 XRT_INPUT_TOUCH_GRIP_POSE = XRT_INPUT_NAME(0x00D1, POSE),
1117 XRT_INPUT_TOUCH_AIM_POSE = XRT_INPUT_NAME(0x00D2, POSE),
1118 XRT_INPUT_TOUCH_TRIGGER_PROXIMITY = XRT_INPUT_NAME(0x00D3, BOOLEAN),
1119 XRT_INPUT_TOUCH_THUMB_PROXIMITY = XRT_INPUT_NAME(0x00D4, BOOLEAN),
1120
1121 XRT_INPUT_HAND_SELECT_VALUE = XRT_INPUT_NAME(0x00E0, VEC1_ZERO_TO_ONE),
1122 XRT_INPUT_HAND_SQUEEZE_VALUE = XRT_INPUT_NAME(0x00E1, VEC1_ZERO_TO_ONE),
1123 XRT_INPUT_HAND_GRIP_POSE = XRT_INPUT_NAME(0x00E2, POSE),
1124 XRT_INPUT_HAND_AIM_POSE = XRT_INPUT_NAME(0x00E3, POSE),
1125
1126 XRT_INPUT_G2_CONTROLLER_X_CLICK = XRT_INPUT_NAME(0x00F0, BOOLEAN),
1127 XRT_INPUT_G2_CONTROLLER_Y_CLICK = XRT_INPUT_NAME(0x00F1, BOOLEAN),
1128 XRT_INPUT_G2_CONTROLLER_A_CLICK = XRT_INPUT_NAME(0x00F2, BOOLEAN),
1129 XRT_INPUT_G2_CONTROLLER_B_CLICK = XRT_INPUT_NAME(0x00F3, BOOLEAN),
1130 XRT_INPUT_G2_CONTROLLER_MENU_CLICK = XRT_INPUT_NAME(0x00F4, BOOLEAN),
1131 XRT_INPUT_G2_CONTROLLER_SQUEEZE_VALUE = XRT_INPUT_NAME(0x00F5, VEC1_ZERO_TO_ONE),
1132 XRT_INPUT_G2_CONTROLLER_TRIGGER_VALUE = XRT_INPUT_NAME(0x00F6, VEC1_ZERO_TO_ONE),
1133 XRT_INPUT_G2_CONTROLLER_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x00F7, BOOLEAN),
1134 XRT_INPUT_G2_CONTROLLER_THUMBSTICK = XRT_INPUT_NAME(0x00F8, VEC2_MINUS_ONE_TO_ONE),
1135 XRT_INPUT_G2_CONTROLLER_GRIP_POSE = XRT_INPUT_NAME(0x00F9, POSE),
1136 XRT_INPUT_G2_CONTROLLER_AIM_POSE = XRT_INPUT_NAME(0x00FA, POSE),
1137 XRT_INPUT_G2_CONTROLLER_HOME_CLICK = XRT_INPUT_NAME(0x00FB, BOOLEAN),
1138 XRT_INPUT_G2_CONTROLLER_SQUEEZE_CLICK = XRT_INPUT_NAME(0x00FC, BOOLEAN),
1139
1140 XRT_INPUT_ODYSSEY_CONTROLLER_MENU_CLICK = XRT_INPUT_NAME(0x0100, BOOLEAN),
1141 XRT_INPUT_ODYSSEY_CONTROLLER_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0101, BOOLEAN),
1142 XRT_INPUT_ODYSSEY_CONTROLLER_TRIGGER_VALUE = XRT_INPUT_NAME(0x0102, VEC1_ZERO_TO_ONE),
1143 XRT_INPUT_ODYSSEY_CONTROLLER_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0103, BOOLEAN),
1144 XRT_INPUT_ODYSSEY_CONTROLLER_THUMBSTICK = XRT_INPUT_NAME(0x0104, VEC2_MINUS_ONE_TO_ONE),
1145 XRT_INPUT_ODYSSEY_CONTROLLER_TRACKPAD_CLICK = XRT_INPUT_NAME(0x0105, BOOLEAN),
1146 XRT_INPUT_ODYSSEY_CONTROLLER_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0106, BOOLEAN),
1147 XRT_INPUT_ODYSSEY_CONTROLLER_TRACKPAD = XRT_INPUT_NAME(0x0107, VEC2_MINUS_ONE_TO_ONE),
1148 XRT_INPUT_ODYSSEY_CONTROLLER_GRIP_POSE = XRT_INPUT_NAME(0x0108, POSE),
1149 XRT_INPUT_ODYSSEY_CONTROLLER_AIM_POSE = XRT_INPUT_NAME(0x0109, POSE),
1150 XRT_INPUT_ODYSSEY_CONTROLLER_HOME_CLICK = XRT_INPUT_NAME(0x010A, BOOLEAN),
1151
1152 XRT_INPUT_ML2_CONTROLLER_MENU_CLICK = XRT_INPUT_NAME(0x0200, BOOLEAN),
1153 XRT_INPUT_ML2_CONTROLLER_SELECT_CLICK = XRT_INPUT_NAME(0x0201, BOOLEAN),
1154 XRT_INPUT_ML2_CONTROLLER_TRIGGER_CLICK = XRT_INPUT_NAME(0x0202, BOOLEAN),
1155 XRT_INPUT_ML2_CONTROLLER_TRIGGER_VALUE = XRT_INPUT_NAME(0x0203, VEC1_ZERO_TO_ONE),
1156 XRT_INPUT_ML2_CONTROLLER_TRACKPAD_CLICK = XRT_INPUT_NAME(0x0204, BOOLEAN),
1157 XRT_INPUT_ML2_CONTROLLER_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0205, BOOLEAN),
1158 XRT_INPUT_ML2_CONTROLLER_TRACKPAD_FORCE = XRT_INPUT_NAME(0x0206, VEC1_ZERO_TO_ONE),
1159 XRT_INPUT_ML2_CONTROLLER_TRACKPAD = XRT_INPUT_NAME(0x0207, VEC2_MINUS_ONE_TO_ONE),
1160 XRT_INPUT_ML2_CONTROLLER_GRIP_POSE = XRT_INPUT_NAME(0x0208, POSE),
1161 XRT_INPUT_ML2_CONTROLLER_AIM_POSE = XRT_INPUT_NAME(0x0209, POSE),
1162 XRT_INPUT_ML2_CONTROLLER_SHOULDER_CLICK = XRT_INPUT_NAME(0x020A, BOOLEAN),
1163
1164 XRT_INPUT_VIVE_TRACKER_SYSTEM_CLICK = XRT_INPUT_NAME(0x0210, BOOLEAN),
1165 XRT_INPUT_VIVE_TRACKER_MENU_CLICK = XRT_INPUT_NAME(0x0211, BOOLEAN),
1166 XRT_INPUT_VIVE_TRACKER_TRIGGER_CLICK = XRT_INPUT_NAME(0x0212, BOOLEAN),
1167 XRT_INPUT_VIVE_TRACKER_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0213, BOOLEAN),
1168 XRT_INPUT_VIVE_TRACKER_TRIGGER_VALUE = XRT_INPUT_NAME(0x0214, VEC1_ZERO_TO_ONE),
1169 XRT_INPUT_VIVE_TRACKER_TRACKPAD = XRT_INPUT_NAME(0x0215, VEC2_MINUS_ONE_TO_ONE),
1170 XRT_INPUT_VIVE_TRACKER_TRACKPAD_CLICK = XRT_INPUT_NAME(0x0216, BOOLEAN),
1171 XRT_INPUT_VIVE_TRACKER_TRACKPAD_TOUCH = XRT_INPUT_NAME(0x0217, BOOLEAN),
1172 XRT_INPUT_VIVE_TRACKER_GRIP_POSE = XRT_INPUT_NAME(0x0218, POSE),
1173
1174 XRT_INPUT_PSSENSE_PS_CLICK = XRT_INPUT_NAME(0x0300, BOOLEAN),
1175 XRT_INPUT_PSSENSE_SHARE_CLICK = XRT_INPUT_NAME(0x0301, BOOLEAN),
1176 XRT_INPUT_PSSENSE_OPTIONS_CLICK = XRT_INPUT_NAME(0x0302, BOOLEAN),
1177 XRT_INPUT_PSSENSE_SQUARE_CLICK = XRT_INPUT_NAME(0x0303, BOOLEAN),
1178 XRT_INPUT_PSSENSE_SQUARE_TOUCH = XRT_INPUT_NAME(0x0304, BOOLEAN),
1179 XRT_INPUT_PSSENSE_TRIANGLE_CLICK = XRT_INPUT_NAME(0x0305, BOOLEAN),
1180 XRT_INPUT_PSSENSE_TRIANGLE_TOUCH = XRT_INPUT_NAME(0x0306, BOOLEAN),
1181 XRT_INPUT_PSSENSE_CROSS_CLICK = XRT_INPUT_NAME(0x0307, BOOLEAN),
1182 XRT_INPUT_PSSENSE_CROSS_TOUCH = XRT_INPUT_NAME(0x0308, BOOLEAN),
1183 XRT_INPUT_PSSENSE_CIRCLE_CLICK = XRT_INPUT_NAME(0x0309, BOOLEAN),
1184 XRT_INPUT_PSSENSE_CIRCLE_TOUCH = XRT_INPUT_NAME(0x030a, BOOLEAN),
1185 XRT_INPUT_PSSENSE_SQUEEZE_CLICK = XRT_INPUT_NAME(0x030b, BOOLEAN),
1186 XRT_INPUT_PSSENSE_SQUEEZE_TOUCH = XRT_INPUT_NAME(0x030c, BOOLEAN),
1187 XRT_INPUT_PSSENSE_SQUEEZE_PROXIMITY = XRT_INPUT_NAME(0x030d, BOOLEAN),
1188 XRT_INPUT_PSSENSE_SQUEEZE_PROXIMITY_FLOAT = XRT_INPUT_NAME(0x030e, VEC1_ZERO_TO_ONE),
1189 XRT_INPUT_PSSENSE_TRIGGER_CLICK = XRT_INPUT_NAME(0x030f, BOOLEAN),
1190 XRT_INPUT_PSSENSE_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0310, BOOLEAN),
1191 XRT_INPUT_PSSENSE_TRIGGER_VALUE = XRT_INPUT_NAME(0x0311, VEC1_ZERO_TO_ONE),
1192 XRT_INPUT_PSSENSE_TRIGGER_PROXIMITY = XRT_INPUT_NAME(0x0312, BOOLEAN),
1193 XRT_INPUT_PSSENSE_TRIGGER_PROXIMITY_FLOAT = XRT_INPUT_NAME(0x0313, VEC1_ZERO_TO_ONE),
1194 XRT_INPUT_PSSENSE_THUMBSTICK = XRT_INPUT_NAME(0x0314, VEC2_MINUS_ONE_TO_ONE),
1195 XRT_INPUT_PSSENSE_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0315, BOOLEAN),
1196 XRT_INPUT_PSSENSE_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0316, BOOLEAN),
1197 XRT_INPUT_PSSENSE_GRIP_POSE = XRT_INPUT_NAME(0x0317, POSE),
1198 XRT_INPUT_PSSENSE_AIM_POSE = XRT_INPUT_NAME(0x0318, POSE),
1199
1200 // XR_EXT_hand_interaction
1201 XRT_INPUT_HAND_PINCH_POSE = XRT_INPUT_NAME(0x0401, POSE),
1202 XRT_INPUT_HAND_POKE_POSE = XRT_INPUT_NAME(0x0402, POSE),
1203 XRT_INPUT_HAND_PINCH_VALUE = XRT_INPUT_NAME(0x0403, VEC1_ZERO_TO_ONE),
1204 XRT_INPUT_HAND_AIM_ACTIVATE_VALUE = XRT_INPUT_NAME(0x0404, VEC1_ZERO_TO_ONE),
1205 XRT_INPUT_HAND_GRASP_VALUE = XRT_INPUT_NAME(0x0405, VEC1_ZERO_TO_ONE),
1206 XRT_INPUT_HAND_PINCH_READY = XRT_INPUT_NAME(0x0406, BOOLEAN),
1207 XRT_INPUT_HAND_AIM_ACTIVATE_READY = XRT_INPUT_NAME(0x0407, BOOLEAN),
1208 XRT_INPUT_HAND_GRASP_READY = XRT_INPUT_NAME(0x0408, BOOLEAN),
1209
1210 XRT_INPUT_OPPO_MR_X_CLICK = XRT_INPUT_NAME(0x0500, BOOLEAN),
1211 XRT_INPUT_OPPO_MR_X_TOUCH = XRT_INPUT_NAME(0x0501, BOOLEAN),
1212 XRT_INPUT_OPPO_MR_Y_CLICK = XRT_INPUT_NAME(0x0502, BOOLEAN),
1213 XRT_INPUT_OPPO_MR_Y_TOUCH = XRT_INPUT_NAME(0x0503, BOOLEAN),
1214 XRT_INPUT_OPPO_MR_MENU_CLICK = XRT_INPUT_NAME(0x0504, BOOLEAN),
1215 XRT_INPUT_OPPO_MR_HEART_RATE_VALUE = XRT_INPUT_NAME(0x0505, VEC1_ZERO_TO_ONE),
1216 XRT_INPUT_OPPO_MR_A_CLICK = XRT_INPUT_NAME(0x0506, BOOLEAN),
1217 XRT_INPUT_OPPO_MR_A_TOUCH = XRT_INPUT_NAME(0x0507, BOOLEAN),
1218 XRT_INPUT_OPPO_MR_B_CLICK = XRT_INPUT_NAME(0x0508, BOOLEAN),
1219 XRT_INPUT_OPPO_MR_B_TOUCH = XRT_INPUT_NAME(0x0509, BOOLEAN),
1220 XRT_INPUT_OPPO_MR_HOME_CLICK = XRT_INPUT_NAME(0x050A, BOOLEAN),
1221 XRT_INPUT_OPPO_MR_SQUEEZE_VALUE = XRT_INPUT_NAME(0x050B, VEC1_ZERO_TO_ONE),
1222 XRT_INPUT_OPPO_MR_TRIGGER_TOUCH = XRT_INPUT_NAME(0x050C, BOOLEAN),
1223 XRT_INPUT_OPPO_MR_TRIGGER_VALUE = XRT_INPUT_NAME(0x050D, VEC1_ZERO_TO_ONE),
1224 XRT_INPUT_OPPO_MR_GRIP_POSE = XRT_INPUT_NAME(0x050E, POSE),
1225 XRT_INPUT_OPPO_MR_AIM_POSE = XRT_INPUT_NAME(0x050F, POSE),
1226 XRT_INPUT_OPPO_MR_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0510, BOOLEAN),
1227 XRT_INPUT_OPPO_MR_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0511, BOOLEAN),
1228 XRT_INPUT_OPPO_MR_THUMBSTICK = XRT_INPUT_NAME(0x0512, VEC2_MINUS_ONE_TO_ONE),
1229
1230 XRT_INPUT_GENERIC_FACE_TRACKING = XRT_INPUT_NAME(0x0600, FACE_TRACKING),
1231
1232 XRT_INPUT_HTC_EYE_FACE_TRACKING = XRT_INPUT_NAME(0x0601, FACE_TRACKING),
1233 XRT_INPUT_HTC_LIP_FACE_TRACKING = XRT_INPUT_NAME(0x0602, FACE_TRACKING),
1234 XRT_INPUT_FB_FACE_TRACKING2_AUDIO = XRT_INPUT_NAME(0x0603, FACE_TRACKING),
1235 XRT_INPUT_FB_FACE_TRACKING2_VISUAL = XRT_INPUT_NAME(0x0604, FACE_TRACKING),
1236 XRT_INPUT_ANDROID_FACE_TRACKING = XRT_INPUT_NAME(0x0605, FACE_TRACKING),
1237
1238 XRT_INPUT_GENERIC_BODY_TRACKING = XRT_INPUT_NAME(0x0700, BODY_TRACKING),
1239 XRT_INPUT_FB_BODY_TRACKING = XRT_INPUT_NAME(0x0701, BODY_TRACKING),
1240 XRT_INPUT_META_FULL_BODY_TRACKING = XRT_INPUT_NAME(0x0702, BODY_TRACKING),
1241 XRT_INPUT_BD_BODY_TRACKING = XRT_INPUT_NAME(0x0703, BODY_TRACKING),
1242 XRT_INPUT_BD_BODY_TRACKING_WITHOUT_ARM = XRT_INPUT_NAME(0x0704, BODY_TRACKING),
1243
1244 XRT_INPUT_PICO_NEO3_X_CLICK = XRT_INPUT_NAME(0x0800, BOOLEAN),
1245 XRT_INPUT_PICO_NEO3_X_TOUCH = XRT_INPUT_NAME(0x0801, BOOLEAN),
1246 XRT_INPUT_PICO_NEO3_Y_CLICK = XRT_INPUT_NAME(0x0802, BOOLEAN),
1247 XRT_INPUT_PICO_NEO3_Y_TOUCH = XRT_INPUT_NAME(0x0803, BOOLEAN),
1248 XRT_INPUT_PICO_NEO3_MENU_CLICK = XRT_INPUT_NAME(0x0804, BOOLEAN),
1249 XRT_INPUT_PICO_NEO3_SYSTEM_CLICK = XRT_INPUT_NAME(0x0805, BOOLEAN),
1250 XRT_INPUT_PICO_NEO3_TRIGGER_CLICK = XRT_INPUT_NAME(0x0806, BOOLEAN),
1251 XRT_INPUT_PICO_NEO3_TRIGGER_VALUE = XRT_INPUT_NAME(0x0807, VEC1_ZERO_TO_ONE),
1252 XRT_INPUT_PICO_NEO3_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0808, BOOLEAN),
1253 XRT_INPUT_PICO_NEO3_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0809, BOOLEAN),
1254 XRT_INPUT_PICO_NEO3_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x080A, BOOLEAN),
1255 XRT_INPUT_PICO_NEO3_THUMBSTICK = XRT_INPUT_NAME(0x080B, VEC2_MINUS_ONE_TO_ONE),
1256 XRT_INPUT_PICO_NEO3_SQUEEZE_CLICK = XRT_INPUT_NAME(0x080C, BOOLEAN),
1257 XRT_INPUT_PICO_NEO3_SQUEEZE_VALUE = XRT_INPUT_NAME(0x080D, VEC1_ZERO_TO_ONE),
1258 XRT_INPUT_PICO_NEO3_GRIP_POSE = XRT_INPUT_NAME(0x080E, POSE),
1259 XRT_INPUT_PICO_NEO3_AIM_POSE = XRT_INPUT_NAME(0x080F, POSE),
1260 XRT_INPUT_PICO_NEO3_A_CLICK = XRT_INPUT_NAME(0x0810, BOOLEAN),
1261 XRT_INPUT_PICO_NEO3_A_TOUCH = XRT_INPUT_NAME(0x0811, BOOLEAN),
1262 XRT_INPUT_PICO_NEO3_B_CLICK = XRT_INPUT_NAME(0x0812, BOOLEAN),
1263 XRT_INPUT_PICO_NEO3_B_TOUCH = XRT_INPUT_NAME(0x0813, BOOLEAN),
1264
1265 XRT_INPUT_PICO4_X_CLICK = XRT_INPUT_NAME(0x0900, BOOLEAN),
1266 XRT_INPUT_PICO4_X_TOUCH = XRT_INPUT_NAME(0x0901, BOOLEAN),
1267 XRT_INPUT_PICO4_Y_CLICK = XRT_INPUT_NAME(0x0902, BOOLEAN),
1268 XRT_INPUT_PICO4_Y_TOUCH = XRT_INPUT_NAME(0x0903, BOOLEAN),
1269 XRT_INPUT_PICO4_SYSTEM_CLICK = XRT_INPUT_NAME(0x0905, BOOLEAN),
1270 XRT_INPUT_PICO4_TRIGGER_CLICK = XRT_INPUT_NAME(0x0906, BOOLEAN),
1271 XRT_INPUT_PICO4_TRIGGER_VALUE = XRT_INPUT_NAME(0x0907, VEC1_ZERO_TO_ONE),
1272 XRT_INPUT_PICO4_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0908, BOOLEAN),
1273 XRT_INPUT_PICO4_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0909, BOOLEAN),
1274 XRT_INPUT_PICO4_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x090A, BOOLEAN),
1275 XRT_INPUT_PICO4_THUMBSTICK = XRT_INPUT_NAME(0x090B, VEC2_MINUS_ONE_TO_ONE),
1276 XRT_INPUT_PICO4_SQUEEZE_CLICK = XRT_INPUT_NAME(0x090C, BOOLEAN),
1277 XRT_INPUT_PICO4_SQUEEZE_VALUE = XRT_INPUT_NAME(0x090D, VEC1_ZERO_TO_ONE),
1278 XRT_INPUT_PICO4_GRIP_POSE = XRT_INPUT_NAME(0x090E, POSE),
1279 XRT_INPUT_PICO4_AIM_POSE = XRT_INPUT_NAME(0x090F, POSE),
1280 XRT_INPUT_PICO4_A_CLICK = XRT_INPUT_NAME(0x0910, BOOLEAN),
1281 XRT_INPUT_PICO4_A_TOUCH = XRT_INPUT_NAME(0x0911, BOOLEAN),
1282 XRT_INPUT_PICO4_B_CLICK = XRT_INPUT_NAME(0x0912, BOOLEAN),
1283 XRT_INPUT_PICO4_B_TOUCH = XRT_INPUT_NAME(0x0913, BOOLEAN),
1284 XRT_INPUT_PICO4_MENU_CLICK = XRT_INPUT_NAME(0x0914, BOOLEAN),
1285
1286 XRT_INPUT_PICO_G3_MENU_CLICK = XRT_INPUT_NAME(0x0A01, BOOLEAN),
1287 XRT_INPUT_PICO_G3_TRIGGER_CLICK = XRT_INPUT_NAME(0x0A02, BOOLEAN),
1288 XRT_INPUT_PICO_G3_TRIGGER_VALUE = XRT_INPUT_NAME(0x0A03, VEC1_ZERO_TO_ONE),
1289 XRT_INPUT_PICO_G3_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0A04, BOOLEAN),
1290 XRT_INPUT_PICO_G3_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0A05, BOOLEAN),
1291 XRT_INPUT_PICO_G3_THUMBSTICK = XRT_INPUT_NAME(0x0A06, VEC2_MINUS_ONE_TO_ONE),
1292 XRT_INPUT_PICO_G3_GRIP_POSE = XRT_INPUT_NAME(0x0A07, POSE),
1293 XRT_INPUT_PICO_G3_AIM_POSE = XRT_INPUT_NAME(0x0A08, POSE),
1294
1295 XRT_INPUT_VIVE_COSMOS_X_CLICK = XRT_INPUT_NAME(0x0B00, BOOLEAN),
1296 XRT_INPUT_VIVE_COSMOS_Y_CLICK = XRT_INPUT_NAME(0x0B01, BOOLEAN),
1297 XRT_INPUT_VIVE_COSMOS_MENU_CLICK = XRT_INPUT_NAME(0x0B02, BOOLEAN),
1298 XRT_INPUT_VIVE_COSMOS_A_CLICK = XRT_INPUT_NAME(0x0B03, BOOLEAN),
1299 XRT_INPUT_VIVE_COSMOS_B_CLICK = XRT_INPUT_NAME(0x0B04, BOOLEAN),
1300 XRT_INPUT_VIVE_COSMOS_SYSTEM_CLICK = XRT_INPUT_NAME(0x0B05, BOOLEAN),
1301 XRT_INPUT_VIVE_COSMOS_SHOULDER_CLICK = XRT_INPUT_NAME(0x0B06, BOOLEAN),
1302 XRT_INPUT_VIVE_COSMOS_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0B07, BOOLEAN),
1303 XRT_INPUT_VIVE_COSMOS_TRIGGER_CLICK = XRT_INPUT_NAME(0x0B08, BOOLEAN),
1304 XRT_INPUT_VIVE_COSMOS_TRIGGER_VALUE = XRT_INPUT_NAME(0x0B09, VEC1_ZERO_TO_ONE),
1305 XRT_INPUT_VIVE_COSMOS_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0B0A, BOOLEAN),
1306 XRT_INPUT_VIVE_COSMOS_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0B0B, BOOLEAN),
1307 XRT_INPUT_VIVE_COSMOS_THUMBSTICK = XRT_INPUT_NAME(0x0B0C, VEC2_MINUS_ONE_TO_ONE),
1308 XRT_INPUT_VIVE_COSMOS_GRIP_POSE = XRT_INPUT_NAME(0x0B0D, POSE),
1309 XRT_INPUT_VIVE_COSMOS_AIM_POSE = XRT_INPUT_NAME(0x0B0E, POSE),
1310
1311 XRT_INPUT_VIVE_FOCUS3_X_CLICK = XRT_INPUT_NAME(0x0C00, BOOLEAN),
1312 XRT_INPUT_VIVE_FOCUS3_Y_CLICK = XRT_INPUT_NAME(0x0C01, BOOLEAN),
1313 XRT_INPUT_VIVE_FOCUS3_MENU_CLICK = XRT_INPUT_NAME(0x0C02, BOOLEAN),
1314 XRT_INPUT_VIVE_FOCUS3_A_CLICK = XRT_INPUT_NAME(0x0C03, BOOLEAN),
1315 XRT_INPUT_VIVE_FOCUS3_B_CLICK = XRT_INPUT_NAME(0x0C04, BOOLEAN),
1316 XRT_INPUT_VIVE_FOCUS3_SYSTEM_CLICK = XRT_INPUT_NAME(0x0C05, BOOLEAN),
1317 XRT_INPUT_VIVE_FOCUS3_SQUEEZE_CLICK = XRT_INPUT_NAME(0x0C06, BOOLEAN),
1318 XRT_INPUT_VIVE_FOCUS3_SQUEEZE_TOUCH = XRT_INPUT_NAME(0x0C07, BOOLEAN),
1319 XRT_INPUT_VIVE_FOCUS3_SQUEEZE_VALUE = XRT_INPUT_NAME(0x0C08, VEC1_ZERO_TO_ONE),
1320 XRT_INPUT_VIVE_FOCUS3_TRIGGER_CLICK = XRT_INPUT_NAME(0x0C09, BOOLEAN),
1321 XRT_INPUT_VIVE_FOCUS3_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0C0A, BOOLEAN),
1322 XRT_INPUT_VIVE_FOCUS3_TRIGGER_VALUE = XRT_INPUT_NAME(0x0C0B, VEC1_ZERO_TO_ONE),
1323 XRT_INPUT_VIVE_FOCUS3_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0C0C, BOOLEAN),
1324 XRT_INPUT_VIVE_FOCUS3_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0C0D, BOOLEAN),
1325 XRT_INPUT_VIVE_FOCUS3_THUMBSTICK = XRT_INPUT_NAME(0x0C0E, VEC2_MINUS_ONE_TO_ONE),
1326 XRT_INPUT_VIVE_FOCUS3_THUMBREST_TOUCH = XRT_INPUT_NAME(0x0C0F, BOOLEAN),
1327 XRT_INPUT_VIVE_FOCUS3_GRIP_POSE = XRT_INPUT_NAME(0x0C10, POSE),
1328 XRT_INPUT_VIVE_FOCUS3_AIM_POSE = XRT_INPUT_NAME(0x0C11, POSE),
1329
1330 XRT_INPUT_TOUCH_PRO_X_CLICK = XRT_INPUT_NAME(0x0D00, BOOLEAN),
1331 XRT_INPUT_TOUCH_PRO_X_TOUCH = XRT_INPUT_NAME(0x0D01, BOOLEAN),
1332 XRT_INPUT_TOUCH_PRO_Y_CLICK = XRT_INPUT_NAME(0x0D02, BOOLEAN),
1333 XRT_INPUT_TOUCH_PRO_Y_TOUCH = XRT_INPUT_NAME(0x0D03, BOOLEAN),
1334 XRT_INPUT_TOUCH_PRO_MENU_CLICK = XRT_INPUT_NAME(0x0D04, BOOLEAN),
1335 XRT_INPUT_TOUCH_PRO_A_CLICK = XRT_INPUT_NAME(0x0D05, BOOLEAN),
1336 XRT_INPUT_TOUCH_PRO_A_TOUCH = XRT_INPUT_NAME(0x0D06, BOOLEAN),
1337 XRT_INPUT_TOUCH_PRO_B_CLICK = XRT_INPUT_NAME(0x0D07, BOOLEAN),
1338 XRT_INPUT_TOUCH_PRO_B_TOUCH = XRT_INPUT_NAME(0x0D08, BOOLEAN),
1339 XRT_INPUT_TOUCH_PRO_SYSTEM_CLICK = XRT_INPUT_NAME(0x0D09, BOOLEAN),
1340 XRT_INPUT_TOUCH_PRO_SQUEEZE_VALUE = XRT_INPUT_NAME(0x0D0A, VEC1_ZERO_TO_ONE),
1341 XRT_INPUT_TOUCH_PRO_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0D0B, BOOLEAN),
1342 XRT_INPUT_TOUCH_PRO_TRIGGER_VALUE = XRT_INPUT_NAME(0x0D0C, VEC1_ZERO_TO_ONE),
1343 XRT_INPUT_TOUCH_PRO_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0D0D, BOOLEAN),
1344 XRT_INPUT_TOUCH_PRO_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0D0E, BOOLEAN),
1345 XRT_INPUT_TOUCH_PRO_THUMBSTICK = XRT_INPUT_NAME(0x0D0F, VEC2_MINUS_ONE_TO_ONE),
1346 XRT_INPUT_TOUCH_PRO_THUMBREST_TOUCH = XRT_INPUT_NAME(0x0D10, BOOLEAN),
1347 XRT_INPUT_TOUCH_PRO_THUMBREST_FORCE = XRT_INPUT_NAME(0x0D11, VEC1_ZERO_TO_ONE),
1348 XRT_INPUT_TOUCH_PRO_GRIP_POSE = XRT_INPUT_NAME(0x0D12, POSE),
1349 XRT_INPUT_TOUCH_PRO_AIM_POSE = XRT_INPUT_NAME(0x0D13, POSE),
1350 XRT_INPUT_TOUCH_PRO_TRIGGER_PROXIMITY = XRT_INPUT_NAME(0x0D14, BOOLEAN),
1351 XRT_INPUT_TOUCH_PRO_THUMB_PROXIMITY = XRT_INPUT_NAME(0x0D15, BOOLEAN),
1352 XRT_INPUT_TOUCH_PRO_TRIGGER_CURL = XRT_INPUT_NAME(0x0D16, VEC1_ZERO_TO_ONE),
1353 XRT_INPUT_TOUCH_PRO_TRIGGER_SLIDE = XRT_INPUT_NAME(0x0D17, VEC1_ZERO_TO_ONE),
1354 XRT_INPUT_TOUCH_PRO_STYLUS_FORCE = XRT_INPUT_NAME(0x0D18, VEC1_ZERO_TO_ONE),
1355
1356 XRT_INPUT_TOUCH_PLUS_X_CLICK = XRT_INPUT_NAME(0x0E00, BOOLEAN),
1357 XRT_INPUT_TOUCH_PLUS_X_TOUCH = XRT_INPUT_NAME(0x0E01, BOOLEAN),
1358 XRT_INPUT_TOUCH_PLUS_Y_CLICK = XRT_INPUT_NAME(0x0E02, BOOLEAN),
1359 XRT_INPUT_TOUCH_PLUS_Y_TOUCH = XRT_INPUT_NAME(0x0E03, BOOLEAN),
1360 XRT_INPUT_TOUCH_PLUS_MENU_CLICK = XRT_INPUT_NAME(0x0E04, BOOLEAN),
1361 XRT_INPUT_TOUCH_PLUS_A_CLICK = XRT_INPUT_NAME(0x0E05, BOOLEAN),
1362 XRT_INPUT_TOUCH_PLUS_A_TOUCH = XRT_INPUT_NAME(0x0E06, BOOLEAN),
1363 XRT_INPUT_TOUCH_PLUS_B_CLICK = XRT_INPUT_NAME(0x0E07, BOOLEAN),
1364 XRT_INPUT_TOUCH_PLUS_B_TOUCH = XRT_INPUT_NAME(0x0E08, BOOLEAN),
1365 XRT_INPUT_TOUCH_PLUS_SYSTEM_CLICK = XRT_INPUT_NAME(0x0E09, BOOLEAN),
1366 XRT_INPUT_TOUCH_PLUS_SQUEEZE_VALUE = XRT_INPUT_NAME(0x0E0A, VEC1_ZERO_TO_ONE),
1367 XRT_INPUT_TOUCH_PLUS_TRIGGER_TOUCH = XRT_INPUT_NAME(0x0E0B, BOOLEAN),
1368 XRT_INPUT_TOUCH_PLUS_TRIGGER_PROXIMITY = XRT_INPUT_NAME(0x0E0C, BOOLEAN),
1369 XRT_INPUT_TOUCH_PLUS_TRIGGER_VALUE = XRT_INPUT_NAME(0x0E0D, VEC1_ZERO_TO_ONE),
1370 XRT_INPUT_TOUCH_PLUS_TRIGGER_FORCE = XRT_INPUT_NAME(0x0E0E, VEC1_ZERO_TO_ONE),
1371 XRT_INPUT_TOUCH_PLUS_THUMBSTICK_CLICK = XRT_INPUT_NAME(0x0E0F, BOOLEAN),
1372 XRT_INPUT_TOUCH_PLUS_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0x0E10, BOOLEAN),
1373 XRT_INPUT_TOUCH_PLUS_THUMBSTICK = XRT_INPUT_NAME(0x0E11, VEC2_MINUS_ONE_TO_ONE),
1374 XRT_INPUT_TOUCH_PLUS_THUMBREST_TOUCH = XRT_INPUT_NAME(0x0E12, BOOLEAN),
1375 XRT_INPUT_TOUCH_PLUS_GRIP_POSE = XRT_INPUT_NAME(0x0E13, POSE),
1376 XRT_INPUT_TOUCH_PLUS_AIM_POSE = XRT_INPUT_NAME(0x0E14, POSE),
1377 XRT_INPUT_TOUCH_PLUS_THUMB_PROXIMITY = XRT_INPUT_NAME(0x0E15, BOOLEAN),
1378 XRT_INPUT_TOUCH_PLUS_TRIGGER_CURL = XRT_INPUT_NAME(0x0E16, VEC1_ZERO_TO_ONE),
1379 XRT_INPUT_TOUCH_PLUS_TRIGGER_SLIDE = XRT_INPUT_NAME(0x0E17, VEC1_ZERO_TO_ONE),
1380
1381 XRT_INPUT_RIFT_REMOTE_SELECT_CLICK = XRT_INPUT_NAME(0x0F00, BOOLEAN),
1382 XRT_INPUT_RIFT_REMOTE_BACK_CLICK = XRT_INPUT_NAME(0x0F01, BOOLEAN),
1383 XRT_INPUT_RIFT_REMOTE_VOLUME_UP_CLICK = XRT_INPUT_NAME(0x0F02, BOOLEAN),
1384 XRT_INPUT_RIFT_REMOTE_VOLUME_DOWN_CLICK = XRT_INPUT_NAME(0x0F03, BOOLEAN),
1385 XRT_INPUT_RIFT_REMOTE_OCULUS_CLICK = XRT_INPUT_NAME(0x0F04, BOOLEAN),
1386 XRT_INPUT_RIFT_REMOTE_DPAD_DOWN_CLICK = XRT_INPUT_NAME(0x0F05, BOOLEAN),
1387 XRT_INPUT_RIFT_REMOTE_DPAD_RIGHT_CLICK = XRT_INPUT_NAME(0x0F06, BOOLEAN),
1388 XRT_INPUT_RIFT_REMOTE_DPAD_UP_CLICK = XRT_INPUT_NAME(0x0F07, BOOLEAN),
1389 XRT_INPUT_RIFT_REMOTE_DPAD_LEFT_CLICK = XRT_INPUT_NAME(0x0F08, BOOLEAN),
1390
1391 XRT_INPUT_BLUBUR_S1_MENU_CLICK = XRT_INPUT_NAME(0x1000, BOOLEAN),
1392
1393 XRT_INPUT_PSVR2_SYSTEM_CLICK = XRT_INPUT_NAME(0x1100, BOOLEAN),
1394
1395 XRT_INPUT_HAND_CTRL_EMU_PINCH_BOOL = XRT_INPUT_NAME(0x1200, BOOLEAN),
1396 XRT_INPUT_HAND_CTRL_EMU_PINCH_VALUE = XRT_INPUT_NAME(0x1201, VEC1_ZERO_TO_ONE),
1397 XRT_INPUT_HAND_CTRL_EMU_GRIP_POSE = XRT_INPUT_NAME(0x1202, POSE),
1398 XRT_INPUT_HAND_CTRL_EMU_AIM_POSE = XRT_INPUT_NAME(0x1203, POSE),
1399
1400 XRT_INPUT_FLIPVR_A_CLICK = XRT_INPUT_NAME(0x1300, BOOLEAN),
1401 XRT_INPUT_FLIPVR_A_TOUCH = XRT_INPUT_NAME(0x1301, BOOLEAN),
1402 XRT_INPUT_FLIPVR_B_CLICK = XRT_INPUT_NAME(0X1302, BOOLEAN),
1403 XRT_INPUT_FLIPVR_B_TOUCH = XRT_INPUT_NAME(0X1303, BOOLEAN),
1404 XRT_INPUT_FLIPVR_X_CLICK = XRT_INPUT_NAME(0X1304, BOOLEAN),
1405 XRT_INPUT_FLIPVR_X_TOUCH = XRT_INPUT_NAME(0X1305, BOOLEAN),
1406 XRT_INPUT_FLIPVR_Y_CLICK = XRT_INPUT_NAME(0X1306, BOOLEAN),
1407 XRT_INPUT_FLIPVR_Y_TOUCH = XRT_INPUT_NAME(0X1307, BOOLEAN),
1408 XRT_INPUT_FLIPVR_SYSTEM_CLICK = XRT_INPUT_NAME(0X1308, BOOLEAN),
1409 XRT_INPUT_FLIPVR_THUMBSTICK_CLICK = XRT_INPUT_NAME(0X1309, BOOLEAN),
1410 XRT_INPUT_FLIPVR_THUMBSTICK_TOUCH = XRT_INPUT_NAME(0X130A, BOOLEAN),
1411 XRT_INPUT_FLIPVR_THUMBSTICK = XRT_INPUT_NAME(0X130B, VEC2_MINUS_ONE_TO_ONE),
1412 XRT_INPUT_FLIPVR_TRIGGER_CLICK = XRT_INPUT_NAME(0X130C, BOOLEAN),
1413 XRT_INPUT_FLIPVR_TRIGGER_TOUCH = XRT_INPUT_NAME(0X130D, BOOLEAN),
1414 XRT_INPUT_FLIPVR_TRIGGER_VALUE = XRT_INPUT_NAME(0X130E, VEC1_ZERO_TO_ONE),
1415 XRT_INPUT_FLIPVR_SQUEEZE_CLICK = XRT_INPUT_NAME(0X130F, BOOLEAN),
1416 XRT_INPUT_FLIPVR_SQUEEZE_VALUE = XRT_INPUT_NAME(0X1310, VEC1_ZERO_TO_ONE),
1417 XRT_INPUT_FLIPVR_GRIP_POSE = XRT_INPUT_NAME(0X1311, POSE),
1418 XRT_INPUT_FLIPVR_AIM_POSE = XRT_INPUT_NAME(0X1312, POSE),
1419
1420 XRT_INPUT_MX_INK_GRIP_POSE = XRT_INPUT_NAME(0x1400, POSE),
1421 XRT_INPUT_MX_INK_AIM_POSE = XRT_INPUT_NAME(0x1401, POSE),
1422 XRT_INPUT_MX_INK_SYSTEM_CLICK = XRT_INPUT_NAME(0x1402, BOOLEAN),
1423 XRT_INPUT_MX_INK_FRONT_CLICK = XRT_INPUT_NAME(0x1403, BOOLEAN),
1424 XRT_INPUT_MX_INK_FRONT_DOUBLE_TAP = XRT_INPUT_NAME(0x1404, BOOLEAN),
1425 XRT_INPUT_MX_INK_MIDDLE_VALUE = XRT_INPUT_NAME(0x1405, VEC1_ZERO_TO_ONE),
1426 XRT_INPUT_MX_INK_BACK_CLICK = XRT_INPUT_NAME(0x1406, BOOLEAN),
1427 XRT_INPUT_MX_INK_BACK_DOUBLE_TAP = XRT_INPUT_NAME(0x1407, BOOLEAN),
1428 XRT_INPUT_MX_INK_DOCKED = XRT_INPUT_NAME(0x1408, BOOLEAN),
1429 XRT_INPUT_MX_INK_TIP_FORCE = XRT_INPUT_NAME(0x1409, VEC1_ZERO_TO_ONE),
1430 XRT_INPUT_MX_INK_TIP_POSE = XRT_INPUT_NAME(0x140A, POSE),
1431
1432 XRT_INPUT_MAGNETRA2_A_CLICK = XRT_INPUT_NAME(0X1500, BOOLEAN),
1433 XRT_INPUT_MAGNETRA2_B_CLICK = XRT_INPUT_NAME(0X1501, BOOLEAN),
1434 XRT_INPUT_MAGNETRA2_X_CLICK = XRT_INPUT_NAME(0X1502, BOOLEAN),
1435 XRT_INPUT_MAGNETRA2_Y_CLICK = XRT_INPUT_NAME(0X1503, BOOLEAN),
1436 XRT_INPUT_MAGNETRA2_SYSTEM_CLICK = XRT_INPUT_NAME(0X1504, BOOLEAN),
1437 XRT_INPUT_MAGNETRA2_PAIRING_CLICK = XRT_INPUT_NAME(0X1505, BOOLEAN),
1438 XRT_INPUT_MAGNETRA2_TRIGGER_VALUE = XRT_INPUT_NAME(0X1506, VEC1_ZERO_TO_ONE),
1439 XRT_INPUT_MAGNETRA2_TRIGGER_CLICK = XRT_INPUT_NAME(0X1507, BOOLEAN),
1440 XRT_INPUT_MAGNETRA2_SQUEEZE_VALUE = XRT_INPUT_NAME(0X1508, VEC1_ZERO_TO_ONE),
1441 XRT_INPUT_MAGNETRA2_THUMBSTICK = XRT_INPUT_NAME(0X1509, VEC2_MINUS_ONE_TO_ONE),
1442 XRT_INPUT_MAGNETRA2_THUMBSTICK_CLICK = XRT_INPUT_NAME(0X150A, BOOLEAN),
1443 XRT_INPUT_MAGNETRA2_GRIP_POSE = XRT_INPUT_NAME(0X150B, POSE),
1444 XRT_INPUT_MAGNETRA2_AIM_POSE = XRT_INPUT_NAME(0X150C, POSE),
1445
1446 // clang-format on
1447};
1448
1449/*!
1450 * Number of joints in a hand. Corresponds to XR_HAND_JOINT_COUNT_EXT.
1451 *
1452 * @see xrt_hand_joint
1453 * @ingroup xrt_iface
1454 */
1455#define XRT_HAND_JOINT_COUNT 26
1456
1457/*!
1458 * Number of joints in a hand. Corresponds to XrHandJointEXT.
1459 *
1460 * @ingroup xrt_iface
1461 */
1463{
1464 XRT_HAND_JOINT_PALM = 0,
1465 XRT_HAND_JOINT_WRIST = 1,
1466 XRT_HAND_JOINT_THUMB_METACARPAL = 2,
1467 XRT_HAND_JOINT_THUMB_PROXIMAL = 3,
1468 XRT_HAND_JOINT_THUMB_DISTAL = 4,
1469 XRT_HAND_JOINT_THUMB_TIP = 5,
1470 XRT_HAND_JOINT_INDEX_METACARPAL = 6,
1471 XRT_HAND_JOINT_INDEX_PROXIMAL = 7,
1472 XRT_HAND_JOINT_INDEX_INTERMEDIATE = 8,
1473 XRT_HAND_JOINT_INDEX_DISTAL = 9,
1474 XRT_HAND_JOINT_INDEX_TIP = 10,
1475 XRT_HAND_JOINT_MIDDLE_METACARPAL = 11,
1476 XRT_HAND_JOINT_MIDDLE_PROXIMAL = 12,
1477 XRT_HAND_JOINT_MIDDLE_INTERMEDIATE = 13,
1478 XRT_HAND_JOINT_MIDDLE_DISTAL = 14,
1479 XRT_HAND_JOINT_MIDDLE_TIP = 15,
1480 XRT_HAND_JOINT_RING_METACARPAL = 16,
1481 XRT_HAND_JOINT_RING_PROXIMAL = 17,
1482 XRT_HAND_JOINT_RING_INTERMEDIATE = 18,
1483 XRT_HAND_JOINT_RING_DISTAL = 19,
1484 XRT_HAND_JOINT_RING_TIP = 20,
1485 XRT_HAND_JOINT_LITTLE_METACARPAL = 21,
1486 XRT_HAND_JOINT_LITTLE_PROXIMAL = 22,
1487 XRT_HAND_JOINT_LITTLE_INTERMEDIATE = 23,
1488 XRT_HAND_JOINT_LITTLE_DISTAL = 24,
1489 XRT_HAND_JOINT_LITTLE_TIP = 25,
1490 XRT_HAND_JOINT_MAX_ENUM = 0x7FFFFFFF
1491};
1492
1493/*!
1494 * Enumeration for left and right hand.
1495 *
1496 * @ingroup xrt_iface
1497 */
1499{
1500 XRT_HAND_LEFT = 0,
1501 XRT_HAND_RIGHT = 1,
1502};
1503
1504/*!
1505 * Location of a single hand joint. Corresponds to XrHandJointLocationEXT.
1506 *
1507 * @ingroup xrt_iface
1508 */
1510{
1511 struct xrt_space_relation relation;
1512 float radius;
1513};
1514
1515/*!
1516 * Number of fingers on a hand.
1517 *
1518 * @ingroup xrt_iface
1519 */
1520#define XRT_FINGER_COUNT 5
1521
1522/*!
1523 * Names for fingers on a hand.
1524 *
1525 * @ingroup xrt_iface
1526 */
1528{
1529 XRT_FINGER_LITTLE = 0,
1530 XRT_FINGER_RING,
1531 XRT_FINGER_MIDDLE,
1532 XRT_FINGER_INDEX,
1533 XRT_FINGER_THUMB
1534};
1535
1536/*!
1537 * Joint set type used for hand tracking. Corresponds to XrHandJointSetEXT.
1538 *
1539 * @ingroup xrt_iface
1540 */
1542{
1543 union {
1544 struct xrt_hand_joint_value hand_joint_set_default[XRT_HAND_JOINT_COUNT];
1545 } values;
1546
1547 // in driver global space, without tracking_origin offset
1548 struct xrt_space_relation hand_pose;
1549 bool is_active;
1550};
1551
1552/*!
1553 * A union of all input types.
1554 *
1555 * @see xrt_input_type
1556 * @ingroup xrt_iface math
1557 */
1559 struct xrt_vec1 vec1;
1560 struct xrt_vec2 vec2;
1561 bool boolean;
1562};
1563
1564/*!
1565 * The number of bits reserved for the input type in @ref xrt_output_name
1566 * @see xrt_output_type
1567 * @ingroup xrt_iface
1568 */
1569#define XRT_OUTPUT_TYPE_BITWIDTH 8u
1570
1571/*!
1572 * The mask associated with @ref XRT_OUTPUT_TYPE_BITWIDTH
1573 * @see xrt_output_type
1574 * @ingroup xrt_iface
1575 */
1576#define XRT_OUTPUT_TYPE_BITMASK 0xffu
1577
1578/*!
1579 * @brief Create an enum value for xrt_output_name that packs an ID and output
1580 * type.
1581 *
1582 * @param id an integer
1583 * @param type The suffix of an xrt_output_type value name: `XRT_OUTPUT_TYPE_` is
1584 * prepended automatically.
1585 *
1586 * @see xrt_output_name
1587 * @ingroup xrt_iface
1588 */
1589#define XRT_OUTPUT_NAME(id, type) ((UINT32_C(id) << XRT_OUTPUT_TYPE_BITWIDTH) | (uint32_t)XRT_OUTPUT_TYPE_##type)
1590
1591/*!
1592 * @brief Extract the xrt_output_type from an xrt_output_name.
1593 *
1594 * @param name An xrt_output_name value
1595 *
1596 * @relates xrt_output_name
1597 * @returns @ref xrt_output_type
1598 * @ingroup xrt_iface
1599 */
1600#define XRT_GET_OUTPUT_TYPE(name) ((enum xrt_output_type)(name & XRT_OUTPUT_TYPE_BITMASK))
1601
1602/*!
1603 * @brief Extract the xrt_output_name id from an xrt_output_name.
1604 *
1605 * @param name An xrt_output_name value
1606 *
1607 * @relates xrt_output_name
1608 * @returns The extracted id.
1609 * @ingroup xrt_iface
1610 */
1611#define XRT_GET_OUTPUT_ID(name) ((uint32_t)(name >> XRT_OUTPUT_TYPE_BITWIDTH))
1612
1613/*!
1614 * Base type of this output.
1615 *
1616 * @ingroup xrt_iface
1617 */
1619{
1620 // clang-format off
1621 XRT_OUTPUT_TYPE_VIBRATION = 0x00,
1622 XRT_OUTPUT_TYPE_FORCE_FEEDBACK = 0x01,
1623 // clang-format on
1624};
1625
1626/*!
1627 * Name of a output with a baked in type.
1628 *
1629 * @see xrt_output_type
1630 * @ingroup xrt_iface
1631 */
1633{
1634 // clang-format off
1635 XRT_OUTPUT_NAME_SIMPLE_VIBRATION = XRT_OUTPUT_NAME(0x0010, VIBRATION),
1636 XRT_OUTPUT_NAME_PSMV_RUMBLE_VIBRATION = XRT_OUTPUT_NAME(0x0020, VIBRATION),
1637 XRT_OUTPUT_NAME_INDEX_HAPTIC = XRT_OUTPUT_NAME(0x0030, VIBRATION),
1638 XRT_OUTPUT_NAME_VIVE_HAPTIC = XRT_OUTPUT_NAME(0x0040, VIBRATION),
1639 XRT_OUTPUT_NAME_WMR_HAPTIC = XRT_OUTPUT_NAME(0x0050, VIBRATION),
1640
1641 XRT_OUTPUT_NAME_XBOX_HAPTIC_LEFT = XRT_OUTPUT_NAME(0x0060, VIBRATION),
1642 XRT_OUTPUT_NAME_XBOX_HAPTIC_RIGHT = XRT_OUTPUT_NAME(0x0061, VIBRATION),
1643 XRT_OUTPUT_NAME_XBOX_HAPTIC_LEFT_TRIGGER = XRT_OUTPUT_NAME(0x0062, VIBRATION),
1644 XRT_OUTPUT_NAME_XBOX_HAPTIC_RIGHT_TRIGGER = XRT_OUTPUT_NAME(0x0063, VIBRATION),
1645
1646 XRT_OUTPUT_NAME_TOUCH_HAPTIC = XRT_OUTPUT_NAME(0x0070, VIBRATION),
1647
1648 XRT_OUTPUT_NAME_FORCE_FEEDBACK_LEFT = XRT_OUTPUT_NAME(0x0080, FORCE_FEEDBACK),
1649 XRT_OUTPUT_NAME_FORCE_FEEDBACK_RIGHT = XRT_OUTPUT_NAME(0x0081, FORCE_FEEDBACK),
1650
1651 XRT_OUTPUT_NAME_G2_CONTROLLER_HAPTIC = XRT_OUTPUT_NAME(0x0090, VIBRATION),
1652 XRT_OUTPUT_NAME_ODYSSEY_CONTROLLER_HAPTIC = XRT_OUTPUT_NAME(0x00A0, VIBRATION),
1653 XRT_OUTPUT_NAME_ML2_CONTROLLER_VIBRATION = XRT_OUTPUT_NAME(0x00B0, VIBRATION),
1654
1655 XRT_OUTPUT_NAME_PSSENSE_VIBRATION = XRT_OUTPUT_NAME(0x00C0, VIBRATION),
1656 XRT_OUTPUT_NAME_PSSENSE_TRIGGER_FEEDBACK = XRT_OUTPUT_NAME(0x00C1, FORCE_FEEDBACK),
1657
1658 XRT_OUTPUT_NAME_VIVE_TRACKER_HAPTIC = XRT_OUTPUT_NAME(0x00D0, VIBRATION),
1659
1660 XRT_OUTPUT_NAME_OPPO_MR_HAPTIC = XRT_OUTPUT_NAME(0x00E0, VIBRATION),
1661
1662 XRT_OUTPUT_NAME_PICO_NEO3_HAPTIC = XRT_OUTPUT_NAME(0x00F0, VIBRATION),
1663 XRT_OUTPUT_NAME_PICO4_HAPTIC = XRT_OUTPUT_NAME(0x0100, VIBRATION),
1664
1665 XRT_OUTPUT_NAME_VIVE_COSMOS_HAPTIC = XRT_OUTPUT_NAME(0x0200, VIBRATION),
1666 XRT_OUTPUT_NAME_VIVE_FOCUS3_HAPTIC = XRT_OUTPUT_NAME(0x0300, VIBRATION),
1667
1668 XRT_OUTPUT_NAME_TOUCH_PRO_HAPTIC = XRT_OUTPUT_NAME(0x0400, VIBRATION),
1669 XRT_OUTPUT_NAME_TOUCH_PRO_HAPTIC_TRIGGER = XRT_OUTPUT_NAME(0x0500, VIBRATION),
1670 XRT_OUTPUT_NAME_TOUCH_PRO_HAPTIC_THUMB = XRT_OUTPUT_NAME(0x0600, VIBRATION),
1671 XRT_OUTPUT_NAME_TOUCH_PLUS_HAPTIC = XRT_OUTPUT_NAME(0x0700, VIBRATION),
1672
1673 XRT_OUTPUT_NAME_PSVR2_HAPTIC = XRT_OUTPUT_NAME(0x0800, VIBRATION),
1674
1675 XRT_OUTPUT_NAME_FLIPVR_HAPTIC = XRT_OUTPUT_NAME(0x0900, VIBRATION),
1676
1677 XRT_OUTPUT_NAME_MX_INK_HAPTIC = XRT_OUTPUT_NAME(0x0A00, VIBRATION),
1678
1679 // XR_KHR_generic_controller
1680 XRT_OUTPUT_NAME_GENERIC_VIBRATION = XRT_OUTPUT_NAME(0x0B00, VIBRATION),
1681
1682 XRT_OUTPUT_NAME_CONTACTGLOVE2_HAPTIC = XRT_OUTPUT_NAME(0x0C00, VIBRATION),
1683
1684 // clang-format on
1685 // Make sure to add a trailing comma to any new entries.
1686};
1687
1688enum xrt_face_expression2_fb
1689{
1690 XRT_FACE_EXPRESSION2_BROW_LOWERER_L_FB = 0,
1691 XRT_FACE_EXPRESSION2_BROW_LOWERER_R_FB = 1,
1692 XRT_FACE_EXPRESSION2_CHEEK_PUFF_L_FB = 2,
1693 XRT_FACE_EXPRESSION2_CHEEK_PUFF_R_FB = 3,
1694 XRT_FACE_EXPRESSION2_CHEEK_RAISER_L_FB = 4,
1695 XRT_FACE_EXPRESSION2_CHEEK_RAISER_R_FB = 5,
1696 XRT_FACE_EXPRESSION2_CHEEK_SUCK_L_FB = 6,
1697 XRT_FACE_EXPRESSION2_CHEEK_SUCK_R_FB = 7,
1698 XRT_FACE_EXPRESSION2_CHIN_RAISER_B_FB = 8,
1699 XRT_FACE_EXPRESSION2_CHIN_RAISER_T_FB = 9,
1700 XRT_FACE_EXPRESSION2_DIMPLER_L_FB = 10,
1701 XRT_FACE_EXPRESSION2_DIMPLER_R_FB = 11,
1702 XRT_FACE_EXPRESSION2_EYES_CLOSED_L_FB = 12,
1703 XRT_FACE_EXPRESSION2_EYES_CLOSED_R_FB = 13,
1704 XRT_FACE_EXPRESSION2_EYES_LOOK_DOWN_L_FB = 14,
1705 XRT_FACE_EXPRESSION2_EYES_LOOK_DOWN_R_FB = 15,
1706 XRT_FACE_EXPRESSION2_EYES_LOOK_LEFT_L_FB = 16,
1707 XRT_FACE_EXPRESSION2_EYES_LOOK_LEFT_R_FB = 17,
1708 XRT_FACE_EXPRESSION2_EYES_LOOK_RIGHT_L_FB = 18,
1709 XRT_FACE_EXPRESSION2_EYES_LOOK_RIGHT_R_FB = 19,
1710 XRT_FACE_EXPRESSION2_EYES_LOOK_UP_L_FB = 20,
1711 XRT_FACE_EXPRESSION2_EYES_LOOK_UP_R_FB = 21,
1712 XRT_FACE_EXPRESSION2_INNER_BROW_RAISER_L_FB = 22,
1713 XRT_FACE_EXPRESSION2_INNER_BROW_RAISER_R_FB = 23,
1714 XRT_FACE_EXPRESSION2_JAW_DROP_FB = 24,
1715 XRT_FACE_EXPRESSION2_JAW_SIDEWAYS_LEFT_FB = 25,
1716 XRT_FACE_EXPRESSION2_JAW_SIDEWAYS_RIGHT_FB = 26,
1717 XRT_FACE_EXPRESSION2_JAW_THRUST_FB = 27,
1718 XRT_FACE_EXPRESSION2_LID_TIGHTENER_L_FB = 28,
1719 XRT_FACE_EXPRESSION2_LID_TIGHTENER_R_FB = 29,
1720 XRT_FACE_EXPRESSION2_LIP_CORNER_DEPRESSOR_L_FB = 30,
1721 XRT_FACE_EXPRESSION2_LIP_CORNER_DEPRESSOR_R_FB = 31,
1722 XRT_FACE_EXPRESSION2_LIP_CORNER_PULLER_L_FB = 32,
1723 XRT_FACE_EXPRESSION2_LIP_CORNER_PULLER_R_FB = 33,
1724 XRT_FACE_EXPRESSION2_LIP_FUNNELER_LB_FB = 34,
1725 XRT_FACE_EXPRESSION2_LIP_FUNNELER_LT_FB = 35,
1726 XRT_FACE_EXPRESSION2_LIP_FUNNELER_RB_FB = 36,
1727 XRT_FACE_EXPRESSION2_LIP_FUNNELER_RT_FB = 37,
1728 XRT_FACE_EXPRESSION2_LIP_PRESSOR_L_FB = 38,
1729 XRT_FACE_EXPRESSION2_LIP_PRESSOR_R_FB = 39,
1730 XRT_FACE_EXPRESSION2_LIP_PUCKER_L_FB = 40,
1731 XRT_FACE_EXPRESSION2_LIP_PUCKER_R_FB = 41,
1732 XRT_FACE_EXPRESSION2_LIP_STRETCHER_L_FB = 42,
1733 XRT_FACE_EXPRESSION2_LIP_STRETCHER_R_FB = 43,
1734 XRT_FACE_EXPRESSION2_LIP_SUCK_LB_FB = 44,
1735 XRT_FACE_EXPRESSION2_LIP_SUCK_LT_FB = 45,
1736 XRT_FACE_EXPRESSION2_LIP_SUCK_RB_FB = 46,
1737 XRT_FACE_EXPRESSION2_LIP_SUCK_RT_FB = 47,
1738 XRT_FACE_EXPRESSION2_LIP_TIGHTENER_L_FB = 48,
1739 XRT_FACE_EXPRESSION2_LIP_TIGHTENER_R_FB = 49,
1740 XRT_FACE_EXPRESSION2_LIPS_TOWARD_FB = 50,
1741 XRT_FACE_EXPRESSION2_LOWER_LIP_DEPRESSOR_L_FB = 51,
1742 XRT_FACE_EXPRESSION2_LOWER_LIP_DEPRESSOR_R_FB = 52,
1743 XRT_FACE_EXPRESSION2_MOUTH_LEFT_FB = 53,
1744 XRT_FACE_EXPRESSION2_MOUTH_RIGHT_FB = 54,
1745 XRT_FACE_EXPRESSION2_NOSE_WRINKLER_L_FB = 55,
1746 XRT_FACE_EXPRESSION2_NOSE_WRINKLER_R_FB = 56,
1747 XRT_FACE_EXPRESSION2_OUTER_BROW_RAISER_L_FB = 57,
1748 XRT_FACE_EXPRESSION2_OUTER_BROW_RAISER_R_FB = 58,
1749 XRT_FACE_EXPRESSION2_UPPER_LID_RAISER_L_FB = 59,
1750 XRT_FACE_EXPRESSION2_UPPER_LID_RAISER_R_FB = 60,
1751 XRT_FACE_EXPRESSION2_UPPER_LIP_RAISER_L_FB = 61,
1752 XRT_FACE_EXPRESSION2_UPPER_LIP_RAISER_R_FB = 62,
1753 XRT_FACE_EXPRESSION2_TONGUE_TIP_INTERDENTAL_FB = 63,
1754 XRT_FACE_EXPRESSION2_TONGUE_TIP_ALVEOLAR_FB = 64,
1755 XRT_FACE_EXPRESSION2_TONGUE_FRONT_DORSAL_PALATE_FB = 65,
1756 XRT_FACE_EXPRESSION2_TONGUE_MID_DORSAL_PALATE_FB = 66,
1757 XRT_FACE_EXPRESSION2_TONGUE_BACK_DORSAL_VELAR_FB = 67,
1758 XRT_FACE_EXPRESSION2_TONGUE_OUT_FB = 68,
1759 XRT_FACE_EXPRESSION2_TONGUE_RETREAT_FB = 69,
1760 XRT_FACE_EXPRESSION2_COUNT_FB = 70,
1761 XRT_FACE_EXPRESSION_2FB_MAX_ENUM_FB = 0x7FFFFFFF
1762};
1763
1764enum xrt_face_confidence2_fb
1765{
1766 XRT_FACE_CONFIDENCE2_LOWER_FACE_FB = 0,
1767 XRT_FACE_CONFIDENCE2_UPPER_FACE_FB = 1,
1768 XRT_FACE_CONFIDENCE2_COUNT_FB = 2,
1769 XRT_FACE_CONFIDENCE_2FB_MAX_ENUM_FB = 0x7FFFFFFF
1770};
1771
1772enum xrt_face_expression_set2_fb
1773{
1774 XRT_FACE_EXPRESSION_SET2_DEFAULT_FB = 0,
1775 XRT_FACE_EXPRESSION_SET_2FB_MAX_ENUM_FB = 0x7FFFFFFF
1776};
1777
1778enum xrt_face_tracking_data_source2_fb
1779{
1780 XRT_FACE_TRACKING_DATA_SOURCE2_VISUAL_FB = 0,
1781 XRT_FACE_TRACKING_DATA_SOURCE2_AUDIO_FB = 1,
1782 XRT_FACE_TRACKING_DATA_SOURCE_2FB_MAX_ENUM_FB = 0x7FFFFFFF
1783};
1784
1785enum xrt_eye_expression_htc
1786{
1787 XRT_EYE_EXPRESSION_LEFT_BLINK_HTC = 0,
1788 XRT_EYE_EXPRESSION_LEFT_WIDE_HTC = 1,
1789 XRT_EYE_EXPRESSION_RIGHT_BLINK_HTC = 2,
1790 XRT_EYE_EXPRESSION_RIGHT_WIDE_HTC = 3,
1791 XRT_EYE_EXPRESSION_LEFT_SQUEEZE_HTC = 4,
1792 XRT_EYE_EXPRESSION_RIGHT_SQUEEZE_HTC = 5,
1793 XRT_EYE_EXPRESSION_LEFT_DOWN_HTC = 6,
1794 XRT_EYE_EXPRESSION_RIGHT_DOWN_HTC = 7,
1795 XRT_EYE_EXPRESSION_LEFT_OUT_HTC = 8,
1796 XRT_EYE_EXPRESSION_RIGHT_IN_HTC = 9,
1797 XRT_EYE_EXPRESSION_LEFT_IN_HTC = 10,
1798 XRT_EYE_EXPRESSION_RIGHT_OUT_HTC = 11,
1799 XRT_EYE_EXPRESSION_LEFT_UP_HTC = 12,
1800 XRT_EYE_EXPRESSION_RIGHT_UP_HTC = 13
1801};
1802
1803enum xrt_lip_expression_htc
1804{
1805 XRT_LIP_EXPRESSION_JAW_RIGHT_HTC = 0,
1806 XRT_LIP_EXPRESSION_JAW_LEFT_HTC = 1,
1807 XRT_LIP_EXPRESSION_JAW_FORWARD_HTC = 2,
1808 XRT_LIP_EXPRESSION_JAW_OPEN_HTC = 3,
1809 XRT_LIP_EXPRESSION_MOUTH_APE_SHAPE_HTC = 4,
1810 XRT_LIP_EXPRESSION_MOUTH_UPPER_RIGHT_HTC = 5,
1811 XRT_LIP_EXPRESSION_MOUTH_UPPER_LEFT_HTC = 6,
1812 XRT_LIP_EXPRESSION_MOUTH_LOWER_RIGHT_HTC = 7,
1813 XRT_LIP_EXPRESSION_MOUTH_LOWER_LEFT_HTC = 8,
1814 XRT_LIP_EXPRESSION_MOUTH_UPPER_OVERTURN_HTC = 9,
1815 XRT_LIP_EXPRESSION_MOUTH_LOWER_OVERTURN_HTC = 10,
1816 XRT_LIP_EXPRESSION_MOUTH_POUT_HTC = 11,
1817 XRT_LIP_EXPRESSION_MOUTH_SMILE_RIGHT_HTC = 12,
1818 XRT_LIP_EXPRESSION_MOUTH_SMILE_LEFT_HTC = 13,
1819 XRT_LIP_EXPRESSION_MOUTH_SAD_RIGHT_HTC = 14,
1820 XRT_LIP_EXPRESSION_MOUTH_SAD_LEFT_HTC = 15,
1821 XRT_LIP_EXPRESSION_CHEEK_PUFF_RIGHT_HTC = 16,
1822 XRT_LIP_EXPRESSION_CHEEK_PUFF_LEFT_HTC = 17,
1823 XRT_LIP_EXPRESSION_CHEEK_SUCK_HTC = 18,
1824 XRT_LIP_EXPRESSION_MOUTH_UPPER_UPRIGHT_HTC = 19,
1825 XRT_LIP_EXPRESSION_MOUTH_UPPER_UPLEFT_HTC = 20,
1826 XRT_LIP_EXPRESSION_MOUTH_LOWER_DOWNRIGHT_HTC = 21,
1827 XRT_LIP_EXPRESSION_MOUTH_LOWER_DOWNLEFT_HTC = 22,
1828 XRT_LIP_EXPRESSION_MOUTH_UPPER_INSIDE_HTC = 23,
1829 XRT_LIP_EXPRESSION_MOUTH_LOWER_INSIDE_HTC = 24,
1830 XRT_LIP_EXPRESSION_MOUTH_LOWER_OVERLAY_HTC = 25,
1831 XRT_LIP_EXPRESSION_TONGUE_LONGSTEP1_HTC = 26,
1832 XRT_LIP_EXPRESSION_TONGUE_LEFT_HTC = 27,
1833 XRT_LIP_EXPRESSION_TONGUE_RIGHT_HTC = 28,
1834 XRT_LIP_EXPRESSION_TONGUE_UP_HTC = 29,
1835 XRT_LIP_EXPRESSION_TONGUE_DOWN_HTC = 30,
1836 XRT_LIP_EXPRESSION_TONGUE_ROLL_HTC = 31,
1837 XRT_LIP_EXPRESSION_TONGUE_LONGSTEP2_HTC = 32,
1838 XRT_LIP_EXPRESSION_TONGUE_UPRIGHT_MORPH_HTC = 33,
1839 XRT_LIP_EXPRESSION_TONGUE_UPLEFT_MORPH_HTC = 34,
1840 XRT_LIP_EXPRESSION_TONGUE_DOWNRIGHT_MORPH_HTC = 35,
1841 XRT_LIP_EXPRESSION_TONGUE_DOWNLEFT_MORPH_HTC = 36
1842};
1843
1844enum xrt_facial_tracking_type_htc
1845{
1846 XRT_FACIAL_TRACKING_TYPE_EYE_DEFAULT_HTC = 1,
1847 XRT_FACIAL_TRACKING_TYPE_LIP_DEFAULT_HTC = 2
1848};
1849
1850#define XRT_FACIAL_EXPRESSION_EYE_COUNT_HTC 14
1851#define XRT_FACIAL_EXPRESSION_LIP_COUNT_HTC 37
1852
1853enum xrt_face_confidence_regions_android
1854{
1855 XRT_FACE_CONFIDENCE_REGIONS_LOWER_ANDROID = 0,
1856 XRT_FACE_CONFIDENCE_REGIONS_LEFT_UPPER_ANDROID = 1,
1857 XRT_FACE_CONFIDENCE_REGIONS_RIGHT_UPPER_ANDROID = 2,
1858};
1859
1860enum xrt_face_parameter_indices_android
1861{
1862 XRT_FACE_PARAMETER_INDICES_BROW_LOWERER_L_ANDROID = 0,
1863 XRT_FACE_PARAMETER_INDICES_BROW_LOWERER_R_ANDROID = 1,
1864 XRT_FACE_PARAMETER_INDICES_CHEEK_PUFF_L_ANDROID = 2,
1865 XRT_FACE_PARAMETER_INDICES_CHEEK_PUFF_R_ANDROID = 3,
1866 XRT_FACE_PARAMETER_INDICES_CHEEK_RAISER_L_ANDROID = 4,
1867 XRT_FACE_PARAMETER_INDICES_CHEEK_RAISER_R_ANDROID = 5,
1868 XRT_FACE_PARAMETER_INDICES_CHEEK_SUCK_L_ANDROID = 6,
1869 XRT_FACE_PARAMETER_INDICES_CHEEK_SUCK_R_ANDROID = 7,
1870 XRT_FACE_PARAMETER_INDICES_CHIN_RAISER_B_ANDROID = 8,
1871 XRT_FACE_PARAMETER_INDICES_CHIN_RAISER_T_ANDROID = 9,
1872 XRT_FACE_PARAMETER_INDICES_DIMPLER_L_ANDROID = 10,
1873 XRT_FACE_PARAMETER_INDICES_DIMPLER_R_ANDROID = 11,
1874 XRT_FACE_PARAMETER_INDICES_EYES_CLOSED_L_ANDROID = 12,
1875 XRT_FACE_PARAMETER_INDICES_EYES_CLOSED_R_ANDROID = 13,
1876 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_DOWN_L_ANDROID = 14,
1877 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_DOWN_R_ANDROID = 15,
1878 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_LEFT_L_ANDROID = 16,
1879 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_LEFT_R_ANDROID = 17,
1880 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_RIGHT_L_ANDROID = 18,
1881 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_RIGHT_R_ANDROID = 19,
1882 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_UP_L_ANDROID = 20,
1883 XRT_FACE_PARAMETER_INDICES_EYES_LOOK_UP_R_ANDROID = 21,
1884 XRT_FACE_PARAMETER_INDICES_INNER_BROW_RAISER_L_ANDROID = 22,
1885 XRT_FACE_PARAMETER_INDICES_INNER_BROW_RAISER_R_ANDROID = 23,
1886 XRT_FACE_PARAMETER_INDICES_JAW_DROP_ANDROID = 24,
1887 XRT_FACE_PARAMETER_INDICES_JAW_SIDEWAYS_LEFT_ANDROID = 25,
1888 XRT_FACE_PARAMETER_INDICES_JAW_SIDEWAYS_RIGHT_ANDROID = 26,
1889 XRT_FACE_PARAMETER_INDICES_JAW_THRUST_ANDROID = 27,
1890 XRT_FACE_PARAMETER_INDICES_LID_TIGHTENER_L_ANDROID = 28,
1891 XRT_FACE_PARAMETER_INDICES_LID_TIGHTENER_R_ANDROID = 29,
1892 XRT_FACE_PARAMETER_INDICES_LIP_CORNER_DEPRESSOR_L_ANDROID = 30,
1893 XRT_FACE_PARAMETER_INDICES_LIP_CORNER_DEPRESSOR_R_ANDROID = 31,
1894 XRT_FACE_PARAMETER_INDICES_LIP_CORNER_PULLER_L_ANDROID = 32,
1895 XRT_FACE_PARAMETER_INDICES_LIP_CORNER_PULLER_R_ANDROID = 33,
1896 XRT_FACE_PARAMETER_INDICES_LIP_FUNNELER_LB_ANDROID = 34,
1897 XRT_FACE_PARAMETER_INDICES_LIP_FUNNELER_LT_ANDROID = 35,
1898 XRT_FACE_PARAMETER_INDICES_LIP_FUNNELER_RB_ANDROID = 36,
1899 XRT_FACE_PARAMETER_INDICES_LIP_FUNNELER_RT_ANDROID = 37,
1900 XRT_FACE_PARAMETER_INDICES_LIP_PRESSOR_L_ANDROID = 38,
1901 XRT_FACE_PARAMETER_INDICES_LIP_PRESSOR_R_ANDROID = 39,
1902 XRT_FACE_PARAMETER_INDICES_LIP_PUCKER_L_ANDROID = 40,
1903 XRT_FACE_PARAMETER_INDICES_LIP_PUCKER_R_ANDROID = 41,
1904 XRT_FACE_PARAMETER_INDICES_LIP_STRETCHER_L_ANDROID = 42,
1905 XRT_FACE_PARAMETER_INDICES_LIP_STRETCHER_R_ANDROID = 43,
1906 XRT_FACE_PARAMETER_INDICES_LIP_SUCK_LB_ANDROID = 44,
1907 XRT_FACE_PARAMETER_INDICES_LIP_SUCK_LT_ANDROID = 45,
1908 XRT_FACE_PARAMETER_INDICES_LIP_SUCK_RB_ANDROID = 46,
1909 XRT_FACE_PARAMETER_INDICES_LIP_SUCK_RT_ANDROID = 47,
1910 XRT_FACE_PARAMETER_INDICES_LIP_TIGHTENER_L_ANDROID = 48,
1911 XRT_FACE_PARAMETER_INDICES_LIP_TIGHTENER_R_ANDROID = 49,
1912 XRT_FACE_PARAMETER_INDICES_LIPS_TOWARD_ANDROID = 50,
1913 XRT_FACE_PARAMETER_INDICES_LOWER_LIP_DEPRESSOR_L_ANDROID = 51,
1914 XRT_FACE_PARAMETER_INDICES_LOWER_LIP_DEPRESSOR_R_ANDROID = 52,
1915 XRT_FACE_PARAMETER_INDICES_MOUTH_LEFT_ANDROID = 53,
1916 XRT_FACE_PARAMETER_INDICES_MOUTH_RIGHT_ANDROID = 54,
1917 XRT_FACE_PARAMETER_INDICES_NOSE_WRINKLER_L_ANDROID = 55,
1918 XRT_FACE_PARAMETER_INDICES_NOSE_WRINKLER_R_ANDROID = 56,
1919 XRT_FACE_PARAMETER_INDICES_OUTER_BROW_RAISER_L_ANDROID = 57,
1920 XRT_FACE_PARAMETER_INDICES_OUTER_BROW_RAISER_R_ANDROID = 58,
1921 XRT_FACE_PARAMETER_INDICES_UPPER_LID_RAISER_L_ANDROID = 59,
1922 XRT_FACE_PARAMETER_INDICES_UPPER_LID_RAISER_R_ANDROID = 60,
1923 XRT_FACE_PARAMETER_INDICES_UPPER_LIP_RAISER_L_ANDROID = 61,
1924 XRT_FACE_PARAMETER_INDICES_UPPER_LIP_RAISER_R_ANDROID = 62,
1925 XRT_FACE_PARAMETER_INDICES_TONGUE_OUT_ANDROID = 63,
1926 XRT_FACE_PARAMETER_INDICES_TONGUE_LEFT_ANDROID = 64,
1927 XRT_FACE_PARAMETER_INDICES_TONGUE_RIGHT_ANDROID = 65,
1928 XRT_FACE_PARAMETER_INDICES_TONGUE_UP_ANDROID = 66,
1929 XRT_FACE_PARAMETER_INDICES_TONGUE_DOWN_ANDROID = 67,
1930};
1931
1932enum xrt_face_tracking_state_android
1933{
1934 XRT_FACE_TRACKING_STATE_PAUSED_ANDROID = 0,
1935 XRT_FACE_TRACKING_STATE_STOPPED_ANDROID = 1,
1936 XRT_FACE_TRACKING_STATE_TRACKING_ANDROID = 2,
1937};
1938
1939#define XRT_FACE_PARAMETER_COUNT_ANDROID 68
1940
1941#define XRT_FACE_REGION_CONFIDENCE_COUNT_ANDROID 3
1942
1944{
1945 int64_t sample_time_ns;
1946 XRT_ALIGNAS(8) bool is_active;
1947};
1948
1950{
1952 /// ordered by @ref xrt_eye_expression_htc
1953 float expression_weights[XRT_FACIAL_EXPRESSION_EYE_COUNT_HTC];
1954};
1955
1957{
1959 /// ordered by @ref xrt_lip_expression_htc
1960 float expression_weights[XRT_FACIAL_EXPRESSION_LIP_COUNT_HTC];
1961};
1962
1964{
1965 float weights[XRT_FACE_EXPRESSION2_COUNT_FB];
1966 float confidences[XRT_FACE_CONFIDENCE2_COUNT_FB];
1967
1968 enum xrt_face_tracking_data_source2_fb data_source;
1969 int64_t sample_time_ns;
1970
1971 XRT_ALIGNAS(8) bool is_valid;
1972 bool is_eye_following_blendshapes_valid;
1973};
1974
1976{
1977 // ordered by xrt_face_parameter_indices_android
1978 float parameters[XRT_FACE_PARAMETER_COUNT_ANDROID];
1979 float region_confidences[XRT_FACE_REGION_CONFIDENCE_COUNT_ANDROID];
1980
1981 enum xrt_face_tracking_state_android state;
1982 int64_t sample_time_ns;
1983
1984 XRT_ALIGNAS(8) bool is_valid;
1985};
1986
1988{
1989 union {
1990 struct xrt_facial_base_expression_set_htc base_expression_set_htc;
1991 struct xrt_facial_eye_expression_set_htc eye_expression_set_htc;
1992 struct xrt_facial_lip_expression_set_htc lip_expression_set_htc;
1993 struct xrt_facial_expression_set2_fb face_expression_set2_fb;
1994 struct xrt_facial_expression_set_android face_expression_set_android;
1995 };
1996};
1997
1998/// @addtogroup XR_FB_body_tracking
1999enum xrt_body_joint_fb
2000{
2001 XRT_BODY_JOINT_ROOT_FB = 0,
2002 XRT_BODY_JOINT_HIPS_FB = 1,
2003 XRT_BODY_JOINT_SPINE_LOWER_FB = 2,
2004 XRT_BODY_JOINT_SPINE_MIDDLE_FB = 3,
2005 XRT_BODY_JOINT_SPINE_UPPER_FB = 4,
2006 XRT_BODY_JOINT_CHEST_FB = 5,
2007 XRT_BODY_JOINT_NECK_FB = 6,
2008 XRT_BODY_JOINT_HEAD_FB = 7,
2009 XRT_BODY_JOINT_LEFT_SHOULDER_FB = 8,
2010 XRT_BODY_JOINT_LEFT_SCAPULA_FB = 9,
2011 XRT_BODY_JOINT_LEFT_ARM_UPPER_FB = 10,
2012 XRT_BODY_JOINT_LEFT_ARM_LOWER_FB = 11,
2013 XRT_BODY_JOINT_LEFT_HAND_WRIST_TWIST_FB = 12,
2014 XRT_BODY_JOINT_RIGHT_SHOULDER_FB = 13,
2015 XRT_BODY_JOINT_RIGHT_SCAPULA_FB = 14,
2016 XRT_BODY_JOINT_RIGHT_ARM_UPPER_FB = 15,
2017 XRT_BODY_JOINT_RIGHT_ARM_LOWER_FB = 16,
2018 XRT_BODY_JOINT_RIGHT_HAND_WRIST_TWIST_FB = 17,
2019 XRT_BODY_JOINT_LEFT_HAND_PALM_FB = 18,
2020 XRT_BODY_JOINT_LEFT_HAND_WRIST_FB = 19,
2021 XRT_BODY_JOINT_LEFT_HAND_THUMB_METACARPAL_FB = 20,
2022 XRT_BODY_JOINT_LEFT_HAND_THUMB_PROXIMAL_FB = 21,
2023 XRT_BODY_JOINT_LEFT_HAND_THUMB_DISTAL_FB = 22,
2024 XRT_BODY_JOINT_LEFT_HAND_THUMB_TIP_FB = 23,
2025 XRT_BODY_JOINT_LEFT_HAND_INDEX_METACARPAL_FB = 24,
2026 XRT_BODY_JOINT_LEFT_HAND_INDEX_PROXIMAL_FB = 25,
2027 XRT_BODY_JOINT_LEFT_HAND_INDEX_INTERMEDIATE_FB = 26,
2028 XRT_BODY_JOINT_LEFT_HAND_INDEX_DISTAL_FB = 27,
2029 XRT_BODY_JOINT_LEFT_HAND_INDEX_TIP_FB = 28,
2030 XRT_BODY_JOINT_LEFT_HAND_MIDDLE_METACARPAL_FB = 29,
2031 XRT_BODY_JOINT_LEFT_HAND_MIDDLE_PROXIMAL_FB = 30,
2032 XRT_BODY_JOINT_LEFT_HAND_MIDDLE_INTERMEDIATE_FB = 31,
2033 XRT_BODY_JOINT_LEFT_HAND_MIDDLE_DISTAL_FB = 32,
2034 XRT_BODY_JOINT_LEFT_HAND_MIDDLE_TIP_FB = 33,
2035 XRT_BODY_JOINT_LEFT_HAND_RING_METACARPAL_FB = 34,
2036 XRT_BODY_JOINT_LEFT_HAND_RING_PROXIMAL_FB = 35,
2037 XRT_BODY_JOINT_LEFT_HAND_RING_INTERMEDIATE_FB = 36,
2038 XRT_BODY_JOINT_LEFT_HAND_RING_DISTAL_FB = 37,
2039 XRT_BODY_JOINT_LEFT_HAND_RING_TIP_FB = 38,
2040 XRT_BODY_JOINT_LEFT_HAND_LITTLE_METACARPAL_FB = 39,
2041 XRT_BODY_JOINT_LEFT_HAND_LITTLE_PROXIMAL_FB = 40,
2042 XRT_BODY_JOINT_LEFT_HAND_LITTLE_INTERMEDIATE_FB = 41,
2043 XRT_BODY_JOINT_LEFT_HAND_LITTLE_DISTAL_FB = 42,
2044 XRT_BODY_JOINT_LEFT_HAND_LITTLE_TIP_FB = 43,
2045 XRT_BODY_JOINT_RIGHT_HAND_PALM_FB = 44,
2046 XRT_BODY_JOINT_RIGHT_HAND_WRIST_FB = 45,
2047 XRT_BODY_JOINT_RIGHT_HAND_THUMB_METACARPAL_FB = 46,
2048 XRT_BODY_JOINT_RIGHT_HAND_THUMB_PROXIMAL_FB = 47,
2049 XRT_BODY_JOINT_RIGHT_HAND_THUMB_DISTAL_FB = 48,
2050 XRT_BODY_JOINT_RIGHT_HAND_THUMB_TIP_FB = 49,
2051 XRT_BODY_JOINT_RIGHT_HAND_INDEX_METACARPAL_FB = 50,
2052 XRT_BODY_JOINT_RIGHT_HAND_INDEX_PROXIMAL_FB = 51,
2053 XRT_BODY_JOINT_RIGHT_HAND_INDEX_INTERMEDIATE_FB = 52,
2054 XRT_BODY_JOINT_RIGHT_HAND_INDEX_DISTAL_FB = 53,
2055 XRT_BODY_JOINT_RIGHT_HAND_INDEX_TIP_FB = 54,
2056 XRT_BODY_JOINT_RIGHT_HAND_MIDDLE_METACARPAL_FB = 55,
2057 XRT_BODY_JOINT_RIGHT_HAND_MIDDLE_PROXIMAL_FB = 56,
2058 XRT_BODY_JOINT_RIGHT_HAND_MIDDLE_INTERMEDIATE_FB = 57,
2059 XRT_BODY_JOINT_RIGHT_HAND_MIDDLE_DISTAL_FB = 58,
2060 XRT_BODY_JOINT_RIGHT_HAND_MIDDLE_TIP_FB = 59,
2061 XRT_BODY_JOINT_RIGHT_HAND_RING_METACARPAL_FB = 60,
2062 XRT_BODY_JOINT_RIGHT_HAND_RING_PROXIMAL_FB = 61,
2063 XRT_BODY_JOINT_RIGHT_HAND_RING_INTERMEDIATE_FB = 62,
2064 XRT_BODY_JOINT_RIGHT_HAND_RING_DISTAL_FB = 63,
2065 XRT_BODY_JOINT_RIGHT_HAND_RING_TIP_FB = 64,
2066 XRT_BODY_JOINT_RIGHT_HAND_LITTLE_METACARPAL_FB = 65,
2067 XRT_BODY_JOINT_RIGHT_HAND_LITTLE_PROXIMAL_FB = 66,
2068 XRT_BODY_JOINT_RIGHT_HAND_LITTLE_INTERMEDIATE_FB = 67,
2069 XRT_BODY_JOINT_RIGHT_HAND_LITTLE_DISTAL_FB = 68,
2070 XRT_BODY_JOINT_RIGHT_HAND_LITTLE_TIP_FB = 69,
2071 XRT_BODY_JOINT_COUNT_FB = 70,
2072 XRT_BODY_JOINT_NONE_FB = -1,
2073};
2074
2075/// @addtogroup XR_META_body_tracking_full_body
2076enum xrt_full_body_joint_meta
2077{
2078 XRT_FULL_BODY_JOINT_ROOT_META = 0,
2079 XRT_FULL_BODY_JOINT_HIPS_META = 1,
2080 XRT_FULL_BODY_JOINT_SPINE_LOWER_META = 2,
2081 XRT_FULL_BODY_JOINT_SPINE_MIDDLE_META = 3,
2082 XRT_FULL_BODY_JOINT_SPINE_UPPER_META = 4,
2083 XRT_FULL_BODY_JOINT_CHEST_META = 5,
2084 XRT_FULL_BODY_JOINT_NECK_META = 6,
2085 XRT_FULL_BODY_JOINT_HEAD_META = 7,
2086 XRT_FULL_BODY_JOINT_LEFT_SHOULDER_META = 8,
2087 XRT_FULL_BODY_JOINT_LEFT_SCAPULA_META = 9,
2088 XRT_FULL_BODY_JOINT_LEFT_ARM_UPPER_META = 10,
2089 XRT_FULL_BODY_JOINT_LEFT_ARM_LOWER_META = 11,
2090 XRT_FULL_BODY_JOINT_LEFT_HAND_WRIST_TWIST_META = 12,
2091 XRT_FULL_BODY_JOINT_RIGHT_SHOULDER_META = 13,
2092 XRT_FULL_BODY_JOINT_RIGHT_SCAPULA_META = 14,
2093 XRT_FULL_BODY_JOINT_RIGHT_ARM_UPPER_META = 15,
2094 XRT_FULL_BODY_JOINT_RIGHT_ARM_LOWER_META = 16,
2095 XRT_FULL_BODY_JOINT_RIGHT_HAND_WRIST_TWIST_META = 17,
2096 XRT_FULL_BODY_JOINT_LEFT_HAND_PALM_META = 18,
2097 XRT_FULL_BODY_JOINT_LEFT_HAND_WRIST_META = 19,
2098 XRT_FULL_BODY_JOINT_LEFT_HAND_THUMB_METACARPAL_META = 20,
2099 XRT_FULL_BODY_JOINT_LEFT_HAND_THUMB_PROXIMAL_META = 21,
2100 XRT_FULL_BODY_JOINT_LEFT_HAND_THUMB_DISTAL_META = 22,
2101 XRT_FULL_BODY_JOINT_LEFT_HAND_THUMB_TIP_META = 23,
2102 XRT_FULL_BODY_JOINT_LEFT_HAND_INDEX_METACARPAL_META = 24,
2103 XRT_FULL_BODY_JOINT_LEFT_HAND_INDEX_PROXIMAL_META = 25,
2104 XRT_FULL_BODY_JOINT_LEFT_HAND_INDEX_INTERMEDIATE_META = 26,
2105 XRT_FULL_BODY_JOINT_LEFT_HAND_INDEX_DISTAL_META = 27,
2106 XRT_FULL_BODY_JOINT_LEFT_HAND_INDEX_TIP_META = 28,
2107 XRT_FULL_BODY_JOINT_LEFT_HAND_MIDDLE_METACARPAL_META = 29,
2108 XRT_FULL_BODY_JOINT_LEFT_HAND_MIDDLE_PROXIMAL_META = 30,
2109 XRT_FULL_BODY_JOINT_LEFT_HAND_MIDDLE_INTERMEDIATE_META = 31,
2110 XRT_FULL_BODY_JOINT_LEFT_HAND_MIDDLE_DISTAL_META = 32,
2111 XRT_FULL_BODY_JOINT_LEFT_HAND_MIDDLE_TIP_META = 33,
2112 XRT_FULL_BODY_JOINT_LEFT_HAND_RING_METACARPAL_META = 34,
2113 XRT_FULL_BODY_JOINT_LEFT_HAND_RING_PROXIMAL_META = 35,
2114 XRT_FULL_BODY_JOINT_LEFT_HAND_RING_INTERMEDIATE_META = 36,
2115 XRT_FULL_BODY_JOINT_LEFT_HAND_RING_DISTAL_META = 37,
2116 XRT_FULL_BODY_JOINT_LEFT_HAND_RING_TIP_META = 38,
2117 XRT_FULL_BODY_JOINT_LEFT_HAND_LITTLE_METACARPAL_META = 39,
2118 XRT_FULL_BODY_JOINT_LEFT_HAND_LITTLE_PROXIMAL_META = 40,
2119 XRT_FULL_BODY_JOINT_LEFT_HAND_LITTLE_INTERMEDIATE_META = 41,
2120 XRT_FULL_BODY_JOINT_LEFT_HAND_LITTLE_DISTAL_META = 42,
2121 XRT_FULL_BODY_JOINT_LEFT_HAND_LITTLE_TIP_META = 43,
2122 XRT_FULL_BODY_JOINT_RIGHT_HAND_PALM_META = 44,
2123 XRT_FULL_BODY_JOINT_RIGHT_HAND_WRIST_META = 45,
2124 XRT_FULL_BODY_JOINT_RIGHT_HAND_THUMB_METACARPAL_META = 46,
2125 XRT_FULL_BODY_JOINT_RIGHT_HAND_THUMB_PROXIMAL_META = 47,
2126 XRT_FULL_BODY_JOINT_RIGHT_HAND_THUMB_DISTAL_META = 48,
2127 XRT_FULL_BODY_JOINT_RIGHT_HAND_THUMB_TIP_META = 49,
2128 XRT_FULL_BODY_JOINT_RIGHT_HAND_INDEX_METACARPAL_META = 50,
2129 XRT_FULL_BODY_JOINT_RIGHT_HAND_INDEX_PROXIMAL_META = 51,
2130 XRT_FULL_BODY_JOINT_RIGHT_HAND_INDEX_INTERMEDIATE_META = 52,
2131 XRT_FULL_BODY_JOINT_RIGHT_HAND_INDEX_DISTAL_META = 53,
2132 XRT_FULL_BODY_JOINT_RIGHT_HAND_INDEX_TIP_META = 54,
2133 XRT_FULL_BODY_JOINT_RIGHT_HAND_MIDDLE_METACARPAL_META = 55,
2134 XRT_FULL_BODY_JOINT_RIGHT_HAND_MIDDLE_PROXIMAL_META = 56,
2135 XRT_FULL_BODY_JOINT_RIGHT_HAND_MIDDLE_INTERMEDIATE_META = 57,
2136 XRT_FULL_BODY_JOINT_RIGHT_HAND_MIDDLE_DISTAL_META = 58,
2137 XRT_FULL_BODY_JOINT_RIGHT_HAND_MIDDLE_TIP_META = 59,
2138 XRT_FULL_BODY_JOINT_RIGHT_HAND_RING_METACARPAL_META = 60,
2139 XRT_FULL_BODY_JOINT_RIGHT_HAND_RING_PROXIMAL_META = 61,
2140 XRT_FULL_BODY_JOINT_RIGHT_HAND_RING_INTERMEDIATE_META = 62,
2141 XRT_FULL_BODY_JOINT_RIGHT_HAND_RING_DISTAL_META = 63,
2142 XRT_FULL_BODY_JOINT_RIGHT_HAND_RING_TIP_META = 64,
2143 XRT_FULL_BODY_JOINT_RIGHT_HAND_LITTLE_METACARPAL_META = 65,
2144 XRT_FULL_BODY_JOINT_RIGHT_HAND_LITTLE_PROXIMAL_META = 66,
2145 XRT_FULL_BODY_JOINT_RIGHT_HAND_LITTLE_INTERMEDIATE_META = 67,
2146 XRT_FULL_BODY_JOINT_RIGHT_HAND_LITTLE_DISTAL_META = 68,
2147 XRT_FULL_BODY_JOINT_RIGHT_HAND_LITTLE_TIP_META = 69,
2148 XRT_FULL_BODY_JOINT_LEFT_UPPER_LEG_META = 70,
2149 XRT_FULL_BODY_JOINT_LEFT_LOWER_LEG_META = 71,
2150 XRT_FULL_BODY_JOINT_LEFT_FOOT_ANKLE_TWIST_META = 72,
2151 XRT_FULL_BODY_JOINT_LEFT_FOOT_ANKLE_META = 73,
2152 XRT_FULL_BODY_JOINT_LEFT_FOOT_SUBTALAR_META = 74,
2153 XRT_FULL_BODY_JOINT_LEFT_FOOT_TRANSVERSE_META = 75,
2154 XRT_FULL_BODY_JOINT_LEFT_FOOT_BALL_META = 76,
2155 XRT_FULL_BODY_JOINT_RIGHT_UPPER_LEG_META = 77,
2156 XRT_FULL_BODY_JOINT_RIGHT_LOWER_LEG_META = 78,
2157 XRT_FULL_BODY_JOINT_RIGHT_FOOT_ANKLE_TWIST_META = 79,
2158 XRT_FULL_BODY_JOINT_RIGHT_FOOT_ANKLE_META = 80,
2159 XRT_FULL_BODY_JOINT_RIGHT_FOOT_SUBTALAR_META = 81,
2160 XRT_FULL_BODY_JOINT_RIGHT_FOOT_TRANSVERSE_META = 82,
2161 XRT_FULL_BODY_JOINT_RIGHT_FOOT_BALL_META = 83,
2162 XRT_FULL_BODY_JOINT_COUNT_META = 84,
2163 XRT_FULL_BODY_JOINT_NONE_META = 85,
2164};
2165
2166/// @addtogroup XR_META_body_tracking_full_body
2167enum xrt_body_joint_set_type_fb
2168{
2169 XRT_BODY_JOINT_SET_UNKNOWN = 0,
2170 // XR_FB_body_tracking
2171 XRT_BODY_JOINT_SET_DEFAULT_FB,
2172 // XR_META_body_tracking_full_body
2173 XRT_BODY_JOINT_SET_FULL_BODY_META,
2174};
2175
2176/// @addtogroup XR_META_body_tracking_calibration
2177enum xrt_body_tracking_calibration_state_meta
2178{
2179 // Valid calibration, pose is safe to use
2180 XRT_BODY_TRACKING_CALIBRATION_STATE_VALID_META = 1,
2181 // Calibration is still running, pose may be incorrect
2182 XRT_BODY_TRACKING_CALIBRATION_STATE_CALIBRATING_META = 2,
2183 // Calibration is invalid, pose is not safe to use
2184 XRT_BODY_TRACKING_CALIBRATION_STATE_INVALID_META = 3,
2185};
2186
2187/// @addtogroup XR_META_body_tracking_fidelity
2188enum xrt_body_tracking_fidelity_meta
2189{
2190 XRT_BODY_TRACKING_FIDELITY_LOW_META = 1,
2191 XRT_BODY_TRACKING_FIDELITY_HIGH_META = 2,
2192};
2193
2194/// @addtogroup XR_FB_body_tracking
2196{
2197 struct xrt_pose pose;
2198 int32_t joint;
2199 int32_t parent_joint;
2200};
2201
2202/// @addtogroup XR_FB_body_tracking
2204{
2205 /// ordered by @ref xrt_body_joint_fb
2206 struct xrt_body_skeleton_joint_fb joints[XRT_BODY_JOINT_COUNT_FB];
2207};
2208
2209/// @addtogroup XR_META_body_tracking_full_body
2211{
2212 /// ordered by @ref xrt_full_body_joint_meta
2213 struct xrt_body_skeleton_joint_fb joints[XRT_FULL_BODY_JOINT_COUNT_META];
2214};
2215
2216// structure is a container to represent the body skeleton in T-pose including the joint hierarchy,
2217// can have info such as skeleton scale and proportions
2219{
2220 union {
2221 struct xrt_body_skeleton_fb body_skeleton_fb;
2222 struct xrt_full_body_skeleton_meta full_body_skeleton_meta;
2223 };
2224};
2225
2227{
2228 struct xrt_space_relation relation;
2229};
2230
2232{
2233 int64_t sample_time_ns;
2234 float confidence;
2235 uint32_t skeleton_changed_count;
2236 XRT_ALIGNAS(8) bool is_active;
2237
2238 struct
2239 {
2240 // Requires XR_META_body_tracking_calibration, @ref xrt_device_supported::body_tracking_calibration
2241 enum xrt_body_tracking_calibration_state_meta calibration_status;
2242
2243 // Requires XR_META_body_tracking_fidelity, @ref xrt_device_supported::body_tracking_fidelity
2244 enum xrt_body_tracking_fidelity_meta fidelity_status;
2245 } exts;
2246};
2247
2248// XR_FB_body_tracking
2250{
2251 struct xrt_base_body_joint_set_meta base;
2252 // ordered by xrt_body_joint_fb
2253 struct xrt_body_joint_location_fb joint_locations[XRT_BODY_JOINT_COUNT_FB];
2254};
2255
2256// XR_META_body_tracking_full_body
2258{
2259 struct xrt_base_body_joint_set_meta base;
2260 // ordered by xrt_full_body_joint_meta
2261 struct xrt_body_joint_location_fb joint_locations[XRT_FULL_BODY_JOINT_COUNT_META];
2262};
2263
2264/*
2265 *
2266 * XR_BD_body_tracking (PICO body tracking)
2267 *
2268 */
2269
2270#define XRT_BODY_JOINT_COUNT_BD 24
2271#define XRT_BODY_JOINT_WITHOUT_ARM_COUNT_BD 16
2272
2273enum xrt_body_joint_bd
2274{
2275 XRT_BODY_JOINT_PELVIS_BD = 0,
2276 XRT_BODY_JOINT_LEFT_HIP_BD = 1,
2277 XRT_BODY_JOINT_RIGHT_HIP_BD = 2,
2278 XRT_BODY_JOINT_SPINE1_BD = 3,
2279 XRT_BODY_JOINT_LEFT_KNEE_BD = 4,
2280 XRT_BODY_JOINT_RIGHT_KNEE_BD = 5,
2281 XRT_BODY_JOINT_SPINE2_BD = 6,
2282 XRT_BODY_JOINT_LEFT_ANKLE_BD = 7,
2283 XRT_BODY_JOINT_RIGHT_ANKLE_BD = 8,
2284 XRT_BODY_JOINT_SPINE3_BD = 9,
2285 XRT_BODY_JOINT_LEFT_FOOT_BD = 10,
2286 XRT_BODY_JOINT_RIGHT_FOOT_BD = 11,
2287 XRT_BODY_JOINT_NECK_BD = 12,
2288 XRT_BODY_JOINT_LEFT_COLLAR_BD = 13,
2289 XRT_BODY_JOINT_RIGHT_COLLAR_BD = 14,
2290 XRT_BODY_JOINT_HEAD_BD = 15,
2291 XRT_BODY_JOINT_LEFT_SHOULDER_BD = 16,
2292 XRT_BODY_JOINT_RIGHT_SHOULDER_BD = 17,
2293 XRT_BODY_JOINT_LEFT_ELBOW_BD = 18,
2294 XRT_BODY_JOINT_RIGHT_ELBOW_BD = 19,
2295 XRT_BODY_JOINT_LEFT_WRIST_BD = 20,
2296 XRT_BODY_JOINT_RIGHT_WRIST_BD = 21,
2297 XRT_BODY_JOINT_LEFT_HAND_BD = 22,
2298 XRT_BODY_JOINT_RIGHT_HAND_BD = 23,
2299};
2300
2301enum xrt_body_joint_set_type_bd
2302{
2303 XRT_BODY_JOINT_SET_UNKNOWN_BD = 0,
2304 XRT_BODY_JOINT_SET_BODY_WITHOUT_ARM_BD = 1,
2305 XRT_BODY_JOINT_SET_FULL_BODY_BD = 2,
2306};
2307
2309{
2310 struct xrt_space_relation relation;
2311};
2312
2314{
2315 int64_t sample_time_ns;
2316 struct xrt_body_joint_location_bd joint_locations[XRT_BODY_JOINT_COUNT_BD];
2317 XRT_ALIGNAS(8) bool is_active;
2318 bool all_joint_poses_tracked;
2319};
2320
2322{
2323 union {
2324 struct xrt_base_body_joint_set_meta base_body_joint_set_meta;
2325 struct xrt_body_joint_set_fb body_joint_set_fb;
2326 struct xrt_full_body_joint_set_meta full_body_joint_set_meta;
2327 struct xrt_body_joint_set_bd body_joint_set_bd;
2328 };
2329 // in driver global space, without tracking_origin offset
2330 struct xrt_space_relation body_pose;
2331};
2332
2333/*!
2334 * Value used to indicate a haptic pulse of the minimal supported duration.
2335 *
2336 * @ingroup xrt_iface
2337 */
2338#define XRT_MIN_HAPTIC_DURATION -1
2339
2340/*!
2341 * Value used to indicate a haptic pulse of some runtime defined optimal
2342 * frequency.
2343 *
2344 * @ingroup xrt_iface
2345 */
2346
2347#define XRT_FREQUENCY_UNSPECIFIED 0
2348
2349/*!
2350 * Value used as a timeout to indicate the timeout should never occur.
2351 *
2352 * @ingroup xrt_iface
2353 */
2354#define XRT_INFINITE_DURATION (0x7fffffffffffffffLL)
2355
2356enum xrt_force_feedback_location
2357{
2358 XRT_FORCE_FEEDBACK_LOCATION_LEFT_THUMB,
2359 XRT_FORCE_FEEDBACK_LOCATION_LEFT_INDEX,
2360 XRT_FORCE_FEEDBACK_LOCATION_LEFT_MIDDLE,
2361 XRT_FORCE_FEEDBACK_LOCATION_LEFT_RING,
2362 XRT_FORCE_FEEDBACK_LOCATION_LEFT_PINKY,
2363};
2364
2366{
2367 float value;
2368 enum xrt_force_feedback_location location;
2369};
2370
2371enum xrt_output_value_type
2372{
2373 XRT_OUTPUT_VALUE_TYPE_VIBRATION,
2374 XRT_OUTPUT_VALUE_TYPE_PCM_VIBRATION,
2375 XRT_OUTPUT_VALUE_TYPE_FORCE_FEEDBACK,
2376};
2377
2379{
2380 XRT_ALIGNAS(8) float frequency;
2381 float amplitude;
2382 int64_t duration_ns;
2383};
2384
2386{
2387 uint32_t buffer_size;
2388 XRT_ALIGNAS(8) const float *buffer;
2389 XRT_ALIGNAS(8) float sample_rate;
2390 bool append;
2391 uint32_t *samples_consumed;
2392};
2393
2395{
2396 struct xrt_output_force_feedback force_feedback[5];
2397 uint64_t force_feedback_location_count;
2398};
2399
2400/*!
2401 * A union of all output types.
2402 *
2403 * @see xrt_output_type
2404 * @ingroup xrt_iface math
2405 */
2407{
2408 enum xrt_output_value_type type;
2409
2410 union {
2411 struct xrt_output_value_vibration vibration;
2412 struct xrt_output_value_pcm_vibration pcm_vibration;
2413 struct xrt_output_value_force_feedback force_feedback;
2414 };
2415};
2416
2417/*
2418 *
2419 * Misc enums.
2420 *
2421 */
2422
2423/*!
2424 * What form factor is this device, mostly maps onto OpenXR's @p XrFormFactor.
2425 *
2426 * @ingroup xrt_iface
2427 */
2429{
2430 XRT_FORM_FACTOR_HMD, //!< Head mounted display.
2431 XRT_FORM_FACTOR_HANDHELD, //!< Handheld display.
2432};
2433
2434/*!
2435 * View type to be rendered to by the compositor.
2436 */
2438{
2439 XRT_VIEW_TYPE_MONO = 1,
2440 XRT_VIEW_TYPE_STEREO = 2,
2441 XRT_VIEW_TYPE_QUAD = 3,
2442};
2443
2444/*!
2445 * Domain type.
2446 * Use for performance level setting
2447 * Which hardware should be boost/decrease
2448 */
2450{
2451 XRT_PERF_DOMAIN_CPU = 1,
2452 XRT_PERF_DOMAIN_GPU = 2,
2453};
2454
2455enum xrt_perf_sub_domain
2456{
2457 XRT_PERF_SUB_DOMAIN_COMPOSITING = 1,
2458 XRT_PERF_SUB_DOMAIN_RENDERING = 2,
2459 XRT_PERF_SUB_DOMAIN_THERMAL = 3
2460};
2461
2462/*!
2463 * Performance level.
2464 */
2466{
2467 XRT_PERF_SET_LEVEL_POWER_SAVINGS = 0,
2468 XRT_PERF_SET_LEVEL_SUSTAINED_LOW = 25,
2469 XRT_PERF_SET_LEVEL_SUSTAINED_HIGH = 50,
2470 XRT_PERF_SET_LEVEL_BOOST = 75,
2471};
2472
2473/*!
2474 * Performance level.
2475 */
2477{
2478 XRT_PERF_NOTIFY_LEVEL_NORMAL = 0,
2479 XRT_PERF_NOTIFY_LEVEL_WARNING = 25,
2480 XRT_PERF_NOTIFY_LEVEL_IMPAIRED = 75,
2481};
2482
2483/*!
2484 * Visibility mask, mirror of XrVisibilityMaskKHR
2485 *
2486 * @ingroup xrt_iface
2487 */
2489{
2490 XRT_VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH = 1,
2491 XRT_VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH = 2,
2492 XRT_VISIBILITY_MASK_TYPE_LINE_LOOP = 3,
2493};
2494
2495
2496/*
2497 *
2498 * Inline functions
2499 *
2500 */
2501
2502// @note We're not using U_LOG_RAW because we can't include u_logging.h inside xrt_defines.h without causing problems.
2503#if 0
2504#define XRT_REFERENCE_DEBUG_PRINT(ACTION, PTR, COUNT) \
2505 do { \
2506 int32_t __count = (COUNT); \
2507 printf(#ACTION " %p to %u", (void *)(PTR), __count); \
2508 if (__count < 0) { \
2509 XRT_DEBUGBREAK(); \
2510 } \
2511 } while (false)
2512#else
2513#define XRT_REFERENCE_DEBUG_PRINT(ACTION, PTR, COUNT)
2514#endif
2515
2516/*!
2517 * Increment the reference, probably want @ref xrt_reference_inc_and_was_zero.
2518 *
2519 * @memberof xrt_reference
2520 * @ingroup xrt_iface
2521 */
2522static inline void
2524{
2525 XRT_MAYBE_UNUSED int32_t count = xrt_atomic_s32_inc_return(&xref->count);
2526
2527 XRT_REFERENCE_DEBUG_PRINT(Incremented, xref, count);
2528}
2529
2530/*!
2531 * Decrement the reference, probably want @ref xrt_reference_dec_and_is_zero.
2532 *
2533 * @memberof xrt_reference
2534 * @ingroup xrt_iface
2535 */
2536static inline void
2538{
2539 XRT_MAYBE_UNUSED int32_t count = xrt_atomic_s32_dec_return(&xref->count);
2540
2541 XRT_REFERENCE_DEBUG_PRINT(Decremented, xref, count);
2542}
2543
2544/*!
2545 * Increment the reference and return true if the value @p was zero.
2546 *
2547 * @memberof xrt_reference
2548 * @ingroup xrt_iface
2549 */
2550XRT_CHECK_RESULT static inline bool
2552{
2553 int32_t count = xrt_atomic_s32_inc_return(&xref->count);
2554
2555 XRT_REFERENCE_DEBUG_PRINT(Incremented, xref, count);
2556
2557 return count == 1;
2558}
2559
2560/*!
2561 * Decrement the reference and return true if the value is now zero.
2562 *
2563 * @memberof xrt_reference
2564 * @ingroup xrt_iface
2565 */
2566XRT_CHECK_RESULT static inline bool
2568{
2569 int32_t count = xrt_atomic_s32_dec_return(&xref->count);
2570
2571 XRT_REFERENCE_DEBUG_PRINT(Decremented, xref, count);
2572
2573 return count == 0;
2574}
2575
2576#ifdef __cplusplus
2577}
2578#endif
xrt_input_type
Base type of this inputs.
Definition xrt_defines.h:868
xrt_hand
Enumeration for left and right hand.
Definition xrt_defines.h:1499
#define XRT_MATRIX_3X3_ELEMENTS
The number of values in xrt_matrix_3x3.
Definition xrt_defines.h:572
xrt_stereo_format
What type of stereo format a frame has.
Definition xrt_defines.h:233
xrt_visibility_mask_type
Visibility mask, mirror of XrVisibilityMaskKHR.
Definition xrt_defines.h:2489
xrt_blend_mode
Blend mode that the device supports, exact mirror of XrEnvironmentBlendMode.
Definition xrt_defines.h:112
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:2567
#define XRT_INPUT_NAME(id, type)
Create an enum value for xrt_input_name that packs an ID and input type.
Definition xrt_defines.h:919
#define XRT_OUTPUT_NAME(id, type)
Create an enum value for xrt_output_name that packs an ID and output type.
Definition xrt_defines.h:1589
xrt_form_factor
What form factor is this device, mostly maps onto OpenXR's XrFormFactor.
Definition xrt_defines.h:2429
xrt_input_name
Every internal input source known to monado with a baked in type.
Definition xrt_defines.h:951
xrt_output_type
Base type of this output.
Definition xrt_defines.h:1619
static XRT_CHECK_RESULT bool xrt_reference_inc_and_was_zero(struct xrt_reference *xref)
Increment the reference and return true if the value was zero.
Definition xrt_defines.h:2551
#define XRT_UUID_SIZE
Internal define for VK_UUID_SIZE and XR_UUID_SIZE_EXT.
Definition xrt_defines.h:31
#define XRT_MATRIX_2X2_ELEMENTS
The number of values in xrt_matrix_2x2.
Definition xrt_defines.h:545
static void xrt_reference_inc(struct xrt_reference *xref)
Increment the reference, probably want xrt_reference_inc_and_was_zero.
Definition xrt_defines.h:2523
#define XRT_MATRIX_2X2_VECS
The number of 2d vectors in xrt_matrix_2x2.
Definition xrt_defines.h:552
#define XRT_LUID_SIZE
Internal define for VK_LUID_SIZE.
Definition xrt_defines.h:55
static void xrt_reference_dec(struct xrt_reference *xref)
Decrement the reference, probably want xrt_reference_dec_and_is_zero.
Definition xrt_defines.h:2537
xrt_reference_space_type
Type of a OpenXR mapped reference space, maps to the semantic spaces on the xrt_space_overseer struct...
Definition xrt_defines.h:646
#define XRT_HAND_JOINT_COUNT
Number of joints in a hand.
Definition xrt_defines.h:1455
xrt_output_name
Name of a output with a baked in type.
Definition xrt_defines.h:1633
xrt_finger
Names for fingers on a hand.
Definition xrt_defines.h:1528
xrt_hand_joint
Number of joints in a hand.
Definition xrt_defines.h:1463
#define XRT_MATRIX_4X4_ELEMENTS
The number of values in a 4x4 matrix like xrt_matrix_4x4 and xrt_matrix_4x4_f64.
Definition xrt_defines.h:599
xrt_space_relation_flags
Flags of which components of a xrt_space_relation is valid.
Definition xrt_defines.h:676
xrt_device_type
How an xrt_device can be used.
Definition xrt_defines.h:848
@ XRT_INPUT_TYPE_POSE
A tracked pose.
Definition xrt_defines.h:881
@ XRT_INPUT_TYPE_VEC2_MINUS_ONE_TO_ONE
Vec2 input, components in [-1, 1].
Definition xrt_defines.h:875
@ XRT_INPUT_TYPE_VEC3_MINUS_ONE_TO_ONE
Vec3 input, components in [-1, 1].
Definition xrt_defines.h:877
@ XRT_INPUT_TYPE_FACE_TRACKING
A tracked face.
Definition xrt_defines.h:885
@ XRT_INPUT_TYPE_BODY_TRACKING
A tracked body.
Definition xrt_defines.h:887
@ XRT_INPUT_TYPE_HAND_TRACKING
A tracked hand.
Definition xrt_defines.h:883
@ XRT_INPUT_TYPE_VEC1_MINUS_ONE_TO_ONE
Float input in [-1, 1].
Definition xrt_defines.h:873
@ XRT_INPUT_TYPE_BOOLEAN
Boolean (digital, binary) input.
Definition xrt_defines.h:879
@ XRT_INPUT_TYPE_VEC1_ZERO_TO_ONE
Float input in [0, 1].
Definition xrt_defines.h:871
@ XRT_STEREO_FORMAT_OAU
Over & Under.
Definition xrt_defines.h:237
@ XRT_STEREO_FORMAT_SBS
Side by side.
Definition xrt_defines.h:235
@ XRT_STEREO_FORMAT_INTERLEAVED
Interleaved pixels.
Definition xrt_defines.h:236
@ XRT_FORM_FACTOR_HANDHELD
Handheld display.
Definition xrt_defines.h:2431
@ XRT_FORM_FACTOR_HMD
Head mounted display.
Definition xrt_defines.h:2430
@ XRT_INPUT_GENERIC_PALM_POSE
XR_EXT_palm_pose.
Definition xrt_defines.h:962
@ XRT_INPUT_GENERIC_EYE_GAZE_POSE
XR_EXT_eye_gaze_interaction.
Definition xrt_defines.h:965
@ XRT_INPUT_GENERIC_HEAD_POSE
Standard pose used for rendering.
Definition xrt_defines.h:954
Definition t_rift_blobwatch.c:112
A range of API versions supported.
Definition xrt_defines.h:627
Definition xrt_defines.h:2232
Definition xrt_defines.h:2309
Definition xrt_defines.h:2227
Definition xrt_defines.h:2314
Definition xrt_defines.h:2250
Definition xrt_defines.h:2322
Definition xrt_defines.h:2204
struct xrt_body_skeleton_joint_fb joints[XRT_BODY_JOINT_COUNT_FB]
ordered by xrt_body_joint_fb
Definition xrt_defines.h:2206
Definition xrt_defines.h:2196
Definition xrt_defines.h:2219
A 3 element HSV colour with floating point channels.
Definition xrt_defines.h:432
A 3 element colour with floating point channels.
Definition xrt_defines.h:419
A 3 element colour with 8 bits per channel.
Definition xrt_defines.h:394
A 4 element colour with floating point channels.
Definition xrt_defines.h:444
A 4 element colour with 8 bits per channel.
Definition xrt_defines.h:406
Definition xrt_defines.h:1944
Definition xrt_defines.h:1964
Definition xrt_defines.h:1976
Definition xrt_defines.h:1988
Definition xrt_defines.h:1950
float expression_weights[14]
ordered by xrt_eye_expression_htc
Definition xrt_defines.h:1953
Definition xrt_defines.h:1957
float expression_weights[37]
ordered by xrt_lip_expression_htc
Definition xrt_defines.h:1960
Describes a projection matrix fov.
Definition xrt_defines.h:533
Definition xrt_defines.h:2258
Definition xrt_defines.h:2211
struct xrt_body_skeleton_joint_fb joints[XRT_FULL_BODY_JOINT_COUNT_META]
ordered by xrt_full_body_joint_meta
Definition xrt_defines.h:2213
Joint set type used for hand tracking.
Definition xrt_defines.h:1542
Location of a single hand joint.
Definition xrt_defines.h:1510
A limited unique id, it is only unique for the process it is in, so must not be used or synchronized ...
Definition xrt_defines.h:82
To transport LUIDs between different APIs.
Definition xrt_defines.h:63
A tightly packed 2x2 matrix of floats.
Definition xrt_defines.h:560
A tightly packed 3x3 matrix of doubles.
Definition xrt_defines.h:590
A tightly packed 3x3 matrix of floats.
Definition xrt_defines.h:580
A tightly packed 4x4 matrix of double.
Definition xrt_defines.h:617
A tightly packed 4x4 matrix of floats.
Definition xrt_defines.h:607
Normalized image rectangle, coordinates and size in 0 .
Definition xrt_defines.h:501
Image offset.
Definition xrt_defines.h:468
Definition xrt_defines.h:2366
Definition xrt_defines.h:2395
Definition xrt_defines.h:2386
Definition xrt_defines.h:2379
A union of all output types.
Definition xrt_defines.h:2407
A pose composed of a position and orientation.
Definition xrt_defines.h:513
A quaternion with single floats.
Definition xrt_defines.h:246
Image rectangle.
Definition xrt_defines.h:491
Image rectangle.
Definition xrt_defines.h:478
A base class for reference counted objects.
Definition xrt_defines.h:99
A chain of space relations and their associated validity flags.
Definition xrt_defines.h:741
#define XRT_RELATION_CHAIN_CAPACITY
The maximum number of steps that can be in a relation chain.
Definition xrt_defines.h:731
Image size.
Definition xrt_defines.h:457
A relation with two spaces, includes velocity and acceleration.
Definition xrt_defines.h:704
To transport UUIDs between different APIs.
Definition xrt_defines.h:39
Represents a uv triplet for distortion, basically just three xrt_vec2.
Definition xrt_defines.h:300
A 1 element vector with single floats.
Definition xrt_defines.h:269
A 2 element vector with 32 bit integers.
Definition xrt_defines.h:383
A 2 element vector with single floats.
Definition xrt_defines.h:279
A 3 element vector with single doubles.
Definition xrt_defines.h:322
A 3 element vector with 32 bit integers.
Definition xrt_defines.h:371
A 3 element vector with single floats.
Definition xrt_defines.h:310
A union of all input types.
Definition xrt_defines.h:1558
Header holding common defines.
xrt_perf_notify_level
Performance level.
Definition xrt_defines.h:2477
xrt_distortion_model
Which distortion model does the device expose, used both as a bitfield and value.
Definition xrt_defines.h:167
xrt_passthrough_purpose_flags
Specify the kind of passthrough behavior the layer provides.
Definition xrt_defines.h:151
@ XRT_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS
Provided by XR_FB_passthrough_keyboard_hands.
Definition xrt_defines.h:159
@ XRT_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION
Fullscreen layer.
Definition xrt_defines.h:153
@ XRT_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS
Provided by XR_FB_passthrough_keyboard_hands.
Definition xrt_defines.h:157
@ XRT_PASSTHROUGH_LAYER_PURPOSE_PROJECTED
Projected layer.
Definition xrt_defines.h:155
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:758
@ XRT_DEVICE_HTC_FACE_TRACKING
XR_HTC_facial_tracking.
Definition xrt_defines.h:813
@ XRT_DEVICE_FB_BODY_TRACKING
XR_FB_body_tracking.
Definition xrt_defines.h:816
@ XRT_DEVICE_FB_FACE_TRACKING2
XR_FB_face_tracking2.
Definition xrt_defines.h:819
@ XRT_DEVICE_EXT_HAND_INTERACTION
XR_EXT_hand_interaction.
Definition xrt_defines.h:807
@ XRT_DEVICE_ANDROID_FACE_TRACKING
XR_ANDROID_face_tracking.
Definition xrt_defines.h:810
xrt_panel_refresh_type
The type of panel refresh the device has.
Definition xrt_defines.h:179
@ XRT_PANEL_REFRESH_TYPE_ROLLING
panel refreshes progressively along scanout direction, e.g. OLED panels
Definition xrt_defines.h:183
@ XRT_PANEL_REFRESH_TYPE_GLOBAL
entire panel refreshes simultaneously
Definition xrt_defines.h:181
xrt_scanout_direction
Screen scanout direction.
Definition xrt_defines.h:190
xrt_perf_domain
Domain type.
Definition xrt_defines.h:2450
xrt_passthrough_state
Specify additional state change behavior.
Definition xrt_defines.h:136
@ XRT_PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT
Non-recoverable error has occurred.
Definition xrt_defines.h:140
@ XRT_PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT
The runtime has recovered from a previous error and is functioning normally.
Definition xrt_defines.h:144
@ XRT_PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT
Passthrough system requires reinitialization.
Definition xrt_defines.h:138
@ XRT_PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT
A recoverable error has occurred.
Definition xrt_defines.h:142
xrt_view_type
View type to be rendered to by the compositor.
Definition xrt_defines.h:2438
xrt_format
Common formats, use u_format_* functions to reason about them.
Definition xrt_defines.h:204
xrt_passthrough_create_flags
Special flags for creating passthrough.
Definition xrt_defines.h:125
@ XRT_PASSTHROUGH_LAYER_DEPTH
Our compositor just ignores this bit.
Definition xrt_defines.h:129
@ XRT_PASSTHROUGH_IS_RUNNING_AT_CREATION
Start the passthrough on creation.
Definition xrt_defines.h:127
xrt_perf_set_level
Performance level.
Definition xrt_defines.h:2466
Internal result type for XRT.