Blueprints Reference

• Get Hmd Color Desc Returns the native color space of the current device.
• Set Client Color Desc Sets the color space of the client app.
• Set Color Scale and Offset Performs the color scaling operation.

• Get Device Type Returns the current device’s type. This Blueprint replaces the deprecated Get Device Name.
• Get User Profile Returns the current user profile.

• Add Loading Splash Screen Adds a splash screen with parameters to the application.
• Clear Loading Splash Screens Removes all splash screens from the application.
• Enable Auto-Loading Splash Screen Enables or disables automatic display of the splash screen when loading a new level.

• Enable Orientation Tracking Enables or disables orientation tracking.
• Enable Position Tracking Enables or disables positional tracking.
• Get Base Rotation and Base Offset in Meters Returns the current rotation and position of the headset, with respect to the base rotation and position, expressed in meters.
• Get Pose Returns the orientation and position (if available) for the headset.
• Get Raw Sensor Data Reports raw sensor data from the headset.
• Is Device Tracked Determines whether or not a device (such as a controller) is being tracked by the sensors.
• Set Base Rotation and Base Offset in Meters Specifies the current rotation and position of the headset, with respect to the base rotation and position, expressed in apparent meters.

Note: Several Guardian Blueprints are deprecated as of Unreal Engine 4.27. For Guardian-like boundary functionality, place AMRUKGuardianSpawner from the MR Utility Kit in your level to spawn a procedural boundary mesh, or use UOculusXRSceneFunctionLibrary::RequestBoundaryVisibility() from the OculusXRScene module to control boundary visibility.

• Get Guardian Dimensions Returns the dimensions of the Outer Boundary or the Play Area, expressed in Unreal Engine units.
• Get Guardian Points Returns the points, in Unreal Engine world space, that define the Outer Boundary or the Play Area.
• Get Node Guardian Intersection Returns the intersection result between a tracked device (HMD or Controller) and the Guardian boundary. Deprecated in 4.27.
• Get Play Area Transform Returns the transform of the Play Area rectangle, defining its position, rotation, and scale to apply a unit cube to match it with the Play Area.
• Get Point Guardian Intersection Returns the intersection result between the Guardian boundary and a specified Unreal Engine coordinate. Deprecated in 4.27.
• Is Guardian Displayed Returns a boolean result that indicates whether or not the Outer Boundary Guardian is being displayed. Deprecated in 4.27.
• Set Guardian Visibility Specifies whether or not the runtime should render the Guardian. Deprecated in 4.27.

• Has Input Focus Determines whether or not the application has input focus.
• Has System Overlay Present This Blueprint has been replaced by Has Input Focus.

• Get Oculus MR Settings Returns a reference to an Oculus MR Settings object, which has properties that correspond to each of the Mixed Reality capture settings.
• Load from Ini Loads the Mixed Reality Capture settings from Engine.ini to an internal Oculus MR Settings object.
• Save to Ini Saves the Mixed Reality Capture settings from an in-memory Oculus MR Settings object to the Engine.ini file.
• Get Tracking Reference Component and Set Tracking Reference Component Enables your application to add an object which the camera will follow, if you don’t want the camera to follow the first PlayerController (which is the default, and is the approach used by most applications).

• Get Available Display Frequencies Returns the display frequencies that are available with the current headset.
• Get Current Display Frequency Returns the current display frequency for the connected HMD.
• Get GPU Frame Time Returns the amount of time that the GPU spent rendering the most recent frame.
• Get GPU Utilization Returns the GPU utilization availability and value.
• Get Foveated Rendering Level Returns the current multi-resolution level, which applies to fixed foveated rendering.
• Set CPU and GPU Levels Sets the clock rates for the CPU and GPU on mobile devices. Deprecated; use GetSuggestedCpuAndGpuPerformanceLevels and SetSuggestedCpuAndGpuPerformanceLevels instead.
• Set Display Frequency Sets the display frequency (frame rate).
• Set Foveated Rendering Level Sets the multi-resolution level for fixed foveated rendering.

• Set Reorient HMD On Controller Recenter Deprecated in v19. Sets the HMD recenter behavior.