Class Utils

Inheritance
Object
Utils
Namespace: Unity.XR.Oculus
Syntax
public static class Utils

Methods

EnableDynamicFFR(Boolean)

Enable or disable dynamic FFR. Only supported on mobile. See Oculus Documention.

Declaration
public static bool EnableDynamicFFR(bool enable)
Parameters
Type Name Description
Boolean enable

Set to true to enable dynamic FFR or false to disable it.
Returns
Type Description
Boolean

GetFoveationLevel()

Returns the degree of foveation. Only supported on mobile. See Oculus Documentation.

Declaration
public static int GetFoveationLevel()
Returns
Type Description
Int32
  • -1 error retrieving foveation level
  • 0 disables multi-resolution
  • 1 low FFR setting
  • 2 medium FFR setting
  • 3 high FFR setting
  • 4 high top FFR setting

GetSystemHeadsetType()

Returns the type of the current headset

Declaration
public static SystemHeadset GetSystemHeadsetType()
Returns
Type Description
SystemHeadset

SetColorScaleAndOffset(Vector4, Vector4)

Set the color scale and color offset of the eye texture layers

Declaration
public static void SetColorScaleAndOffset(Vector4 colorScale, Vector4 colorOffset)
Parameters
Type Name Description
Vector4 colorScale

Scales the eye layer texture color by this Vector4.
Vector4 colorOffset

Offsets the eye layer texture color by this Vector4

SetFoveationLevel(Int32)

Set the degree of foveation. Only supported on mobile. See Oculus Documention.

Declaration
public static bool SetFoveationLevel(int level)
Parameters
Type Name Description
Int32 level

level can be 0, 1, 2, 3, or 4:

  • 0 disables multi-resolution
  • 1 low FFR setting
  • 2 medium FFR setting
  • 3 high FFR setting
  • 4 high top FFR setting
Returns
Type Description
Boolean