Struct VideoFrameRate

Video frame rate.

Implements

IComparable<VideoFrameRate>

IConvertible

IComparable

IEquatable<VideoFrameRate>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types

Assembly: VisioForge.Core.dll

Syntax

public struct VideoFrameRate : IComparable<VideoFrameRate>, IConvertible, IComparable, IEquatable<VideoFrameRate>

Constructors

VideoFrameRate(double)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(double value)

Parameters

Type	Name	Description
double	value	Frame rate.

VideoFrameRate(int)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(int num)

Parameters

Type	Name	Description
int	num	The value.

VideoFrameRate(int, int)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(int num, int den)

Parameters

Type	Name	Description
int	num	The numerator.
int	den	The denumerator.

VideoFrameRate(long, long)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(long num, long den)

Parameters

Type	Name	Description
long	num	The number.
long	den	The den.

VideoFrameRate(uint)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(uint value)

Parameters

Type	Name	Description
uint	value	Frame rate.

VideoFrameRate(uint, uint)

Initializes a new instance of the VideoFrameRate struct.

Declaration

public VideoFrameRate(uint num, uint den)

Parameters

Type	Name	Description
uint	num	The numerator.
uint	den	The denumerator.

Fields

Empty

The empty value.

Declaration

public static VideoFrameRate Empty

Field Value

Type	Description
VideoFrameRate

Properties

Den

Gets the denuminator.

Declaration

public readonly uint Den { get; }

Property Value

Type	Description
uint	The den.

FPS_10

Gets the 10 FPS.

Declaration

public static VideoFrameRate FPS_10 { get; }

Property Value

Type	Description
VideoFrameRate	The 10 FPS.

FPS_25

Gets the 25 FPS.

Declaration

public static VideoFrameRate FPS_25 { get; }

Property Value

Type	Description
VideoFrameRate	The 25 FPS.

FPS_30

Gets the 30 FPS.

Declaration

public static VideoFrameRate FPS_30 { get; }

Property Value

Type	Description
VideoFrameRate	The 30 FPS.

FPS_60

Gets the 60 FPS.

Declaration

public static VideoFrameRate FPS_60 { get; }

Property Value

Type	Description
VideoFrameRate	The 60 FPS.

IsEmpty

Gets a value indicating whether this instance is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool	true if this instance is empty; otherwise, false.

Num

Gets the numerator.

Declaration

public readonly uint Num { get; }

Property Value

Type	Description
uint	The number.

Value

Gets the value.

Declaration

public double Value { get; }

Property Value

Type	Description
double	The value.

Methods

CompareTo(double)

Compares to.

Declaration

public bool CompareTo(double value)

Parameters

Type	Name	Description
double	value	The value.

Returns

Type	Description
bool	true if successful, false otherwise.

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public int CompareTo(object obj)

Parameters

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

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

Exceptions

Type	Condition
NotImplementedException

CompareTo(VideoFrameRate)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public int CompareTo(VideoFrameRate other)

Parameters

Type	Name	Description
VideoFrameRate	other	An object to compare with this instance.

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

Equals(object)

Determines whether the specified object is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

Equals(VideoFrameRate)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(VideoFrameRate other)

Parameters

Type	Name	Description
VideoFrameRate	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

GetAvgTimePerFrame()

Gets the average time per frame.

Declaration

public long GetAvgTimePerFrame()

Returns

Type	Description
long	Int64.

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

GetTypeCode()

Returns the TypeCode for this instance.

Declaration

public TypeCode GetTypeCode()

Returns

Type	Description
TypeCode	The enumerated constant that is the TypeCode of the class or value type that implements this interface.

ToBoolean(IFormatProvider)

Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information.

Declaration

public bool ToBoolean(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
bool	A Boolean value equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToByte(IFormatProvider)

Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information.

Declaration

public byte ToByte(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
byte	An 8-bit unsigned integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToChar(IFormatProvider)

Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information.

Declaration

public char ToChar(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
char	A Unicode character equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToDateTime(IFormatProvider)

Converts the value of this instance to an equivalent DateTime using the specified culture-specific formatting information.

Declaration

public DateTime ToDateTime(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
DateTime	A DateTime instance equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToDecimal(IFormatProvider)

Converts the value of this instance to an equivalent decimal number using the specified culture-specific formatting information.

Declaration

public decimal ToDecimal(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
decimal	A decimal number equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToDouble(IFormatProvider)

Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information.

Declaration

public double ToDouble(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
double	A double-precision floating-point number equivalent to the value of this instance.

ToInt16(IFormatProvider)

Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information.

Declaration

public short ToInt16(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
short	An 16-bit signed integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToInt32(IFormatProvider)

Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information.

Declaration

public int ToInt32(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
int	An 32-bit signed integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToInt64(IFormatProvider)

Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information.

Declaration

public long ToInt64(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
long	An 64-bit signed integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToSByte(IFormatProvider)

Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information.

Declaration

public sbyte ToSByte(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
sbyte	An 8-bit signed integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToSingle(IFormatProvider)

Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information.

Declaration

public float ToSingle(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
float	A single-precision floating-point number equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

ValueType.ToString()

ToString(CultureInfo)

Returns a string that represents this instance.

Declaration

public string ToString(CultureInfo cultureInfo)

Parameters

Type	Name	Description
CultureInfo	cultureInfo	The culture information.

Returns

Type	Description
string	A string that represents this instance.

ToString(IFormatProvider)

Returns a string that represents this instance.

Declaration

public string ToString(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
string	A string that represents this instance.

Exceptions

Type	Condition
NotImplementedException

ToType(Type, IFormatProvider)

Converts the value of this instance to an object of the specified Type that has an equivalent value, using the specified culture-specific formatting information.

Declaration

public object ToType(Type conversionType, IFormatProvider provider)

Parameters

Type	Name	Description
Type	conversionType	The Type to which the value of this instance is converted.
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
object	An object instance of type conversionType whose value is equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToUInt16(IFormatProvider)

Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information.

Declaration

public ushort ToUInt16(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
ushort	An 16-bit unsigned integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToUInt32(IFormatProvider)

Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information.

Declaration

public uint ToUInt32(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
uint	An 32-bit unsigned integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

ToUInt64(IFormatProvider)

Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information.

Declaration

public ulong ToUInt64(IFormatProvider provider)

Parameters

Type	Name	Description
IFormatProvider	provider	An IFormatProvider interface implementation that supplies culture-specific formatting information.

Returns

Type	Description
ulong	An 64-bit unsigned integer equivalent to the value of this instance.

Exceptions

Type	Condition
NotImplementedException

Operators

operator ==(VideoFrameRate, VideoFrameRate)

Implements the == operator.

Declaration

public static bool operator ==(VideoFrameRate S1, VideoFrameRate S2)

Parameters

Type	Name	Description
VideoFrameRate	S1	The s1.
VideoFrameRate	S2	The s2.

Returns

Type	Description
bool	The result of the operator.

operator >(VideoFrameRate, VideoFrameRate)

Implements the > operator.

Declaration

public static bool operator >(VideoFrameRate S1, VideoFrameRate S2)

Parameters

Type	Name	Description
VideoFrameRate	S1	The s1.
VideoFrameRate	S2	The s2.

Returns

Type	Description
bool	The result of the operator.

operator !=(VideoFrameRate, VideoFrameRate)

Implements the != operator.

Declaration

public static bool operator !=(VideoFrameRate S1, VideoFrameRate S2)

Parameters

Type	Name	Description
VideoFrameRate	S1	The s1.
VideoFrameRate	S2	The s2.

Returns

Type	Description
bool	The result of the operator.

operator <(VideoFrameRate, VideoFrameRate)

Implements the < operator.

Declaration

public static bool operator <(VideoFrameRate S1, VideoFrameRate S2)

Parameters

Type	Name	Description
VideoFrameRate	S1	The s1.
VideoFrameRate	S2	The s2.

Returns

Type	Description
bool	The result of the operator.

Implements

IComparable<T>

IConvertible

IComparable

IEquatable<T>

Extension Methods

MathHelper.Clamp<T>(T, T, T)