Oculus Library

Oculus Library

Windows
MacOS
Linux
On this page

Actions

Enable Orientation Tracking

Enables/disables orientation tracking on devices that support it.

Target is Oculus Function Library

Enable Position Tracking

Enables/disables positional tracking on devices that support it.

Target is Oculus Function Library

Get Available Display Frequencies

Returns the current available frequencies

Target is Oculus Function Library

Get Base Rotation and Base Offset in Meters

Returns current base rotation and base offset. The base offset is currently used base position offset, previously set by the ResetPosition or SetBasePositionOffset calls. It represents a vector that translates the HMD's position into (0,0,0) point, in meters. The axis of the vector are the same as in Unreal: X - forward, Y - right, Z - up.

Target is Oculus Function Library

Get Current Display Frequency

Returns the current display frequency

Target is Oculus Function Library

Get Device Type

Get Device Type

Target is Oculus Function Library

Get Fixed Foveated Rendering Level

Returns the current multiresolution level

Target is Oculus Function Library

Get GPUFrame Time

Returns the GPU frame time on supported mobile platforms (Go for now)

Target is Oculus Function Library

Get GPUUtilization

Returns the GPU utilization availability and value

Target is Oculus Function Library

Get Hmd Color Desc

Returns the color space of the target HMD

Target is Oculus Function Library

Get Pose

Grabs the current orientation and position for the HMD. If positional tracking is not available, DevicePosition will be a zero vector

Target is Oculus Function Library

Get Raw Sensor Data

Reports raw sensor data. If HMD doesn't support any of the parameters then it will be set to zero.

Target is Oculus Function Library

Get System Hmd 3Dof Mode Enabled

Returns true if system headset is in 3dof mode

Target is Oculus Function Library

Get User Profile

Returns current user profile.

Target is Oculus Function Library

Has Input Focus

Returns true, if the app has input focus.

Target is Oculus Function Library

Has System Overlay Present

Returns true, if the system overlay is present.

Target is Oculus Function Library

Is Device Tracked

Returns if the device is currently tracked by the runtime or not.

Target is Oculus Function Library

Set Base Rotation and Base Offset in Meters

Sets 'base rotation' - the rotation that will be subtracted from the actual HMD orientation. Sets base position offset (in meters). The base position offset is the distance from the physical (0, 0, 0) position to current HMD position (bringing the (0, 0, 0) point to the current HMD position) Note, this vector is set by ResetPosition call; use this method with care. The axis of the vector are the same as in Unreal: X - forward, Y - right, Z - up.

Target is Oculus Function Library

Set Client Color Desc

Sets the target HMD to do color space correction to a specific color space

Target is Oculus Function Library

Set Color Scale and Offset

Enables/disables orientation tracking on devices that support it.

Target is Oculus Function Library

Set CPUAnd GPULevels

Returns if the device is currently tracked by the runtime or not.

Target is Oculus Function Library

Set Display Frequency

Sets the requested display frequency

Target is Oculus Function Library

Set Fixed Foveated Rendering Level

Set the requested multiresolution level for the next frame, and whether FFR's level is now dynamic or not.

Target is Oculus Function Library

Categories

Guardian

Guardian

Hand Tracking

Hand Tracking

MR

MR

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback