docs.unity3d.com
    Show / Hide Table of Contents

    Class XRCameraSubsystemDescriptor

    Specifies the functionalities supported by a provider of the XRCameraSubsystem. Provider implementations must derive from XRCameraSubsystem.Provider and may override virtual class members.

    Inheritance
    Object
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider<XRCameraSubsystem, XRCameraSubsystem.Provider>
    XRCameraSubsystemDescriptor
    Inherited Members
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider<UnityEngine.XR.ARSubsystems.XRCameraSubsystem, UnityEngine.XR.ARSubsystems.XRCameraSubsystem.Provider>.Create()
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider.UnityEngine.ISubsystemDescriptor.Create()
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider.id
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider.providerType
    UnityEngine.SubsystemsImplementation.SubsystemDescriptorWithProvider.subsystemTypeOverride
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public sealed class XRCameraSubsystemDescriptor : SubsystemDescriptorWithProvider<XRCameraSubsystem, XRCameraSubsystem.Provider>, ISubsystemDescriptor

    Properties

    supportsAverageBrightness

    Indicates whether the provider implementation can provide a value for averageBrightness.

    Declaration
    public bool supportsAverageBrightness { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide average brightness. Otherwise, false.

    supportsAverageColorTemperature

    Indicates whether the provider implementation can provide a value for averageColorTemperature.

    Declaration
    public bool supportsAverageColorTemperature { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide average camera temperature. Otherwise, false.

    supportsAverageIntensityInLumens

    Indicates whether the provider implementation can provide a value for averageIntensityInLumens.

    Declaration
    public bool supportsAverageIntensityInLumens { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide average intensity in lumens. Otherwise, false.

    supportsCameraConfigurations

    Indicates whether the provider implementation supports camera configurations. If false, the get accessor for currentConfiguration may return null, and the set accessor must throw a NotSupportedException.

    Declaration
    public bool supportsCameraConfigurations { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports camera configurations. Otherwise, false.

    supportsCameraGrain

    Indicates whether the provider implementation can provide a value for cameraGrain.

    Declaration
    public bool supportsCameraGrain { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide a camera grain texture. Otherwise, false.

    supportsCameraImage

    Indicates whether the provider implementation can provide camera images. If false, TryAcquireLatestCpuImage(out XRCpuImage) must throw a NotSupportedException.

    Declaration
    public bool supportsCameraImage { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide camera images. Otherwise, false.

    supportsColorCorrection

    Indicates whether the provider implementation can provide a value for colorCorrection.

    Declaration
    public bool supportsColorCorrection { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide color correction. Otherwise, false.

    supportsDisplayMatrix

    Indicates whether the provider implementation can provide a value for displayMatrix.

    Declaration
    public bool supportsDisplayMatrix { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide a display matrix. Otherwise, false.

    supportsFaceTrackingAmbientIntensityLightEstimation

    Indicates whether the provider implementation supports ambient intensity light estimation while face tracking is enabled. If false, hasAverageBrightness and hasAverageIntensityInLumens must be false while face tracking is enabled.

    Declaration
    public bool supportsFaceTrackingAmbientIntensityLightEstimation { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports ambient intensity while face tracking is enabled. Otherwise, false.

    supportsFaceTrackingHDRLightEstimation

    Indicates whether the provider implementation supports HDR light estimation while face tracking is enabled.

    Declaration
    public bool supportsFaceTrackingHDRLightEstimation { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports HDR light estimation while face tracking is enabled. Otherwise, false.

    supportsFocusModes

    Indicates whether the provider implementation supports the ability to set the camera's focus mode. If false, the set accessor for autoFocusRequested will have no effect.

    Declaration
    public bool supportsFocusModes { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports focus modes. Otherwise, false.

    supportsProjectionMatrix

    Indicates whether the provider implementation can provide a value for projectionMatrix.

    Declaration
    public bool supportsProjectionMatrix { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide a projection matrix. Otherwise, false.

    supportsTimestamp

    Indicates whether the provider implementation can provide a value for timestampNs.

    Declaration
    public bool supportsTimestamp { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation can provide a timestamp. Otherwise, false.

    supportsWorldTrackingAmbientIntensityLightEstimation

    Indicates whether the provider implementation supports ambient intensity light estimation while world tracking. If false, hasAverageBrightness and hasAverageIntensityInLumens must be false while world tracking.

    Declaration
    public bool supportsWorldTrackingAmbientIntensityLightEstimation { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports ambient intensity while world tracking. Otherwise, false.

    supportsWorldTrackingHDRLightEstimation

    Indicates whether the provider implementation supports HDR light estimation while world tracking.

    Declaration
    public bool supportsWorldTrackingHDRLightEstimation { get; }
    Property Value
    Type Description
    Boolean

    true if the implementation supports HDR light estimation while world tracking. Otherwise, false.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023