FrameRange

struct FrameRange

import FrameRange from Wax::Recording;

A range of absolute recording frames in the Wax::Recording namespace. Keeps recording selections distinct from application counters.

import Frame from Wax::Recording;
import FrameRange from Wax::Recording;
api fn Main() : int32 {
    var range = FrameRange.Through(new Frame(3), new Frame(5));
    return range.count as int32;
}

Recording.wax:104

Members

fromfield

public readonly Frame from

The inclusive first frame.

Recording.wax:108

tofield

public readonly Frame to

The exclusive end frame.

Recording.wax:112

constructorconstructor

public constructor (Frame from, Frame to)

Creates [from, to). An end before the start panics; equal endpoints form an empty range.

Recording.wax:117

countgetter

public get count() : int64

The number of frames in the half-open range.

Recording.wax:126

isEmptygetter

public get isEmpty() : bool

Tests whether the endpoints are equal.

Recording.wax:133

Containsmethod

public fn Contains(Frame frame) : bool

Tests from <= frame < to.

Recording.wax:140

Throughmethod

public static fn Through(Frame from, Frame toInclusive) : FrameRange

Creates a range including both supplied endpoints. Reversed bounds or an inclusive end at the maximum frame panic.

Recording.wax:148

StartingAtmethod

public static fn StartingAt(Frame from, int64 count) : FrameRange

Creates count frames beginning at from. Negative count or end overflow panics; zero count is allowed.

Recording.wax:157

EndingAtmethod

public static fn EndingAt(Frame to, int64 count) : FrameRange

Creates count frames before the exclusive end to. Negative count or a start before frame zero panics; zero count is allowed.

Recording.wax:166

EndingThroughmethod

public static fn EndingThrough(Frame toInclusive, int64 count) : FrameRange

Creates a positive number of frames ending at the inclusive endpoint. Nonpositive count, a start before zero, or end overflow panics.

Recording.wax:175

UpToEndingThroughmethod

public static fn UpToEndingThrough(Frame toInclusive, int64 maxCount) : FrameRange

Creates up to maxCount frames ending at the inclusive endpoint, shortening at frame zero. Nonpositive maxCount or end overflow panics.

Recording.wax:184

GetHashCodemethod

public fn GetHashCode() : uint32

Hashes both range endpoints.

Recording.wax:193

Equalsmethod

public fn Equals(FrameRange other) : bool

Tests both endpoints for exact equality.

Recording.wax:200

ToStringmethod

public fn ToString() : string

Provided by the compiler.

ToStringBuffermethod

public fn ToStringBuffer(StringBuilder builder) : int32

Provided by the compiler.