Struct embedded_graphics::image::SubImage[][src]

pub struct SubImage<'a, T> { /* fields omitted */ }
Expand description

Sub image.

A sub image is rectangular subsection of an ImageDrawable. It can, for example, be used to draw individual sprites from a larger sprite atlas.

To create a sub image call the sub_image method on the parent ImageDrawable. See the module-level documentation for an example.

Trait Implementations

impl<'a, T: Debug> Debug for SubImage<'a, T>[src]

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

Formats the value using the given formatter. Read more

impl<'a, T> ImageDrawable for SubImage<'a, T> where
    T: ImageDrawable
[src]

type Color = T::Color

The color type.

fn draw<DT>(&self, target: &mut DT) -> Result<(), DT::Error> where
    DT: DrawTarget<Color = Self::Color>, 
[src]

Draws the entire image to the target. Read more

fn draw_sub_image<DT>(
    &self,
    target: &mut DT,
    area: &Rectangle
) -> Result<(), DT::Error> where
    DT: DrawTarget<Color = Self::Color>, 
[src]

Draws a part of the image to the target. Read more

impl<T> OriginDimensions for SubImage<'_, T>[src]

fn size(&self) -> Size[src]

Returns the size of the bounding box.

Auto Trait Implementations

impl<'a, T> RefUnwindSafe for SubImage<'a, T> where
    T: RefUnwindSafe

impl<'a, T> Send for SubImage<'a, T> where
    T: Sync

impl<'a, T> Sync for SubImage<'a, T> where
    T: Sync

impl<'a, T> Unpin for SubImage<'a, T>

impl<'a, T> UnwindSafe for SubImage<'a, T> where
    T: RefUnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Dimensions for T where
    T: OriginDimensions
[src]

pub fn bounding_box(&self) -> Rectangle[src]

Returns the bounding box.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<Src, Dst> LosslessTryInto<Dst> for Src where
    Dst: LosslessTryFrom<Src>, 
[src]

pub fn lossless_try_into(self) -> Option<Dst>[src]

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src where
    Dst: LossyFrom<Src>, 
[src]

pub fn lossy_into(self) -> Dst[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V