Struct FrameStats

Namespace

MiniTui

Assembly

MiniTui.dll

One frame's numbers (1.x spec §9.4).

public readonly record struct FrameStats : IEquatable<FrameStats>

Implements

IEquatable<FrameStats>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

FrameStats(long, TimeSpan, TimeSpan, int, long?, bool)

One frame's numbers (1.x spec §9.4).

public FrameStats(long Frame, TimeSpan RenderTime, TimeSpan FlushTime, int CellsChanged, long? BytesWritten, bool FullRedraw)

Parameters

Frame long

The frame's number: 1 for the first frame drawn by this run.

RenderTime TimeSpan

Drawing the frame (the render callback or screen, overlays and toasts), without the debug overlay.

FlushTime TimeSpan

Comparing the buffers and the backend writing the changes.

CellsChanged int

The cells sent to the backend; every cell on a full redraw.

BytesWritten long?

The bytes written to the terminal, or null on backends that don't write bytes (conhost, tests).

FullRedraw bool

True if the frame redrew the whole screen.

Properties

BytesWritten

The bytes written to the terminal, or null on backends that don't write bytes (conhost, tests).

public long? BytesWritten { get; init; }

Property Value

long?

CellsChanged

The cells sent to the backend; every cell on a full redraw.

public int CellsChanged { get; init; }

Property Value

int

FlushTime

Comparing the buffers and the backend writing the changes.

public TimeSpan FlushTime { get; init; }

Property Value

TimeSpan

Frame

The frame's number: 1 for the first frame drawn by this run.

public long Frame { get; init; }

Property Value

long

FullRedraw

True if the frame redrew the whole screen.

public bool FullRedraw { get; init; }

Property Value

bool

RenderTime

Drawing the frame (the render callback or screen, overlays and toasts), without the debug overlay.

public TimeSpan RenderTime { get; init; }

Property Value

TimeSpan