Struct XRCameraSubsystemCinfo

Contains the parameters for creating a new XRCameraSubsystemDescriptor.

Inherited Members

ValueType.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XRCameraSubsystemCinfo : IEquatable<XRCameraSubsystemCinfo>

Properties

id

The identifier for the provider implementation of the subsystem.

Declaration

public string id { readonly get; set; }

Property Value

Type	Description
String	The identifier value.

implementationType

The provider implementation type to use for instantiation.

Declaration

[Obsolete("XRCameraSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
public Type implementationType { readonly get; set;
}

Property Value

Type	Description
Type	The provider implementation type.

providerType

The provider implementation type to use for instantiation.

Declaration

public Type providerType { readonly get; set; }

Property Value

Type	Description
Type	The provider implementation type.

subsystemTypeOverride

The XRCameraSubsystem-derived type to use for instantiation. The instantiated instance of this type will forward casted calls to its provider.

Declaration

public Type subsystemTypeOverride { readonly get; set; }

Property Value

Type	Description
Type	The subsystem implementation type. If null, XRCameraSubsystem will be instantiated.

supportsAverageBrightness

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

Declaration

public bool supportsAverageBrightness { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

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 { readonly get; set; }

Property Value

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

Methods

Equals(Object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare against.

Returns

Type	Description
Boolean	True if obj is of type XRCameraSubsystemCinfo and Equals(XRCameraSubsystemCinfo) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(XRCameraSubsystemCinfo)

Tests for equality.

Declaration

public bool Equals(XRCameraSubsystemCinfo other)

Parameters

Type	Name	Description
XRCameraSubsystemCinfo	other	The other XRCameraSubsystemCinfo to compare against.

Returns

Type	Description
Boolean	True if every field in other is equal to this XRCameraSubsystemCinfo, otherwise false.

Implements

IEquatable<T>.Equals(T)

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

Operators

Equality(XRCameraSubsystemCinfo, XRCameraSubsystemCinfo)

Tests for equality. Same as Equals(XRCameraSubsystemCinfo).

Declaration

public static bool operator ==(XRCameraSubsystemCinfo lhs, XRCameraSubsystemCinfo rhs)

Parameters

Type	Name	Description
XRCameraSubsystemCinfo	lhs	The left-hand side of the comparison.
XRCameraSubsystemCinfo	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(XRCameraSubsystemCinfo, XRCameraSubsystemCinfo)

Tests for inequality. Same as !Equals(XRCameraSubsystemCinfo).

Declaration

public static bool operator !=(XRCameraSubsystemCinfo lhs, XRCameraSubsystemCinfo rhs)

Parameters

Type	Name	Description
XRCameraSubsystemCinfo	lhs	The left-hand side of the comparison.
XRCameraSubsystemCinfo	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	True if lhs is not equal to rhs, otherwise false.