Struct Frame

Namespace

Backdash.Data

Assembly

Backdash.dll

Value representation of a Frame

public readonly struct Frame : IComparable<Frame>, IComparable<int>, IEquatable<int>, IUtf8SpanFormattable, IFormattable, IComparisonOperators<Frame, Frame, bool>, IEqualityOperators<Frame, Frame, bool>, IAdditionOperators<Frame, Frame, Frame>, ISubtractionOperators<Frame, Frame, Frame>, IIncrementOperators<Frame>, IDecrementOperators<Frame>, IComparisonOperators<Frame, int, bool>, IEqualityOperators<Frame, int, bool>, IModulusOperators<Frame, int, Frame>, IAdditionOperators<Frame, int, Frame>, ISubtractionOperators<Frame, int, Frame>, IAdditionOperators<Frame, FrameSpan, FrameSpan>, IEquatable<Frame>

Implements

IComparable<Frame>

IComparable<int>

IEquatable<int>

IUtf8SpanFormattable

IFormattable

IComparisonOperators<Frame, Frame, bool>

IEqualityOperators<Frame, Frame, bool>

IAdditionOperators<Frame, Frame, Frame>

ISubtractionOperators<Frame, Frame, Frame>

IIncrementOperators<Frame>

IDecrementOperators<Frame>

IComparisonOperators<Frame, int, bool>

IEqualityOperators<Frame, int, bool>

IModulusOperators<Frame, int, Frame>

IAdditionOperators<Frame, int, Frame>

ISubtractionOperators<Frame, int, Frame>

IAdditionOperators<Frame, FrameSpan, FrameSpan>

IEquatable<Frame>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

Frame(int)

Initialize new Frame for frame number.

public Frame(int number)

Parameters

number int

Fields

MaxValue

Returns max frame value

public static readonly Frame MaxValue

Field Value

Frame

Null

Return Null frame value

public static readonly Frame Null

Field Value

Frame

Number

Returns the int value for the current Frame.

public readonly int Number

Field Value

int

One

Return frame value 1

public static readonly Frame One

Field Value

Frame

Zero

Return frame value 0

public static readonly Frame Zero

Field Value

Frame

Properties

IsNotNull

Returns true if the current frame is not a null frame

public bool IsNotNull { get; }

Property Value

bool

IsNull

Returns true if the current frame is a null frame

public bool IsNull { get; }

Property Value

bool

Methods

Abs(in Frame)

Returns the absolute value of a Frame.

public static Frame Abs(in Frame frame)

Parameters

frame Frame

Returns

Frame

Clamp(in Frame, in Frame, in Frame)

Clamps frame value to a range

public static Frame Clamp(in Frame frame, in Frame min, in Frame max)

Parameters

frame Frame

min Frame

max Frame

Returns

Frame

Clamp(in Frame, int, int)

Clamps frame value to a range

public static Frame Clamp(in Frame frame, int min, int max)

Parameters

frame Frame

min int

max int

Returns

Frame

CompareTo(Frame)

public int CompareTo(Frame other)

Parameters

other Frame

Returns

int

CompareTo(int)

public int CompareTo(int other)

Parameters

other int

Returns

int

Equals(Frame)

public bool Equals(Frame other)

Parameters

other Frame

Returns

bool

Equals(int)

public bool Equals(int other)

Parameters

other int

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Max(in Frame, in Frame)

Returns the larger of two Frame.

public static Frame Max(in Frame left, in Frame right)

Parameters

left Frame

right Frame

Returns

Frame

Min(in Frame, in Frame)

Returns the smaller of two Frame.

public static Frame Min(in Frame left, in Frame right)

Parameters

left Frame

right Frame

Returns

Frame

Next()

Returns the next frame for the current Frame value.

public Frame Next()

Returns

Frame

Previous()

Returns the previous frame for the current Frame value.

public Frame Previous()

Returns

Frame

ToString()

public override string ToString()

Returns

string

ToString(string?, IFormatProvider?)

public string ToString(string? format, IFormatProvider? formatProvider)

Parameters

format string

formatProvider IFormatProvider

Returns

string

TryFormat(Span<byte>, out int, ReadOnlySpan<char>, IFormatProvider?)

public bool TryFormat(Span<byte> utf8Destination, out int bytesWritten, ReadOnlySpan<char> format, IFormatProvider? provider)

Parameters

utf8Destination Span<byte>

bytesWritten int

format ReadOnlySpan<char>

provider IFormatProvider

Returns

bool

Operators

explicit operator int(Frame)

Returns the int value for the current Frame.

public static explicit operator int(Frame frame)

Parameters

frame Frame

Returns

int

explicit operator Frame(int)

Initialize new Frame for frame number.

public static explicit operator Frame(int frame)

Parameters

frame int

Returns

Frame

Explicit Interface Implementations

operator +(Frame, Frame)

static Frame operator +(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

Frame

operator +(Frame, FrameSpan)

static FrameSpan operator +(Frame left, FrameSpan right)

Parameters

left Frame

right FrameSpan

Returns

FrameSpan

operator +(Frame, int)

static Frame operator +(Frame a, int b)

Parameters

a Frame

b int

Returns

Frame

operator --(Frame)

static Frame operator --(Frame value)

Parameters

value Frame

Returns

Frame

operator ==(Frame, Frame)

static bool operator ==(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator ==(Frame, int)

static bool operator ==(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator >(Frame, Frame)

static bool operator >(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator >(Frame, int)

static bool operator >(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator >=(Frame, Frame)

static bool operator >=(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator >=(Frame, int)

static bool operator >=(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator ++(Frame)

static Frame operator ++(Frame value)

Parameters

value Frame

Returns

Frame

operator !=(Frame, Frame)

static bool operator !=(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator !=(Frame, int)

static bool operator !=(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator <(Frame, Frame)

static bool operator <(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator <(Frame, int)

static bool operator <(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator <=(Frame, Frame)

static bool operator <=(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

bool

operator <=(Frame, int)

static bool operator <=(Frame left, int right)

Parameters

left Frame

right int

Returns

bool

operator %(Frame, int)

static Frame operator %(Frame left, int right)

Parameters

left Frame

right int

Returns

Frame

operator -(Frame, Frame)

static Frame operator -(Frame left, Frame right)

Parameters

left Frame

right Frame

Returns

Frame

operator -(Frame, int)

static Frame operator -(Frame a, int b)

Parameters

a Frame

b int

Returns

Frame