Libovr 1.43 Reference Guide

OVR_ErrorCode.h File Reference

This header provides LibOVR error code declarations.
See Also:

Macros

#define
OVR_RESULT_DEFINED
Allows ovrResult to be independently defined.
#define
OVR_SUCCESS
Indicates if an ovrResult indicates success.
#define
OVR_UNQUALIFIED_SUCCESS
Indicates if an ovrResult indicates an unqualified success.
#define
OVR_FAILURE
Indicates if an ovrResult indicates failure.
#define
OVR_SUCCESS_DEFINED
Allows ovrResult to be independently defined.

Enumerations

enum
ovrSuccessType {
}
enum
ovrSuccessTypes {
}
enum
ovrErrorType {
ovrErrorType.ovrError_MemoryAllocationFailure = -1000, ovrErrorType.ovrError_InvalidSession = -1002, ovrErrorType.ovrError_Timeout = -1003, ovrErrorType.ovrError_NotInitialized = -1004, ovrErrorType.ovrError_InvalidParameter = -1005, ovrErrorType.ovrError_ServiceError = -1006, ovrErrorType.ovrError_NoHmd = -1007, ovrErrorType.ovrError_Unsupported = -1009, ovrErrorType.ovrError_DeviceUnavailable = -1010, ovrErrorType.ovrError_InvalidHeadsetOrientation = -1011, ovrErrorType.ovrError_ClientSkippedDestroy = -1012, ovrErrorType.ovrError_ClientSkippedShutdown = -1013, ovrErrorType.ovrError_ServiceDeadlockDetected = -1014, ovrErrorType.ovrError_InvalidOperation = -1015, ovrErrorType.ovrError_InsufficientArraySize = -1016, ovrErrorType.ovrError_NoExternalCameraInfo = -1017, ovrErrorType.ovrError_LostTracking = -1018, ovrErrorType.ovrError_ExternalCameraInitializedFailed = -1019, ovrErrorType.ovrError_ExternalCameraCaptureFailed = -1020, ovrErrorType.ovrError_ExternalCameraNameListsBufferSize = -1021, ovrErrorType.ovrError_ExternalCameraNameListsMistmatch = -1022, ovrErrorType.ovrError_ExternalCameraNotCalibrated = -1023, ovrErrorType.ovrError_ExternalCameraNameWrongSize = -1024, ovrErrorType.ovrError_AccessDenied = -1025, ovrErrorType.ovrError_AudioDeviceNotFound = -2001, ovrErrorType.ovrError_AudioComError = -2002, ovrErrorType.ovrError_Initialize = -3000, ovrErrorType.ovrError_LibLoad = -3001, ovrErrorType.ovrError_LibVersion = -3002, ovrErrorType.ovrError_ServiceConnection = -3003, ovrErrorType.ovrError_ServiceVersion = -3004, ovrErrorType.ovrError_IncompatibleOS = -3005, ovrErrorType.ovrError_DisplayInit = -3006, ovrErrorType.ovrError_ServerStart = -3007, ovrErrorType.ovrError_Reinitialization = -3008, ovrErrorType.ovrError_MismatchedAdapters = -3009, ovrErrorType.ovrError_LeakingResources = -3010, ovrErrorType.ovrError_ClientVersion = -3011, ovrErrorType.ovrError_OutOfDateOS = -3012, ovrErrorType.ovrError_OutOfDateGfxDriver = -3013, ovrErrorType.ovrError_IncompatibleGPU = -3014, ovrErrorType.ovrError_NoValidVRDisplaySystem = -3015, ovrErrorType.ovrError_Obsolete = -3016, ovrErrorType.ovrError_DisabledOrDefaultAdapter = -3017, ovrErrorType.ovrError_HybridGraphicsNotSupported = -3018, ovrErrorType.ovrError_DisplayManagerInit = -3019, ovrErrorType.ovrError_TrackerDriverInit = -3020, ovrErrorType.ovrError_LibSignCheck = -3021, ovrErrorType.ovrError_LibPath = -3022, ovrErrorType.ovrError_LibSymbols = -3023, ovrErrorType.ovrError_RemoteSession = -3024, ovrErrorType.ovrError_InitializeVulkan = -3025, ovrErrorType.ovrError_BlacklistedGfxDriver = -3026, ovrErrorType.ovrError_DisplayLost = -6000, ovrErrorType.ovrError_TextureSwapChainFull = -6001, ovrErrorType.ovrError_TextureSwapChainInvalid = -6002, ovrErrorType.ovrError_GraphicsDeviceReset = -6003, ovrErrorType.ovrError_DisplayRemoved = -6004, ovrErrorType.ovrError_ContentProtectionNotAvailable = -6005, ovrErrorType.ovrError_ApplicationInvisible = -6006, ovrErrorType.ovrError_Disallowed = -6007, ovrErrorType.ovrError_DisplayPluggedIncorrectly = -6008, ovrErrorType.ovrError_DisplayLimitReached = -6009, ovrErrorType.ovrError_RuntimeException = -7000, ovrErrorType.ovrError_NoCalibration = -9000, ovrErrorType.ovrError_OldVersion = -9001, ovrErrorType.ovrError_MisformattedBlock = -9002
}

Typedefs

int32_t
API call results are represented at the highest level by a single ovrResult.

Detailed Description

Copyright (c) Facebook Technologies, LLC and its affiliates. All rights reserved.

Macros Documentation

#define OVR_RESULT_DEFINED
Allows ovrResult to be independently defined.
#define OVR_SUCCESS
Indicates if an ovrResult indicates success.
Some functions return additional successful values other than ovrSucces and require usage of this macro to indicate successs.
#define OVR_UNQUALIFIED_SUCCESS
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.
#define OVR_FAILURE
Indicates if an ovrResult indicates failure.
#define OVR_SUCCESS_DEFINED
Allows ovrResult to be independently defined.

Enumeration Type Documentation

enum OVR_ErrorCode.h.ovrSuccessType
Enumerator
ovrSuccess
This is a general success result. Use OVR_SUCCESS to test for success.
enum OVR_ErrorCode.h.ovrSuccessTypes
Enumerator
ovrSuccess_NotVisible
Returned from a call to SubmitFrame.
ovrSuccess_BoundaryInvalid
Boundary is invalid due to sensor change or was not setup.
ovrSuccess_DeviceUnavailable
Device is not available for the requested operation.
enum OVR_ErrorCode.h.ovrErrorType
Enumerator
ovrError_MemoryAllocationFailure
Failure to allocate memory.
ovrError_InvalidSession
Invalid ovrSession parameter provided.
ovrError_Timeout
The operation timed out.
ovrError_NotInitialized
The system or component has not been initialized.
ovrError_InvalidParameter
Invalid parameter provided. See error info or log for details.
ovrError_ServiceError
Generic service error. See error info or log for details.
ovrError_NoHmd
The given HMD doesn't exist.
ovrError_Unsupported
Function call is not supported on this hardware/software.
ovrError_DeviceUnavailable
Specified device type isn't available.
ovrError_InvalidHeadsetOrientation
The headset was in an invalid orientation for the requested operation (e.g.
ovrError_ClientSkippedDestroy
The client failed to call ovr_Destroy on an active session before calling ovr_Shutdown.
ovrError_ClientSkippedShutdown
The client failed to call ovr_Shutdown or the client crashed.
ovrError_ServiceDeadlockDetected
Function call is invalid for object's current state.
ovrError_InvalidOperation
Increase size of output array.
ovrError_InsufficientArraySize= -1016
ovrError_NoExternalCameraInfo
There is not any external camera information stored by ovrServer.
ovrError_LostTracking
Tracking is lost when ovr_GetDevicePoses() is called.
ovrError_ExternalCameraInitializedFailed
There was a problem initializing the external camera for capture.
ovrError_ExternalCameraCaptureFailed
There was a problem capturing external camera frames.
ovrError_ExternalCameraNameListsBufferSize
The external camera friendly name list and the external camera name list are not the fixed size(OVR_MAX_EXTERNAL_CAMERA_NAME_BUFFER_SIZE).
ovrError_ExternalCameraNameListsMistmatch
The external camera friendly name list is not the same size as the external camera name list.
ovrError_ExternalCameraNotCalibrated
The external camera property has not been sent to OVRServer when the user tries to open the camera.
ovrError_ExternalCameraNameWrongSize
The external camera name is larger than OVR_EXTERNAL_CAMERA_NAME_SIZE-1.
ovrError_AccessDenied
The caller doesn't have permissions for the requested action.
ovrError_AudioDeviceNotFound
Failure to find the specified audio device.
ovrError_AudioComError
Generic COM error.
ovrError_Initialize
Generic initialization error.
ovrError_LibLoad
Couldn't load LibOVRRT.
ovrError_LibVersion
LibOVRRT version incompatibility.
ovrError_ServiceConnection
Couldn't connect to the OVR Service.
ovrError_ServiceVersion
OVR Service version incompatibility.
ovrError_IncompatibleOS
The operating system version is incompatible.
ovrError_DisplayInit
Unable to initialize the HMD display.
ovrError_ServerStart
Unable to start the server. Is it already running?
ovrError_Reinitialization
Attempting to re-initialize with a different version.
ovrError_MismatchedAdapters
Chosen rendering adapters between client and service do not match.
ovrError_LeakingResources
Calling application has leaked resources.
ovrError_ClientVersion
Client version too old to connect to service.
ovrError_OutOfDateOS
The operating system is out of date.
ovrError_OutOfDateGfxDriver
The graphics driver is out of date.
ovrError_IncompatibleGPU
The graphics hardware is not supported.
ovrError_NoValidVRDisplaySystem
No valid VR display system found.
ovrError_Obsolete
Feature or API is obsolete and no longer supported.
ovrError_DisabledOrDefaultAdapter
No supported VR display system found, but disabled or driverless adapter found.
ovrError_HybridGraphicsNotSupported
The system is using hybrid graphics (Optimus, etc...), which is not support.
ovrError_DisplayManagerInit
Initialization of the DisplayManager failed.
ovrError_TrackerDriverInit
Failed to get the interface for an attached tracker.
ovrError_LibSignCheck
LibOVRRT signature check failure.
ovrError_LibPath
LibOVRRT path failure.
ovrError_LibSymbols
LibOVRRT symbol resolution failure.
ovrError_RemoteSession
Failed to connect to the service because remote connections to the service are not allowed.
ovrError_InitializeVulkan
Vulkan initialization error.
ovrError_BlacklistedGfxDriver
The graphics driver is black-listed.
ovrError_DisplayLost
In the event of a system-wide graphics reset or cable unplug this is returned to the app.
ovrError_TextureSwapChainFull
ovr_CommitTextureSwapChain was called too many times on a texture swapchain without calling submit to use the chain.
ovrError_TextureSwapChainInvalid
The ovrTextureSwapChain is in an incomplete or inconsistent state.
ovrError_GraphicsDeviceReset
Graphics device has been reset (TDR, etc...)
ovrError_DisplayRemoved
HMD removed from the display adapter.
ovrError_ContentProtectionNotAvailable
Content protection is not available for the display.
ovrError_ApplicationInvisible
Application declared itself as an invisible type and is not allowed to submit frames.
ovrError_Disallowed
The given request is disallowed under the current conditions.
ovrError_DisplayPluggedIncorrectly
Display portion of HMD is plugged into an incompatible port (ex: IGP)
ovrError_DisplayLimitReached
Returned in the event a virtual display system reaches a display limit.
ovrError_RuntimeException
A runtime exception occurred.
ovrError_NoCalibration
Result of a missing calibration block.
ovrError_OldVersion
Result of an old calibration block.
ovrError_MisformattedBlock
Result of a bad calibration block due to lengths.

Typedef Documentation

typedef int32_t ovrResult ( )
API call results are represented at the highest level by a single ovrResult.
1
7
8
9
10
11
12
13
14
15
16
17
19
20
26
27
28
29
36
37
38
39
42
43
44
45
46
47
48
49
50
52
53
54
55
56
57
62
63
65
66
68
69
70
71
72
73
74
75
76
78
79
81
82
84
85
87
88
90
91
93
94
96
97
99
100
102
103
106
107
110
111
113
114
116
117
119
120
122
123
125
126
128
129
131
132
134
135
138
139
142
143
146
147
149
150
152
153
154
155
156
157
159
160
162
163
164
165
166
167
169
170
172
173
175
176
178
179
181
182
184
185
187
188
190
191
193
194
196
197
199
200
202
203
205
206
208
209
211
212
214
215
217
218
220
221
223
224
226
227
229
230
232
233
235
236
238
239
241
242
244
245
247
248
249
250
251
252
254
255
258
259
262
263
265
266
268
269
271
272
274
275
277
278
280
281
283
284
285
286
287
288
291
292
293
294
295
296
298
299
301
302
304
305
306
307
308
309
310
311
312
315
317
318
321
322
323
324
/********************************************************************************/
#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,

  ovrError_ExternalCameraInitializedFailed = -1019,

  ovrError_ExternalCameraCaptureFailed = -1020,

  ovrError_ExternalCameraNameListsBufferSize = -1021,

  ovrError_ExternalCameraNameListsMistmatch = -1022,

  ovrError_ExternalCameraNotCalibrated = -1023,

  ovrError_ExternalCameraNameWrongSize = -1024,

  ovrError_AccessDenied = -1025,

/*************************************************/
/* 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,

  ovrError_BlacklistedGfxDriver = -3026,

/********************/
/* 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,

  ovrError_DisplayLimitReached = -6009,

/****************/
/* 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 */
The documentation for this file was generated from the following file: Include/OVR_ErrorCode.h