Struct AROcclusionFrameEventArgs

A structure for occlusion information pertaining to a particular frame. This is used to communicate information in the frameReceived event.

Implements
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
public struct AROcclusionFrameEventArgs : IEquatable<AROcclusionFrameEventArgs>

Properties

disabledMaterialKeywords

The list of keywords to be disabled for the material.

Declaration
[Obsolete("disabledMaterialKeywords has been deprecated in AR Foundation version 6.0. Use disabledShaderKeywords instead.")]
public readonly List<string> disabledMaterialKeywords { get; }
Property Value
Type Description
List<string>

disabledShaderKeywords

The disabled shader keywords.

Declaration
public readonly ReadOnlyCollection<string> disabledShaderKeywords { get; }
Property Value
Type Description
ReadOnlyCollection<string>

enabledMaterialKeywords

The list of keywords to be enabled for the material.

Declaration
[Obsolete("enabledMaterialKeywords has been deprecated in AR Foundation version 6.0. Use enabledShaderKeywords instead.")]
public readonly List<string> enabledMaterialKeywords { get; }
Property Value
Type Description
List<string>

enabledShaderKeywords

The enabled shader keywords.

Declaration
public readonly ReadOnlyCollection<string> enabledShaderKeywords { get; }
Property Value
Type Description
ReadOnlyCollection<string>

propertyNameIds

Ids of the property name associated with each texture. This is a parallel List to the textures list.

Declaration
public readonly List<int> propertyNameIds { get; }
Property Value
Type Description
List<int>

textures

The occlusion textures associated with this frame. These are generally external textures, which exist only on the GPU. To use them on the CPU (for example, for computer vision processing), you must read them back from the GPU.

Declaration
public readonly List<Texture2D> textures { get; }
Property Value
Type Description
List<Texture2D>

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
bool

True if obj is of type AROcclusionFrameEventArgs and Equals(AROcclusionFrameEventArgs) also returns true; otherwise false.
Overrides

Equals(AROcclusionFrameEventArgs)

Tests for equality.

Declaration
public bool Equals(AROcclusionFrameEventArgs other)
Parameters
Type Name Description
AROcclusionFrameEventArgs other

The other AROcclusionFrameEventArgs to compare against.
Returns
Type Description
bool

True if every field in other is equal to this AROcclusionFrameEventArgs, otherwise false.

GetHashCode()

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

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code generated from this object's fields.
Overrides

Operators

operator ==(AROcclusionFrameEventArgs, AROcclusionFrameEventArgs)

Tests for equality. Same as Equals(AROcclusionFrameEventArgs).

Declaration
public static bool operator ==(AROcclusionFrameEventArgs lhs, AROcclusionFrameEventArgs rhs)
Parameters
Type Name Description
AROcclusionFrameEventArgs lhs

The left-hand side of the comparison.
AROcclusionFrameEventArgs rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is equal to rhs, otherwise false.

operator !=(AROcclusionFrameEventArgs, AROcclusionFrameEventArgs)

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

Declaration
public static bool operator !=(AROcclusionFrameEventArgs lhs, AROcclusionFrameEventArgs rhs)
Parameters
Type Name Description
AROcclusionFrameEventArgs lhs

The left-hand side of the comparison.
AROcclusionFrameEventArgs rhs

The right-hand side of the comparison.
Returns
Type Description
bool

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

Implements