Class VisionOSSettings

Holds settings that are used to configure the Apple visionOS XR Plug-in.

Inheritance

object

Object

ScriptableObject

VisionOSSettings

Implements

IPackageSettings

Inherited Members

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.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

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: UnityEditor.XR.VisionOS

Assembly: Unity.XR.VisionOS.Editor.dll

Syntax

[Serializable]
[XRConfigurationData("Apple visionOS", "UnityEditor.XR.VisionOS.VisionOSSettings")]
public class VisionOSSettings : ScriptableObject, IPackageSettings

Properties

appMode

App mode.

Declaration

public VisionOSSettings.AppMode appMode { get; set; }

Property Value

Type	Description
VisionOSSettings.AppMode

currentSettings

Get or set the VisionOSSettings to use for the Player build.

Declaration

public static VisionOSSettings currentSettings { get; set; }

Property Value

Type	Description
VisionOSSettings

foveatedRendering

Controls if foveated rendering is enabled or disabled. This setting only applies to Virtual Reality apps. Foveated rendering requires the Universal Render Pipeline.

Declaration

public bool foveatedRendering { get; set; }

Property Value

Type	Description
bool

handsTrackingUsageDescription

Hands tracking usage description (added to Info.plist).

Declaration

public string handsTrackingUsageDescription { get; set; }

Property Value

Type	Description
string

il2CPPLargeExeWorkaround

Setting that determines if the IL2CPP_LARGE_EXECUTABLE_ARM_WORKAROUND flag is used when building an Xcode project.

Declaration

public bool il2CPPLargeExeWorkaround { get; set; }

Property Value

Type	Description
bool

mrImmersionStyle

The ImmersionStyle to be used for the MR ImmersiveSpace.

Declaration

public VisionOSSettings.ImmersionStyle mrImmersionStyle { get; set; }

Property Value

Type	Description
VisionOSSettings.ImmersionStyle

skipPresentToMainScreen

XR setting to signal to Unity that it should not try to present frames to the main screen. This setting was previously disabled to work around an issue that caused Unity versions prior to 2022.3.42f1 to leak GPU resources. In Unity 2022.3.42f1 and above, enabling this setting will fix a known issue with frame pacing on visionOS. Do not modify this setting from its default value unless you have a specific reason. It should be enabled on Unity 2022.3.42f1 and above, and disabled otherwise.

Declaration

public bool skipPresentToMainScreen { get; set; }

Property Value

Type	Description
bool

upperLimbVisibility

Upper limb visibility setting (currently only set at the beginning of an app)

Declaration

public bool upperLimbVisibility { get; set; }

Property Value

Type	Description
bool

vrImmersionStyle

The ImmersionStyle to be used for the VR ImmersiveSpace.

Declaration

public VisionOSSettings.ImmersionStyle vrImmersionStyle { get; set; }

Property Value

Type	Description
VisionOSSettings.ImmersionStyle

worldSensingUsageDescription

World sensing usage description (added to Info.plist).

Declaration

public string worldSensingUsageDescription { get; set; }

Property Value

Type	Description
string

Methods

GetOrCreateRuntimeSettings()

Declaration

public VisionOSRuntimeSettings GetOrCreateRuntimeSettings()

Returns

Type	Description
VisionOSRuntimeSettings

GetOrCreateSettings()

Gets the currently selected settings, or creates default settings if no VisionOSSettings have been set in Player Settings.

Declaration

public static VisionOSSettings GetOrCreateSettings()

Returns

Type	Description
VisionOSSettings	The visionOS settings to use for the current Player build.

ImmersionStyleToString(ImmersionStyle)

Convert the immersionStyle setting to a string that can be written into Swift code generated during the build process.

Declaration

public static string ImmersionStyleToString(VisionOSSettings.ImmersionStyle immersionStyle)

Parameters

Type	Name	Description
VisionOSSettings.ImmersionStyle	immersionStyle	The state of the immersion style setting.

Returns

Type	Description
string	Swift code that can be used for build postprocessors.

Exceptions

Type	Condition
ArgumentOutOfRangeException	Thrown if the value of immersionStyle isn't one of the known values (Automatic, Full, Mixed, or Progressive)

UpperLimbVisibilityToString(bool)

Convert the upperLimbVisibility setting to a string that can be written into Swift code generated during the build process.

Declaration

public static string UpperLimbVisibilityToString(bool upperLimbVisibility)

Parameters

Type	Name	Description
bool	upperLimbVisibility	The state of the upper limb visibility setting.

Returns

Type	Description
string	Swift code that can be used for build postprocessors.

Implements

IPackageSettings