Scripting API

Scripting API

ProfiledFrame

Struct in Abyss.Core, from Abyss.Core.

A frame of the main thread's as the engine timed it, for the editor's Profiler: its number, when it started and how long it took — to the next one's start — and of that how long each of Bevy's main schedules took, and how long the host's frame and its fixed steps took within them. Times in nanoseconds, from when recording started.

public readonly struct ProfiledFrame

Remarks

Laid out as abyss_core::profile::ProfiledFrame is.

Fields

Frame

public readonly ulong Frame

Its number: Bevy's frame count as it started.

StartedNs

public readonly ulong StartedNs

When it started.

TotalNs

public readonly ulong TotalNs

How long it took, to the next frame's start.

HostNs

public readonly ulong HostNs

How long the host's frame took.

FixedHostNs

public readonly ulong FixedHostNs

How long the host's fixed steps took, together.

FixedSteps

public readonly uint FixedSteps

How many fixed steps it took.

StageCount

public readonly uint StageCount

How many of ProfiledFrame.StagesNs are its schedules'.

StagesNs

public readonly ProfileStages StagesNs

How long each main schedule took, in World.ProfilePartName's order.

Constants

MaxStages

public const int MaxStages = 16

How many main schedules a frame times each of; any after them are timed as the last.