Package org.lwjgl.ovr

Class OVRErrorCode

java.lang.Object

org.lwjgl.ovr.OVRErrorCode

public class OVRErrorCode
extends java.lang.Object

LibOVR error code declarations.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ovrError_Abandoned ovrError_AccessDenied ovrError_ApplicationInvisible ovrError_AudioComError ovrError_AudioDeviceNotFound ovrError_BlacklistedGfxDriver ovrError_ClientSkippedDestroy ovrError_ClientSkippedShutdown ovrError_ClientVersion ovrError_ContentProtectionNotAvailable ovrError_DeviceUnavailable ovrError_DisabledOrDefaultAdapter ovrError_Disallowed ovrError_DisplayInit ovrError_DisplayLimitReached ovrError_DisplayLost ovrError_DisplayManagerInit ovrError_DisplayPluggedIncorrectly ovrError_DisplayRemoved ovrError_ExternalCameraCaptureFailed ovrError_ExternalCameraInitializedFailed ovrError_ExternalCameraNameListsBufferSize ovrError_ExternalCameraNameListsMistmatch ovrError_ExternalCameraNameWrongSize ovrError_ExternalCameraNotCalibrated ovrError_GraphicsDeviceReset ovrError_HybridGraphicsNotSupported ovrError_IncompatibleGPU ovrError_IncompatibleOS ovrError_Incomplete ovrError_Initialize ovrError_InitializeVulkan ovrError_InsufficientArraySize ovrError_InvalidHeadsetOrientation ovrError_InvalidOperation ovrError_InvalidParameter ovrError_InvalidSession ovrError_LeakingResources ovrError_LibLoad ovrError_LibPath ovrError_LibSignCheck ovrError_LibSymbols ovrError_LibVersion ovrError_LostTracking ovrError_MemoryAllocationFailure ovrError_MisformattedBlock ovrError_MismatchedAdapters ovrError_NoCalibration ovrError_NoExternalCameraInfo ovrError_NoHmd ovrError_NotInitialized ovrError_NoValidVRDisplaySystem ovrError_Obsolete ovrError_OldVersion ovrError_OutOfDateGfxDriver ovrError_OutOfDateOS ovrError_Reinitialization ovrError_RemoteSession ovrError_RuntimeException ovrError_ServerStart ovrError_ServiceConnection ovrError_ServiceDeadlockDetected ovrError_ServiceError ovrError_ServiceVersion ovrError_TextureSwapChainFull ovrError_TextureSwapChainInvalid ovrError_Timeout ovrError_TrackerDriverInit ovrError_Unsupported	Error codes (ovrErrorType)
static int	ovrSuccess ovrSuccess_BoundaryInvalid ovrSuccess_DeviceUnavailable ovrSuccess_NotVisible	Success codes (ovrSuccessType).

Method Summary

Modifier and Type	Method	Description
static boolean	OVR_FAILURE(int result)	Indicates if an ovrResult indicates failure.
static boolean	OVR_SUCCESS(int result)	Indicates if an ovrResult indicates success.
static boolean	OVR_UNQUALIFIED_SUCCESS(int result)	Indicates if an ovrResult indicates an unqualified success.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ovrSuccess, ovrSuccess_NotVisible, ovrSuccess_BoundaryInvalid, ovrSuccess_DeviceUnavailable

Success codes (ovrSuccessType). Success is a value greater or equal to 0, while all error types are negative values.

Enum values:

• Success - This is a general success result.
• Success_NotVisible - 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 Success, rendering should continue as usual.
• Success_BoundaryInvalid - Boundary is invalid due to sensor change or was not setup.
• Success_DeviceUnavailable - Device is not available for the requested operation.

ovrError_MemoryAllocationFailure, ovrError_InvalidSession, ovrError_Timeout, ovrError_NotInitialized, ovrError_InvalidParameter, ovrError_ServiceError, ovrError_NoHmd, ovrError_Unsupported, ovrError_DeviceUnavailable, ovrError_InvalidHeadsetOrientation, ovrError_ClientSkippedDestroy, ovrError_ClientSkippedShutdown, ovrError_ServiceDeadlockDetected, ovrError_InvalidOperation, ovrError_InsufficientArraySize, ovrError_NoExternalCameraInfo, ovrError_LostTracking, ovrError_ExternalCameraInitializedFailed, ovrError_ExternalCameraCaptureFailed, ovrError_ExternalCameraNameListsBufferSize, ovrError_ExternalCameraNameListsMistmatch, ovrError_ExternalCameraNotCalibrated, ovrError_ExternalCameraNameWrongSize, ovrError_AccessDenied, ovrError_AudioDeviceNotFound, ovrError_AudioComError, ovrError_Initialize, ovrError_LibLoad, ovrError_LibVersion, ovrError_ServiceConnection, ovrError_ServiceVersion, ovrError_IncompatibleOS, ovrError_DisplayInit, ovrError_ServerStart, ovrError_Reinitialization, ovrError_MismatchedAdapters, ovrError_LeakingResources, ovrError_ClientVersion, ovrError_OutOfDateOS, ovrError_OutOfDateGfxDriver, ovrError_IncompatibleGPU, ovrError_NoValidVRDisplaySystem, ovrError_Obsolete, ovrError_DisabledOrDefaultAdapter, ovrError_HybridGraphicsNotSupported, ovrError_DisplayManagerInit, ovrError_TrackerDriverInit, ovrError_LibSignCheck, ovrError_LibPath, ovrError_LibSymbols, ovrError_RemoteSession, ovrError_InitializeVulkan, ovrError_BlacklistedGfxDriver, ovrError_Incomplete, ovrError_Abandoned, ovrError_DisplayLost, ovrError_TextureSwapChainFull, ovrError_TextureSwapChainInvalid, ovrError_GraphicsDeviceReset, ovrError_DisplayRemoved, ovrError_ContentProtectionNotAvailable, ovrError_ApplicationInvisible, ovrError_Disallowed, ovrError_DisplayPluggedIncorrectly, ovrError_DisplayLimitReached, ovrError_RuntimeException, ovrError_NoCalibration, ovrError_OldVersion, ovrError_MisformattedBlock

Error codes (ovrErrorType)

Enum values:

• Error_MemoryAllocationFailure - Failure to allocate memory.
• Error_InvalidSession - Invalid ovrSession parameter provided.
• Error_Timeout - The operation timed out.
• Error_NotInitialized - The system or component has not been initialized.
• Error_InvalidParameter - Invalid parameter provided. See error info or log for details.
• Error_ServiceError - Generic service error. See error info or log for details.
• Error_NoHmd - The given HMD doesn't exist.
• Error_Unsupported - Function call is not supported on this hardware/software
• Error_DeviceUnavailable - Specified device type isn't available.
• Error_InvalidHeadsetOrientation - The headset was in an invalid orientation for the requested operation (e.g. vertically oriented during OVR.ovr_RecenterTrackingOrigin(long)).
• Error_ClientSkippedDestroy - The client failed to call OVR.ovr_Destroy(long) on an active session before calling OVR.ovr_Shutdown(). Or the client crashed.
• Error_ClientSkippedShutdown - The client failed to call OVR.ovr_Shutdown() or the client crashed.
• Error_ServiceDeadlockDetected - The service watchdog discovered a deadlock.
• Error_InvalidOperation - Function call is invalid for object's current state.
• Error_InsufficientArraySize - Increase size of output array
• Error_NoExternalCameraInfo - There is not any external camera information stored by ovrServer.
• Error_LostTracking - Tracking is lost when GetDevicePoses is called.
• Error_ExternalCameraInitializedFailed - There was a problem initializing the external camera for capture
• Error_ExternalCameraCaptureFailed - There was a problem capturing external camera frames
• Error_ExternalCameraNameListsBufferSize - The external camera friendly name list and the external camera name list are not the fixed size(OVR.OVR_MAX_EXTERNAL_CAMERA_COUNT).
• Error_ExternalCameraNameListsMistmatch - The external camera friendly name list is not the same size as the external camera name list.
• Error_ExternalCameraNotCalibrated - The external camera property has not been sent to OVRServer when the user tries to open the camera.
• Error_ExternalCameraNameWrongSize - The external camera name is larger than OVR.OVR_EXTERNAL_CAMERA_NAME_SIZE-1
• Error_AccessDenied - The caller doesn't have permissions for the requested action.
• Error_AudioDeviceNotFound - Failure to find the specified audio device.
• Error_AudioComError - Generic COM error.
• Error_Initialize - Generic initialization error.
• Error_LibLoad - Couldn't load LibOVRRT.
• Error_LibVersion - LibOVRRT version incompatibility.
• Error_ServiceConnection - Couldn't connect to the OVR Service.
• Error_ServiceVersion - OVR Service version incompatibility.
• Error_IncompatibleOS - The operating system version is incompatible.
• Error_DisplayInit - Unable to initialize the HMD display.
• Error_ServerStart - Unable to start the server. Is it already running?
• Error_Reinitialization - Attempting to re-initialize with a different version.
• Error_MismatchedAdapters - Chosen rendering adapters between client and service do not match
• Error_LeakingResources - Calling application has leaked resources
• Error_ClientVersion - Client version too old to connect to service
• Error_OutOfDateOS - The operating system is out of date.
• Error_OutOfDateGfxDriver - The graphics driver is out of date.
• Error_IncompatibleGPU - The graphics hardware is not supported
• Error_NoValidVRDisplaySystem - No valid VR display system found.
• Error_Obsolete - Feature or API is obsolete and no longer supported.
• Error_DisabledOrDefaultAdapter - No supported VR display system found, but disabled or driverless adapter found.
• Error_HybridGraphicsNotSupported - The system is using hybrid graphics (Optimus, etc...), which is not support.
• Error_DisplayManagerInit - Initialization of the DisplayManager failed.
• Error_TrackerDriverInit - Failed to get the interface for an attached tracker
• Error_LibSignCheck - LibOVRRT signature check failure.
• Error_LibPath - LibOVRRT path failure.
• Error_LibSymbols - LibOVRRT symbol resolution failure.
• Error_RemoteSession - Failed to connect to the service because remote connections to the service are not allowed.
• Error_InitializeVulkan - Vulkan initialization error.
• Error_BlacklistedGfxDriver - The graphics driver is black-listed.
• Error_Incomplete - Requested async work not yet complete.
• Error_Abandoned - Requested async work was abandoned and result is incomplete.
• Error_DisplayLost - In the event of a system-wide graphics reset or cable unplug this is returned to the app.
• Error_TextureSwapChainFull - CommitTextureSwapChain was called too many times on a texture swapchain without calling submit to use the chain.
• Error_TextureSwapChainInvalid - The ovrTextureSwapChain is in an incomplete or inconsistent state. Ensure CommitTextureSwapChain was called at least once first.
• Error_GraphicsDeviceReset - Graphics device has been reset (TDR, etc...)
• Error_DisplayRemoved - HMD removed from the display adapter
• Error_ContentProtectionNotAvailable - Content protection is not available for the display
• Error_ApplicationInvisible - Application declared itself as an invisible type and is not allowed to submit frames.
• Error_Disallowed - The given request is disallowed under the current conditions.
• Error_DisplayPluggedIncorrectly - Display portion of HMD is plugged into an incompatible port (ex: IGP)
• Error_DisplayLimitReached - Returned in the event a virtual display system reaches a display limit
• Error_RuntimeException - A runtime exception occurred. The application is required to shutdown LibOVR and re-initialize it before this error state will be cleared.
• Error_NoCalibration - Result of a missing calibration block.
• Error_OldVersion - Result of an old calibration block.
• Error_MisformattedBlock - Result of a bad calibration block due to lengths.

Method Detail

OVR_SUCCESS

public static boolean OVR_SUCCESS(int result)

Indicates if an ovrResult indicates success.

Some functions return additional successful values other than Success and require usage of this macro to indicate success.

Parameters:

result - the ovrResult to check

OVR_UNQUALIFIED_SUCCESS

public static boolean OVR_UNQUALIFIED_SUCCESS(int result)

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 SUCCESS, which checks for result >= ovrSuccess.

Parameters:

result - the ovrResult to check

OVR_FAILURE

public static boolean OVR_FAILURE(int result)

Indicates if an ovrResult indicates failure.

Parameters:

result - the ovrResult to check