Libovr 1.17 Reference Guide

/********************************************************************************/
#ifndef OVR_ErrorCode_h
#define OVR_ErrorCode_h

#include "OVR_Version.h"
#include <stdint.h>



#ifndef OVR_RESULT_DEFINED
#define OVR_RESULT_DEFINED 
typedef int32_t ovrResult;
#endif

#if !defined(OVR_SUCCESS)
#define OVR_SUCCESS(result) (result >= 0)
#endif

#if !defined(OVR_UNQUALIFIED_SUCCESS)
#define OVR_UNQUALIFIED_SUCCESS(result) (result == ovrSuccess)
#endif

#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 
typedef enum ovrSuccessType_ {
  ovrSuccess = 0,
} ovrSuccessType;
#endif

// Public success types
// Success is a value greater or equal to 0, while all error types are negative values.
typedefenum ovrSuccessTypes_ {
  ovrSuccess_NotVisible = 1000,

  ovrSuccess_BoundaryInvalid = 1001,

  ovrSuccess_DeviceUnavailable = 1002,

} ovrSuccessTypes;

// Public error types
typedefenum ovrErrorType_ {
/******************/
/* General errors */
/******************/

  ovrError_MemoryAllocationFailure = -1000,

  ovrError_InvalidSession = -1002,

  ovrError_Timeout = -1003,

  ovrError_NotInitialized = -1004,

  ovrError_InvalidParameter = -1005,

  ovrError_ServiceError = -1006,

  ovrError_NoHmd = -1007,

  ovrError_Unsupported = -1009,

  ovrError_DeviceUnavailable = -1010,

  ovrError_InvalidHeadsetOrientation = -1011,

  ovrError_ClientSkippedDestroy = -1012,

  ovrError_ClientSkippedShutdown = -1013,

  ovrError_ServiceDeadlockDetected = -1014,

  ovrError_InvalidOperation = -1015,

  ovrError_InsufficientArraySize = -1016,

  ovrError_NoExternalCameraInfo = -1017,

  ovrError_LostTracking = -1018,

/*************************************************/
/* Audio error range, reserved for Audio errors. */
/*************************************************/

  ovrError_AudioDeviceNotFound = -2001,

  ovrError_AudioComError = -2002,

/**************************/
/* Initialization errors. */
/**************************/

  ovrError_Initialize = -3000,

  ovrError_LibLoad = -3001,

  ovrError_LibVersion = -3002,

  ovrError_ServiceConnection = -3003,

  ovrError_ServiceVersion = -3004,

  ovrError_IncompatibleOS = -3005,

  ovrError_DisplayInit = -3006,

  ovrError_ServerStart = -3007,

  ovrError_Reinitialization = -3008,

  ovrError_MismatchedAdapters = -3009,

  ovrError_LeakingResources = -3010,

  ovrError_ClientVersion = -3011,

  ovrError_OutOfDateOS = -3012,

  ovrError_OutOfDateGfxDriver = -3013,

  ovrError_IncompatibleGPU = -3014,

  ovrError_NoValidVRDisplaySystem = -3015,

  ovrError_Obsolete = -3016,

  ovrError_DisabledOrDefaultAdapter = -3017,

  ovrError_HybridGraphicsNotSupported = -3018,

  ovrError_DisplayManagerInit = -3019,

  ovrError_TrackerDriverInit = -3020,

  ovrError_LibSignCheck = -3021,

  ovrError_LibPath = -3022,

  ovrError_LibSymbols = -3023,

  ovrError_RemoteSession = -3024,

  ovrError_InitializeVulkan = -3025,

/********************/
/* Rendering errors */
/********************/

  ovrError_DisplayLost = -6000,

  ovrError_TextureSwapChainFull = -6001,

  ovrError_TextureSwapChainInvalid = -6002,

  ovrError_GraphicsDeviceReset = -6003,

  ovrError_DisplayRemoved = -6004,

  ovrError_ContentProtectionNotAvailable = -6005,

  ovrError_ApplicationInvisible = -6006,

  ovrError_Disallowed = -6007,

  ovrError_DisplayPluggedIncorrectly = -6008,

/****************/
/* Fatal errors */
/****************/

  ovrError_RuntimeException = -7000,

/**********************/
/* Calibration errors */
/**********************/

  ovrError_NoCalibration = -9000,

  ovrError_OldVersion = -9001,

  ovrError_MisformattedBlock = -9002,

/****************/
/* Other errors */
/****************/


} ovrErrorType;

typedefstruct ovrErrorInfo_ {
  ovrResult Result;

char ErrorString[512];
} ovrErrorInfo;

#endif /* OVR_ErrorCode_h */