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