Struct Budget 

pub struct Budget {
    pub frame_avg_ms: Option<f32>,
    pub frame_p99_ms: Option<f32>,
    pub frame_max_ms: Option<f32>,
    pub allocs_per_frame: Option<f32>,
    pub systems: BTreeMap<String, f32>,
    pub scopes: BTreeMap<String, f32>,
}

Limits for a PerfReport, checked with PerfReport::assert_within in tests and CI. Everything starts unlimited.

Timings vary between machines; allocation counts don’t, so an allocs_per_frame(0.0) budget is the one to rely on in CI, with generous time limits next to it. Budgets are also JSON ({"frame_p99_ms": 2, "systems": {"movement": 0.5}}), which is how C and C++ pass them.

use ponko::Budget;
let budget = Budget::new()
    .frame_p99_ms(2.0)
    .allocs_per_frame(0.0)
    .system("movement", 0.5)
    .scope("ai/pathing", 1.0);
assert_eq!(budget.systems["movement"], 0.5);

Fields

frame_avg_ms: Option<f32>

Most average frame time, in ms.

frame_p99_ms: Option<f32>

Most 99th percentile frame time, in ms.

frame_max_ms: Option<f32>

Most time for the slowest frame, in ms.

allocs_per_frame: Option<f32>

Most heap allocations per frame. Needs the counting allocator.

systems: BTreeMap<String, f32>

Most average ms per frame for systems. Names match the full name or its last part (movement matches my_game::movement).

scopes: BTreeMap<String, f32>

Most average ms per frame for scopes.

Implementations

impl Budget

pub fn new() -> Self

No limits yet.

pub fn frame_avg_ms(self, ms: f32) -> Self

Limits the average frame time.

pub fn frame_p99_ms(self, ms: f32) -> Self

Limits the 99th percentile frame time.

pub fn frame_max_ms(self, ms: f32) -> Self

Limits the slowest frame.

pub fn allocs_per_frame(self, n: f32) -> Self

Limits heap allocations per frame (0.0: none).

pub fn system(self, name: &str, ms: f32) -> Self

Limits a system’s average time per frame.

pub fn scope(self, name: &str, ms: f32) -> Self

Limits a scope’s average time per frame.

pub fn from_json(json: &str) -> Result<Self, String>

Reads a budget from JSON.

Errors

If the text isn’t a budget.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Budget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Budget

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Budget

where Budget: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Budget

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Budget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Budget