Struct FrameTime

A struct that represents a time relative to a frame sequence.

Namespace: Unity.LiveCapture

Assembly: Unity.LiveCapture.dll

Syntax

[Serializable]
public struct FrameTime

Constructors

FrameTime(int, Subframe)

Creates a new FrameTime instance.

Declaration

public FrameTime(int frameNumber, Subframe subframe = default)

Parameters

Type	Name	Description
int	frameNumber	The number of the frame in the sequence.
Subframe	subframe	The subframe value used to indicate a time somewhere within the duration of the frame.

Properties

FrameNumber

The number of the frame in the sequence.

Declaration

public readonly int FrameNumber { get; }

Property Value

Type	Description
int

Subframe

The time within the frame.

Declaration

public readonly Subframe Subframe { get; }

Property Value

Type	Description
Subframe

Methods

Ceil()

Gets the frame time rounded up to the start of the next frame.

Declaration

public readonly FrameTime Ceil()

Returns

Type	Description
FrameTime	A FrameTime with no subframe component.

CompareTo(object)

Compares this instance to a specified object and returns an indication of their relative values.

Declaration

public readonly int CompareTo(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
int	A signed number indicating the relative values of this instance and obj. * Returns a negative value when obj is not a valid FrameTime instance or this instance is less than obj. * Returns zero when this instance is the same as obj. * Returns a positive value when this instance is greater than obj.

CompareTo(FrameTime)

Compares this instance to a specified FrameTime and returns an indication of their relative values.

Declaration

public readonly int CompareTo(FrameTime other)

Parameters

Type	Name	Description
FrameTime	other	The value to compare with this instance.

Returns

Type	Description
int	A signed number indicating the relative values of this instance and other. * Returns a negative value when this instance is less than other. * Returns zero when this instance is the same as other. * Returns a positive value when this instance is greater than other.

Equals(object)

Returns a value indicating whether this instance is equal to a specified object.

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	An object to compare with this instance.

Returns

Type	Description
bool	true if obj is an instance of FrameTime and equals the value of this instance; otherwise, false.

Overrides

ValueType.Equals(object)

Equals(FrameTime)

Returns a value indicating whether this instance is equal to a specified FrameTime.

Declaration

public readonly bool Equals(FrameTime other)

Parameters

Type	Name	Description
FrameTime	other	A value to compare with this instance.

Returns

Type	Description
bool	true if other has the same value as this instance; otherwise, false.

Floor()

Gets the frame time rounded down to the start of the current frame.

Declaration

public readonly FrameTime Floor()

Returns

Type	Description
FrameTime	A FrameTime with no subframe component.

FromFrameTime(double, int)

Creates a new FrameTime instance from a frame time.

Declaration

public static FrameTime FromFrameTime(double frameTime, int subframeResolution = 51200)

Parameters

Type	Name	Description
double	frameTime	The frame time with the frame number in the integer part and the subframe in the decimal part.
int	subframeResolution	The number of possible subframe values in the frame. If this value is not greater than zero, the subframe value is treated as zero.

Returns

Type	Description
FrameTime	A new FrameTime that represents the given frame time.

FromSeconds(FrameRate, double, int)

Creates a new FrameTime instance from a time in seconds and a frame rate.

Declaration

public static FrameTime FromSeconds(FrameRate frameRate, double time, int subframeResolution = 51200)

Parameters

Type	Name	Description
FrameRate	frameRate	The frame rate of the frame sequence.
double	time	The time in seconds.
int	subframeResolution	The number of possible subframe values in the frame. If this value is not greater than zero, the subframe value is treated as zero.

Returns

Type	Description
FrameTime	A new FrameTime that represents the given time, or default if frameRate is invalid.

Remarks

The input time is clamped to the range [-MaxRepresentableSeconds(FrameRate), MaxRepresentableSeconds(FrameRate)] defined for the provided FrameRate.

GetHashCode()

Returns the hash code for this instance.

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
int	The hash code for this instance.

Overrides

ValueType.GetHashCode()

MaxRepresentableSeconds(FrameRate)

Calculates the maximum length of a frame sequence in seconds that can be represented by a FrameTime.

Declaration

public static double MaxRepresentableSeconds(FrameRate frameRate)

Parameters

Type	Name	Description
FrameRate	frameRate	The frame rate of the frame sequence.

Returns

Type	Description
double	The maximum time in seconds, or default if frameRate is invalid.

Remap(FrameTime, FrameRate, FrameRate)

Converts a FrameTime in a frame sequence with a given FrameRate to a time in a frame sequence with a different FrameTime.

Declaration

public static FrameTime Remap(FrameTime frameTime, FrameRate srcRate, FrameRate dstRate)

Parameters

Type	Name	Description
FrameTime	frameTime	The frame time to remap.
FrameRate	srcRate	The original frame rate.
FrameRate	dstRate	The frame rate to convert to.

Returns

Type	Description
FrameTime	A new FrameTime remapped to the the target frame rate, or default if srcRate or dstRate is invalid.

Exceptions

Type	Condition
OverflowException	Thrown if the resulting value is outside the range representable by the FrameTime type.

Round()

Gets the frame time rounded to the nearest start of a frame.

Declaration

public readonly FrameTime Round()

Returns

Type	Description
FrameTime	A FrameTime with no subframe component.

Remarks

Subframe values exactly half way in a frame are rounded towards negative infinity.

ToSeconds(FrameRate)

Gets the time in seconds represented by this FrameTime for a given FrameRate.

Declaration

public readonly double ToSeconds(FrameRate frameRate)

Parameters

Type	Name	Description
FrameRate	frameRate	The frame rate of the frame sequence.

Returns

Type	Description
double	The time in seconds since the start of the frame sequence, or default if frameRate is invalid.

ToString()

Returns a string that represents the current instance.

Declaration

public override readonly string ToString()

Returns

Type	Description
string	A string that represents the current instance.

Overrides

ValueType.ToString()

Operators

operator +(FrameTime, FrameTime)

Calculates the sum of two specified FrameTime values.

Declaration

public static FrameTime operator +(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first frame time.
FrameTime	b	The second frame time.

Returns

Type	Description
FrameTime	The sum of a and b.

Exceptions

Type	Condition
OverflowException	Thrown if the resulting value is outside the range representable by the FrameTime type.

operator --(FrameTime)

Decrements a FrameTime by a single frame.

Declaration

public static FrameTime operator --(FrameTime a)

Parameters

Type	Name	Description
FrameTime	a	The frame time to Decrement.

Returns

Type	Description
FrameTime	The decremented frame time.

Exceptions

Type	Condition
OverflowException	Thrown if the resulting value is outside the range representable by the FrameTime type.

operator ==(FrameTime, FrameTime)

Indicates whether two specified instances of FrameTime are equal.

Declaration

public static bool operator ==(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a and b have the same value; otherwise, false.

explicit operator double(FrameTime)

Gets the value of a FrameTime as a double.

Declaration

public static explicit operator double(FrameTime rate)

Parameters

Type	Name	Description
FrameTime	rate	The value to cast.

Returns

Type	Description
double	The frame time with the frame number in the integer part and the subframe in the decimal part.

explicit operator float(FrameTime)

Gets the value of a FrameTime as a float.

Declaration

public static explicit operator float(FrameTime rate)

Parameters

Type	Name	Description
FrameTime	rate	The value to cast.

Returns

Type	Description
float	The frame time with the frame number in the integer part and the subframe in the decimal part.

operator >(FrameTime, FrameTime)

Indicates whether one specified FrameTime is later than another specified FrameTime.

Declaration

public static bool operator >(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a is later than b; otherwise, false.

operator >=(FrameTime, FrameTime)

Indicates whether one specified FrameTime is later than or the same as another specified FrameTime.

Declaration

public static bool operator >=(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a is later than or the same as b; otherwise, false.

operator ++(FrameTime)

Increments a FrameTime by a single frame.

Declaration

public static FrameTime operator ++(FrameTime a)

Parameters

Type	Name	Description
FrameTime	a	The frame time to increment.

Returns

Type	Description
FrameTime	The incremented frame time.

Exceptions

Type	Condition
OverflowException	Thrown if the resulting value is outside the range representable by the FrameTime type.

operator !=(FrameTime, FrameTime)

Indicates whether two specified instances of FrameTime are not equal.

Declaration

public static bool operator !=(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a and b do not have the same value; otherwise, false.

operator <(FrameTime, FrameTime)

Indicates whether one specified FrameTime is earlier than another specified FrameTime.

Declaration

public static bool operator <(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a is earlier than b; otherwise, false.

operator <=(FrameTime, FrameTime)

Indicates whether one specified FrameTime is earlier than or the same as another specified FrameTime.

Declaration

public static bool operator <=(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The first instance to compare.
FrameTime	b	The second instance to compare.

Returns

Type	Description
bool	true if a is earlier than or the same as b; otherwise, false.

operator -(FrameTime, FrameTime)

Calculates the difference between two specified FrameTime values.

Declaration

public static FrameTime operator -(FrameTime a, FrameTime b)

Parameters

Type	Name	Description
FrameTime	a	The frame time.
FrameTime	b	The frame time to subtract.

Returns

Type	Description
FrameTime	The subtraction of b from a.

Exceptions

Type	Condition
OverflowException	Thrown if the resulting value is outside the range representable by the FrameTime type.