30#define OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_thing, THING, name, lookup) \
32 oxr_log_init(log, name); \
33 if (thing == XR_NULL_HANDLE) { \
34 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == NULL)"); \
36 new_thing = (struct oxr_thing *)((uintptr_t)thing); \
37 if (new_thing->handle.debug != OXR_XR_DEBUG_##THING) { \
38 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == %p)", (void *)new_thing); \
40 if (new_thing->handle.state != OXR_HANDLE_STATE_LIVE) { \
41 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == %p) state == %s", \
42 (void *)new_thing, oxr_handle_state_to_string(new_thing->handle.state)); \
44 oxr_log_set_instance(log, lookup); \
47#define OXR_VERIFY_SET(log, arg, new_arg, oxr_thing, THING) \
49 if (arg == XR_NULL_HANDLE) { \
50 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #arg " == NULL)"); \
52 new_arg = (struct oxr_thing *)((uintptr_t)arg); \
53 if (new_arg->handle.debug != OXR_XR_DEBUG_##THING) { \
54 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #arg " == %p)", (void *)new_arg); \
65#define OXR_VERIFY_INSTANCE_AND_INIT_LOG(log, thing, new_thing, name) \
66 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_instance, INSTANCE, name, new_thing)
67#define OXR_VERIFY_MESSENGER_AND_INIT_LOG(log, thing, new_thing, name) \
68 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_messenger, MESSENGER, name, new_thing->inst)
69#define OXR_VERIFY_SESSION_AND_INIT_LOG(log, thing, new_thing, name) \
70 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_session, SESSION, name, new_thing->sys->inst)
71#define OXR_VERIFY_SPACE_AND_INIT_LOG(log, thing, new_thing, name) \
72 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_space, SPACE, name, new_thing->sess->sys->inst)
73#define OXR_VERIFY_ACTION_AND_INIT_LOG(log, thing, new_thing, name) \
74 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_action, ACTION, name, new_thing->act_set->inst)
75#define OXR_VERIFY_SWAPCHAIN_AND_INIT_LOG(log, thing, new_thing, name) \
76 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_swapchain, SWAPCHAIN, name, new_thing->sess->sys->inst)
77#define OXR_VERIFY_ACTIONSET_AND_INIT_LOG(log, thing, new_thing, name) \
78 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_action_set, ACTIONSET, name, new_thing->inst)
79#define OXR_VERIFY_HAND_TRACKER_AND_INIT_LOG(log, thing, new_thing, name) \
80 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_hand_tracker, HTRACKER, name, new_thing->sess->sys->inst)
81#define OXR_VERIFY_FORCE_FEEDBACK_AND_INIT_LOG(log, thing, new_thing, name) \
82 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_force_feedback, FFB, name, new_thing->sess->sys->inst)
83#define OXR_VERIFY_PASSTHROUGH_AND_INIT_LOG(log, thing, new_thing, name) \
84 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_passthrough, PASSTHROUGH, name, new_thing->sess->sys->inst)
85#define OXR_VERIFY_PASSTHROUGH_LAYER_AND_INIT_LOG(log, thing, new_thing, name) \
86 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_passthrough_layer, PASSTHROUGH_LAYER, name, new_thing->sess->sys->inst)
87#define OXR_VERIFY_FACE_TRACKER_HTC_AND_INIT_LOG(log, thing, new_thing, name) \
88 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_facial_tracker_htc, FTRACKER, name, new_thing->sess->sys->inst)
89#define OXR_VERIFY_FACE_TRACKER2_FB_AND_INIT_LOG(log, thing, new_thing, name) \
90 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_face_tracker2_fb, FTRACKER, name, new_thing->sess->sys->inst)
91#define OXR_VERIFY_BODY_TRACKER_FB_AND_INIT_LOG(log, thing, new_thing, name) \
92 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_body_tracker_fb, BTRACKER, name, new_thing->sess->sys->inst)
93#define OXR_VERIFY_XDEVLIST_AND_INIT_LOG(log, thing, new_thing, name) \
94 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_xdev_list, XDEVLIST, name, new_thing->sess->sys->inst)
95#define OXR_VERIFY_PLANE_DETECTOR_AND_INIT_LOG(log, thing, new_thing, name) \
96 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_plane_detector_ext, PLANEDET, name, new_thing->sess->sys->inst)
97#define OXR_VERIFY_FUTURE_AND_INIT_LOG(log, thing, new_thing, name) \
98 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_future_ext, FUTURE, name, new_thing->inst); \
99 OXR_VERIFY_FUTURE_VALID(log, new_thing)
102#define OXR_VERIFY_INSTANCE_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_instance, INSTANCE);
103#define OXR_VERIFY_MESSENGER_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_messenger, MESSENGER);
104#define OXR_VERIFY_SESSION_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_session, SESSION);
105#define OXR_VERIFY_SPACE_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_space, SPACE);
106#define OXR_VERIFY_ACTION_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_action, ACTION);
107#define OXR_VERIFY_SWAPCHAIN_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_swapchain, SWAPCHAIN);
108#define OXR_VERIFY_ACTIONSET_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_action_set, ACTIONSET);
109#define OXR_VERIFY_XDEVLIST_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_xdev_list, XDEVLIST);
111#define OXR_VERIFY_FUTURE_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_future_ext, FUTURE);
117#define OXR_VERIFY_EXTENSION(log, inst, mixed_case_name) \
119 if (!(inst)->extensions.mixed_case_name) { \
120 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, \
121 "Requires XR_" #mixed_case_name " extension enabled"); \
130#define OXR_VERIFY_EXTENSIONS_OR(log, inst, mixed_case_name1, mixed_case_name2) \
132 if (!(inst)->extensions.mixed_case_name1 && !(inst)->extensions.mixed_case_name2) { \
133 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, \
134 "Requires XR_" #mixed_case_name1 "or XR_" #mixed_case_name2 \
135 " extension enabled"); \
142#define OXR_API_VERSION_AT_LEAST(inst, major, minor) \
143 ((inst)->openxr_version.major_minor >= XR_MAKE_VERSION(major, minor, 0))
148#define OXR_VERIFY_API_VERSION_AT_LEAST(log, inst, major, minor) \
150 if (!OXR_VERSION_AT_LEAST(inst, major, minor)) { \
151 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, "Requires OpenXR version %d.%d.x", \
156#define OXR_VERIFY_ARG_NOT_NULL(log, arg) \
159 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == NULL)"); \
163#define OXR_VERIFY_ARG_NOT_ZERO(log, arg) \
166 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == 0) must be non-zero"); \
170#define OXR_VERIFY_ARG_ZERO(log, arg) \
173 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == 0) must be zero"); \
177#define OXR_VERIFY_ARG_TYPE_CAN_BE_NULL(log, arg, type_enum) \
179 if (arg != NULL && arg->type != type_enum) { \
180 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg "->type == %u)", arg->type); \
184#define OXR_VERIFY_ARG_TYPE_AND_NOT_NULL(log, arg, type_enum) \
187 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == NULL)"); \
189 OXR_VERIFY_ARG_TYPE_CAN_BE_NULL(log, arg, type_enum); \
196#define OXR_VERIFY_ARG_ARRAY_ELEMENT_TYPE(log, array, index, type_enum) \
198 if ((array)[index].type != type_enum) { \
199 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
200 "(" #array "[%u]->type == 0x%08x) expected 0x%08x", index, \
201 (array)[index].type, type_enum); \
205#define OXR_VERIFY_TWO_CALL_ARRAY(log, inputCapacity, countOutput, array) \
207 OXR_VERIFY_ARG_NOT_NULL(log, countOutput); \
208 if (inputCapacity > 0) { \
209 OXR_VERIFY_ARG_NOT_NULL(log, array); \
213#define OXR_VERIFY_TWO_CALL_ARRAY_AND_TYPE(log, inputCapacity, countOutput, array, type_enum) \
215 OXR_VERIFY_ARG_NOT_NULL(log, countOutput); \
216 if (inputCapacity > 0) { \
217 OXR_VERIFY_ARG_NOT_NULL(log, array); \
218 for (uint32_t i = 0; i < inputCapacity; ++i) { \
219 OXR_VERIFY_ARG_ARRAY_ELEMENT_TYPE(log, array, i, type_enum); \
224#define OXR_VERIFY_SUBACTION_PATHS(log, count, paths) \
226 if (count > 0 && paths == NULL) { \
227 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
228 "(" #count ") is not zero but " #paths " is NULL"); \
232#define OXR_VERIFY_ARG_SINGLE_LEVEL_FIXED_LENGTH_PATH(log, path) \
234 XrResult verify_ret = oxr_verify_fixed_size_single_level_path(log, path, ARRAY_SIZE(path), #path); \
235 if (verify_ret != XR_SUCCESS) { \
240#define OXR_VERIFY_ARG_LOCALIZED_NAME(log, string) \
242 XrResult verify_ret = oxr_verify_localized_name(log, string, ARRAY_SIZE(string), #string); \
243 if (verify_ret != XR_SUCCESS) { \
248#define OXR_VERIFY_POSE(log, p) \
250 if (!math_quat_validate((struct xrt_quat *)&p.orientation)) { \
251 return oxr_error(log, XR_ERROR_POSE_INVALID, "(" #p ".orientation) is not a valid quat"); \
254 if (!math_vec3_validate((struct xrt_vec3 *)&p.position)) { \
255 return oxr_error(log, XR_ERROR_POSE_INVALID, "(" #p ".position) is not valid"); \
259#define OXR_VERIFY_FORM_FACTOR(log, form_factor) \
261 XrFormFactor _form_factor = (form_factor); \
262 if (_form_factor != XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY && \
263 _form_factor != XR_FORM_FACTOR_HANDHELD_DISPLAY) { \
265 return oxr_error(log, XR_ERROR_FORM_FACTOR_UNSUPPORTED, \
266 "(" #form_factor " == 0x%08x) is not a valid form factor", _form_factor); \
270#define OXR_VERIFY_VIEW_CONFIG_TYPE(log, inst, view_conf) \
272 XrResult verify_ret = oxr_verify_view_config_type(log, inst, view_conf, #view_conf); \
273 if (verify_ret != XR_SUCCESS) { \
278#define OXR_VERIFY_VIEW_CONFIG_TYPE_SUPPORTED(log, sys, view_conf) \
280 XrResult verify_ret = oxr_verify_view_config_type_supported(log, sys, view_conf, #view_conf); \
281 if (verify_ret != XR_SUCCESS) { \
286#define OXR_VERIFY_VIEW_INDEX(log, index) \
289 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
290 "Invalid view index %d, only 2 views supported", index); \
294#define OXR_VERIFY_SWAPCHAIN_USAGE_FLAGS_NOT_MUTUALLY_EXCLUSIVE(log, flags, mutually_exclusive_a, \
295 mutually_exclusive_b) \
297 if (((flags) & (mutually_exclusive_a)) != 0 && ((flags) & (mutually_exclusive_b)) != 0) { \
298 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
299 "(" #flags ") Swapchain usage flags " #mutually_exclusive_a \
300 " and " #mutually_exclusive_b \
301 " are mutually exclusive in this graphics API"); \
305#define OXR_VERIFY_SESSION_NOT_LOST(log, sess) \
307 if (sess->has_lost) { \
308 return oxr_error(log, XR_ERROR_SESSION_LOST, "Session is lost"); \
312#define OXR_VERIFY_SESSION_RUNNING(log, sess) \
314 if (!oxr_frame_sync_is_session_running(&sess->frame_sync)) { \
315 return oxr_error(log, XR_ERROR_SESSION_NOT_RUNNING, "Session is not running"); \
319#define OXR_VERIFY_PASSTHROUGH_FLAGS(log, flags) \
321 (flags & (XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB | XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB)) == 0) \
322 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
323 "flags is not a valid combination of XrPassthroughFlagBitsFB values");
325#define OXR_VERIFY_PASSTHROUGH_LAYER_PURPOSE(log, purpose) \
326 if ((purpose != XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB && \
327 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB && \
328 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB && \
329 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB)) \
330 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
331 "purpose is not a valid XrPassthroughLayerPurposeFB value");
333#define OXR_VERIFY_PASSTHROUGH_LAYER_STYLE(log, style) \
335 uint32_t duplicate_check = 0; \
336 const XrPassthroughStyleFB *next = style->next; \
338 if (next->type != XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB && \
339 next->type != XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB && \
340 next->type != XR_TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB) \
341 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
342 "style next structure chain contains invalid pointers"); \
343 if ((next->type & duplicate_check) != 0) \
344 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
345 "style next structure chain contains duplicate items"); \
346 duplicate_check |= next->type; \
347 next = (const XrPassthroughStyleFB *)next->next; \
351#define OXR_VERIFY_HAND_TRACKING_DATA_SOURCE_OR_NULL(log, data_source_info) \
353 if (data_source_info != NULL) { \
354 XrResult verify_ret = oxr_verify_XrHandTrackingDataSourceInfoEXT(log, data_source_info); \
355 if (verify_ret != XR_SUCCESS) { \
361#define OXR_VERIFY_FUTURE_VALID(LOG, OXR_FT) \
363 if (OXR_FT->xft == NULL) { \
364 return oxr_error(LOG, XR_ERROR_FUTURE_INVALID_EXT, "future is not valid"); \
368#define OXR_VERIFY_ARG_TIME_NOT_ZERO(log, xr_time) \
370 if (xr_time <= (XrTime)0) { \
371 return oxr_error(log, XR_ERROR_TIME_INVALID, "(time == %" PRIi64 ") is not a valid time.", \
384oxr_verify_full_path_c(
struct oxr_logger *log,
const char *path,
const char *name);
415 uint32_t countSubactionPaths,
416 const XrPath *subactionPaths,
417 const char *variable);
438 const char *variable);
444oxr_verify_view_config_type(
struct oxr_logger *log,
446 XrViewConfigurationType view_conf,
447 const char *view_conf_name);
450oxr_verify_view_config_type_supported(
struct oxr_logger *log,
452 XrViewConfigurationType view_conf,
453 const char *view_conf_name);
456oxr_verify_XrSessionCreateInfo(
struct oxr_logger * ,
458 const XrSessionCreateInfo * );
460#if defined(XR_USE_PLATFORM_XLIB) && defined(XR_USE_GRAPHICS_API_OPENGL)
462oxr_verify_XrGraphicsBindingOpenGLXlibKHR(
struct oxr_logger * ,
const XrGraphicsBindingOpenGLXlibKHR * );
465#if defined(XR_USE_PLATFORM_WIN32) && defined(XR_USE_GRAPHICS_API_OPENGL)
467oxr_verify_XrGraphicsBindingOpenGLWin32KHR(
struct oxr_logger * ,
468 const XrGraphicsBindingOpenGLWin32KHR * );
471#if defined(XR_USE_GRAPHICS_API_VULKAN)
473oxr_verify_XrGraphicsBindingVulkanKHR(
struct oxr_logger * ,
const XrGraphicsBindingVulkanKHR * );
476#if defined(XR_USE_PLATFORM_EGL)
478oxr_verify_XrGraphicsBindingEGLMNDX(
struct oxr_logger *log,
const XrGraphicsBindingEGLMNDX *next);
481#if defined(XR_USE_PLATFORM_ANDROID) && defined(XR_USE_GRAPHICS_API_OPENGL_ES)
483oxr_verify_XrGraphicsBindingOpenGLESAndroidKHR(
struct oxr_logger *,
const XrGraphicsBindingOpenGLESAndroidKHR *);
487#if defined(XR_USE_GRAPHICS_API_D3D11)
489oxr_verify_XrGraphicsBindingD3D11KHR(
struct oxr_logger *,
const XrGraphicsBindingD3D11KHR *);
492#if defined(XR_USE_GRAPHICS_API_D3D12)
494oxr_verify_XrGraphicsBindingD3D12KHR(
struct oxr_logger *,
const XrGraphicsBindingD3D12KHR *);
497#ifdef XR_EXT_dpad_binding
499oxr_verify_XrInteractionProfileDpadBindingEXT(
struct oxr_logger *,
500 const XrInteractionProfileDpadBindingEXT *,
501 const char *error_prefix);
504#ifdef OXR_HAVE_EXT_hand_tracking_data_source
506oxr_verify_XrHandTrackingDataSourceInfoEXT(
struct oxr_logger *,
const XrHandTrackingDataSourceInfoEXT *);
XrResult oxr_verify_subaction_paths_create(struct oxr_logger *log, struct oxr_instance *inst, uint32_t countSubactionPaths, const XrPath *subactionPaths, const char *variable)
Verify a set of subaction paths for action creation.
Definition: oxr_verify.c:299
XrResult oxr_verify_subaction_path_sync(struct oxr_logger *log, const struct oxr_instance *inst, const struct oxr_action_set *act_set, XrPath path, uint32_t index)
Verify a set of subaction paths for action sync.
Definition: oxr_verify.c:320
XrResult oxr_verify_fixed_size_single_level_path(struct oxr_logger *, const char *path, uint32_t array_size, const char *name)
Verify a single path level that sits inside of a fixed sized array.
Definition: oxr_verify.c:65
XrResult oxr_verify_subaction_path_get(struct oxr_logger *log, struct oxr_instance *inst, XrPath path, const struct oxr_subaction_paths *act_subaction_paths, struct oxr_subaction_paths *out_subaction_paths, const char *variable)
Verify a set of subaction paths for action state get.
Definition: oxr_verify.c:350
XrResult oxr_verify_full_path(struct oxr_logger *log, const char *path, size_t length, const char *name)
Verify a full path.
Definition: oxr_verify.c:140
XrResult oxr_verify_localized_name(struct oxr_logger *, const char *string, uint32_t array_size, const char *name)
Verify an arbitrary UTF-8 string that sits inside of a fixed sized array.
Definition: oxr_verify.c:96
The objects that handle session running status and blocking of xrWaitFrame.
A group of actions.
Definition: oxr_objects.h:2595
Structure tracking which extensions are enabled for a given instance.
Definition: oxr_objects.h:1701
Main object that ties everything together.
Definition: oxr_objects.h:1714
Logger struct that lives on the stack, one for each call client call.
Definition: oxr_logger.h:40
A parsed equivalent of a list of sub-action paths.
Definition: oxr_objects.h:2172
Single or multiple devices grouped together to form a system that sessions can be created from.
Definition: oxr_objects.h:1525