28#define OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_thing, THING, name, lookup) \
30 oxr_log_init(log, name); \
31 if (thing == XR_NULL_HANDLE) { \
32 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == NULL)"); \
34 new_thing = (struct oxr_thing *)((uintptr_t)thing); \
35 if (new_thing->handle.debug != OXR_XR_DEBUG_##THING) { \
36 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == %p)", (void *)new_thing); \
38 if (new_thing->handle.state != OXR_HANDLE_STATE_LIVE) { \
39 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #thing " == %p) state == %s", \
40 (void *)new_thing, oxr_handle_state_to_string(new_thing->handle.state)); \
42 oxr_log_set_instance(log, lookup); \
45#define OXR_VERIFY_SET(log, arg, new_arg, oxr_thing, THING) \
47 if (arg == XR_NULL_HANDLE) { \
48 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #arg " == NULL)"); \
50 new_arg = (struct oxr_thing *)((uintptr_t)arg); \
51 if (new_arg->handle.debug != OXR_XR_DEBUG_##THING) { \
52 return oxr_error(log, XR_ERROR_HANDLE_INVALID, "(" #arg " == %p)", (void *)new_arg); \
63#define OXR_VERIFY_INSTANCE_AND_INIT_LOG(log, thing, new_thing, name) \
64 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_instance, INSTANCE, name, new_thing)
65#define OXR_VERIFY_MESSENGER_AND_INIT_LOG(log, thing, new_thing, name) \
66 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_messenger, MESSENGER, name, new_thing->inst)
67#define OXR_VERIFY_SESSION_AND_INIT_LOG(log, thing, new_thing, name) \
68 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_session, SESSION, name, new_thing->sys->inst)
69#define OXR_VERIFY_SPACE_AND_INIT_LOG(log, thing, new_thing, name) \
70 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_space, SPACE, name, new_thing->sess->sys->inst)
71#define OXR_VERIFY_ACTION_AND_INIT_LOG(log, thing, new_thing, name) \
72 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_action, ACTION, name, new_thing->act_set->inst)
73#define OXR_VERIFY_SWAPCHAIN_AND_INIT_LOG(log, thing, new_thing, name) \
74 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_swapchain, SWAPCHAIN, name, new_thing->sess->sys->inst)
75#define OXR_VERIFY_ACTIONSET_AND_INIT_LOG(log, thing, new_thing, name) \
76 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_action_set, ACTIONSET, name, new_thing->inst)
77#define OXR_VERIFY_HAND_TRACKER_AND_INIT_LOG(log, thing, new_thing, name) \
78 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_hand_tracker, HTRACKER, name, new_thing->sess->sys->inst)
79#define OXR_VERIFY_FORCE_FEEDBACK_AND_INIT_LOG(log, thing, new_thing, name) \
80 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_force_feedback, FFB, name, new_thing->sess->sys->inst)
81#define OXR_VERIFY_PASSTHROUGH_AND_INIT_LOG(log, thing, new_thing, name) \
82 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_passthrough, PASSTHROUGH, name, new_thing->sess->sys->inst)
83#define OXR_VERIFY_PASSTHROUGH_LAYER_AND_INIT_LOG(log, thing, new_thing, name) \
84 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_passthrough_layer, PASSTHROUGH_LAYER, name, new_thing->sess->sys->inst)
85#define OXR_VERIFY_FACE_TRACKER_HTC_AND_INIT_LOG(log, thing, new_thing, name) \
86 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_facial_tracker_htc, FTRACKER, name, new_thing->sess->sys->inst)
87#define OXR_VERIFY_FACE_TRACKER2_FB_AND_INIT_LOG(log, thing, new_thing, name) \
88 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_face_tracker2_fb, FTRACKER, name, new_thing->sess->sys->inst)
89#define OXR_VERIFY_BODY_TRACKER_FB_AND_INIT_LOG(log, thing, new_thing, name) \
90 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_body_tracker_fb, BTRACKER, name, new_thing->sess->sys->inst)
91#define OXR_VERIFY_XDEVLIST_AND_INIT_LOG(log, thing, new_thing, name) \
92 OXR_VERIFY_AND_SET_AND_INIT(log, thing, new_thing, oxr_xdev_list, XDEVLIST, name, new_thing->sess->sys->inst)
93#define OXR_VERIFY_PLANE_DETECTOR_AND_INIT_LOG(log, thing, new_thing, name) \
94 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_INSTANCE_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_instance, INSTANCE);
98#define OXR_VERIFY_MESSENGER_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_messenger, MESSENGER);
99#define OXR_VERIFY_SESSION_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_session, SESSION);
100#define OXR_VERIFY_SPACE_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_space, SPACE);
101#define OXR_VERIFY_ACTION_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_action, ACTION);
102#define OXR_VERIFY_SWAPCHAIN_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_swapchain, SWAPCHAIN);
103#define OXR_VERIFY_ACTIONSET_NOT_NULL(log, arg, new_arg) OXR_VERIFY_SET(log, arg, new_arg, oxr_action_set, ACTIONSET);
104#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_EXTENSION(log, inst, mixed_case_name) \
113 if (!(inst)->extensions.mixed_case_name) { \
114 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, \
115 "Requires XR_" #mixed_case_name " extension enabled"); \
124#define OXR_VERIFY_EXTENSIONS_OR(log, inst, mixed_case_name1, mixed_case_name2) \
126 if (!(inst)->extensions.mixed_case_name1 && !(inst)->extensions.mixed_case_name2) { \
127 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, \
128 "Requires XR_" #mixed_case_name1 "or XR_" #mixed_case_name2 \
129 " extension enabled"); \
136#define OXR_API_VERSION_AT_LEAST(inst, major, minor) \
137 ((inst)->openxr_version.major_minor >= XR_MAKE_VERSION(major, minor, 0))
142#define OXR_VERIFY_API_VERSION_AT_LEAST(log, inst, major, minor) \
144 if (!OXR_VERSION_AT_LEAST(inst, major, minor)) { \
145 return oxr_error((log), XR_ERROR_FUNCTION_UNSUPPORTED, "Requires OpenXR version %d.%d.x", \
150#define OXR_VERIFY_ARG_NOT_NULL(log, arg) \
153 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == NULL)"); \
157#define OXR_VERIFY_ARG_NOT_ZERO(log, arg) \
160 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == 0) must be non-zero"); \
164#define OXR_VERIFY_ARG_ZERO(log, arg) \
167 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == 0) must be zero"); \
171#define OXR_VERIFY_ARG_TYPE_CAN_BE_NULL(log, arg, type_enum) \
173 if (arg != NULL && arg->type != type_enum) { \
174 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg "->type == %u)", arg->type); \
178#define OXR_VERIFY_ARG_TYPE_AND_NOT_NULL(log, arg, type_enum) \
181 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, "(" #arg " == NULL)"); \
183 OXR_VERIFY_ARG_TYPE_CAN_BE_NULL(log, arg, type_enum); \
190#define OXR_VERIFY_ARG_ARRAY_ELEMENT_TYPE(log, array, index, type_enum) \
192 if ((array)[index].type != type_enum) { \
193 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
194 "(" #array "[%u]->type == 0x%08x) expected 0x%08x", index, \
195 (array)[index].type, type_enum); \
199#define OXR_VERIFY_SUBACTION_PATHS(log, count, paths) \
201 if (count > 0 && paths == NULL) { \
202 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
203 "(" #count ") is not zero but " #paths " is NULL"); \
207#define OXR_VERIFY_ARG_SINGLE_LEVEL_FIXED_LENGTH_PATH(log, path) \
209 XrResult verify_ret = oxr_verify_fixed_size_single_level_path(log, path, ARRAY_SIZE(path), #path); \
210 if (verify_ret != XR_SUCCESS) { \
215#define OXR_VERIFY_ARG_LOCALIZED_NAME(log, string) \
217 XrResult verify_ret = oxr_verify_localized_name(log, string, ARRAY_SIZE(string), #string); \
218 if (verify_ret != XR_SUCCESS) { \
223#define OXR_VERIFY_POSE(log, p) \
225 if (!math_quat_validate((struct xrt_quat *)&p.orientation)) { \
226 return oxr_error(log, XR_ERROR_POSE_INVALID, "(" #p ".orientation) is not a valid quat"); \
229 if (!math_vec3_validate((struct xrt_vec3 *)&p.position)) { \
230 return oxr_error(log, XR_ERROR_POSE_INVALID, "(" #p ".position) is not valid"); \
234#define OXR_VERIFY_VIEW_CONFIG_TYPE(log, inst, view_conf) \
236 XrResult verify_ret = oxr_verify_view_config_type(log, inst, view_conf, #view_conf); \
237 if (verify_ret != XR_SUCCESS) { \
242#define OXR_VERIFY_VIEW_INDEX(log, index) \
245 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
246 "Invalid view index %d, only 2 views supported", index); \
250#define OXR_VERIFY_SWAPCHAIN_USAGE_FLAGS_NOT_MUTUALLY_EXCLUSIVE(log, flags, mutually_exclusive_a, \
251 mutually_exclusive_b) \
253 if (((flags) & (mutually_exclusive_a)) != 0 && ((flags) & (mutually_exclusive_b)) != 0) { \
254 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
255 "(" #flags ") Swapchain usage flags " #mutually_exclusive_a \
256 " and " #mutually_exclusive_b \
257 " are mutually exclusive in this graphics API"); \
261#define OXR_VERIFY_SESSION_NOT_LOST(log, sess) \
263 if (sess->has_lost) { \
264 return oxr_error(log, XR_ERROR_SESSION_LOST, "Session is lost"); \
268#define OXR_VERIFY_SESSION_RUNNING(log, sess) \
270 if (!oxr_frame_sync_is_session_running(&sess->frame_sync)) { \
271 return oxr_error(log, XR_ERROR_SESSION_NOT_RUNNING, "Session is not running"); \
275#define OXR_VERIFY_PASSTHROUGH_FLAGS(log, flags) \
277 (flags & (XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB | XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB)) == 0) \
278 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
279 "flags is not a valid combination of XrPassthroughFlagBitsFB values");
281#define OXR_VERIFY_PASSTHROUGH_LAYER_PURPOSE(log, purpose) \
282 if ((purpose != XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB && \
283 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB && \
284 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB && \
285 purpose != XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB)) \
286 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
287 "purpose is not a valid XrPassthroughLayerPurposeFB value");
289#define OXR_VERIFY_PASSTHROUGH_LAYER_STYLE(log, style) \
291 uint32_t duplicate_check = 0; \
292 const XrPassthroughStyleFB *next = style->next; \
294 if (next->type != XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB && \
295 next->type != XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB && \
296 next->type != XR_TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB) \
297 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
298 "style next structure chain contains invalid pointers"); \
299 if ((next->type & duplicate_check) != 0) \
300 return oxr_error(log, XR_ERROR_VALIDATION_FAILURE, \
301 "style next structure chain contains duplicate items"); \
302 duplicate_check |= next->type; \
303 next = (const XrPassthroughStyleFB *)next->next; \
314oxr_verify_full_path_c(
struct oxr_logger *log,
const char *path,
const char *name);
345 uint32_t countSubactionPaths,
346 const XrPath *subactionPaths,
347 const char *variable);
368 const char *variable);
374oxr_verify_view_config_type(
struct oxr_logger *log,
376 XrViewConfigurationType view_conf,
377 const char *view_conf_name);
380oxr_verify_XrSessionCreateInfo(
struct oxr_logger * ,
382 const XrSessionCreateInfo * );
384#if defined(XR_USE_PLATFORM_XLIB) && defined(XR_USE_GRAPHICS_API_OPENGL)
386oxr_verify_XrGraphicsBindingOpenGLXlibKHR(
struct oxr_logger * ,
const XrGraphicsBindingOpenGLXlibKHR * );
389#if defined(XR_USE_PLATFORM_WIN32) && defined(XR_USE_GRAPHICS_API_OPENGL)
391oxr_verify_XrGraphicsBindingOpenGLWin32KHR(
struct oxr_logger * ,
392 const XrGraphicsBindingOpenGLWin32KHR * );
395#if defined(XR_USE_GRAPHICS_API_VULKAN)
397oxr_verify_XrGraphicsBindingVulkanKHR(
struct oxr_logger * ,
const XrGraphicsBindingVulkanKHR * );
400#if defined(XR_USE_PLATFORM_EGL) && defined(XR_USE_GRAPHICS_API_OPENGL)
402oxr_verify_XrGraphicsBindingEGLMNDX(
struct oxr_logger *log,
const XrGraphicsBindingEGLMNDX *next);
405#if defined(XR_USE_PLATFORM_ANDROID) && defined(XR_USE_GRAPHICS_API_OPENGL_ES)
407oxr_verify_XrGraphicsBindingOpenGLESAndroidKHR(
struct oxr_logger *,
const XrGraphicsBindingOpenGLESAndroidKHR *);
411#if defined(XR_USE_GRAPHICS_API_D3D11)
413oxr_verify_XrGraphicsBindingD3D11KHR(
struct oxr_logger *,
const XrGraphicsBindingD3D11KHR *);
416#if defined(XR_USE_GRAPHICS_API_D3D12)
418oxr_verify_XrGraphicsBindingD3D12KHR(
struct oxr_logger *,
const XrGraphicsBindingD3D12KHR *);
421#ifdef XR_EXT_dpad_binding
423oxr_verify_XrInteractionProfileDpadBindingEXT(
struct oxr_logger *,
424 const XrInteractionProfileDpadBindingEXT *,
425 const char *error_prefix);
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:298
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:319
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:64
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:349
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:139
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:95
The objects that handle session running status and blocking of xrWaitFrame.
A group of actions.
Definition: oxr_objects.h:2500
Structure tracking which extensions are enabled for a given instance.
Definition: oxr_objects.h:1638
Main object that ties everything together.
Definition: oxr_objects.h:1651
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:2077