Skip to content

Commit

Permalink
OpenXR: improve error reporting
Browse files Browse the repository at this point in the history
  • Loading branch information
@Detegr
Detegr committed Aug 16, 2024
1 parent c900b28 commit ccde95f
Showing 1 changed file with 126 additions and 3 deletions.
129 changes: 126 additions & 3 deletions src/OpenXR.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,129 @@ namespace g {
bool api_layer_search_path_fixed;
}

constexpr std::string xr_result_to_str(XrResult res)
{
// XrResultToString can't be used without a valid XrInstance
// so rolling out my own
switch (res) {
case 0: return "XR_SUCCESS";
case 1: return "XR_TIMEOUT_EXPIRED";
case 3: return "XR_SESSION_LOSS_PENDING";
case 4: return "XR_EVENT_UNAVAILABLE";
case 7: return "XR_SPACE_BOUNDS_UNAVAILABLE";
case 8: return "XR_SESSION_NOT_FOCUSED";
case 9: return "XR_FRAME_DISCARDED";
case -1: return "XR_ERROR_VALIDATION_FAILURE";
case -2: return "XR_ERROR_RUNTIME_FAILURE";
case -3: return "XR_ERROR_OUT_OF_MEMORY";
case -4: return "XR_ERROR_API_VERSION_UNSUPPORTED";
case -6: return "XR_ERROR_INITIALIZATION_FAILED";
case -7: return "XR_ERROR_FUNCTION_UNSUPPORTED";
case -8: return "XR_ERROR_FEATURE_UNSUPPORTED";
case -9: return "XR_ERROR_EXTENSION_NOT_PRESENT";
case -10: return "XR_ERROR_LIMIT_REACHED";
case -11: return "XR_ERROR_SIZE_INSUFFICIENT";
case -12: return "XR_ERROR_HANDLE_INVALID";
case -13: return "XR_ERROR_INSTANCE_LOST";
case -14: return "XR_ERROR_SESSION_RUNNING";
case -16: return "XR_ERROR_SESSION_NOT_RUNNING";
case -17: return "XR_ERROR_SESSION_LOST";
case -18: return "XR_ERROR_SYSTEM_INVALID";
case -19: return "XR_ERROR_PATH_INVALID";
case -20: return "XR_ERROR_PATH_COUNT_EXCEEDED";
case -21: return "XR_ERROR_PATH_FORMAT_INVALID";
case -22: return "XR_ERROR_PATH_UNSUPPORTED";
case -23: return "XR_ERROR_LAYER_INVALID";
case -24: return "XR_ERROR_LAYER_LIMIT_EXCEEDED";
case -25: return "XR_ERROR_SWAPCHAIN_RECT_INVALID";
case -26: return "XR_ERROR_SWAPCHAIN_FORMAT_UNSUPPORTED";
case -27: return "XR_ERROR_ACTION_TYPE_MISMATCH";
case -28: return "XR_ERROR_SESSION_NOT_READY";
case -29: return "XR_ERROR_SESSION_NOT_STOPPING";
case -30: return "XR_ERROR_TIME_INVALID";
case -31: return "XR_ERROR_REFERENCE_SPACE_UNSUPPORTED";
case -32: return "XR_ERROR_FILE_ACCESS_ERROR";
case -33: return "XR_ERROR_FILE_CONTENTS_INVALID";
case -34: return "XR_ERROR_FORM_FACTOR_UNSUPPORTED";
case -35: return "XR_ERROR_FORM_FACTOR_UNAVAILABLE";
case -36: return "XR_ERROR_API_LAYER_NOT_PRESENT";
case -37: return "XR_ERROR_CALL_ORDER_INVALID";
case -38: return "XR_ERROR_GRAPHICS_DEVICE_INVALID";
case -39: return "XR_ERROR_POSE_INVALID";
case -40: return "XR_ERROR_INDEX_OUT_OF_RANGE";
case -41: return "XR_ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED";
case -42: return "XR_ERROR_ENVIRONMENT_BLEND_MODE_UNSUPPORTED";
case -44: return "XR_ERROR_NAME_DUPLICATED";
case -45: return "XR_ERROR_NAME_INVALID";
case -46: return "XR_ERROR_ACTIONSET_NOT_ATTACHED";
case -47: return "XR_ERROR_ACTIONSETS_ALREADY_ATTACHED";
case -48: return "XR_ERROR_LOCALIZED_NAME_DUPLICATED";
case -49: return "XR_ERROR_LOCALIZED_NAME_INVALID";
case -50: return "XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING";
case -51: return "XR_ERROR_RUNTIME_UNAVAILABLE";
case -1000710001: return "XR_ERROR_EXTENSION_DEPENDENCY_NOT_ENABLED";
case -1000710000: return "XR_ERROR_PERMISSION_INSUFFICIENT";
case -1000003000: return "XR_ERROR_ANDROID_THREAD_SETTINGS_ID_INVALID_KHR";
case -1000003001: return "XR_ERROR_ANDROID_THREAD_SETTINGS_FAILURE_KHR";
case -1000039001: return "XR_ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT";
case -1000053000: return "XR_ERROR_SECONDARY_VIEW_CONFIGURATION_TYPE_NOT_ENABLED_MSFT";
case -1000055000: return "XR_ERROR_CONTROLLER_MODEL_KEY_INVALID_MSFT";
case -1000066000: return "XR_ERROR_REPROJECTION_MODE_UNSUPPORTED_MSFT";
case -1000097000: return "XR_ERROR_COMPUTE_NEW_SCENE_NOT_COMPLETED_MSFT";
case -1000097001: return "XR_ERROR_SCENE_COMPONENT_ID_INVALID_MSFT";
case -1000097002: return "XR_ERROR_SCENE_COMPONENT_TYPE_MISMATCH_MSFT";
case -1000097003: return "XR_ERROR_SCENE_MESH_BUFFER_ID_INVALID_MSFT";
case -1000097004: return "XR_ERROR_SCENE_COMPUTE_FEATURE_INCOMPATIBLE_MSFT";
case -1000097005: return "XR_ERROR_SCENE_COMPUTE_CONSISTENCY_MISMATCH_MSFT";
case -1000101000: return "XR_ERROR_DISPLAY_REFRESH_RATE_UNSUPPORTED_FB";
case -1000108000: return "XR_ERROR_COLOR_SPACE_UNSUPPORTED_FB";
case -1000113000: return "XR_ERROR_SPACE_COMPONENT_NOT_SUPPORTED_FB";
case -1000113001: return "XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB";
case -1000113002: return "XR_ERROR_SPACE_COMPONENT_STATUS_PENDING_FB";
case -1000113003: return "XR_ERROR_SPACE_COMPONENT_STATUS_ALREADY_SET_FB";
case -1000118000: return "XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB";
case -1000118001: return "XR_ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB";
case -1000118002: return "XR_ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB";
case -1000118003: return "XR_ERROR_NOT_PERMITTED_PASSTHROUGH_FB";
case -1000118004: return "XR_ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB";
case -1000118050: return "XR_ERROR_UNKNOWN_PASSTHROUGH_FB";
case -1000119000: return "XR_ERROR_RENDER_MODEL_KEY_INVALID_FB";
case 1000119020: return "XR_RENDER_MODEL_UNAVAILABLE_FB";
case -1000124000: return "XR_ERROR_MARKER_NOT_TRACKED_VARJO";
case -1000124001: return "XR_ERROR_MARKER_ID_INVALID_VARJO";
case -1000138000: return "XR_ERROR_MARKER_DETECTOR_PERMISSION_DENIED_ML";
case -1000138001: return "XR_ERROR_MARKER_DETECTOR_LOCATE_FAILED_ML";
case -1000138002: return "XR_ERROR_MARKER_DETECTOR_INVALID_DATA_QUERY_ML";
case -1000138003: return "XR_ERROR_MARKER_DETECTOR_INVALID_CREATE_INFO_ML";
case -1000138004: return "XR_ERROR_MARKER_INVALID_ML";
case -1000139000: return "XR_ERROR_LOCALIZATION_MAP_INCOMPATIBLE_ML";
case -1000139001: return "XR_ERROR_LOCALIZATION_MAP_UNAVAILABLE_ML";
case -1000139002: return "XR_ERROR_LOCALIZATION_MAP_FAIL_ML";
case -1000139003: return "XR_ERROR_LOCALIZATION_MAP_IMPORT_EXPORT_PERMISSION_DENIED_ML";
case -1000139004: return "XR_ERROR_LOCALIZATION_MAP_PERMISSION_DENIED_ML";
case -1000139005: return "XR_ERROR_LOCALIZATION_MAP_ALREADY_EXISTS_ML";
case -1000139006: return "XR_ERROR_LOCALIZATION_MAP_CANNOT_EXPORT_CLOUD_MAP_ML";
case -1000142001: return "XR_ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT";
case -1000142002: return "XR_ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT";
case 1000147000: return "XR_SCENE_MARKER_DATA_NOT_STRING_MSFT";
case -1000169000: return "XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB";
case -1000169001: return "XR_ERROR_SPACE_LOCALIZATION_FAILED_FB";
case -1000169002: return "XR_ERROR_SPACE_NETWORK_TIMEOUT_FB";
case -1000169003: return "XR_ERROR_SPACE_NETWORK_REQUEST_FAILED_FB";
case -1000169004: return "XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB";
case -1000266000: return "XR_ERROR_PASSTHROUGH_COLOR_LUT_BUFFER_SIZE_MISMATCH_META";
case 1000291000: return "XR_ENVIRONMENT_DEPTH_NOT_AVAILABLE_META";
case -1000306000: return "XR_ERROR_HINT_ALREADY_SET_QCOM";
case -1000319000: return "XR_ERROR_NOT_AN_ANCHOR_HTC";
case -1000429000: return "XR_ERROR_SPACE_NOT_LOCATABLE_EXT";
case -1000429001: return "XR_ERROR_PLANE_DETECTION_PERMISSION_DENIED_EXT";
case -1000469001: return "XR_ERROR_FUTURE_PENDING_EXT";
case -1000469002: return "XR_ERROR_FUTURE_INVALID_EXT";
default:
return std::format("XR_ERROR_UNKNOWN_{}", static_cast<int64_t>(res));
}
}

template <typename T>
T get_extension(XrInstance instance, const std::string& fnName)
{
Expand Down Expand Up @@ -165,11 +288,11 @@ OpenXR::OpenXR()

if (auto err = xrCreateInstance(&instanceInfo, &instance); err != XR_SUCCESS) {
if (err == XR_ERROR_EXTENSION_NOT_PRESENT) {
throw std::runtime_error("xrCreateInstance failed. A requested extension is missing.");
throw std::runtime_error("xrCreateInstance failed: XR_ERROR_EXTENSION_NOT_PRESENT\nA requested extension is missing.");
} else if (err == XR_ERROR_FILE_ACCESS_ERROR) {
throw std::runtime_error("xrCreateInstance failed. Make sure Visual C++ redistributables (https://aka.ms/vs/17/release/vc_redist.x64.exe) are installed. Please try uninstalling Reshade if it is installed.");
throw std::runtime_error("xrCreateInstance failed. XR_ERROR_FILE_ACCESS_ERROR\nMake sure Visual C++ redistributables (https://aka.ms/vs/17/release/vc_redist.x64.exe) are installed. Please try uninstalling Reshade if it is installed.");
}
throw std::runtime_error(std::format("Failed to initialize OpenXR: xrCreateInstance {}", static_cast<int>(err)));
throw std::runtime_error(std::format("Failed to initialize OpenXR. xrCreateInstance failed: {}", xr_result_to_str(err)));
}

XrSystemGetInfo system_get_info = {
Expand Down

0 comments on commit ccde95f

Please sign in to comment.