Class FeatureExtensions

Extension methods for Feature flags.

Inheritance
Object
FeatureExtensions
Namespace: UnityEngine.XR.ARSubsystems
Syntax
public static class FeatureExtensions

Methods

All(Feature, Feature)

Tests whether all the features in features are present in self.

Declaration
public static bool All(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

The Features to test against.
Returns
Type Description
Boolean

true if all the features in features are also in self, otherwise false.

Any(Feature, Feature)

Tests whether any of the features in features are present in self.

Declaration
public static bool Any(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

The Features to test against.
Returns
Type Description
Boolean

true if any of the features in features are also in self, otherwise false.

Cameras(Feature)

Filters just the camera-related Feature flags.

Declaration
public static Feature Cameras(this Feature self)
Parameters
Type Name Description
Feature self

The Feature being extended.
Returns
Type Description
Feature

The camera-related Feature flags from self.
See Also

Count(Feature)

Calculates the number of enabled features in self.

Declaration
public static int Count(this Feature self)
Parameters
Type Name Description
Feature self

The Feature being extended.
Returns
Type Description
Int32

The number of enabled Feature flags.

Intersection(Feature, Feature)

Computes the intersection of self and features, i.e., the set of features present in both self and features.

Declaration
public static Feature Intersection(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

Features to intersect with self
Returns
Type Description
Feature

The intersection of self and features, i.e., the set of features common to both self and features.

LightEstimation(Feature)

Filters just the light estimation related Feature flags.

Declaration
public static Feature LightEstimation(this Feature self)
Parameters
Type Name Description
Feature self

The Feature being extended.
Returns
Type Description
Feature

The light estimation related Feature flags from self.

None(Feature, Feature)

Tests whether there are any common features between self and features.

Declaration
public static bool None(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

The Features to test against.
Returns
Type Description
Boolean

true if none of the features in self are in features, otherwise false.

SetDifference(Feature, Feature)

Computes the set difference, i.e., removes all flags in features from self.

Declaration
public static Feature SetDifference(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

Features to remove from self
Returns
Type Description
Feature

The set difference of self and features, i.e., all members of self which do not belong to features.

SetEnabled(Feature, Feature, Boolean)

Sets or removes one or more Feature flags.

Declaration
public static Feature SetEnabled(this Feature self, Feature feature, bool enabled)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature feature

The Feature(s) to set or remove.
Boolean enabled

If true, the flag(s) in feature will be set. If false, it/they will be removed.
Returns
Type Description
Feature

self with the Feature(s) set or removed according to the value of enabled.

SymmetricDifference(Feature, Feature)

Computes the symmetric difference, i.e., the set of all features that belong to exactly one of self and features (present in one but not both).

Declaration
public static Feature SymmetricDifference(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

Features with which to compute the symmetric difference against self
Returns
Type Description
Feature

The symmetric difference of self and features, i.e., the features that belong to self or features, but not both.

ToStringList(Feature, String)

Generates a single string representing the list of enabled features separated by separator or a comma if not specified.

Declaration
public static string ToStringList(this Feature features, string separator = ", ")
Parameters
Type Name Description
Feature features

The Feature being extended.
String separator

The string separator to insert between elements of the list, or ", " if omitted.
Returns
Type Description
String

A string of Features separated by separator. If none of the features are enabled, returns "(None)".
Remarks

This method makes several heap allocations, generating garbage. It is intended for debugging purposes and should not be called frequently in a production application.

TrackingModes(Feature)

Filters just the tracking-related Feature flags.

Declaration
public static Feature TrackingModes(this Feature self)
Parameters
Type Name Description
Feature self

The Feature being extended.
Returns
Type Description
Feature

The tracking-related Feature flags from self.
See Also

Union(Feature, Feature)

Computes the union of self and features, i.e., the set of features in self or features or both.

Declaration
public static Feature Union(this Feature self, Feature features)
Parameters
Type Name Description
Feature self

The Feature being extended.
Feature features

Features to union with self
Returns
Type Description
Feature

The union of self and features, i.e., the set of features in self or features or both.

WithoutCameraOrTracking(Feature)

Removes all camera and tracking-related Feature flags.

Declaration
public static Feature WithoutCameraOrTracking(this Feature self)
Parameters
Type Name Description
Feature self

The Feature being extended.
Returns
Type Description
Feature

self with camera and tracking-related bits removed.
See Also