Head Mounted Display

Head Mounted Display

Windows
MacOS
Linux
On this page

Actions

Enable HMD

Switches to/from using HMD and stereo rendering.

Target is Head Mounted Display Function Library

Get HMDDevice Name

Returns the name of the device, so scripts can modify their behaviour appropriately

Target is Head Mounted Display Function Library

Get HMDWorn State

Returns the worn state of the device.

Target is Head Mounted Display Function Library

Get Num Of Tracking Sensors

If the HMD has multiple positional tracking sensors, return a total number of them currently connected.

Target is Head Mounted Display Function Library

Get Orientation and Position

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

Target is Head Mounted Display Function Library

Get Pixel Density

Returns the current VR pixel density. Pixel density sets the VR render target texture size as a factor of recommended texture size. The recommended texture size is the size that will result in no under sampling in most distorted area of the view when computing the final image to be displayed on the device by the runtime compositor.

Target is Head Mounted Display Function Library

Get Tracking Origin

Returns current tracking origin type (eye level or floor level).

Target is Head Mounted Display Function Library

Get Tracking Sensor Parameters

If the HMD has a positional sensor, this will return the game-world location of it, as well as the parameters for the bounding region of tracking. This allows an in-game representation of the legal positional tracking range. All values will be zeroed if the sensor is not available or the HMD does not support it.

Target is Head Mounted Display Function Library

Get Tracking to World Transform

Returns a transform that can be used to convert points from tracking space to world space. Does NOT include the set WorldToMeters scale, as that is added in by the backing XR system to their tracking space poses.

Target is Head Mounted Display Function Library

Get VR Focus State

Returns current state of VR focus.

Target is Head Mounted Display Function Library

Get World to Meters Scale

Returns the World to Meters scale, which corresponds to the scale of the world as perceived by the player

Target is Head Mounted Display Function Library

Has Valid Tracking Position

If the HMD supports positional tracking, whether or not we are currently being tracked

Target is Head Mounted Display Function Library

Is Head Mounted Display Connected

Returns whether or not the HMD hardware is connected and ready to use. It may or may not actually be in use.

Target is Head Mounted Display Function Library

Is Head Mounted Display Enabled

Returns whether or not we are currently using the head mounted display.

Target is Head Mounted Display Function Library

Reset Orientation and Position

Resets orientation by setting roll and pitch to 0, assuming that current yaw is forward direction and assuming current position as a 'zero-point' (for positional tracking).

Target is Head Mounted Display Function Library

Set Clipping Planes

Sets near and far clipping planes (NCP and FCP) for stereo rendering. Similar to 'stereo ncp= fcp' console command, but NCP and FCP set by this call won't be saved in .ini file.

Target is Head Mounted Display Function Library

Set Tracking Origin

Sets current tracking origin type (eye level or floor level).

Target is Head Mounted Display Function Library

Set World to Meters Scale

Sets the World to Meters scale, which changes the scale of the world as perceived by the player

Target is Head Mounted Display Function Library

Categories

External Tracking

External Tracking

Loading Screen

Loading Screen

Spectator Screen

Spectator Screen

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