Class AutomaticDynamicResolutionFeature

This OpenXRFeature enables the use of Automatic Viewport Dynamic Resolution in OpenXR.

Inheritance

object

Object

ScriptableObject

OpenXRFeature

AutomaticDynamicResolutionFeature

Inherited Members

OpenXRFeature.enabled

OpenXRFeature.xrGetInstanceProcAddr

OpenXRFeature.HookGetInstanceProcAddr(IntPtr)

OpenXRFeature.OnSubsystemCreate()

OpenXRFeature.OnSubsystemStart()

OpenXRFeature.OnSubsystemStop()

OpenXRFeature.OnSubsystemDestroy()

OpenXRFeature.OnSystemChange(ulong)

OpenXRFeature.OnSessionCreate(ulong)

OpenXRFeature.OnAppSpaceChange(ulong)

OpenXRFeature.OnSessionStateChange(int, int)

OpenXRFeature.OnSessionBegin(ulong)

OpenXRFeature.OnSessionEnd(ulong)

OpenXRFeature.OnSessionExiting(ulong)

OpenXRFeature.OnSessionDestroy(ulong)

OpenXRFeature.OnInstanceDestroy(ulong)

OpenXRFeature.OnSessionLossPending(ulong)

OpenXRFeature.OnInstanceLossPending(ulong)

OpenXRFeature.OnFormFactorChange(int)

OpenXRFeature.OnViewConfigurationTypeChange(int)

OpenXRFeature.OnEnvironmentBlendModeChange(XrEnvironmentBlendMode)

OpenXRFeature.OnEnabledChange()

OpenXRFeature.PathToString(ulong)

OpenXRFeature.StringToPath(string)

OpenXRFeature.GetCurrentInteractionProfile(ulong)

OpenXRFeature.GetCurrentInteractionProfile(string)

OpenXRFeature.GetCurrentAppSpace()

OpenXRFeature.GetViewConfigurationTypeForRenderPass(int)

OpenXRFeature.SetEnvironmentBlendMode(XrEnvironmentBlendMode)

OpenXRFeature.GetEnvironmentBlendMode()

OpenXRFeature.GetValidationChecks(List<OpenXRFeature.ValidationRule>, BuildTargetGroup)

OpenXRFeature.CreateSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, string)

OpenXRFeature.StartSubsystem<T>()

OpenXRFeature.StopSubsystem<T>()

OpenXRFeature.DestroySubsystem<T>()

OpenXRFeature.OnEnable()

OpenXRFeature.OnDisable()

OpenXRFeature.Awake()

OpenXRFeature.GetAction(InputAction)

OpenXRFeature.GetAction(InputDevice, InputFeatureUsage)

OpenXRFeature.GetAction(InputDevice, string)

OpenXRFeature.RegisterStatsDescriptor(string, OpenXRFeature.StatFlags)

OpenXRFeature.SetStatAsFloat(ulong, float)

OpenXRFeature.SetStatAsUInt(ulong, uint)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, InstantiateParameters)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.OpenXR.Features

Assembly: Unity.XR.OpenXR.dll

Syntax

public class AutomaticDynamicResolutionFeature : OpenXRFeature

Fields

maxResolutionScalarLimit

The maximum possible value of the resolution scalars.

Declaration

public const float maxResolutionScalarLimit = 2

Field Value

Type	Description
float

minResolutionScalarLimit

The minimum possible value of the resolution scalars

Declaration

public const float minResolutionScalarLimit = 0.05

Field Value

Type	Description
float

Properties

maxResolutionScalar

Stores the current maximum resolution scalar. It is bounded from below by the current value of minResolutionScalar, and from above by maxResolutionScalarLimit.

Declaration

public float maxResolutionScalar { get; }

Property Value

Type	Description
float

Remarks

Only the getter is public. You can change this value in: "Project Settings -> XR Plug-in Management -> OpenXR -> Automatic Viewport Dynamic Resolution"

minResolutionScalar

Stores the current minimum resolution scalar. It is bounded from below by minResolutionScalarLimit, and from above by the current value of maxResolutionScalar.

Declaration

public float minResolutionScalar { get; }

Property Value

Type	Description
float

Remarks

Only the getter is public. You can change this value in: "Project Settings -> XR Plug-in Management -> OpenXR -> Automatic Viewport Dynamic Resolution"

usingSuggestedResolutionScale

Are we currently using the suggested resolution provided by the extension(s), or are we disregarding it and not updating resolution automatically. Default is true.

Declaration

public static bool usingSuggestedResolutionScale { get; }

Property Value

Type	Description
bool

Remarks

Call SetUsingSuggestedResolutionScale(bool) to change this value. Only the getter is public.

Methods

IsAutomaticDynamicResolutionScalingSupported()

Determines if automatic dynamic resolution scaling is supported.

Declaration

public static bool IsAutomaticDynamicResolutionScalingSupported()

Returns

Type	Description
bool	Returns true if automatic dynamic resolution scaling is supported, and returns false if it is not.

OnInstanceCreate(ulong)

Called after xrCreateInstance. Override this method to validate that any necessary OpenXR extensions were successfully enabled (OpenXRRuntime.IsExtensionEnabled) and that any required system properties are supported. If this method returns false, the feature's enabled property is set to false.

Declaration

protected override bool OnInstanceCreate(ulong instance)

Parameters

Type	Name	Description
ulong	instance

Returns

Type	Description
bool	true if this feature successfully initialized. Otherwise, false.

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

Remarks

If this feature is a required feature of an enabled feature set, returning false here causes the OpenXRLoader to fail, and XR Plug-in Management will fall back to another loader if enabled.

See Also

Enabling OpenXR spec extension strings

SetUsingSuggestedResolutionScale(bool)

Set whether or not we are using the suggested resolution provided by the extensions, rather than disregarding it and not updating resolution automatically. Default is true.

Declaration

public static void SetUsingSuggestedResolutionScale(bool usingSuggestedScale)

Parameters

Type	Name	Description
bool	usingSuggestedScale	The flag whether or not to use the suggested resolution and update the resolution automatically.