Struct ARCameraFrameEventArgs

A structure for camera-related information pertaining to a particular frame. This is used to communicate information in the cameraFrameReceived event.

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: UnityEngine.XR.ARFoundation

Syntax

public struct ARCameraFrameEventArgs : IEquatable<ARCameraFrameEventArgs>

Constructors

ARCameraFrameEventArgs(LightEstimationData, Nullable<Single>)

Constructs an ARCameraFrameEventArgs.

Declaration

public ARCameraFrameEventArgs(LightEstimationData lightEstimation, float ? time)

Parameters

Type	Name	Description
LightEstimationData	lightEstimation	The LightEstimationData for the frame.
System.Nullable<System.Single>	time	The time, in seconds, for the frame.

Properties

lightEstimation

The LightEstimationData associated with this frame.

Declaration

public LightEstimationData lightEstimation { get; }

Property Value

Type	Description
LightEstimationData

time

The time, in seconds, associated with this frame. Use time.HasValue to determine if this data is available.

Declaration

public float ? time { get; }

Property Value

Type	Description
System.Nullable<System.Single>

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

Equals(ARCameraFrameEventArgs)

Declaration

public bool Equals(ARCameraFrameEventArgs other)

Parameters

Type	Name	Description
ARCameraFrameEventArgs	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()

Operators

Equality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

Declaration

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

Parameters

Type	Name	Description
ARCameraFrameEventArgs	lhs
ARCameraFrameEventArgs	rhs

Returns

Type	Description
System.Boolean

Inequality(ARCameraFrameEventArgs, ARCameraFrameEventArgs)

Declaration

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

Parameters

Type	Name	Description
ARCameraFrameEventArgs	lhs
ARCameraFrameEventArgs	rhs

Returns

Type	Description
System.Boolean