Struct XRHandRecordingFrameCapturedEventArgs

Provides details about a new frame captured during a recording session.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.Hands.Capture.Recording

Assembly: Unity.XR.Hands.dll

Syntax

public readonly struct XRHandRecordingFrameCapturedEventArgs

Properties

elapsedTime

The elapsed time since the recording started.

Declaration

public float elapsedTime { get; }

Property Value

Type	Description
float

frameIndex

The index of the captured frame in the recording session.

Declaration

public int frameIndex { get; }

Property Value

Type	Description
int

Remarks

The index is zero-based

subsystem

The XRHandSubsystem instance associated with the recording session.

Declaration

public XRHandSubsystem subsystem { get; }

Property Value

Type	Description
XRHandSubsystem

updateSuccessFlags

The updateSuccessFlags flags indicating what data were updated during the Dynamic update step in this frame.

Declaration

public XRHandSubsystem.UpdateSuccessFlags updateSuccessFlags { get; }

Property Value

Type	Description
XRHandSubsystem.UpdateSuccessFlags

updateSuccessFlagsBeforeRender

The updateSuccessFlags flags indicating what data were updated during the BeforeRender update step in this frame.

Declaration

public XRHandSubsystem.UpdateSuccessFlags updateSuccessFlagsBeforeRender { get; }

Property Value

Type	Description
XRHandSubsystem.UpdateSuccessFlags	This can only ever have success flags set if the XRHandRecordingOptions option of AlsoCaptureBeforeRender was enabled on XRHandRecordingInitializeArgs.recordingOptions when XRHandRecordingBlob.TryInitialize(XRHandRecordingInitializeArgs) was called at the beginning of the recording that this XRHandRecordingFrameCaptureEventArgs represents addition to.