Struct XRHandCaptureFrame

A single frame of captured hand data.

Implements

IEquatable<XRHandCaptureFrame>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Hands.Capture

Assembly: Unity.XR.Hands.dll

Syntax

[Serializable]
public struct XRHandCaptureFrame : IEquatable<XRHandCaptureFrame>

Properties

timestamp

The timestamp of this captured frame in seconds since the start of the recording.

Declaration

public float timestamp { get; }

Property Value

Type	Description
float	The time at which this frame was captured.

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	Returns true if obj is of type XRHandCaptureFrame and Equals(XRHandCaptureFrame) also returns true; otherwise returns false.

Overrides

ValueType.Equals(object)

Equals(XRHandCaptureFrame)

Tests for equality.

Declaration

public bool Equals(XRHandCaptureFrame other)

Parameters

Type	Name	Description
XRHandCaptureFrame	other	The XRHandCaptureFrame to compare against.

Returns

Type	Description
bool	Returns true if every field in other is equal to this XRHandCaptureFrame. Returns false otherwise.

GetHashCode()

Computes a hash code from all fields of XRHandCaptureFrame.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	Returns a hash code of this object.

Overrides

ValueType.GetHashCode()

IsHandTracked(Handedness)

Reports whether the frame contains the specified hand.

Declaration

public bool IsHandTracked(Handedness handedness)

Parameters

Type	Name	Description
Handedness	handedness	The Handedness of the hand to check.

Returns

Type	Description
bool	true if data for the specified hand is available; otherwise, false.

TryGetJoint(out XRHandJoint, Handedness, XRHandJointID)

Attempts to retrieve the joint data for the specified hand and joint ID.

Declaration

public bool TryGetJoint(out XRHandJoint joint, Handedness handedness, XRHandJointID id)

Parameters

Type	Name	Description
XRHandJoint	joint	The output parameter to store the retrieved joint data.
Handedness	handedness	The Handedness of the hand to retrieve the joint data for.
XRHandJointID	id	The ID of the joint to retrieve.

Returns

Type	Description
bool	true if the joint data was successfully retrieved; otherwise, false.

Operators

operator ==(XRHandCaptureFrame, XRHandCaptureFrame)

Tests for equality. Same as Equals(XRHandCaptureFrame).

Declaration

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

Parameters

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

Returns

Type	Description
bool	Returns true if lhs is equal to rhs, otherwise returns false.

operator !=(XRHandCaptureFrame, XRHandCaptureFrame)

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

Declaration

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

Parameters

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

Returns

Type	Description
bool	Returns true if lhs is not equal to rhs, otherwise returns false.

Implements

IEquatable<T>