Package org.lwjgl.ovr

Class OVRErrorCode



  • public class OVRErrorCode
    extends java.lang.Object
    LibOVR error code declarations.
    • Field Detail

      • ovrSuccess

        public static final int ovrSuccess
        This is a general success result.
        See Also:
        Constant Field Values
      • ovrSuccess_NotVisible

        public static final int ovrSuccess_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.
        See Also:
        Constant Field Values
      • ovrSuccess_HMDFirmwareMismatch

        public static final int ovrSuccess_HMDFirmwareMismatch
        The HMD Firmware is out of date but is acceptable.
        See Also:
        Constant Field Values
      • ovrSuccess_TrackerFirmwareMismatch

        public static final int ovrSuccess_TrackerFirmwareMismatch
        The Tracker Firmware is out of date but is acceptable.
        See Also:
        Constant Field Values
      • ovrSuccess_ControllerFirmwareMismatch

        public static final int ovrSuccess_ControllerFirmwareMismatch
        The controller firmware is out of date but is acceptable.
        See Also:
        Constant Field Values
      • ovrSuccess_TrackerDriverNotFound

        public static final int ovrSuccess_TrackerDriverNotFound
        The tracker driver interface was not found. Can be a temporary error.
        See Also:
        Constant Field Values
      • ovrError_MemoryAllocationFailure

        public static final int ovrError_MemoryAllocationFailure
        Failure to allocate memory.
        See Also:
        Constant Field Values
      • ovrError_SocketCreationFailure

        public static final int ovrError_SocketCreationFailure
        Failure to create a socket.
        See Also:
        Constant Field Values
      • ovrError_InvalidSession

        public static final int ovrError_InvalidSession
        Invalid ovrSession parameter provided.
        See Also:
        Constant Field Values
      • ovrError_Timeout

        public static final int ovrError_Timeout
        The operation timed out.
        See Also:
        Constant Field Values
      • ovrError_NotInitialized

        public static final int ovrError_NotInitialized
        The system or component has not been initialized.
        See Also:
        Constant Field Values
      • ovrError_InvalidParameter

        public static final int ovrError_InvalidParameter
        Invalid parameter provided. See error info or log for details.
        See Also:
        Constant Field Values
      • ovrError_ServiceError

        public static final int ovrError_ServiceError
        Generic service error. See error info or log for details.
        See Also:
        Constant Field Values
      • ovrError_NoHmd

        public static final int ovrError_NoHmd
        The given HMD doesn't exist.
        See Also:
        Constant Field Values
      • ovrError_Unsupported

        public static final int ovrError_Unsupported
        Function call is not supported on this hardware/software
        See Also:
        Constant Field Values
      • ovrError_DeviceUnavailable

        public static final int ovrError_DeviceUnavailable
        Specified device type isn't available.
        See Also:
        Constant Field Values
      • ovrError_ServiceDeadlockDetected

        public static final int ovrError_ServiceDeadlockDetected
        The service watchdog discovered a deadlock.
        See Also:
        Constant Field Values
      • ovrError_AudioReservedBegin

        public static final int ovrError_AudioReservedBegin
        First Audio error.
        See Also:
        Constant Field Values
      • ovrError_AudioDeviceNotFound

        public static final int ovrError_AudioDeviceNotFound
        Failure to find the specified audio device.
        See Also:
        Constant Field Values
      • ovrError_AudioComError

        public static final int ovrError_AudioComError
        Generic COM error.
        See Also:
        Constant Field Values
      • ovrError_AudioReservedEnd

        public static final int ovrError_AudioReservedEnd
        Last Audio error.
        See Also:
        Constant Field Values
      • ovrError_Initialize

        public static final int ovrError_Initialize
        Generic initialization error.
        See Also:
        Constant Field Values
      • ovrError_LibLoad

        public static final int ovrError_LibLoad
        Couldn't load LibOVRRT.
        See Also:
        Constant Field Values
      • ovrError_LibVersion

        public static final int ovrError_LibVersion
        LibOVRRT version incompatibility.
        See Also:
        Constant Field Values
      • ovrError_ServiceConnection

        public static final int ovrError_ServiceConnection
        Couldn't connect to the OVR Service.
        See Also:
        Constant Field Values
      • ovrError_ServiceVersion

        public static final int ovrError_ServiceVersion
        OVR Service version incompatibility.
        See Also:
        Constant Field Values
      • ovrError_IncompatibleOS

        public static final int ovrError_IncompatibleOS
        The operating system version is incompatible.
        See Also:
        Constant Field Values
      • ovrError_DisplayInit

        public static final int ovrError_DisplayInit
        Unable to initialize the HMD display.
        See Also:
        Constant Field Values
      • ovrError_ServerStart

        public static final int ovrError_ServerStart
        Unable to start the server. Is it already running?
        See Also:
        Constant Field Values
      • ovrError_Reinitialization

        public static final int ovrError_Reinitialization
        Attempting to re-initialize with a different version.
        See Also:
        Constant Field Values
      • ovrError_MismatchedAdapters

        public static final int ovrError_MismatchedAdapters
        Chosen rendering adapters between client and service do not match
        See Also:
        Constant Field Values
      • ovrError_LeakingResources

        public static final int ovrError_LeakingResources
        Calling application has leaked resources
        See Also:
        Constant Field Values
      • ovrError_ClientVersion

        public static final int ovrError_ClientVersion
        Client version too old to connect to service
        See Also:
        Constant Field Values
      • ovrError_OutOfDateOS

        public static final int ovrError_OutOfDateOS
        The operating system is out of date.
        See Also:
        Constant Field Values
      • ovrError_OutOfDateGfxDriver

        public static final int ovrError_OutOfDateGfxDriver
        The graphics driver is out of date.
        See Also:
        Constant Field Values
      • ovrError_IncompatibleGPU

        public static final int ovrError_IncompatibleGPU
        The graphics hardware is not supported
        See Also:
        Constant Field Values
      • ovrError_NoValidVRDisplaySystem

        public static final int ovrError_NoValidVRDisplaySystem
        No valid VR display system found.
        See Also:
        Constant Field Values
      • ovrError_Obsolete

        public static final int ovrError_Obsolete
        Feature or API is obsolete and no longer supported.
        See Also:
        Constant Field Values
      • ovrError_DisabledOrDefaultAdapter

        public static final int ovrError_DisabledOrDefaultAdapter
        No supported VR display system found, but disabled or driverless adapter found.
        See Also:
        Constant Field Values
      • ovrError_HybridGraphicsNotSupported

        public static final int ovrError_HybridGraphicsNotSupported
        The system is using hybrid graphics (Optimus, etc...), which is not support.
        See Also:
        Constant Field Values
      • ovrError_DisplayManagerInit

        public static final int ovrError_DisplayManagerInit
        Initialization of the DisplayManager failed.
        See Also:
        Constant Field Values
      • ovrError_TrackerDriverInit

        public static final int ovrError_TrackerDriverInit
        Failed to get the interface for an attached tracker
        See Also:
        Constant Field Values
      • ovrError_InvalidBundleAdjustment

        public static final int ovrError_InvalidBundleAdjustment
        Headset has no bundle adjustment data.
        See Also:
        Constant Field Values
      • ovrError_USBBandwidth

        public static final int ovrError_USBBandwidth
        The USB hub cannot handle the camera frame bandwidth.
        See Also:
        Constant Field Values
      • ovrError_USBEnumeratedSpeed

        public static final int ovrError_USBEnumeratedSpeed
        The USB camera is not enumerating at the correct device speed.
        See Also:
        Constant Field Values
      • ovrError_ImageSensorCommError

        public static final int ovrError_ImageSensorCommError
        Unable to communicate with the image sensor.
        See Also:
        Constant Field Values
      • ovrError_GeneralTrackerFailure

        public static final int ovrError_GeneralTrackerFailure
        We use this to report various sensor issues that don't fit in an easily classifiable bucket.
        See Also:
        Constant Field Values
      • ovrError_ExcessiveFrameTruncation

        public static final int ovrError_ExcessiveFrameTruncation
        A more than acceptable number of frames are coming back truncated.
        See Also:
        Constant Field Values
      • ovrError_ExcessiveFrameSkipping

        public static final int ovrError_ExcessiveFrameSkipping
        A more than acceptable number of frames have been skipped.
        See Also:
        Constant Field Values
      • ovrError_SyncDisconnected

        public static final int ovrError_SyncDisconnected
        The sensor is not receiving the sync signal (cable disconnected?).
        See Also:
        Constant Field Values
      • ovrError_TrackerMemoryReadFailure

        public static final int ovrError_TrackerMemoryReadFailure
        Failed to read memory from the sensor.
        See Also:
        Constant Field Values
      • ovrError_TrackerMemoryWriteFailure

        public static final int ovrError_TrackerMemoryWriteFailure
        Failed to write memory from the sensor.
        See Also:
        Constant Field Values
      • ovrError_TrackerFrameTimeout

        public static final int ovrError_TrackerFrameTimeout
        Timed out waiting for a camera frame.
        See Also:
        Constant Field Values
      • ovrError_TrackerTruncatedFrame

        public static final int ovrError_TrackerTruncatedFrame
        Truncated frame returned from sensor.
        See Also:
        Constant Field Values
      • ovrError_TrackerDriverFailure

        public static final int ovrError_TrackerDriverFailure
        The sensor driver has encountered a problem.
        See Also:
        Constant Field Values
      • ovrError_TrackerNRFFailure

        public static final int ovrError_TrackerNRFFailure
        The sensor wireless subsystem has encountered a problem.
        See Also:
        Constant Field Values
      • ovrError_HardwareGone

        public static final int ovrError_HardwareGone
        The hardware has been unplugged
        See Also:
        Constant Field Values
      • ovrError_NordicEnabledNoSync

        public static final int ovrError_NordicEnabledNoSync
        The nordic indicates that sync is enabled but it is not sending sync pulses
        See Also:
        Constant Field Values
      • ovrError_NordicSyncNoFrames

        public static final int ovrError_NordicSyncNoFrames
        It looks like we're getting a sync signal, but no camera frames have been received
        See Also:
        Constant Field Values
      • ovrError_CatastrophicFailure

        public static final int ovrError_CatastrophicFailure
        A catastrophic failure has occurred. We will attempt to recover by resetting the device
        See Also:
        Constant Field Values
      • ovrError_CatastrophicTimeout

        public static final int ovrError_CatastrophicTimeout
        The catastrophic recovery has timed out.
        See Also:
        Constant Field Values
      • ovrError_RepeatCatastrophicFail

        public static final int ovrError_RepeatCatastrophicFail
        Catastrophic failure has repeated too many times.
        See Also:
        Constant Field Values
      • ovrError_USBOpenDeviceFailure

        public static final int ovrError_USBOpenDeviceFailure
        Could not open handle for Rift device (likely already in use by another process).
        See Also:
        Constant Field Values
      • ovrError_HMDGeneralFailure

        public static final int ovrError_HMDGeneralFailure
        Unexpected HMD issues that don't fit a specific bucket.
        See Also:
        Constant Field Values
      • ovrError_HMDFirmwareMismatch

        public static final int ovrError_HMDFirmwareMismatch
        The HMD Firmware is out of date and is unacceptable.
        See Also:
        Constant Field Values
      • ovrError_TrackerFirmwareMismatch

        public static final int ovrError_TrackerFirmwareMismatch
        The sensor Firmware is out of date and is unacceptable.
        See Also:
        Constant Field Values
      • ovrError_BootloaderDeviceDetected

        public static final int ovrError_BootloaderDeviceDetected
        A bootloader HMD is detected by the service.
        See Also:
        Constant Field Values
      • ovrError_TrackerCalibrationError

        public static final int ovrError_TrackerCalibrationError
        The sensor calibration is missing or incorrect.
        See Also:
        Constant Field Values
      • ovrError_ControllerFirmwareMismatch

        public static final int ovrError_ControllerFirmwareMismatch
        The controller firmware is out of date and is unacceptable.
        See Also:
        Constant Field Values
      • ovrError_DevManDeviceDetected

        public static final int ovrError_DevManDeviceDetected
        A DeviceManagement mode HMD is detected by the service.
        See Also:
        Constant Field Values
      • ovrError_RebootedBootloaderDevice

        public static final int ovrError_RebootedBootloaderDevice
        Had to reboot bootloader device, which succeeded.
        See Also:
        Constant Field Values
      • ovrError_FailedRebootBootloaderDev

        public static final int ovrError_FailedRebootBootloaderDev
        Had to reboot bootloader device, which failed. Device is stuck in bootloader mode.
        See Also:
        Constant Field Values
      • ovrError_IMUTooManyLostSamples

        public static final int ovrError_IMUTooManyLostSamples
        Too many lost IMU samples.
        See Also:
        Constant Field Values
      • ovrError_IMURateError

        public static final int ovrError_IMURateError
        IMU rate is outside of the expected range.
        See Also:
        Constant Field Values
      • ovrError_FeatureReportFailure

        public static final int ovrError_FeatureReportFailure
        A feature report has failed.
        See Also:
        Constant Field Values
      • ovrError_HMDWirelessTimeout

        public static final int ovrError_HMDWirelessTimeout
        HMD wireless interface never returned from busy state.
        See Also:
        Constant Field Values
      • ovrError_BootloaderAssertLog

        public static final int ovrError_BootloaderAssertLog
        HMD Bootloader Assert Log was not empty.
        See Also:
        Constant Field Values
      • ovrError_AppAssertLog

        public static final int ovrError_AppAssertLog
        HMD App Assert Log was not empty.
        See Also:
        Constant Field Values
      • ovrError_Incomplete

        public static final int ovrError_Incomplete
        Requested async work not yet complete.
        See Also:
        Constant Field Values
      • ovrError_Abandoned

        public static final int ovrError_Abandoned
        Requested async work was abandoned and result is incomplete.
        See Also:
        Constant Field Values
      • ovrError_DisplayLost

        public static final int ovrError_DisplayLost
        In the event of a system-wide graphics reset or cable unplug this is returned to the app.
        See Also:
        Constant Field Values
      • ovrError_TextureSwapChainFull

        public static final int ovrError_TextureSwapChainFull
        CommitTextureSwapChain was called too many times on a texture swapchain without calling submit to use the chain.
        See Also:
        Constant Field Values
      • ovrError_TextureSwapChainInvalid

        public static final int ovrError_TextureSwapChainInvalid
        The ovrTextureSwapChain is in an incomplete or inconsistent state. Ensure CommitTextureSwapChain was called at least once first.
        See Also:
        Constant Field Values
      • ovrError_GraphicsDeviceReset

        public static final int ovrError_GraphicsDeviceReset
        Graphics device has been reset (TDR, etc...)
        See Also:
        Constant Field Values
      • ovrError_DisplayRemoved

        public static final int ovrError_DisplayRemoved
        HMD removed from the display adapter
        See Also:
        Constant Field Values
      • ovrError_ContentProtectionNotAvailable

        public static final int ovrError_ContentProtectionNotAvailable
        Content protection is not available for the display
        See Also:
        Constant Field Values
      • ovrError_ApplicationInvisible

        public static final int ovrError_ApplicationInvisible
        Application declared itself as an invisible type and is not allowed to submit frames.
        See Also:
        Constant Field Values
      • ovrError_Disallowed

        public static final int ovrError_Disallowed
        The given request is disallowed under the current conditions.
        See Also:
        Constant Field Values
      • ovrError_DisplayPluggedIncorrectly

        public static final int ovrError_DisplayPluggedIncorrectly
        Display portion of HMD is plugged into an incompatible port (ex: IGP)
        See Also:
        Constant Field Values
      • ovrError_RuntimeException

        public static final int ovrError_RuntimeException
        A runtime exception occurred. The application is required to shutdown LibOVR and re-initialize it before this error state will be cleared.
        See Also:
        Constant Field Values
      • ovrError_MetricsUnknownApp

        public static final int ovrError_MetricsUnknownApp
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsDuplicateApp

        public static final int ovrError_MetricsDuplicateApp
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsNoEvents

        public static final int ovrError_MetricsNoEvents
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsRuntime

        public static final int ovrError_MetricsRuntime
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsFile

        public static final int ovrError_MetricsFile
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsNoClientInfo

        public static final int ovrError_MetricsNoClientInfo
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsNoAppMetaData

        public static final int ovrError_MetricsNoAppMetaData
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsNoApp

        public static final int ovrError_MetricsNoApp
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsOafFailure

        public static final int ovrError_MetricsOafFailure
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsSessionAlreadyActive

        public static final int ovrError_MetricsSessionAlreadyActive
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
      • ovrError_MetricsSessionNotActive

        public static final int ovrError_MetricsSessionNotActive
        Error codes (ovrErrorType)
        See Also:
        Constant Field Values
    • 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