Skip to main content

ImageGeometry

Struct ImageGeometry 

#[non_exhaustive]
pub struct ImageGeometry { pub source: (u32, u32), pub orientation: ImageOrientation, pub content: Rect, pub bounds: Rect, }
Expand description

The placement of a source raster in a widget’s box, and the mapping between the box’s points and the source’s pixels.

compute places it; snapped moves the picture’s edges onto the device-pixel grid. A widget computes it once per layout, paints from it and maps input through it, so the pixel under the pointer is the pixel drawn there.

Fields (Non-exhaustive)§

This struct is marked as 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.
§source: (u32, u32)

The source size in pixels, before orientation.

§orientation: ImageOrientation

How the source is turned for display.

§content: Rect

Where the whole displayed picture lies, widget-local. It exceeds bounds where the fit crops.

§bounds: Rect

The widget’s box, widget-local: its origin is (0, 0).

Implementations§

§

impl ImageGeometry

pub fn new( source: (u32, u32), orientation: ImageOrientation, content: Rect, bounds: Rect, ) -> ImageGeometry

A placement computed elsewhere: content is where the whole displayed picture lies inside bounds, both widget-local.

pub fn compute( bounds: Size, source: (u32, u32), fit: ImageFit, alignment: Alignment, rtl: bool, orientation: ImageOrientation, ) -> ImageGeometry

A source-sized raster turned by orientation and fitted into a box of size bounds by fit, placed by alignment (rtl resolving Leading and Trailing). Not snapped.

pub fn snapped(self, to_device: Transform2D) -> ImageGeometry

The same placement with the picture’s four edges moved to the nearest device-pixel boundary.

to_device maps a widget-local point to device pixels: the widget’s window origin, any transform its ancestors apply, then the HiDPI scale. Snapping applies only when that keeps edges on edges, a transform with no rotation or shear; any other returns the placement unchanged. An edge moves by at most half a device pixel, and an axis snapping would collapse keeps its unsnapped edges. Snapping twice changes nothing more.

pub fn snaps_under(to_device: Transform2D) -> bool

Whether snapped moves edges under to_device: a transform with no rotation or shear, and a finite scale other than zero on both axes. A placement is the same under any two transforms it does not snap under.

pub fn displayed(&self) -> (u32, u32)

The source size as displayed: swapped for a quarter turn.

pub fn visible(&self) -> Option<Rect>

The part of the picture inside the box, widget-local; None when the two do not overlap.

pub fn map_to_source(&self, local: Point) -> Option<(u32, u32)>

The source pixel whose displayed square contains local, or None on the letterbox, outside the box, or with nothing to show.

pub fn map_to_source_clamped(&self, local: Point) -> Option<(u32, u32)>

The source pixel nearest local: the point is clamped into the picture first. None only with nothing to show.

pub fn map_to_source_f32(&self, local: Point) -> Option<(f32, f32)>

Continuous source coordinates of local, unclamped: pixel k spans [k, k + 1). None only with nothing to show.

pub fn map_from_source(&self, rect: PixelRect) -> Option<Rect>

Where the source pixels of rect are displayed, widget-local: the bounding box of their displayed squares. None when rect is empty or does not lie inside the source.

Trait Implementations§

§

impl Clone for ImageGeometry

§

fn clone(&self) -> ImageGeometry

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
§

impl Copy for ImageGeometry

§

impl Debug for ImageGeometry

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for ImageGeometry

§

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

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

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for ImageGeometry

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
§

impl<T> AnyEq for T
where T: Any + PartialEq,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

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

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
§

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

§

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
§

impl<T> Downcast for T
where T: Any,

§

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

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

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

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

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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.

§

impl<T> Instrument for T

§

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = Infallible

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

impl<T> Upcast<T> for T

§

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

§

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

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

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

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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