Struct AROcclusionFrameEventArgs

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

Namespace: UnityEngine.XR.ARFoundation

Syntax

public struct AROcclusionFrameEventArgs : IEquatable<AROcclusionFrameEventArgs>

Properties

disabledMaterialKeywords

The list of keywords to be disabled for the material.

Declaration

public List<string> disabledMaterialKeywords { readonly get; }

Property Value

Type	Description
List<String>

enabledMaterialKeywords

The list of keywords to be enabled for the material.

Declaration

public List<string> enabledMaterialKeywords { readonly get; }

Property Value

Type	Description
List<String>

propertyNameIds

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

Declaration

public List<int> propertyNameIds { readonly get; }

Property Value

Type	Description
List<Int32>

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, e.g., for computer vision processing, you will need to read them back from the GPU.

Declaration

public List<Texture2D> textures { readonly 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
Boolean	True if obj is of type AROcclusionFrameEventArgs and Equals(AROcclusionFrameEventArgs) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

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
Boolean	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
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

Operators

Equality(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
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(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
Boolean	True if lhs is not equal to rhs, otherwise false.