FrameSummary

namespace Griff.Runtime;

public sealed class FrameSummary

How a stretch of frames went: how many, the frame rate and its 1% low (the rate of the slowest 1% of frames), the average and worst frame, and what the game’s steps, building and drawing took on average; then the garbage a frame made on average (in bytes), the most one made, and how many times the garbage collector ran in all.

Properties

Allocated

public double Allocated { get; init; }

AverageMs

public double AverageMs { get; init; }

BuildMs

public double BuildMs { get; init; }

Collections

public int Collections { get; init; }

DrawMs

public double DrawMs { get; init; }

Draws

public double Draws { get; init; }

Fps

public double Fps { get; init; }

Frames

public int Frames { get; init; }

Garbage

public string Garbage { get; }

The garbage a frame made on average, e.g. “0 B”, “12.5 KB” or “1.2 MB”.

LowFps

public double LowFps { get; init; }

MostAllocated

public long MostAllocated { get; init; }

StepMs

public double StepMs { get; init; }

Steps

public double Steps { get; init; }

WorstMs

public double WorstMs { get; init; }

Methods

Deconstruct

public void Deconstruct(out int Frames, out double Fps, out double LowFps, out double AverageMs, out double WorstMs, out double StepMs, out double BuildMs, out double DrawMs, out double Steps, out double Draws, out double Allocated, out long MostAllocated, out int Collections)

Equals

public override bool Equals(object? obj)

Equals

public bool Equals(FrameSummary? other)

GetHashCode

public override int GetHashCode()

ToString

public override string ToString()

Fields

None

public static readonly FrameSummary None