Skip to main content

DesignMapping

Struct DesignMapping 

Source
pub struct DesignMapping {
    pub design: [f32; 2],
    pub canvas_dp: [f32; 2],
    pub policy: DesignFit,
}
Expand description

A design box mapped onto a dp canvas under one DesignFit policy: the scale, the offsets it implies, the inverse, and the snapping rule. Build it per frame, or on resize, from the measured canvas and the game’s design size.

Degenerate sides (<= 0.0: the state before the first measure) fall back exactly like contain_fit / cover_fit: scale 1.0, offsets 0.0, so the mapping is the identity on design units and visible reports that canvas over 1.0. Sides so far apart that the ratio underflows past the shared 1e-6 guard read the same way. A non-finite side is not repaired: it surfaces in the offsets rather than being replaced by an invented number.

Fields§

§design: [f32; 2]

Design box in design units.

§canvas_dp: [f32; 2]

Measured canvas in dp.

§policy: DesignFit

Which ratio wins.

Implementations§

Source§

impl DesignMapping

Source

pub fn contain(canvas_dp: [f32; 2], design: [f32; 2]) -> Self

Contain, the design box fully visible. Canvas first, matching contain_fit.

Source

pub fn cover(canvas_dp: [f32; 2], design: [f32; 2]) -> Self

Cover, the canvas fully filled and the overflow cropped. Canvas first, matching cover_fit.

Source

pub fn scale(&self) -> f32

dp per design unit for this policy: the games’ grid_scale / ui_scale under DesignFit::Contain, world_scale under DesignFit::Cover.

Source

pub fn fit(&self) -> (f32, f32, f32)

The (scale, offset_x, offset_y) tuple the framing functions take. With the default centered camera the design origin lands at the offsets, so this tuple feeds fit_view_proj_with_roll, world_to_dp and picks alike; under DesignFit::Cover the offsets are negative on the cropped axis.

Source

pub fn box_dp(&self) -> [f32; 2]

The design box scaled to dp at scale: the games’ cover_box under DesignFit::Cover, whose top-left sits at the offsets fit reports.

Source

pub fn visible(&self) -> [f32; 2]

Design units the canvas shows, the games’ field_size. For a measured canvas under DesignFit::Contain this is the design box or more (the roomier axis reveals past it); under DesignFit::Cover it is the design sub-rect that survives cropping, so content that must stay visible belongs inside it.

Source

pub fn design_to_dp(&self, design: [f32; 2]) -> [f32; 2]

Design units to dp through the fit: offset + design * scale, no rounding.

Source

pub fn dp_to_design(&self, dp: [f32; 2]) -> [f32; 2]

Inverse of design_to_dp. Exact up to float error for any scale the fits can report (they never report zero).

Source

pub fn snap_box(&self, at: [f32; 2], size: [f32; 2]) -> ([f32; 2], [f32; 2])

Snap a design box onto whole dp: round the converted top-left and bottom-right corners, then derive the dp extent from the two snapped corners. Two boxes that share a design-space edge therefore share the snapped edge exactly, and the extent can never disagree with its own corners (round(x) + round(w) can, by up to a dp per seam). Opt in: this is for art that must land on whole dp, not for moving content.

Trait Implementations§

Source§

impl Clone for DesignMapping

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 DesignMapping

Source§

impl Debug for DesignMapping

Source§

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

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

impl PartialEq for DesignMapping

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 DesignMapping

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more