Struct StageWork 

#[non_exhaustive]
pub struct StageWork {

    pub sleep_scanned: u64,
    pub parked: u64,
    pub unparked: u64,
    pub force_field_bodies: u64,
    pub integrated: u64,
    pub broadphase_primitives: u64,
    pub broadphase_pairs: u64,
    pub broadphase_box_tests: u64,
    pub resolution_bodies: u64,
    pub velocity_bodies: u64,
    pub damping_bodies: u64,
    pub sleep_evaluated: u64,
    pub parked_sleep_updates: u64,
    pub tree_inserts: u64,
    pub tree_removes: u64,
}

How much work the last PhysicsWorld::step did, stage by stage.

Every counter is a number of items a stage visited, summed over the substeps of that one call (reset when step starts). They count work, not time, so a test can assert on them without measuring a clock. step_parallel, step_with_bridge, the TGS backend and the public substep API add to the same counters but do not reset them.

With the sleep skip on (PhysicsWorld::set_sleep_skip, the default) a sleeping body that is at rest and not attached to a joint or distance constraint is parked: every stage below except sleep_scanned and parked_sleep_updates leaves it out, and the broad-phase finds its contacts through a persistent tree instead of rebuilding it. The counters then depend on the awake bodies only, except those two, which stay one per sleeping body per step (a check that the parked state was not edited between steps, and the idle_frames count the snapshot carries).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sleep_scanned: u64

Bodies examined at the start of the step to decide which are parked.

parked: u64

Bodies parked for this step (not counting ones woken during it).

unparked: u64

Parked bodies woken by a contact during the step.

force_field_bodies: u64

Bodies the force fields were applied to.

integrated: u64

Bodies visited by position integration.

broadphase_primitives: u64

Bodies put into the per-substep broad-phase BVH.

broadphase_pairs: u64

Candidate pairs the broad-phase handed to the narrow-phase.

broadphase_box_tests: u64

Pairs of bodies whose exact boxes the Broadphase::Hybrid broad-phase compared to find broadphase_pairs (0 with the other broad-phases).

resolution_bodies: u64

Bodies tested against the static and SDF colliders.

velocity_bodies: u64

Bodies whose velocity was derived from their position change.

damping_bodies: u64

Bodies visited by the frame damping.

sleep_evaluated: u64

Bodies whose sleep state was evaluated from their velocity.

parked_sleep_updates: u64

Parked bodies whose sleep bookkeeping was advanced without evaluation.

tree_inserts: u64

Proxies inserted into the parked-body tree.

tree_removes: u64

Proxies removed from the parked-body tree.

Trait Implementations

impl Clone for StageWork

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StageWork

impl Debug for StageWork

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

Formats the value using the given formatter.

impl Default for StageWork

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StageWork

impl PartialEq for StageWork

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StageWork