mirror of
https://github.com/copyrighttxt/watrbx-game-engine.git
synced 2026-09-05 05:07:48 +00:00
146 lines
7.7 KiB
C
146 lines
7.7 KiB
C
/********************************************************************************//**
|
|
\file OVR_ErrorCode.h
|
|
\brief This header provides LibOVR error code declarations.
|
|
\copyright Copyright 2015 Oculus VR, LLC All Rights reserved.
|
|
*************************************************************************************/
|
|
|
|
#ifndef OVR_ErrorCode_h
|
|
#define OVR_ErrorCode_h
|
|
|
|
|
|
#include "OVR_Version.h"
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef OVR_RESULT_DEFINED
|
|
#define OVR_RESULT_DEFINED ///< Allows ovrResult to be independently defined.
|
|
/// API call results are represented at the highest level by a single ovrResult.
|
|
typedef int32_t ovrResult;
|
|
#endif
|
|
|
|
|
|
/// \brief Indicates if an ovrResult indicates success.
|
|
///
|
|
/// Some functions return additional successful values other than ovrSucces and
|
|
/// require usage of this macro to indicate successs.
|
|
///
|
|
#if !defined(OVR_SUCCESS)
|
|
#define OVR_SUCCESS(result) (result >= 0)
|
|
#endif
|
|
|
|
|
|
/// \brief Indicates if an ovrResult indicates an unqualified success.
|
|
///
|
|
/// This is useful for indicating that the code intentionally wants to
|
|
/// check for result == ovrSuccess as opposed to OVR_SUCCESS(), which
|
|
/// checks for result >= ovrSuccess.
|
|
///
|
|
#if !defined(OVR_UNQUALIFIED_SUCCESS)
|
|
#define OVR_UNQUALIFIED_SUCCESS(result) (result == ovrSuccess)
|
|
#endif
|
|
|
|
|
|
/// \brief Indicates if an ovrResult indicates failure.
|
|
///
|
|
#if !defined(OVR_FAILURE)
|
|
#define OVR_FAILURE(result) (!OVR_SUCCESS(result))
|
|
#endif
|
|
|
|
|
|
// Success is a value greater or equal to 0, while all error types are negative values.
|
|
#ifndef OVR_SUCCESS_DEFINED
|
|
#define OVR_SUCCESS_DEFINED ///< Allows ovrResult to be independently defined.
|
|
typedef enum ovrSuccessType_
|
|
{
|
|
/// This is a general success result. Use OVR_SUCCESS to test for success.
|
|
ovrSuccess = 0,
|
|
|
|
/// Returned from a call to SubmitFrame. The call succeeded, but what the app
|
|
/// rendered will not be visible on the HMD. Ideally the app should continue
|
|
/// calling SubmitFrame, but not do any rendering. When the result becomes
|
|
/// ovrSuccess, rendering should continue as usual.
|
|
ovrSuccess_NotVisible = 1000,
|
|
|
|
ovrSuccess_HMDFirmwareMismatch = 4100, ///< The HMD Firmware is out of date but is acceptable.
|
|
ovrSuccess_TrackerFirmwareMismatch = 4101, ///< The Tracker Firmware is out of date but is acceptable.
|
|
ovrSuccess_ControllerFirmwareMismatch = 4104, ///< The controller firmware is out of date but is acceptable.
|
|
|
|
} ovrSuccessType;
|
|
#endif
|
|
|
|
|
|
typedef enum ovrErrorType_
|
|
{
|
|
/* General errors */
|
|
ovrError_MemoryAllocationFailure = -1000, ///< Failure to allocate memory.
|
|
ovrError_SocketCreationFailure = -1001, ///< Failure to create a socket.
|
|
ovrError_InvalidSession = -1002, ///< Invalid ovrSession parameter provided.
|
|
ovrError_Timeout = -1003, ///< The operation timed out.
|
|
ovrError_NotInitialized = -1004, ///< The system or component has not been initialized.
|
|
ovrError_InvalidParameter = -1005, ///< Invalid parameter provided. See error info or log for details.
|
|
ovrError_ServiceError = -1006, ///< Generic service error. See error info or log for details.
|
|
ovrError_NoHmd = -1007, ///< The given HMD doesn't exist.
|
|
|
|
/* Audio error range, reserved for Audio errors. */
|
|
ovrError_AudioReservedBegin = -2000, ///< First Audio error.
|
|
ovrError_AudioDeviceNotFound = -2001, ///< Failure to find the specified audio device.
|
|
ovrError_AudioComError = -2002, ///< Generic COM error.
|
|
ovrError_AudioReservedEnd = -2999, ///< Last Audio error.
|
|
|
|
/* Initialization errors. */
|
|
ovrError_Initialize = -3000, ///< Generic initialization error.
|
|
ovrError_LibLoad = -3001, ///< Couldn't load LibOVRRT.
|
|
ovrError_LibVersion = -3002, ///< LibOVRRT version incompatibility.
|
|
ovrError_ServiceConnection = -3003, ///< Couldn't connect to the OVR Service.
|
|
ovrError_ServiceVersion = -3004, ///< OVR Service version incompatibility.
|
|
ovrError_IncompatibleOS = -3005, ///< The operating system version is incompatible.
|
|
ovrError_DisplayInit = -3006, ///< Unable to initialize the HMD display.
|
|
ovrError_ServerStart = -3007, ///< Unable to start the server. Is it already running?
|
|
ovrError_Reinitialization = -3008, ///< Attempting to re-initialize with a different version.
|
|
ovrError_MismatchedAdapters = -3009, ///< Chosen rendering adapters between client and service do not match
|
|
ovrError_LeakingResources = -3010, ///< Calling application has leaked resources
|
|
ovrError_ClientVersion = -3011, ///< Client version too old to connect to service
|
|
ovrError_OutOfDateOS = -3012, ///< The operating system is out of date.
|
|
ovrError_OutOfDateGfxDriver = -3013, ///< The graphics driver is out of date.
|
|
ovrError_IncompatibleGPU = -3014, ///< The graphics hardware is not supported
|
|
ovrError_NoValidVRDisplaySystem = -3015, ///< No valid VR display system found.
|
|
|
|
/* Hardware errors */
|
|
ovrError_InvalidBundleAdjustment = -4000, ///< Headset has no bundle adjustment data.
|
|
ovrError_USBBandwidth = -4001, ///< The USB hub cannot handle the camera frame bandwidth.
|
|
ovrError_USBEnumeratedSpeed = -4002, ///< The USB camera is not enumerating at the correct device speed.
|
|
ovrError_ImageSensorCommError = -4003, ///< Unable to communicate with the image sensor.
|
|
ovrError_GeneralTrackerFailure = -4004, ///< We use this to report various tracker issues that don't fit in an easily classifiable bucket.
|
|
ovrError_ExcessiveFrameTruncation = -4005, ///< A more than acceptable number of frames are coming back truncated.
|
|
ovrError_ExcessiveFrameSkipping = -4006, ///< A more than acceptable number of frames have been skipped.
|
|
ovrError_SyncDisconnected = -4007, ///< The tracker is not receiving the sync signal (cable disconnected?)
|
|
ovrError_TrackerMemoryReadFailure = -4008, ///< Failed to read memory from the tracker
|
|
ovrError_TrackerMemoryWriteFailure = -4009, ///< Failed to write memory from the tracker
|
|
ovrError_TrackerFrameTimeout = -4010, ///< Timed out waiting for a camera frame
|
|
ovrError_TrackerTruncatedFrame = -4011, ///< Truncated frame returned from tracker
|
|
ovrError_HMDFirmwareMismatch = -4100, ///< The HMD Firmware is out of date and is unacceptable.
|
|
ovrError_TrackerFirmwareMismatch = -4101, ///< The Tracker Firmware is out of date and is unacceptable.
|
|
ovrError_BootloaderDeviceDetected = -4102, ///< A bootloader HMD is detected by the service
|
|
ovrError_TrackerCalibrationError = -4103, ///< The tracker calibration is missing or incorrect
|
|
ovrError_ControllerFirmwareMismatch = -4104, ///< The controller firmware is out of date and is unacceptable
|
|
|
|
/* Synchronization errors */
|
|
ovrError_Incomplete = -5000, ///<Requested async work not yet complete.
|
|
ovrError_Abandoned = -5001, ///<Requested async work was abandoned and result is incomplete.
|
|
|
|
/* Rendering errors */
|
|
ovrError_DisplayLost = -6000, ///<In the event of a system-wide graphics reset or cable unplug this is returned to the app
|
|
|
|
/* Fatal errors */
|
|
ovrError_RuntimeException = -7000, ///< A runtime exception occurred. The application is required to shutdown LibOVR and re-initialize it before this error state will be cleared.
|
|
|
|
} ovrErrorType;
|
|
|
|
|
|
#endif /* OVR_ErrorCode_h */
|