API reference
API reference
Select your platform
No SDKs available
No versions available

OculusXRHMDTypes.h File

Enumeration Types

Enumeration EOculusXRTrackedDeviceType

UMETA
=(DisplayName = "No Devices")
UMETA
=(DisplayName = "HMD")
UMETA
=(DisplayName = "Left Hand")
UMETA
=(DisplayName = "Right Hand")
UMETA
=(DisplayName = "All Hands")
UMETA
=(DisplayName = "DeviceObject Zero")
UMETA
=(DisplayName = "All Devices")

Enumeration EOculusXRFoveatedRenderingMethod

FixedFoveatedRendering
= 0
EyeTrackedFoveatedRendering
= 1

Enumeration EOculusXRFoveatedRenderingLevel

Off
= 0
Low
= 1
Medium
= 2
High
= 3
HighTop
= 4

Enumeration EOculusXRBoundaryType

UMETA
=(DisplayName = "Outer Boundary")
UMETA
=(DisplayName = "Play Area")

Enumeration EOculusXRColorSpace

Unknown
The default value from GetHmdColorSpace until SetClientColorDesc is called. Only valid on PC, and will be remapped to Quest on Mobile.
Unmanaged
No color correction, not recommended for production use. See documentation for more info.
Rec_2020
Color space for standardized color across all Oculus HMDs with D65 white point.
Rec_709
Rec. 709 is used on Oculus Go and shares the same primary color coordinates as sRGB.
Rift_CV1
Oculus Rift CV1 uses a unique color space, see documentation for more info.
Rift_S
Oculus Rift S uses a unique color space, see documentation for more info.
Quest
Oculus Quest's native color space is slightly different than Rift CV1.
P3
DCI-P3 color space. See documentation for more details.
Adobe_RGB
Similar to sRGB but with deeper greens using D65 white point.

Enumeration EOculusXRHandTrackingSupport

ControllersOnly
No description available
ControllersAndHands
No description available
HandsOnly
No description available

Enumeration EOculusXRHandTrackingFrequency

LOW
No description available
HIGH
No description available
MAX
No description available

Enumeration EOculusXRHandTrackingVersion

Default
No description available
V1
No description available
V2
No description available

Enumeration EOculusXRProcessorPerformanceLevel

PowerSavings
= 0 UMETA(DisplayName = "PowerSavings", ToolTip = "Usually used in non-XR section (head-locked / static screen), during which power savings are to be prioritized")
SustainedLow
= 1 UMETA(DisplayName = "SustainedLow", ToolTip = "App enters a low and stable complexity section, during which reducing power is more important than occasional late rendering frames")
SustainedHigh
= 2 UMETA(DisplayName = "SustainedHigh", ToolTip = "Let XR Runtime to perform consistent XR compositing and frame rendering within a thermally sustainable range")
Boost
= 3 UMETA(DisplayName = "Boost(*)", ToolTip = "Allow XR Runtime to step up beyond the thermally sustainable range for short period. (Currently equivalent to SustainedHigh and not recommended to be used on Quest)")

Enumeration EOculusXRDeviceType

OculusMobile_Deprecated0
= 0
OculusQuest_Deprecated
No description available
OculusQuest2
No description available
MetaQuestPro
No description available
MetaQuest3
No description available
MetaQuest3S
No description available
Rift
= 100
Rift_S
No description available
Quest_Link_Deprecated
No description available
Quest2_Link
No description available
MetaQuestProLink
No description available
MetaQuest3Link
No description available
MetaQuest3SLink
No description available
OculusUnknown
= 200

Enumeration EOculusXRControllerType

None
= 0
MetaQuestTouch
= 1
MetaQuestTouchPro
= 2
MetaQuestTouchPlus
= 3
Unknown
= 0x7f

Enumeration EOculusXRXrApi

OVRPluginOpenXR
= 0 UMETA(DisplayName = "Oculus OVRPlugin + OpenXR backend (current recommended)", ToolTip = "Oculus plugin integration using OpenXR backend on both Mobile and PC. All new features will ship on backend for the forseeable future.")
NativeOpenXR
= 1 UMETA(DisplayName = "Epic Native OpenXR with Oculus vendor extensions", ToolTip = "Disable Legacy Oculus in favor of the native OpenXR implementation, with Oculus vendor extensions. Must enable the OpenXR plugin. This will be where Epic focuses XR development going forward. Oculus OpenXR extensions may be moved into a separate plugin (or plugins) in the future to improve modularity. The features supported by OpenXR are listed in the OpenXR specification on khronos.org, and the features supported by a given runtime can be verified with the \"OpenXR Explorer\" application on GitHub.")

Enumeration EOculusXRControllerPoseAlignment

Default
= 0 UMETA(ToolTip = "Default pose alignment used in all versions of the Meta XR plugin. Recommended pose for compatibility with previous assets designed for the Meta XR plugin.")
Grip
= 1 UMETA(ToolTip = "Grip pose alignment as defined by OpenXR. Use this for cross-plugin compatibility with assets designed for the native OpenXR grip pose.")
Aim
= 2 UMETA(ToolTip = "Aim pose alignment as defined by OpenXR. Use this for cross-plugin compatibility with assets designed for the native OpenXR aim pose.")

Enumeration EOculusXROcclusionsMode

Disabled
Environment depth occlusions disabled.
HardOcclusions_Deprecated
Hard occlusions, this is deprecated. Use soft occlusions instead.
SoftOcclusions
Soft occlusions, shows soft edges between the real and virtual world.

Enumeration EOculusXREyeBufferSharpenType

UMETA
No Sharpening.
UMETA
Normal Sharpening.
UMETA
Quality Sharpening.
UMETA
Auto Filtering: Runtime automatically chooses the appropriate sharpening filter.
SLST_MAX
No description available

Enumeration EProcessorFavor

FavorEqually
= 0 UMETA(DisplayName = "Favor Equally")
FavorCPU
= 1 UMETA(DisplayName = "Favor CPU")
FavorGPU
= 2 UMETA(DisplayName = "Favor GPU")

Enumeration EOculusXRHMDBodyTrackingFidelity

Unset
= 0 UMETA(Hidden)
Low
= 1
High
= 2

Enumeration EOculusXRHMDBodyJointSet

UpperBody
= 0
FullBody
= 1

Enumeration EFaceTrackingDataSourceConfig

Visual
= 0 UMETA(DisplayName = "Visual")
Audio
= 1 UMETA(DisplayName = "Audio")
MAX
= 2 UMETA(Hidden)

Enumeration ESystemSplashBackgroundType

Black
= 0 UMETA(DisplayName = "Black")
Contextual
= 1 UMETA(DisplayName = "Passthrough (Contextual)")

Enumeration EOculusXRMPPoseRestoreType

Disabled
DONOT restore head and controller poses.
PositionOnly
Only restore head and controller position.
PositionAndRotation
Restore head and controller position and rotation.

Variables

static const TCHAR * VAR_PixelDensityMin[Get]
static const TCHAR * VAR_PixelDensityMax[Get]
Did you find this page helpful?
Thumbs up icon
Thumbs down icon