Struct XREnvironmentProbeSubsystemCinfo

Contains the parameters for creating a new XREnvironmentProbeSubsystemDescriptor.

Inherited Members

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XREnvironmentProbeSubsystemCinfo : IEquatable<XREnvironmentProbeSubsystemCinfo>

Properties

id

Specifies an identifier for the provider implementation of the subsystem.

Declaration

public string id { readonly get; set; }

Property Value

Type	Description
String	The identifier for the provider implementation of the subsystem.

implementationType

Specifies the provider implementation type to use for instantiation.

Declaration

[Obsolete("XREnvironmentProbeSubsystem 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	Specifies the provider implementation type to use for instantiation.

providerType

Specifies the provider implementation type to use for instantiation.

Declaration

public Type providerType { readonly get; set; }

Property Value

Type	Description
Type	The provider implementation type to use for instantiation.

subsystemTypeOverride

Specifies the XREnvironmentProbeSubsystem-derived type that forwards casted calls to its provider.

Declaration

public Type subsystemTypeOverride { readonly get; set; }

Property Value

Type	Description
Type	The type of the subsystem to use for instantiation. If null, `XREnvironmentProbeSubsystem` will be instantiated.

supportsAutomaticPlacement

Whether the implementation supports automatic placement of environment probes.

Declaration

public bool supportsAutomaticPlacement { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if automatic placement of environment probes is supported. Otherwise, `false`.

supportsEnvironmentTexture

Whether the implementation supports generation of environment textures.

Declaration

public bool supportsEnvironmentTexture { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if the generation of environment textures is supported. Otherwise, `false`.

supportsEnvironmentTextureHDR

Whether the implementation supports generation of HDR environment textures.

Declaration

public bool supportsEnvironmentTextureHDR { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if the generation of HDR environment textures is supported. Otherwise, `false`.

supportsManualPlacement

Whether the implementation supports manual placement of environment probes.

Declaration

public bool supportsManualPlacement { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if manual placement of environment probes is supported. Otherwise, `false`.

supportsRemovalOfAutomatic

Whether the implementation supports removal of automatically placed environment probes.

Declaration

public bool supportsRemovalOfAutomatic { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if removal of automatically placed environment probes is supported. Otherwise, `false`.

supportsRemovalOfManual

Whether the implementation supports removal of manually placed environment probes.

Declaration

public bool supportsRemovalOfManual { readonly get; set; }

Property Value

Type	Description
Boolean	`true` if removal of manually placed environment probes is supported. 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 XREnvironmentProbeSubsystemCinfo and Equals(XREnvironmentProbeSubsystemCinfo) also returns `true`; otherwise `false`.

Overrides

ValueType.Equals(Object)

Equals(XREnvironmentProbeSubsystemCinfo)

Tests for equality.

Declaration

public bool Equals(XREnvironmentProbeSubsystemCinfo other)

Parameters

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

Returns

Type	Description
Boolean	`True` if every field in `other` is equal to this XREnvironmentProbeSubsystemCinfo, 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(XREnvironmentProbeSubsystemCinfo, XREnvironmentProbeSubsystemCinfo)

Tests for equality. Same as Equals(XREnvironmentProbeSubsystemCinfo).

Declaration

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

Parameters

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

Returns

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

Inequality(XREnvironmentProbeSubsystemCinfo, XREnvironmentProbeSubsystemCinfo)

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

Declaration

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

Parameters

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

Returns

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