UnityARCameraSettings Class

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.Experimental.UnityAR

Assembly:: Microsoft.MixedReality.Toolkit.Providers.UnityAR.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Camera settings provider for use with the Unity AR Foundation system.

public ref class UnityARCameraSettings : Microsoft::MixedReality::Toolkit::CameraSystem::BaseCameraSettingsProvider

[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.CameraSystem.IMixedRealityCameraSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS, "Unity AR Foundation Camera Settings", "UnityAR/Profiles/DefaultUnityARCameraSettingsProfile.asset", "MixedRealityToolkit.Providers", false)]
public class UnityARCameraSettings : Microsoft.MixedReality.Toolkit.CameraSystem.BaseCameraSettingsProvider

[Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.CameraSystem.IMixedRealityCameraSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS, "Unity AR Foundation Camera Settings", "UnityAR/Profiles/DefaultUnityARCameraSettingsProfile.asset", "MixedRealityToolkit.Providers", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)]
public class UnityARCameraSettings : Microsoft.MixedReality.Toolkit.CameraSystem.BaseCameraSettingsProvider

[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.CameraSystem.IMixedRealityCameraSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS, "Unity AR Foundation Camera Settings", "UnityAR/Profiles/DefaultUnityARCameraSettingsProfile.asset", "MixedRealityToolkit.Providers", false)>]
type UnityARCameraSettings = class
    inherit BaseCameraSettingsProvider

[<Microsoft.MixedReality.Toolkit.MixedRealityDataProvider(typeof(Microsoft.MixedReality.Toolkit.CameraSystem.IMixedRealityCameraSystem), Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.Android | Microsoft.MixedReality.Toolkit.Utilities.SupportedPlatforms.IOS, "Unity AR Foundation Camera Settings", "UnityAR/Profiles/DefaultUnityARCameraSettingsProfile.asset", "MixedRealityToolkit.Providers", false, Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.LegacyXR | Microsoft.MixedReality.Toolkit.Utilities.SupportedUnityXRPipelines.XRSDK)>]
type UnityARCameraSettings = class
    inherit BaseCameraSettingsProvider

Public Class UnityARCameraSettings
Inherits BaseCameraSettingsProvider

Inheritance: Object

BaseService

BaseDataProvider<IMixedRealityCameraSystem>

BaseCameraSettingsProvider
UnityARCameraSettings

Attributes: MixedRealityDataProviderAttribute

Constructors

UnityARCameraSettings(IMixedRealityCameraSystem, String, UInt32, BaseCameraSettingsProfile)

Constructor.

Fields

DefaultPriority	(Inherited from BaseService)
disposed	Value indicating if the object has completed disposal. (Inherited from BaseService)

Properties

ConfigurationProfile	The configuration profile for the service. (Inherited from BaseService)
IsEnabled	Indicates whether or not the service is currently enabled. (Inherited from BaseService)
IsInitialized	Indicates whether or not the service has been initialized. (Inherited from BaseService)
IsMarkedDestroyed	Indicates whether or not the Destroy method been called on this service. (Inherited from BaseService)
IsOpaque	Returns whether or not the current display rendering mode is opaque.
Name	Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action. (Inherited from BaseService)
Priority	Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated. (Inherited from BaseService)
Registrar	Obsolete. The service registrar instance that registered this service. (Inherited from BaseDataProvider<T>)
Service	The service instance to which this provider is providing data. (Inherited from BaseDataProvider<T>)
SettingsProfile	The profile used to configure the camera.

Methods

ApplyConfiguration()	Applies provider specific configuration settings. (Inherited from BaseCameraSettingsProvider)
Destroy()	Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed. (Inherited from BaseService)
Disable()	Optional Disable function to pause the service. (Inherited from BaseService)
Dispose()	Cleanup resources used by this object. (Inherited from BaseService)
Dispose(Boolean)	Cleanup resources used by the object (Inherited from BaseService)
Enable()	Optional Enable function to enable / re-enable the service. (Inherited from BaseService)
Initialize()	The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit. (Inherited from BaseService)
LateUpdate()	Optional LateUpdate function to that is called after Update has been called on all services. (Inherited from BaseService)
Reset()	Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change. (Inherited from BaseService)
Update()	Optional Update function to perform per-frame updates of the service. (Inherited from BaseService)

Applies to

Share via