Skip to main content

SolverBackend

Enum SolverBackend 

Source
#[non_exhaustive]
pub enum SolverBackend { Xpbd, Tgs, }
Expand description

Selects which rigid-body integrator PhysicsWorld::step dispatches to.

Both variants read and write the same RigidBody fields, so a world can be migrated between backends between steps without changing any other configuration. They are not numerically interchangeable — XPBD is position-based (Macklin/Müller) and TGS is a sub-stepping impulse-based projected Gauss-Seidel integrator (Müller et al. 2020, see the crate-internal solver_tgs module) — so the same scene produces different (both physically valid) trajectories under each backend. Pick one and stay on it for a given simulation; do not expect bit-identical replay across a backend switch.

§Notes on the Tgs path

DistanceConstraints are enforced as bilateral velocity-level impulse joints (JointOriented in solver_tgs_hooks_6dof_oriented), solved every TGS inner sub-step alongside contacts, plus a Baumgarte position correction for residual drift — a genuinely different algorithm from XPBD’s position-based compliance solve, so the two backends converge to slightly different equilibria for the same scene (not a bug; see tests/analytic_tgs_wiring.rs‘s joint tests for both backends’ measured bands).

Pre-solve hooks and contact modifiers run once over the tick’s contacts before the solve (tests/analytic_tgs_backend_coverage.rs).

The world’s Joints are solved inside the TGS substep loop: after each substep’s impulse solve, the same position-level joint projection the XPBD substep runs is applied and its correction is added to the bodies’ linear and angular velocities (tests/analytic_tgs_joints_in_substep.rs).

  • Requires the std feature (solver_tgs is std-gated, same as the rest of the TGS family). Selecting Tgs in a build without std is not silently ignored at the type level — the variant still exists — but PhysicsWorld::step falls back to running Xpbd for that build, since there is no TGS implementation to dispatch to. This is a documented, defined fallback (a different already-correct solver runs), not state corruption.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Xpbd

Extended Position-Based Dynamics — the solver this crate has shipped since 0.1.0. Default.

§

Tgs

Sub-stepping impulse-based temporal Gauss-Seidel. See the gaps listed on SolverBackend itself before using this in production.

Trait Implementations§

Source§

impl Clone for SolverBackend

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for SolverBackend

Source§

impl Debug for SolverBackend

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SolverBackend

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for SolverBackend

Source§

impl PartialEq for SolverBackend

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SolverBackend

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.