LWJGL 3.3.3 · org.lwjgl.ovr.OVR

Field Summary

Modifier and Type	Field and Description
public static final int	OVR_EXTERNAL_CAMERA_NAME_SIZE External camera constants
public static final int	OVR_FORMAT_B4G4R4A4_UNORM The format of a texture.
public static final int	OVR_FORMAT_B5G5R5A1_UNORM The format of a texture.
public static final int	OVR_FORMAT_B5G6R5_UNORM The format of a texture.
public static final int	OVR_FORMAT_B8G8R8_UNORM The format of a texture.
public static final int	OVR_FORMAT_B8G8R8A8_UNORM The format of a texture.
public static final int	OVR_FORMAT_B8G8R8A8_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_B8G8R8X8_UNORM The format of a texture.
public static final int	OVR_FORMAT_B8G8R8X8_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_BC1_UNORM The format of a texture.
public static final int	OVR_FORMAT_BC1_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_BC2_UNORM The format of a texture.
public static final int	OVR_FORMAT_BC2_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_BC3_UNORM The format of a texture.
public static final int	OVR_FORMAT_BC3_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_BC6H_SF16 The format of a texture.
public static final int	OVR_FORMAT_BC6H_UF16 The format of a texture.
public static final int	OVR_FORMAT_BC7_UNORM The format of a texture.
public static final int	OVR_FORMAT_BC7_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_D16_UNORM The format of a texture.
public static final int	OVR_FORMAT_D24_UNORM_S8_UINT The format of a texture.
public static final int	OVR_FORMAT_D32_FLOAT The format of a texture.
public static final int	OVR_FORMAT_D32_FLOAT_S8X24_UINT The format of a texture.
public static final int	OVR_FORMAT_R11G11B10_FLOAT The format of a texture.
public static final int	OVR_FORMAT_R16G16B16A16_FLOAT The format of a texture.
public static final int	OVR_FORMAT_R8G8B8A8_UNORM The format of a texture.
public static final int	OVR_FORMAT_R8G8B8A8_UNORM_SRGB The format of a texture.
public static final int	OVR_FORMAT_UNKNOWN The format of a texture.
public static final int	OVR_HAPTICS_BUFFER_SAMPLES_MAX Maximum number of samples in `OVRHapticsBuffer`.
public static final int	OVR_MAX_EXTENSION_NAME_SIZE Defines the largest size for an extension name string, including the '\0' terminator.
public static final int	OVR_MAX_EXTERNAL_CAMERA_COUNT External camera constants
public static final int	ovrBoundary_Outer Boundary types that specified while using the boundary system.
public static final int	ovrBoundary_PlayArea Boundary types that specified while using the boundary system.
public static final int	ovrButton_A Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_B Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Back Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Down Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Enter Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Home Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Left Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_LMask Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_LShoulder Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_LThumb Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Private Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Right Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_RMask Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_RShoulder Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_RThumb Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Up Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_VolDown Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_VolUp Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_X Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrButton_Y Describes button input types.(`ovrButton`) Button inputs are combined; that is they will be reported as pressed if they are pressed on either one of the two devices.
public static final int	ovrCameraStatus_Calibrated Camera status flags.
public static final int	ovrCameraStatus_Calibrating Camera status flags.
public static final int	ovrCameraStatus_CalibrationFailed Camera status flags.
public static final int	ovrCameraStatus_Capturing Camera status flags.
public static final int	ovrCameraStatus_Connected Camera status flags.
public static final int	ovrCameraStatus_None Camera status flags.
public static final int	ovrColorSpace_Adobe_RGB Color space types for HMDs.
public static final int	ovrColorSpace_P3 Color space types for HMDs.
public static final int	ovrColorSpace_Quest Color space types for HMDs.
public static final int	ovrColorSpace_Rec_2020 Color space types for HMDs.
public static final int	ovrColorSpace_Rec_709 Color space types for HMDs.
public static final int	ovrColorSpace_Rift_CV1 Color space types for HMDs.
public static final int	ovrColorSpace_Rift_S Color space types for HMDs.
public static final int	ovrColorSpace_Unknown Color space types for HMDs.
public static final int	ovrColorSpace_Unmanaged Color space types for HMDs.
public static final int	ovrControllerType_Active Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_LTouch Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_None Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Object0 Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Object1 Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Object2 Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Object3 Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Remote Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_RTouch Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_Touch Which controller is connected; multiple can be connected at once.
public static final int	ovrControllerType_XBox Which controller is connected; multiple can be connected at once.
public static final int	ovrDebugHudStereo_CrosshairAtInfinity Debug HUD is provided to help developers gauge and debug the fidelity of their app's stereo rendering characteristics.
public static final int	ovrDebugHudStereo_Off Debug HUD is provided to help developers gauge and debug the fidelity of their app's stereo rendering characteristics.
public static final int	ovrDebugHudStereo_Quad Debug HUD is provided to help developers gauge and debug the fidelity of their app's stereo rendering characteristics.
public static final int	ovrDebugHudStereo_QuadWithCrosshair Debug HUD is provided to help developers gauge and debug the fidelity of their app's stereo rendering characteristics.
public static final int	ovrExtension_TextureLayout_Octilinear Optional extensions.
public static final int	ovrEye_Count Specifies which eye is being used for rendering.
public static final int	ovrEye_Left Specifies which eye is being used for rendering.
public static final int	ovrEye_Right Specifies which eye is being used for rendering.
public static final int	ovrFalse Boolean values
public static final int	ovrFovStencil_BorderLine Viewport stencil types provided by the `GetFovStencil` call.
public static final int	ovrFovStencil_HiddenArea Viewport stencil types provided by the `GetFovStencil` call.
public static final int	ovrFovStencil_VisibleArea Viewport stencil types provided by the `GetFovStencil` call.
public static final int	ovrFovStencil_VisibleRectangle Viewport stencil types provided by the `GetFovStencil` call.
public static final int	ovrFovStencilFlag_MeshOriginAtBottomLeft Flags used by `OVRFovStencilDesc` and which are passed to `GetFovStencil`.
public static final int	ovrHand_Count Names for the left and right hand array indexes.
public static final int	ovrHand_Left Names for the left and right hand array indexes.
public static final int	ovrHand_Right Names for the left and right hand array indexes.
public static final int	ovrHapticsBufferSubmit_Enqueue Haptics buffer submit mode.
public static final int	ovrHmd_CB HMD types.
public static final int	ovrHmd_CV1 HMD types.
public static final int	ovrHmd_DK2 HMD types.
public static final int	ovrHmd_E3_2015 HMD types.
public static final int	ovrHmd_ES06 HMD types.
public static final int	ovrHmd_ES09 HMD types.
public static final int	ovrHmd_ES11 HMD types.
public static final int	ovrHmd_None HMD types.
public static final int	ovrHmd_Other HMD types.
public static final int	ovrHmd_Quest HMD types.
public static final int	ovrHmd_Quest2 HMD types.
public static final int	ovrHmd_RiftS HMD types.
public static final int	ovrHmdCap_DebugDevice HMD capability bits reported by device.
public static final int	ovrInit_Debug Initialization flags.
public static final int	ovrInit_FocusAware Initialization flags.
public static final int	ovrInit_Invisible Initialization flags.
public static final int	ovrInit_MixedRendering Initialization flags.
public static final int	ovrInit_RequestVersion Initialization flags.
public static final int	ovrInit_WritableBits Initialization flags.
public static final int	ovrLayerFlag_HeadLocked Identifies flags used by `OVRLayerHeader` and which are passed to `SubmitFrame`.
public static final int	ovrLayerFlag_HighQuality Identifies flags used by `OVRLayerHeader` and which are passed to `SubmitFrame`.
public static final int	ovrLayerFlag_TextureOriginAtBottomLeft Identifies flags used by `OVRLayerHeader` and which are passed to `SubmitFrame`.
public static final int	ovrLayerHud_Info Layer HUD enables the HMD user to see information about a layer.
public static final int	ovrLayerHud_Off Layer HUD enables the HMD user to see information about a layer.
public static final int	ovrLayerType_Cube Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_Cylinder Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_Disabled Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_EyeFov Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_EyeFovDepth Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_EyeFovMultires Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_EyeMatrix Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLayerType_Quad Describes layer types that can be passed to `SubmitFrame`.
public static final int	ovrLogLevel_Debug Logging levels.
public static final int	ovrLogLevel_Error Logging levels.
public static final int	ovrLogLevel_Info Logging levels.
public static final int	ovrMaxLayerCount Specifies the maximum number of layers supported by `SubmitFrame`.
public static final int	ovrMaxProvidedFrameStats Enum values: `MaxProvidedFrameStats` - Maximum number of frames of performance stats provided back to the caller of `GetPerfStats`.
public static final int	ovrMirrorOption_Default Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_ForceSymmetricFov Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_IncludeGuardian Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_IncludeNotifications Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_IncludeSystemGui Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_LeftEyeOnly Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_PostDistortion Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrMirrorOption_RightEyeOnly Bit flags used as part of `OVRMirrorTextureDesc`'s `MirrorOptions` field.
public static final int	ovrPerfHud_AppRenderTiming Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_AwsStats Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_CompRenderTiming Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_LatencyTiming Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_LinkPerf Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_Off Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_PerfSummary Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrPerfHud_VersionInfo Performance HUD enables the HMD user to see information critical to the real-time operation of the VR application such as latency timing, and CPU & GPU performance metrics.
public static final int	ovrStatus_OrientationTracked Bit flags describing the current status of sensor tracking.
public static final int	ovrStatus_OrientationValid Bit flags describing the current status of sensor tracking.
public static final int	ovrStatus_PositionTracked Bit flags describing the current status of sensor tracking.
public static final int	ovrStatus_PositionValid Bit flags describing the current status of sensor tracking.
public static final int	ovrTexture_2D The type of texture resource.
public static final int	ovrTexture_2D_External The type of texture resource.
public static final int	ovrTexture_Cube The type of texture resource.
public static final int	ovrTextureBind_DX_DepthStencil The bindings required for texture swap chain.
public static final int	ovrTextureBind_DX_RenderTarget The bindings required for texture swap chain.
public static final int	ovrTextureBind_DX_UnorderedAccess The bindings required for texture swap chain.
public static final int	ovrTextureBind_None The bindings required for texture swap chain.
public static final int	ovrTextureLayout_Octilinear Describes eye texture layouts.
public static final int	ovrTextureLayout_Rectilinear Describes eye texture layouts.
public static final int	ovrTextureMisc_AllowGenerateMips Misc flags overriding particular behaviors of a texture swap chain.
public static final int	ovrTextureMisc_AutoGenerateMips Misc flags overriding particular behaviors of a texture swap chain.
public static final int	ovrTextureMisc_DX_Typeless Misc flags overriding particular behaviors of a texture swap chain.
public static final int	ovrTextureMisc_None Misc flags overriding particular behaviors of a texture swap chain.
public static final int	ovrTextureMisc_ProtectedContent Misc flags overriding particular behaviors of a texture swap chain.
public static final int	ovrTouch_A Describes touch input types.
public static final int	ovrTouch_B Describes touch input types.
public static final int	ovrTouch_LButtonMask Describes touch input types.
public static final int	ovrTouch_LIndexPointing Describes touch input types.
public static final int	ovrTouch_LIndexTrigger Describes touch input types.
public static final int	ovrTouch_LPoseMask Describes touch input types.
public static final int	ovrTouch_LThumb Describes touch input types.
public static final int	ovrTouch_LThumbRest Describes touch input types.
public static final int	ovrTouch_LThumbUp Describes touch input types.
public static final int	ovrTouch_RButtonMask Describes touch input types.
public static final int	ovrTouch_RIndexPointing Describes touch input types.
public static final int	ovrTouch_RIndexTrigger Describes touch input types.
public static final int	ovrTouch_RPoseMask Describes touch input types.
public static final int	ovrTouch_RThumb Describes touch input types.
public static final int	ovrTouch_RThumbRest Describes touch input types.
public static final int	ovrTouch_RThumbUp Describes touch input types.
public static final int	ovrTouch_X Describes touch input types.
public static final int	ovrTouch_Y Describes touch input types.
public static final int	ovrTrackedDevice_All Position tracked devices.
public static final int	ovrTrackedDevice_HMD Position tracked devices.
public static final int	ovrTrackedDevice_LTouch Position tracked devices.
public static final int	ovrTrackedDevice_None Position tracked devices.
public static final int	ovrTrackedDevice_Object0 Position tracked devices.
public static final int	ovrTrackedDevice_Object1 Position tracked devices.
public static final int	ovrTrackedDevice_Object2 Position tracked devices.
public static final int	ovrTrackedDevice_Object3 Position tracked devices.
public static final int	ovrTrackedDevice_RTouch Position tracked devices.
public static final int	ovrTrackedDevice_Touch Position tracked devices.
public static final int	ovrTracker_Connected Specifies sensor flags.
public static final int	ovrTracker_PoseTracked Specifies sensor flags.
public static final int	ovrTrackingCap_MagYawCorrection Tracking capability bits reported by the device.
public static final int	ovrTrackingCap_Orientation Tracking capability bits reported by the device.
public static final int	ovrTrackingCap_Position Tracking capability bits reported by the device.
public static final int	ovrTrackingOrigin_EyeLevel Specifies the coordinate system ovrTrackingState returns tracking poses in. (`ovrTrackingOrigin`) Used with `SetTrackingOriginType`.
public static final int	ovrTrackingOrigin_FloorLevel Specifies the coordinate system ovrTrackingState returns tracking poses in. (`ovrTrackingOrigin`) Used with `SetTrackingOriginType`.
public static final int	ovrTrue Boolean values

Access	Constructor and Description
protected	OVR()

Method Summary

Modifier and Type Method and Description

public static native int

novr_BeginFrame(long session, long frameIndex)

Unsafe version of: BeginFrame

public static native void

novr_ClearShouldRecenterFlag(long session)

Unsafe version of: ClearShouldRecenterFlag

public static native int

novr_CommitTextureSwapChain(long session, long chain)

Unsafe version of: CommitTextureSwapChain

public static native int

novr_Create(long pSession, long pLuid)

Unsafe version of: Create

public static native void

novr_Destroy(long session)

Unsafe version of: Destroy

public static native void

novr_DestroyMirrorTexture(long session, long mirrorTexture)

Unsafe version of: DestroyMirrorTexture

public static native void

novr_DestroyTextureSwapChain(long session, long chain)

Unsafe version of: DestroyTextureSwapChain

public static native int

novr_EnableExtension(long session, int extension)

Unsafe version of: EnableExtension

public static native int

novr_EndFrame(long session, long frameIndex, long viewScaleDesc, long layerPtrList, int

indicates the number of valid elements in layerPtrList. The maximum supported layerCount is not currently specified, but may be specified in a future version.

layerCount)

Unsafe version of: EndFrame

public static native boolean

novr_GetBool(long session, long propertyName, boolean defaultVal)

Unsafe version of: GetBool

public static native int

novr_GetBoundaryDimensions(long session, int boundaryType, long outDimensions)

Unsafe version of: GetBoundaryDimensions

public static native int

novr_GetBoundaryGeometry(long session, int boundaryType, long outFloorPoints, long outFloorPointsCount)

Unsafe version of: GetBoundaryGeometry

public static native int

novr_GetBoundaryGeometry(long session, int boundaryType, long outFloorPoints, int[] outFloorPointsCount)

Array version of: novr_GetBoundaryGeometry

public static native int

novr_GetBoundaryVisible(long session, long outIsVisible)

Unsafe version of: GetBoundaryVisible

public static native int

novr_GetConnectedControllerTypes(long session)

Unsafe version of: GetConnectedControllerTypes

public static native int

novr_GetControllerVibrationState(long session, int controllerType, long outState)

Unsafe version of: GetControllerVibrationState

public static native int

novr_GetDevicePoses(long session, long deviceTypes, int

number of queried poses. This number must match the length of the outDevicePoses and deviceTypes array.

deviceCount, double absTime, long outDevicePoses)

Unsafe version of: GetDevicePoses

public static native int

novr_GetDevicePoses(long session, int[] deviceTypes, int deviceCount, double absTime, long outDevicePoses)

Array version of: novr_GetDevicePoses

public static native int

novr_GetExternalCameras(long session, long cameras, long

supply the array capacity, will return the actual \\# of cameras defined. If *inoutCameraCount is too small, will return Error_InsufficientArraySize.

inoutCameraCount)

Unsafe version of: GetExternalCameras

public static native int

novr_GetExternalCameras(long session, long cameras, int[] inoutCameraCount)

Array version of: novr_GetExternalCameras

public static native float

novr_GetFloat(long session, long propertyName, float defaultVal)

Unsafe version of: GetFloat

public static native int

novr_GetFloatArray(long session, long propertyName, long values, int

the maximum number of elements to write to the values array

valuesCapacity)

Unsafe version of: GetFloatArray

public static native int

novr_GetFloatArray(long session, long propertyName, float[] values, int valuesCapacity)

Array version of: novr_GetFloatArray

public static native int

novr_GetFovStencil(long session, long fovStencilDesc, long meshBuffer)

Unsafe version of: GetFovStencil

public static native void

novr_GetFovTextureSize(long session, int eye, long fov, float pixelsPerDisplayPixel, long __result)

Unsafe version of: GetFovTextureSize

public static native void

novr_GetHmdColorDesc(long session, long __result)

Unsafe version of: GetHmdColorDesc

public static native void

novr_GetHmdDesc(long session, long __result)

Unsafe version of: GetHmdDesc

public static native int

novr_GetInputState(long session, int controllerType, long inputState)

Unsafe version of: GetInputState

public static native int

novr_GetInt(long session, long propertyName, int defaultVal)

Unsafe version of: GetInt

public static native void

novr_GetLastErrorInfo(long errorInfo)

Unsafe version of: GetLastErrorInfo

public static native int

novr_GetPerfStats(long session, long outStats)

Unsafe version of: GetPerfStats

public static native double

novr_GetPredictedDisplayTime(long session, long frameIndex)

Unsafe version of: GetPredictedDisplayTime

public static native void

novr_GetRenderDesc(long session, int eyeType, long fov, long __result)

Unsafe version of: GetRenderDesc

public static native int

novr_GetSessionStatus(long session, long sessionStatus)

Unsafe version of: GetSessionStatus

public static native long

novr_GetString(long session, long propertyName, long defaultVal)

Unsafe version of: GetString

public static native int

novr_GetTextureSwapChainCurrentIndex(long session, long chain, long out_Index)

Unsafe version of: GetTextureSwapChainCurrentIndex

public static native int

novr_GetTextureSwapChainCurrentIndex(long session, long chain, int[] out_Index)

Array version of: novr_GetTextureSwapChainCurrentIndex

public static native int

novr_GetTextureSwapChainDesc(long session, long chain, long out_Desc)

Unsafe version of: GetTextureSwapChainDesc

public static native int

novr_GetTextureSwapChainLength(long session, long chain, long out_Length)

Unsafe version of: GetTextureSwapChainLength

public static native int

novr_GetTextureSwapChainLength(long session, long chain, int[] out_Length)

Array version of: novr_GetTextureSwapChainLength

public static native void

novr_GetTouchHapticsDesc(long session, int controllerType, long __result)

Unsafe version of: GetTouchHapticsDesc

public static native int

novr_GetTrackerCount(long session)

Unsafe version of: GetTrackerCount

public static native void

novr_GetTrackerDesc(long session, int trackerDescIndex, long __result)

Unsafe version of: GetTrackerDesc

public static native void

novr_GetTrackerPose(long session, int trackerPoseIndex, long __result)

Unsafe version of: GetTrackerPose

public static native int

novr_GetTrackingOriginType(long session)

Unsafe version of: GetTrackingOriginType

public static native void

novr_GetTrackingState(long session, double absTime, boolean latencyMarker, long __result)

Unsafe version of: GetTrackingState

public static native long

novr_GetVersionString()

Unsafe version of: GetVersionString

public static native int

novr_IdentifyClient(long identity)

Unsafe version of: IdentifyClient

public static native int

novr_Initialize(long params)

Unsafe version of: Initialize

public static native int

novr_IsExtensionSupported(long session, int extension, long outExtensionSupported)

Unsafe version of: IsExtensionSupported

public static native int

novr_RecenterTrackingOrigin(long session)

Unsafe version of: RecenterTrackingOrigin

public static native int

novr_RequestBoundaryVisible(long session, boolean visible)

Unsafe version of: RequestBoundaryVisible

public static native int

novr_ResetBoundaryLookAndFeel(long session)

Unsafe version of: ResetBoundaryLookAndFeel

public static native int

novr_ResetPerfStats(long session)

Unsafe version of: ResetPerfStats

public static native boolean

novr_SetBool(long session, long propertyName, boolean value)

Unsafe version of: SetBool

public static native int

novr_SetBoundaryLookAndFeel(long session, long lookAndFeel)

Unsafe version of: SetBoundaryLookAndFeel

public static native int

novr_SetClientColorDesc(long session, long colorDesc)

Unsafe version of: SetClientColorDesc

public static native int

novr_SetControllerVibration(long session, int controllerType, float frequency, float amplitude)

Unsafe version of: SetControllerVibration

public static native int

novr_SetExternalCameraProperties(long session, long name, long intrinsics, long extrinsics)

Unsafe version of: SetExternalCameraProperties

public static native boolean

novr_SetFloat(long session, long propertyName, float value)

Unsafe version of: SetFloat

public static native boolean

novr_SetFloatArray(long session, long propertyName, long values, int

the number of elements to write

valuesSize)

Unsafe version of: SetFloatArray

public static native boolean

novr_SetFloatArray(long session, long propertyName, float[] values, int valuesSize)

Array version of: novr_SetFloatArray

public static native boolean

novr_SetInt(long session, long propertyName, int value)

Unsafe version of: SetInt

public static native boolean

novr_SetString(long hmddesc, long propertyName, long value)

Unsafe version of: SetString

public static native int

novr_SetTrackingOriginType(long session, int origin)

Unsafe version of: SetTrackingOriginType

public static native int

novr_SpecifyTrackingOrigin(long session, long originPose)

Unsafe version of: SpecifyTrackingOrigin

public static native int

novr_SubmitControllerVibration(long session, int controllerType, long buffer)

Unsafe version of: SubmitControllerVibration

public static native int

novr_SubmitFrame(long session, long frameIndex, long viewScaleDesc, long layerPtrList, int

the number of valid elements in layerPtrList. The maximum supported layerCount is not currently specified, but may be specified in a future version.

layerCount)

Unsafe version of: SubmitFrame

public static native int

novr_TestBoundary(long session, int deviceBitmask, int boundaryType, long outTestResult)

Unsafe version of: TestBoundary

public static native int

novr_TestBoundaryPoint(long session, long point, int singleBoundaryType, long outTestResult)

Unsafe version of: TestBoundaryPoint

public static native int

novr_TraceMessage(int level, long message)

Unsafe version of: TraceMessage

public static native int

novr_WaitToBeginFrame(long session, long frameIndex)

Unsafe version of: WaitToBeginFrame

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: command completed successfully.
Error_DisplayLost: The session has become invalid (such as due to a device removal) and the shared resources need to be released (DestroyTextureSwapChain), the session needs to destroyed (Destroy) and recreated (Create), and new resources need to be created (ovr_CreateTextureSwapChainXXX). The application's existing private graphics resources do not need to be recreated unless the new ovr_Create call returns a different GraphicsLuid.

ovr_BeginFrame(long

an ovrSession previously returned by Create

session, long

specifies the targeted application frame index. It must match what was passed to WaitToBeginFrame.

frameIndex)

Called from render thread before application begins rendering.

public static void

ovr_ClearShouldRecenterFlag(long

an ovrSession previously returned by Create

session)

Clears the ShouldRecenter status bit in OVRSessionStatus.

public static int

ovr_CommitTextureSwapChain(long

an ovrSession previously returned by Create

session, long

the ovrTextureSwapChain to commit

chain)

Commits any pending changes to an ovrTextureSwapChain, and advances its current index.

public static int

Returns:

an ovrResult indicating success or failure. Upon failure the returned ovrSession will be NULL.

ovr_Create(PointerBuffer

a pointer to an ovrSession which will be written to upon success

pSession, OVRGraphicsLuid

a system specific graphics adapter identifier that locates which graphics adapter has the HMD attached. This must match the adapter used by the application or no rendering output will be possible. This is important for stability on multi-adapter systems. An application that simply chooses the default adapter will not run reliably on multi-adapter systems.

pLuid)

Creates a handle to a VR session.

public static void

ovr_Destroy(long

an ovrSession previously returned by Create

session)

Destroys the session.

public static void

ovr_DestroyMirrorTexture(long

an ovrSession previously returned by Create

session, long

the ovrTexture to destroy. If it is NULL then this function has no effect.

mirrorTexture)

Destroys a mirror texture previously created by one of the mirror texture creation functions.

public static void

ovr_DestroyTextureSwapChain(long

an ovrSession previously returned by Create

session, long

the ovrTextureSwapChain to destroy. If it is NULL then this function has no effect.

chain)

Destroys an ovrTextureSwapChain and frees all the resources associated with it.

public static int

Returns:

an ovrResult indicating success or failure. Extension is only enabled if successful. In the case of failure use GetLastErrorInfo to get more information.

ovr_EnableExtension(long

an ovrSession previously returned by Create

session, int

extension to enable.

extension)

Enable extension.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: rendering completed successfully.
Error_DisplayLost: The session has become invalid (such as due to a device removal) and the shared resources need to be released (DestroyTextureSwapChain), the session needs to destroyed (Destroy) and recreated (Create), and new resources need to be created (ovr_CreateTextureSwapChainXXX). The application's existing private graphics resources do not need to be recreated unless the new ovr_Create call returns a different GraphicsLuid.
Error_TextureSwapChainInvalid: The ovrTextureSwapChain is in an incomplete or inconsistent state. Ensure CommitTextureSwapChain was called at least once first.

ovr_EndFrame(long

an ovrSession previously returned by Create

session, long

specifies the targeted application frame index. It must match what was passed to BeginFrame.

frameIndex, OVRViewScaleDesc

provides additional information needed only if layerPtrList contains an LayerType_Quad. If NULL, a default version is used based on the current configuration and a 1.0 world scale.

viewScaleDesc, PointerBuffer

specifies a list of ovrLayer pointers, which can include NULL entries to indicate that any previously shown layer at that index is to not be displayed. Each layer header must be a part of a layer structure such as OVRLayerEyeFov or OVRLayerQuad, with Header.Type identifying its type. A NULL layerPtrList entry in the array indicates the absence of the given layer.

layerPtrList)

Called from render thread after application has finished rendering.

public static boolean

Returns:

the property interpreted as a boolean value. Returns defaultVal if the property doesn't exist.

ovr_GetBool(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid for only the call

propertyName, boolean

specifes the value to return if the property couldn't be read

defaultVal)

Reads a boolean property.

public static boolean

Returns:

the property interpreted as a boolean value. Returns defaultVal if the property doesn't exist.

ovr_GetBool(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid for only the call

propertyName, boolean

specifes the value to return if the property couldn't be read

defaultVal)

Reads a boolean property.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_BoundaryInvalid: The call succeeded but the result is not a valid boundary due to not being set up.

ovr_GetBoundaryDimensions(long

an ovrSession previously returned by Create

session, int

the boundary type. One of:

Boundary_Outer

Boundary_PlayArea

boundaryType, OVRVector3f

dimensions of the axis aligned bounding box that encloses the area in meters (width, height and length)

outDimensions)

Gets the dimension of the Boundary System's "play area" or "outer boundary".

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_BoundaryInvalid: The call succeeded but the result is not a valid boundary due to not being set up.

ovr_GetBoundaryGeometry(long

an ovrSession previously returned by Create

session, int

the boundary type. One of:

Boundary_Outer

Boundary_PlayArea

boundaryType, OVRVector3f

an array of 3D points (in clockwise order) defining the boundary at floor height (can be NULL to retrieve only the number of points)

outFloorPoints, IntBuffer

the number of 3D points returned in the array

outFloorPointsCount)

Gets the geometry of the Boundary System's "play area" or "outer boundary" as 3D floor points.

public static int

ovr_GetBoundaryGeometry(long session, int boundaryType, OVRVector3f outFloorPoints, int[] outFloorPointsCount)

Array version of: GetBoundaryGeometry

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_BoundaryInvalid: The call succeeded but the result is not a valid boundary due to not being set up.

ovr_GetBoundaryVisible(long

an ovrSession previously returned by Create

session, ByteBuffer

True, if the boundary is visible

outIsVisible)

Returns if the boundary is currently visible.

public static int

ovr_GetConnectedControllerTypes(long

an ovrSession previously returned by Create

session)

Returns controller types connected to the system OR'ed together.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_DeviceUnavailable: The call succeeded but the device referred to by controllerType is not available.

ovr_GetControllerVibrationState(long

an ovrSession previously returned by Create

session, int

the controller where the Haptics buffer will be played

controllerType, OVRHapticsPlaybackState

the state of the haptics engine

outState)

Gets the Haptics engine playback state of a specific Touch controller.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success

ovr_GetDevicePoses(long

an ovrSession previously returned by Create

session, IntBuffer

array of device types to query for their poses

deviceTypes, double

specifies the absolute future time to predict the return ovrTrackingState value. Use 0 to request the most recent tracking state.

absTime, OVRPoseStatef.Buffer

array of poses, one for each device type in deviceTypes arrays

outDevicePoses)

Returns an array of poses, where each pose matches a device type provided by the deviceTypes array parameter.

public static int

ovr_GetDevicePoses(long session, int[] deviceTypes, double absTime, OVRPoseStatef.Buffer outDevicePoses)

Array version of: GetDevicePoses

public static int

Returns:

the list of external cameras the system knows about. Returns Error_NoExternalCameraInfo if there is not any external camera information.

ovr_GetExternalCameras(long

an ovrSession previously returned by Create

session, OVRExternalCamera.Buffer

pointer to the array. If null and the provided array capacity is sufficient, will return ovrError_NullArrayPointer.

cameras, IntBuffer

supply the array capacity, will return the actual \\# of cameras defined. If *inoutCameraCount is too small, will return Error_InsufficientArraySize.

inoutCameraCount)

Returns the number of camera properties of all cameras

public static int

ovr_GetExternalCameras(long session, OVRExternalCamera.Buffer cameras, int[] inoutCameraCount)

Array version of: GetExternalCameras

public static float

Returns:

the property interpreted as a float value. Returns defaultVal if the property doesn't exist.

ovr_GetFloat(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, float

specifes the value to return if the property couldn't be read

defaultVal)

Reads a float property.

public static float

Returns:

the property interpreted as a float value. Returns defaultVal if the property doesn't exist.

ovr_GetFloat(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, float

specifes the value to return if the property couldn't be read

defaultVal)

Reads a float property.

public static int

Returns:

the number of elements read, or 0 if property doesn't exist or is empty

ovr_GetFloatArray(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, FloatBuffer

an array of float to write to

values)

Reads a float array property.

public static int

Returns:

the number of elements read, or 0 if property doesn't exist or is empty

ovr_GetFloatArray(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, FloatBuffer

an array of float to write to

values)

Reads a float array property.

public static int

ovr_GetFloatArray(long session, ByteBuffer propertyName, float[] values)

Array version of: GetFloatArray

public static int

ovr_GetFloatArray(long session, CharSequence propertyName, float[] values)

Array version of: GetFloatArray

public static int

Returns:

an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information. Return values include but aren't limited to:

Success: Completed successfully.
Error_ServiceConnection: The service connection was lost and the application must destroy the session.
Error_InvalidParameter: One or more of the parameters

ovr_GetFovStencil(long

an ovrSession previously returned by Create

session, OVRFovStencilDesc

info provided by caller necessary to generate a stencil mesh

fovStencilDesc, OVRFovStencilMeshBuffer

mesh buffer to be partially filled in and returned by the SDK

meshBuffer)

Returns a viewport stencil mesh to be used for defining the area or outline the user can see through the lens on an area defined by a given ovrFovPort.

public static OVRSizei

ovr_GetFovTextureSize(long

an ovrSession previously returned by Create

session, int

which eye (left or right) to calculate for. One of:

Eye_Left

Eye_Right

eye, OVRFovPort

the OVRFovPort to use

fov, float

the ratio of the number of render target pixels to display pixels at the center of distortion. 1.0 is the default value. Lower values can improve performance, higher values give improved quality.

pixelsPerDisplayPixel, OVRSizei

the texture width and height size

__result)

Calculates the recommended viewport size for rendering a given eye within the HMD with a given FOV cone.

public static ovrHmdColorDesc

ovr_GetHmdColorDesc(long

specifies an ovrSession previously returned by Create or NULL

session, ovrHmdColorDesc

an ovrHmdColorDesc

__result)

Returns native color space information about the current HMD.

public static OVRHmdDesc

ovr_GetHmdDesc(long

an ovrSession previously returned by Create or NULL

session, OVRHmdDesc

an OVRHmdDesc. If invoked with NULL session argument, ovrHmdDesc::Type to Hmd_None indicates that the HMD is not connected.

__result)

Returns information about the current HMD.

public static int

Returns:

Success if the new state was successfully obtained

ovr_GetInputState(long

an ovrSession previously returned by Create

session, int

which controllers the input will be returned for

controllerType, OVRInputState

the input state that will be filled in

inputState)

Returns the most recent input state for controllers, without positional tracking info.

public static int

Returns:

the property interpreted as an integer value. Returns defaultVal if the property doesn't exist.

ovr_GetInt(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, int

specifes the value to return if the property couldn't be read

defaultVal)

Reads an integer property.

public static int

Returns:

the property interpreted as an integer value. Returns defaultVal if the property doesn't exist.

ovr_GetInt(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, int

specifes the value to return if the property couldn't be read

defaultVal)

Reads an integer property.

public static void

ovr_GetLastErrorInfo(OVRErrorInfo

The last OVRErrorInfo for the current thread

errorInfo)

Returns information about the most recent failed return value by the current thread for this library.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success

ovr_GetPerfStats(long

an ovrSession previously returned by Create

session, OVRPerfStats

contains the performance stats for the application and SDK compositor

outStats)

Retrieves performance stats for the VR app as well as the SDK compositor.

public static double

Returns:

the absolute frame midpoint time for the given frameIndex

ovr_GetPredictedDisplayTime(long

an ovrSession previously returned by Create

session, long

the frame the caller wishes to target. A value of zero returns the next frame index.

frameIndex)

Gets the time of the specified frame midpoint.

public static OVREyeRenderDesc

ovr_GetRenderDesc(long

an ovrSession previously returned by Create

session, int

which eye (left or right) for which to perform calculations. One of:

Eye_Left

Eye_Right

eyeType, OVRFovPort

the OVRFovPort to use.

fov, OVREyeRenderDesc

the computed OVREyeRenderDesc for the given eyeType and field of view

__result)

Computes the distortion viewport, view adjust, and other rendering parameters for the specified eye.

public static int

ovr_GetSessionStatus(long

an ovrSession previously returned by Create

session, OVRSessionStatus

an OVRSessionStatus that is filled in

sessionStatus)

Returns status information for the application.

public static String

Returns:

the string property if it exists. Otherwise returns defaultVal, which can be specified as NULL. The return memory is guaranteed to be valid until next call to ovr_GetString or until the HMD is destroyed, whichever occurs first.

ovr_GetString(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, ByteBuffer

specifes the value to return if the property couldn't be read

defaultVal)

Reads a string property.

public static String

Returns:

ovr_GetString(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, CharSequence

specifes the value to return if the property couldn't be read

defaultVal)

Reads a string property.

public static int

ovr_GetTextureSwapChainCurrentIndex(long

an ovrSession previously returned by Create

session, long

the ovrTextureSwapChain for which the index should be retrieved

chain, IntBuffer

returns the current (free) index in specified chain

out_Index)

Gets the current index in an ovrTextureSwapChain.

public static int

ovr_GetTextureSwapChainCurrentIndex(long session, long chain, int[] out_Index)

Array version of: GetTextureSwapChainCurrentIndex

public static int

ovr_GetTextureSwapChainDesc(long

an ovrSession previously returned by Create

session, long

the ovrTextureSwapChain for which the description should be retrieved

chain, OVRTextureSwapChainDesc

returns the description of the specified chain

out_Desc)

Gets the description of the buffers in an ovrTextureSwapChain.

public static int

ovr_GetTextureSwapChainLength(long

an ovrSession previously returned by Create

session, long

the ovrTextureSwapChain for which the length should be retrieved

chain, IntBuffer

returns the number of buffers in the specified chain

out_Length)

Gets the number of buffers in an ovrTextureSwapChain.

public static int

ovr_GetTextureSwapChainLength(long session, long chain, int[] out_Length)

Array version of: GetTextureSwapChainLength

public static native double

Returns:

seconds as a floating point value

ovr_GetTimeInSeconds()

Returns global, absolute high-resolution time in seconds.

public static OVRTouchHapticsDesc

ovr_GetTouchHapticsDesc(long

an ovrSession previously returned by Create

session, int

the controller to retrieve the information from

controllerType, OVRTouchHapticsDesc

an OVRTouchHapticsDesc

__result)

Gets information about Haptics engine for the specified Touch controller.

public static int

ovr_GetTrackerCount(long

an ovrSession previously returned by Create

session)

Returns the number of attached trackers.

public static OVRTrackerDesc

ovr_GetTrackerDesc(long

an ovrSession previously returned by Create

session, int

a tracker index. The valid indexes are in the range of 0 to the tracker count returned by GetTrackerCount.

trackerDescIndex, OVRTrackerDesc

an OVRTrackerDesc. An empty OVRTrackerDesc will be returned if trackerDescIndex is out of range.

__result)

Returns a given attached tracker description.

public static OVRTrackerPose

ovr_GetTrackerPose(long

an ovrSession previously returned by Create

session, int

index of the tracker being requested.

trackerPoseIndex, OVRTrackerPose __result)

Returns the OVRTrackerPose for the given attached tracker.

public static int

ovr_GetTrackingOriginType(long

an ovrSession previously returned by Create

session)

Gets the tracking origin state.

public static OVRTrackingState

ovr_GetTrackingState(long

an ovrSession previously returned by Create

session, double

the absolute future time to predict the return OVRTrackingState value. Use 0 to request the most recent tracking state.

absTime, boolean

specifies that this call is the point in time where the "App-to-Mid-Photon" latency timer starts from. If a given ovrLayer provides "SensorSampleTime", that will override the value stored here.

latencyMarker, OVRTrackingState

the OVRTrackingState that is predicted for the given absTime

__result)

Returns tracking state reading based on the specified absolute system time.

public static String

Returns:

a UTF8-encoded null-terminated version string

ovr_GetVersionString()

Returns the version string representing the LibOVRRT version.

public static int

ovr_IdentifyClient(ByteBuffer

specifies one or more newline-delimited lines of optional info

identity)

Identifies client application info.

public static int

ovr_IdentifyClient(CharSequence

specifies one or more newline-delimited lines of optional info

identity)

Identifies client application info.

public static int

Returns:

an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information. Example failed results include:

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: Attempted to re-initialize with a different version.

ovr_Initialize(OVRInitParams

specifies custom initialization options. May be NULL to indicate default options when using the CAPI shim. If you are directly calling the LibOVRRT version of ovr_Initialize in the LibOVRRT DLL then this must be valid and include Init_RequestVersion.

params)

Initialize LibOVR for application usage.

public static int

Returns:

an ovrResult indicating success or failure. In the case of failure use GetLastErrorInfo to get more information.

ovr_IsExtensionSupported(long

an ovrSession previously returned by Create

session, int

extension to query

extension, ByteBuffer

set to extension support status. True if supported.

outExtensionSupported)

Queries extension support status.

public static int

ovr_RecenterTrackingOrigin(long

an ovrSession previously returned by Create

session)

Re-centers the sensor position and orientation.

public static int

Returns:

Success upon success

ovr_RequestBoundaryVisible(long

an ovrSession previously returned by Create

session, boolean

forces the outer boundary to be visible. An application can't force it to be invisible, but can cancel its request by passing false.

visible)

Requests boundary to be visible.

public static int

Returns:

Success upon success

ovr_ResetBoundaryLookAndFeel(long

an ovrSession previously returned by Create

session)

Resets the look and feel of the Boundary System to its default state.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success

ovr_ResetPerfStats(long

an ovrSession previously returned by Create

session)

Resets the accumulated stats reported in each OVRPerfStatsPerCompositorFrame back to zero.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetBool(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, boolean

the value to write

value)

Writes or creates a boolean property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetBool(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, boolean

the value to write

value)

Writes or creates a boolean property.

public static int

Returns:

Success upon success

ovr_SetBoundaryLookAndFeel(long

an ovrSession previously returned by Create

session, OVRBoundaryLookAndFeel

the look and feel parameters

lookAndFeel)

Compatibility stub.

public static int

Returns:

an ovrResult indicating success or failure

ovr_SetClientColorDesc(long

an ovrSession previously returned by Create or NULL

session, ovrHmdColorDesc

the color description to use for the current HMD

colorDesc)

Sets the color space actively being used by the client app.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_DeviceUnavailable: The call succeeded but the device referred to by controllerType is not available.

ovr_SetControllerVibration(long

an ovrSession previously returned by Create

session, int

the controller to set the vibration to

controllerType, float

the vibration frequency. Supported values are: 0.0 (disabled), 0.5 and 1.0. Non valid values will be clamped.

frequency, float

the vibration amplitude in the [0.0, 1.0] range

amplitude)

Sets constant vibration (with specified frequency and amplitude) to a controller.

public static int

Returns:

Success or an ovrError code

ovr_SetExternalCameraProperties(long

an ovrSession previously returned by Create

session, ByteBuffer

specifies which camera to set the intrinsics or extrinsics for. The name must be at most OVR_EXTERNAL_CAMERA_NAME_SIZE - 1 characters. Otherwise, Error_ExternalCameraNameWrongSize is returned.

name, OVRCameraIntrinsics

contains the intrinsic parameters to set, can be null

intrinsics, OVRCameraExtrinsics

ontains the extrinsic parameters to set, can be null

extrinsics)

Sets the camera intrinsics and/or extrinsics stored for the cameraName camera.

public static int

Returns:

Success or an ovrError code

ovr_SetExternalCameraProperties(long

an ovrSession previously returned by Create

session, CharSequence

specifies which camera to set the intrinsics or extrinsics for. The name must be at most OVR_EXTERNAL_CAMERA_NAME_SIZE - 1 characters. Otherwise, Error_ExternalCameraNameWrongSize is returned.

name, OVRCameraIntrinsics

contains the intrinsic parameters to set, can be null

intrinsics, OVRCameraExtrinsics

ontains the extrinsic parameters to set, can be null

extrinsics)

Sets the camera intrinsics and/or extrinsics stored for the cameraName camera.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetFloat(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, float

the value to write

value)

Writes or creates a float property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetFloat(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, float

the value to write

value)

Writes or creates a float property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetFloatArray(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, FloatBuffer

an array of float to write from

values)

Writes or creates a float array property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetFloatArray(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, FloatBuffer

an array of float to write from

values)

Writes or creates a float array property.

public static boolean

ovr_SetFloatArray(long session, ByteBuffer propertyName, float[] values)

Array version of: SetFloatArray

public static boolean

ovr_SetFloatArray(long session, CharSequence propertyName, float[] values)

Array version of: SetFloatArray

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetInt(long

an ovrSession previously returned by Create

session, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, int

the value to write

value)

Writes or creates an integer property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetInt(long

an ovrSession previously returned by Create

session, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, int

the value to write

value)

Writes or creates an integer property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetString(long

an ovrSession previously returned by Create

hmddesc, ByteBuffer

the name of the property, which needs to be valid only for the call

propertyName, ByteBuffer

the string property, which only needs to be valid for the duration of the call

value)

Writes or creates a string property.

public static boolean

Returns:

true if successful, otherwise false. A false result should only occur if the property name is empty or if the property is read-only.

ovr_SetString(long

an ovrSession previously returned by Create

hmddesc, CharSequence

the name of the property, which needs to be valid only for the call

propertyName, CharSequence

the string property, which only needs to be valid for the duration of the call

value)

Writes or creates a string property.

public static int

ovr_SetTrackingOriginType(long

an ovrSession previously returned by Create

session, int

an ovrTrackingOrigin to be used for all OVRPosef

origin)

Sets the tracking origin type.

public static native void

ovr_Shutdown()

Shuts down LibOVR.

public static int

ovr_SpecifyTrackingOrigin(long

an ovrSession previously returned by Create

session, OVRPosef

specifies a pose that will be used to transform the current tracking origin

originPose)

Allows manually tweaking the sensor position and orientation.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_DeviceUnavailable: The call succeeded but the device referred to by controllerType is not available.

ovr_SubmitControllerVibration(long

an ovrSession previously returned by Create

session, int

the controller where the Haptics buffer will be played

controllerType, OVRHapticsBuffer

the Haptics buffer containing amplitude samples to be played

buffer)

Submits a Haptics buffer (used for vibration) to Touch (only) controllers.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon one of the possible success values:

Success: rendering completed successfully.
Success_NotVisible: rendering completed successfully but was not displayed on the HMD, usually because another application currently has ownership of the HMD. Applications receiving this result should stop rendering new content, call GetSessionStatus to detect visibility.
Error_DisplayLost: The session has become invalid (such as due to a device removal) and the shared resources need to be released (DestroyTextureSwapChain), the session needs to be destroyed (Destroy) and recreated (Create), and new resources need to be created (ovr_CreateTextureSwapChainXXX). The application's existing private graphics resources do not need to be recreated unless the new ovr_Create call returns a different GraphicsLuid.
Error_TextureSwapChainInvalid: The ovrTextureSwapChain is in an incomplete or inconsistent state. Ensure CommitTextureSwapChain was called at least once first.

ovr_SubmitFrame(long

an ovrSession previously returned by Create

session, long

the targeted application frame index, or 0 to refer to one frame after the last time SubmitFrame was called

frameIndex, OVRViewScaleDesc

provides additional information needed only if layerPtrList contains an LayerType_Quad. If NULL, a default version is used based on the current configuration and a 1.0 world scale.

viewScaleDesc, PointerBuffer

a list of ovrLayer pointers, which can include NULL entries to indicate that any previously shown layer at that index is to not be displayed. Each layer header must be a part of a layer structure such as OVRLayerEyeFov or OVRLayerQuad, with Header.Type identifying its type. A NULL layerPtrList entry in the array indicates the absence of the given layer.

layerPtrList)

Submits layers for distortion and display.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_BoundaryInvalid: The call succeeded but the result is not a valid boundary due to not being set up.
Success_DeviceUnavailable: The call succeeded but the device referred to by deviceBitmask is not available.

ovr_TestBoundary(long

an ovrSession previously returned by Create

session, int

bitmask of one or more tracked devices to test. One or more of:

`TrackedDevice_None`	`TrackedDevice_HMD`	`TrackedDevice_LTouch`	`TrackedDevice_RTouch`
`TrackedDevice_Touch`	`TrackedDevice_Object0`	`TrackedDevice_Object1`	`TrackedDevice_Object2`
`TrackedDevice_Object3`	`TrackedDevice_All`

deviceBitmask, int

the boundary type. One of:

Boundary_Outer

Boundary_PlayArea

boundaryType, OVRBoundaryTestResult

result of collision/proximity test, contains information such as distance and closest point

outTestResult)

Tests collision/proximity of position tracked devices (e.g. HMD and/or Touch) against the Boundary System.

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: The call succeeded and a result was returned.
Success_BoundaryInvalid: The call succeeded but the result is not a valid boundary due to not being set up.

ovr_TestBoundaryPoint(long

an ovrSession previously returned by Create

session, OVRVector3f

the 3D point to test

point, int

the boundary type. One of:

Boundary_Outer

Boundary_PlayArea

singleBoundaryType, OVRBoundaryTestResult

result of collision/proximity test, contains information such as distance and closest point

outTestResult)

Tests collision/proximity of a 3D point against the Boundary System.

public static int

Returns:

the strlen of the message or a negative value if the message is too large

ovr_TraceMessage(int

an ovrLogLevel constant. One of:

LogLevel_Debug

LogLevel_Info

LogLevel_Error

level, ByteBuffer

a UTF8-encoded null-terminated string

message)

Writes a message string to the LibOVR tracing mechanism (if enabled).

public static int

Returns:

the strlen of the message or a negative value if the message is too large

ovr_TraceMessage(int

an ovrLogLevel constant. One of:

LogLevel_Debug

LogLevel_Info

LogLevel_Error

level, CharSequence

a UTF8-encoded null-terminated string

message)

Writes a message string to the LibOVR tracing mechanism (if enabled).

public static int

Returns:

an ovrResult for which OVR_SUCCESS(result) is false upon error and true upon success. Return values include but aren't limited to:

Success: command completed successfully.
Success_NotVisible: rendering of a previous frame completed successfully but was not displayed on the HMD, usually because another application currently has ownership of the HMD. Applications receiving this result should stop rendering new content and call GetSessionStatus to detect visibility.
Error_DisplayLost: The session has become invalid (such as due to a device removal) and the shared resources need to be released (DestroyTextureSwapChain), the session needs to destroyed (Destroy) and recreated (Create), and new resources need to be created (ovr_CreateTextureSwapChainXXX). The application's existing private graphics resources do not need to be recreated unless the new ovr_Create call returns a different GraphicsLuid.

ovr_WaitToBeginFrame(long

an ovrSession previously returned by Create

session, long

specifies the targeted application frame index

frameIndex)

Waits until surfaces are available and it is time to begin rendering the frame.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class OVR

Field Summary

Constructor Summary

Method Summary