Struct AspectRatio 

pub struct AspectRatio { /* private fields */ }

A width-to-height ratio, exact.

Stored as an integer fraction rather than an f64 because 16:9 is not representable in binary floating point, and a window that must stay aspect-locked across thousands of resize events accumulates that error into a visible drift. Comparisons and the fit math below stay in integers where they can.

Implementations

impl AspectRatio

pub const WIDESCREEN: Self

16:9.

pub const CLASSIC: Self

4:3.

pub const SQUARE: Self

1:1.

pub const fn new(width: u32, height: u32) -> Self

A ratio of width : height.

Panics

If either term is zero. A degenerate aspect ratio has no correct behaviour and silently substituting one hides the caller’s bug.

pub const fn numerator(self) -> u32

The width term.

pub const fn denominator(self) -> u32

The height term.

pub fn as_f64(self) -> f64

The ratio as a float, for shader constants and letterbox math.

pub fn fit(self, bounds: PhysicalSize) -> PhysicalSize

The largest size with this aspect ratio that fits inside bounds.

This is the letterbox computation, and it lives here because the windowing rules in docs/notes/backends.md make in-renderer letterboxing the universal fallback: Wayland has no aspect hint at all, and a tiling window manager can force any size on any backend, so every consumer that aspect-locks needs this math and none of them should write it twice.

Returns a size of at most bounds in both axes, and at least 1×1.

Trait Implementations

impl Clone for AspectRatio

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 AspectRatio

impl Debug for AspectRatio

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

Formats the value using the given formatter.

impl Display for AspectRatio

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

Formats the value using the given formatter.

impl Eq for AspectRatio

impl Hash for AspectRatio

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AspectRatio

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AspectRatio