Class Utils

Inheritance

object

Utils

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.XR.Oculus

Assembly: solution.dll

Syntax

public static class Utils

Properties

eyeTrackedFoveatedRenderingEnabled

Gets or sets whether eye tracked foveated rendering is enabled or not.

Declaration

public static bool eyeTrackedFoveatedRenderingEnabled { get; set; }

Property Value

Type	Description
bool

eyeTrackedFoveatedRenderingSupported

Returns whether or not eye tracked foveated rendering (ETFR) is supported. You cannot enable ETFR using eyeTrackedFoveatedRenderingEnabled if the feature isn't supported.

Declaration

public static bool eyeTrackedFoveatedRenderingSupported { get; }

Property Value

Type	Description
bool

foveatedRenderingLevel

Gets or sets the foveated rendering level. This works for both FFR and ETFR level can be 0, 1, 2, 3, or 4:

• -1 (get) not supported on current platform
• 0 foveated rendering disabled
• 1 low foveated rendering level
• 2 medium foveated rendering level
• 3 high foveated rendering level
• 4 high top foveated rendering level

Declaration

public static int foveatedRenderingLevel { get; set; }

Property Value

Type	Description
int

useDynamicFoveatedRendering

Gets or sets dynamic foveated rendering which will change the foveated rendering level automatically based on the current performance. Works for both FFR and ETFR.

Declaration

public static bool useDynamicFoveatedRendering { get; set; }

Property Value

Type	Description
bool

Methods

EnableDynamicFFR(bool)

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

Declaration

[Obsolete("Please use useDynamicFoveatedRendering instead", false)]
public static bool EnableDynamicFFR(bool enable)

Parameters

Type	Name	Description
bool	enable	Set to true to enable dynamic foveated rendering or false to disable it.

Returns

Type	Description
bool

GetEnvironmentDepthFrameDesc(int)

Declaration

public static Utils.EnvironmentDepthFrameDesc GetEnvironmentDepthFrameDesc(int eye)

Parameters

Type	Name	Description
int	eye

Returns

Type	Description
Utils.EnvironmentDepthFrameDesc

GetEnvironmentDepthHandRemovalSupported()

Declaration

public static bool GetEnvironmentDepthHandRemovalSupported()

Returns

Type	Description
bool

GetEnvironmentDepthSupported()

Declaration

public static bool GetEnvironmentDepthSupported()

Returns

Type	Description
bool

GetEnvironmentDepthTextureId(ref uint)

Declaration

public static bool GetEnvironmentDepthTextureId(ref uint id)

Parameters

Type	Name	Description
uint	id

Returns

Type	Description
bool

GetFoveationLevel()

Returns the level of foveated rendering. Only supported on mobile. See Oculus Documentation.

Declaration

[Obsolete("Please use foveatedRenderingLevel instead.", false)]
public static int GetFoveationLevel()

Returns

Type	Description
int	-1 error 0 disables foveated rendering 1 low foveated rendering level 2 medium foveated rendering level 3 high foveated rendering level 4 high top foveated rendering level

GetSystemHeadsetType()

Returns the type of the current headset

Declaration

public static SystemHeadset GetSystemHeadsetType()

Returns

Type	Description
SystemHeadset

IsEyeTrackingPermissionGranted()

Returns true if the user has allowed the Eye Tracking permission.

Declaration

public static bool IsEyeTrackingPermissionGranted()

Returns

Type	Description
bool

IsScenePermissionGranted()

Returns true if the user has allowed the USE_SCENE permission

Declaration

public static bool IsScenePermissionGranted()

Returns

Type	Description
bool

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

SetEnvironmentDepthHandRemoval(bool)

Declaration

public static bool SetEnvironmentDepthHandRemoval(bool isEnabled)

Parameters

Type	Name	Description
bool	isEnabled

Returns

Type	Description
bool

SetEnvironmentDepthRendering(bool)

Declaration

public static void SetEnvironmentDepthRendering(bool isEnabled)

Parameters

Type	Name	Description
bool	isEnabled

SetFoveationLevel(int)

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

Declaration

[Obsolete("Please use foveatedRenderingLevel instead.", false)]
public static bool SetFoveationLevel(int level)

Parameters

Type	Name	Description
int	level	level can be 0, 1, 2, 3, or 4: 0 disables foveated rendering 1 low foveated rendering level 2 medium foveated rendering level 3 high foveated rendering level 4 high top foveated rendering level

Returns

Type	Description
bool

SetupEnvironmentDepth(EnvironmentDepthCreateParams)

Declaration

public static void SetupEnvironmentDepth(Utils.EnvironmentDepthCreateParams createParams)

Parameters

Type	Name	Description
Utils.EnvironmentDepthCreateParams	createParams

ShutdownEnvironmentDepth()

Declaration

public static void ShutdownEnvironmentDepth()