public Class OVRUtil

Modes used to generate Touch Haptics from audio PCM buffer.

Enum values:

• HapticsGenMode_PointSample - Point sample original signal at Haptics frequency
• HapticsGenMode_Count

Modes used to generate Touch Haptics from audio PCM buffer.

Enum values:

• HapticsGenMode_PointSample - Point sample original signal at Haptics frequency
• HapticsGenMode_Count

Enumerates modifications to the projection matrix based on the application's needs.

Enum values:

• Projection_None - Use for generating a default projection matrix that is:
  • Right-handed.
  • Near depth values stored in the depth buffer are smaller than far depth values.
  • Both near and far are explicitly defined.
  • With a clipping range that is (0 to w).
• Projection_LeftHanded - Enable if using left-handed transformations in your application.
• Projection_FarLessThanNear - After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision.
• Projection_FarClipAtInfinity - When this flag is used, the zfar value pushed into Matrix4f_Projection will be ignored NOTE: Enable only if Projection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity.
• Projection_ClipRangeOpenGL - Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL.

Enumerates modifications to the projection matrix based on the application's needs.

Enum values:

• Projection_None - Use for generating a default projection matrix that is:
  • Right-handed.
  • Near depth values stored in the depth buffer are smaller than far depth values.
  • Both near and far are explicitly defined.
  • With a clipping range that is (0 to w).
• Projection_LeftHanded - Enable if using left-handed transformations in your application.
• Projection_FarLessThanNear - After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision.
• Projection_FarClipAtInfinity - When this flag is used, the zfar value pushed into Matrix4f_Projection will be ignored NOTE: Enable only if Projection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity.
• Projection_ClipRangeOpenGL - Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL.

Enumerates modifications to the projection matrix based on the application's needs.

Enum values:

• Projection_None - Use for generating a default projection matrix that is:
  • Right-handed.
  • Near depth values stored in the depth buffer are smaller than far depth values.
  • Both near and far are explicitly defined.
  • With a clipping range that is (0 to w).
• Projection_LeftHanded - Enable if using left-handed transformations in your application.
• Projection_FarLessThanNear - After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision.
• Projection_FarClipAtInfinity - When this flag is used, the zfar value pushed into Matrix4f_Projection will be ignored NOTE: Enable only if Projection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity.
• Projection_ClipRangeOpenGL - Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL.

Enumerates modifications to the projection matrix based on the application's needs.

Enum values:

• Projection_None - Use for generating a default projection matrix that is:
  • Right-handed.
  • Near depth values stored in the depth buffer are smaller than far depth values.
  • Both near and far are explicitly defined.
  • With a clipping range that is (0 to w).
• Projection_LeftHanded - Enable if using left-handed transformations in your application.
• Projection_FarLessThanNear - After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision.
• Projection_FarClipAtInfinity - When this flag is used, the zfar value pushed into Matrix4f_Projection will be ignored NOTE: Enable only if Projection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity.
• Projection_ClipRangeOpenGL - Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL.

Enumerates modifications to the projection matrix based on the application's needs.

Enum values:

• Projection_None - Use for generating a default projection matrix that is:
  • Right-handed.
  • Near depth values stored in the depth buffer are smaller than far depth values.
  • Both near and far are explicitly defined.
  • With a clipping range that is (0 to w).
• Projection_LeftHanded - Enable if using left-handed transformations in your application.
• Projection_FarLessThanNear - After the projection transform is applied, far values stored in the depth buffer will be less than closer depth values. NOTE: Enable only if the application is using a floating-point depth buffer for proper precision.
• Projection_FarClipAtInfinity - When this flag is used, the zfar value pushed into Matrix4f_Projection will be ignored NOTE: Enable only if Projection_FarLessThanNear is also enabled where the far clipping plane will be pushed to infinity.
• Projection_ClipRangeOpenGL - Enable if the application is rendering with OpenGL and expects a projection matrix with a clipping range of (-w to w). Ignore this flag if your application already handles the conversion from D3D range (0 to w) to OpenGL.

Unsafe version of: _CalcEyePoses

Unsafe version of: _Detect

Unsafe version of: _GenHapticsFromAudioData

Unsafe version of: _GetEyePoses

Array version of: novr_GetEyePoses

Unsafe version of: _ReadWavFromBuffer

Parameters

dataSizeInBytes:int

size of the buffer in bytes

Unsafe version of: _ReleaseAudioChannelData

Unsafe version of: _ReleaseHapticsClip

Unsafe version of: Matrix4f_OrthoSubProjection

Unsafe version of: Matrix4f_Projection

Unsafe version of: Posef_FlipHandedness

Unsafe version of: TimewarpProjectionDesc_FromProjection

Computes offset eye poses based on headPose returned by OVRTrackingState.

Parameters

headPose:OVRPosef

indicates the HMD position and orientation to use for the calculation

HmdToEyePose:OVRPosef.Buffer

can be OVREyeRenderDesc.HmdToEyePose returned from GetRenderDesc. For monoscopic rendering, use a position vector that is average of the two position vectors for each eye .

outEyePoses:OVRPosef.Buffer

if outEyePoses are used for rendering, they should be passed to SubmitFrame in OVRLayerEyeFov::RenderPose or OVRLayerEyeFovDepth::RenderPose

Detects Oculus Runtime and Device Status.

Checks for Oculus Runtime and Oculus HMD device status without loading the LibOVRRT shared library. This may be called before Initialize to help decide whether or not to initialize LibOVR.

Parameters

timeoutMilliseconds:int

a timeout to wait for HMD to be attached or 0 to poll

Annotations

@NativeType:ovrDetectResult

Generates playable Touch Haptics data from an audio channel.

Parameters

outHapticsClip:OVRHapticsClip

generated Haptics clip

audioChannel:OVRAudioChannelData

input audio channel data

genMode:int

mode used to convert and audio channel data to Haptics data. Must be:

HapticsGenMode_PointSample

Annotations

@NativeType:ovrResult

Returns the predicted head pose in outHmdTrackingState and offset eye poses in outEyePoses.

This is a thread-safe function where caller should increment frameIndex with every frame and pass that index where applicable to functions called on the rendering thread. Assuming outEyePoses are used for rendering, it should be passed as a part of OVRLayerEyeFov. The caller does not need to worry about applying HmdToEyePose to the returned outEyePoses variables.

Parameters

session:long

an ovrSession previously returned by Create

frameIndex:long

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

latencyMarker: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 "SensorSampleTimestamp", that will override the value stored here.

HmdToEyePose:OVRPosef.Buffer

can be OVREyeRenderDesc.HmdToEyePose returned from GetRenderDesc. For monoscopic rendering, use a position vector that is the average of the two position vectors for each eye.

outEyePoses:OVRPosef.Buffer

the predicted eye poses

outSensorSampleTime:DoubleBuffer

the time when this function was called. May be NULL, in which case it is ignored.

Array version of: _GetEyePoses

Reads an audio channel from Wav (Waveform Audio File) data.

Input must be a byte buffer representing a valid Wav file. Audio samples from the specified channel are read, converted to float [-1.0f, 1.0f] and returned through OVRAudioChannelData.

Supported formats: PCM 8b, 16b, 32b and IEEE float (little-endian only).

Parameters

outAudioChannel:OVRAudioChannelData

output audio channel data

inputData:ByteBuffer

a binary buffer representing a valid Wav file data

stereoChannelToUse:int

audio channel index to extract (0 for mono)

Annotations

@NativeType:ovrResult

Releases memory allocated for ovrAudioChannelData. Must be called to avoid memory leak.

Parameters

audioChannel:OVRAudioChannelData

pointer to an audio channel

Releases memory allocated for ovrHapticsClip. Must be called to avoid memory leak.

Parameters

hapticsClip:OVRHapticsClip

pointer to a haptics clip

Generates an orthographic sub-projection.

Used for 2D rendering, Y is down.

Parameters

projection:OVRMatrix4f

the perspective matrix that the orthographic matrix is derived from

orthoScale:OVRVector2f

equal to 1.0f / pixelsPerTanAngleAtCenter

orthoDistance:float

equal to the distance from the camera in meters, such as 0.8m

HmdToEyeOffsetX:float

the offset of the eye from the center

__result:OVRMatrix4f

the calculated projection matrix

Annotations

@NativeType:ovrMatrix4f

Used to generate projection from ovrEyeDesc::Fov.

Parameters

fov:OVRFovPort

the OVRFovPort to use

znear:float

distance to near Z limit

zfar:float

distance to far Z limit

projectionModFlags:int

a combination of the ovrProjectionModifier flags. One or more of:

Projection_None	Projection_FarLessThanNear	Projection_FarClipAtInfinity
Projection_ClipRangeOpenGL

__result:OVRMatrix4f

the calculated projection matrix

Annotations

@NativeType:ovrMatrix4f

Tracking poses provided by the SDK come in a right-handed coordinate system. If an application is passing in Projection_LeftHanded into Matrix4f_Projection, then it should also use this function to flip the HMD tracking poses to be left-handed.

While this utility function is intended to convert a left-handed OVRPosef into a right-handed coordinate system, it will also work for converting right-handed to left-handed since the flip operation is the same for both cases.

Parameters

inPose:OVRPosef

a pose that is right-handed

outPose:OVRPosef

the pose that is requested to be left-handed (can be the same pointer to inPose)

Extracts the required data from the result of Matrix4f_Projection.

Parameters

projection:OVRMatrix4f

the project matrix from which to extract OVRTimewarpProjectionDesc

projectionModFlags:int

a combination of the ovrProjectionModifier flags. One or more of:

Projection_None	Projection_LeftHanded	Projection_FarLessThanNear
Projection_FarClipAtInfinity	Projection_ClipRangeOpenGL

__result:OVRTimewarpProjectionDesc

the extracted ovrTimewarpProjectionDesc

Annotations

@NativeType:ovrTimewarpProjectionDesc