Skip to content

ludus::platform::PaceResult

Ludus Wiki · API overview · Browse API

Struct

Diagnostics for one Pace() call. All timestamps share the injected clock's domain.

Declared in modules/platform/include/ludus/platform/frame_pacing.h

#include <ludus/platform/frame_pacing.h>
struct ludus::platform::PaceResult final

Fields

Outcome

PaceOutcome ludus::platform::PaceResult::Outcome = PaceOutcome::Disabled
What the call did.

Related types: PaceOutcome

Declared in modules/platform/include/ludus/platform/frame_pacing.h

Target

foundation::time::Timestamp ludus::platform::PaceResult::Target
The frame-start target this call honored. Equals Wake when the schedule was (re-)anchored.

Related types: foundation::time::Timestamp

Declared in modules/platform/include/ludus/platform/frame_pacing.h

Wake

foundation::time::Timestamp ludus::platform::PaceResult::Wake
The final clock reading: when the frame actually starts.

Related types: foundation::time::Timestamp

Declared in modules/platform/include/ludus/platform/frame_pacing.h

Lateness

foundation::time::Duration ludus::platform::PaceResult::Lateness
Wake minus Target when the frame started at or after its target, otherwise zero.

Related types: foundation::time::Duration

Declared in modules/platform/include/ludus/platform/frame_pacing.h

SkippedTargets

foundation::uint64 ludus::platform::PaceResult::SkippedTargets = 0
Whole targets after Target that had already passed. Late skips them; Rescheduled abandons them.

Related types: foundation::uint64

Declared in modules/platform/include/ludus/platform/frame_pacing.h

WaitCount

foundation::uint32 ludus::platform::PaceResult::WaitCount = 0
Wait requests issued through the clock.

Related types: foundation::uint32

Declared in modules/platform/include/ludus/platform/frame_pacing.h

EarlyWakeCount

foundation::uint32 ludus::platform::PaceResult::EarlyWakeCount = 0
Waits that returned (Completed or Interrupted) before the target was reached.

Related types: foundation::uint32

Declared in modules/platform/include/ludus/platform/frame_pacing.h