Skip to main content

OverlayTransform

Struct OverlayTransform 

Source
pub struct OverlayTransform { /* private fields */ }
Expand description

A uniform similarity transform mapping the reference canvas to the live window: a single scale plus a recentering. Built from the live viewport; an invalid (zero) viewport yields the identity (overlay drawn at reference pixels), which is what unit tests and the pre-backend init frames see.

Implementations§

Source§

impl OverlayTransform

Source

pub fn from_viewport(viewport: [f32; 2]) -> Self

Build the transform for a live logical viewport [width, height]. A degenerate viewport gives the identity transform.

Source

pub fn cover_from_viewport(viewport: [f32; 2]) -> Self

Build the “cover” transform for a live logical viewport: the larger axis ratio, so the reference canvas always fills the window (the overflowing axis is cropped equally on both sides). Used by full-bleed stage imagery (scene backdrops, character portraits) that must reach the window edges without distorting; the canvas bottom maps at or below the window bottom, so bottom-anchored content stays flush at any aspect ratio.

Source

pub fn bottom_anchored_from_viewport(viewport: [f32; 2]) -> Self

Build the “bottom-anchored” transform for a live logical viewport: the fit scale (no cropping, elements keep their proportions), but shifted vertically so the reference bottom edge (y = reference height) maps to the window bottom. Bottom-anchored overlay furniture (a dialog box and its controls) hugs the window bottom at any aspect ratio, where a plain fit would float it above the letterbox margin.

Source

pub fn scale(&self) -> f32

The uniform scale factor applied to sizes (glyph scale, sprite extent).

Source

pub fn forward(&self, x: f32, y: f32) -> (f32, f32)

Map a reference-space point to window space.

Source

pub fn inverse(&self, x: f32, y: f32) -> (f32, f32)

Map a window-space point back to reference space (the inverse of forward). Used to hit-test the live cursor against reference-space UI rects.

Trait Implementations§

Source§

impl Clone for OverlayTransform

Source§

fn clone(&self) -> OverlayTransform

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 OverlayTransform

Source§

impl Debug for OverlayTransform

Source§

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

Formats the value using the given formatter. Read more

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> 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, <T as TryFrom<U>>::Error>

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.