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, Vector3, Quaternion, CancellationToken)

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

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

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

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

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

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

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

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: 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

highQualityRecordingMode

This setting is for when you want to create a high quality recording of your app. Enabling this setting will disable rendering in the right eye and disable foveated rendering. This is expected to be used when creating a high quality recording with Reality Composer Pro.

Declaration

public bool highQualityRecordingMode { get; set; }

Property Value

Type	Description
bool

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

metalImmersionStyle

The ImmersionStyle to be used for the Metal ImmersiveSpace.

Declaration

public VisionOSSettings.ImmersionStyle metalImmersionStyle { get; set; }

Property Value

Type	Description
VisionOSSettings.ImmersionStyle

metalImmersiveOverlays

The visibility of persistent system overlays (such as the visionOS hand gesture menus) in Metal immersive spaces.

Declaration

public VisionOSSettings.Visibility metalImmersiveOverlays { get; set; }

Property Value

Type	Description
VisionOSSettings.Visibility

realityKitImmersionStyle

The ImmersionStyle to be used for the RealityKit ImmersiveSpace.

Declaration

public VisionOSSettings.ImmersionStyle realityKitImmersionStyle { get; set; }

Property Value

Type	Description
VisionOSSettings.ImmersionStyle

realityKitImmersiveOverlays

The visibility of persistent system overlays (such as the visionOS hand gesture menus) in RealityKit immersive spaces.

Declaration

public VisionOSSettings.Visibility realityKitImmersiveOverlays { get; set; }

Property Value

Type	Description
VisionOSSettings.Visibility

upperLimbVisibility

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

Declaration

public VisionOSSettings.Visibility upperLimbVisibility { get; set; }

Property Value

Type	Description
VisionOSSettings.Visibility

useACTool

Setting this to true will enable the use of the actool utility during player builds to compile reference image libraries.

Declaration

public bool useACTool { get; set; }

Property Value

Type	Description
bool

worldSensingUsageDescription

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

Declaration

public string worldSensingUsageDescription { get; set; }

Property Value

Type	Description
string

Methods

GetOrCreateRuntimeSettings()

Retrieves an existing VisionOSRuntimeSettings asset or creates a new one.

Declaration

public VisionOSRuntimeSettings GetOrCreateRuntimeSettings()

Returns

Type	Description
VisionOSRuntimeSettings	A 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)

Returns the Swift string representation of the provided immersion style value.

Declaration

public static string ImmersionStyleToString(VisionOSSettings.ImmersionStyle immersionStyle)

Parameters

Type	Name	Description
VisionOSSettings.ImmersionStyle	immersionStyle	The immersion style value to convert.

Returns

Type	Description
string	The Swift string representation of the immersion style.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If an unknown value is provided.

VisibilityToString(Visibility)

Returns the Swift string representation of the provided visibility value.

Declaration

public static string VisibilityToString(VisionOSSettings.Visibility visibility)

Parameters

Type	Name	Description
VisionOSSettings.Visibility	visibility	The visibility value to convert.

Returns

Type	Description
string	The Swift string representation of the visibility.

Exceptions

Type	Condition
ArgumentOutOfRangeException	If an unknown value is provided.

Implements

IPackageSettings