Struct embedded_graphics::image::SubImage

source · [−]

pub struct SubImage<'a, T> { /* private fields */ }

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

source

impl<'a, T: Debug> Debug for SubImage<'a, T>

source

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

Formats the value using the given formatter. Read more

source

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

type Color = T::Color

The color type.

source

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

Draws the entire image to the target. Read more

source

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

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

source

impl<T> OriginDimensions for SubImage<'_, T>

source

fn size(&self) -> Size

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

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Az for T

source

pub fn az<Dst>(self) -> Dst where
T: Cast<Dst>,

Casts the value.

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Src, Dst> CastFrom<Src> for Dst where
Src: Cast<Dst>,

source

pub fn cast_from(src: Src) -> Dst

Casts the value.

source

impl<T> CheckedAs for T

source

pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,

Casts the value.

source

impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,

source

pub fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

source

impl<T> Dimensions for T where
T: OriginDimensions,

source

pub fn bounding_box(&self) -> Rectangle

Returns the bounding box.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub 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> OverflowingAs for T

source

pub fn overflowing_as<Dst>(self) -> (Dst, bool ) where
T: OverflowingCast<Dst>,

Casts the value.

source

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,

source

pub fn overflowing_cast_from(src: Src) -> (Dst, bool )

OverflowingCasts the value.

source

impl<T> SaturatingAs for T

source

pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,

Casts the value.

source

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,

source

pub fn saturating_cast_from(src: Src) -> Dst

Casts the value.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> UnwrappedAs for T

source

pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,

Casts the value.

source

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,

source

pub fn unwrapped_cast_from(src: Src) -> Dst

UnwrappedCasts the value.

source

impl<T> WrappingAs for T

source

pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,

Casts the value.

source

impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,

source

pub fn wrapping_cast_from(src: Src) -> Dst

WrappingCasts the value.

Struct embedded_graphics::image::SubImage

Trait Implementations

impl<'a, T: Debug> Debug for SubImage<'a, T>

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

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

type Color = T::Color

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

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

impl<T> OriginDimensions for SubImage<'_, T>

fn size(&self) -> Size

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,

pub fn type_id(&self) -> TypeId

impl<T> Az for T

pub fn az<Dst>(self) -> Dst where T: Cast<Dst>,

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<Src, Dst> CastFrom<Src> for Dst where Src: Cast<Dst>,

pub fn cast_from(src: Src) -> Dst

impl<T> CheckedAs for T

pub fn checked_as<Dst>(self) -> Option<Dst> where T: CheckedCast<Dst>,

impl<Src, Dst> CheckedCastFrom<Src> for Dst where Src: CheckedCast<Dst>,

pub fn checked_cast_from(src: Src) -> Option<Dst>

impl<T> Dimensions for T where T: OriginDimensions,

pub fn bounding_box(&self) -> Rectangle

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> OverflowingAs for T

pub fn overflowing_as<Dst>(self) -> (Dst, bool) where T: OverflowingCast<Dst>,

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where Src: OverflowingCast<Dst>,

pub fn overflowing_cast_from(src: Src) -> (Dst, bool)

impl<T> SaturatingAs for T

pub fn saturating_as<Dst>(self) -> Dst where T: SaturatingCast<Dst>,

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where Src: SaturatingCast<Dst>,

pub fn saturating_cast_from(src: Src) -> Dst

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

impl<T> UnwrappedAs for T

pub fn unwrapped_as<Dst>(self) -> Dst where T: UnwrappedCast<Dst>,

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where Src: UnwrappedCast<Dst>,

pub fn unwrapped_cast_from(src: Src) -> Dst

impl<T> WrappingAs for T

pub fn wrapping_as<Dst>(self) -> Dst where T: WrappingCast<Dst>,

impl<Src, Dst> WrappingCastFrom<Src> for Dst where Src: WrappingCast<Dst>,

pub fn wrapping_cast_from(src: Src) -> Dst

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

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

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

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> UnwindSafe for SubImage<'a, T> where
T: RefUnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

pub fn az<Dst>(self) -> Dst where
T: Cast<Dst>,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Src, Dst> CastFrom<Src> for Dst where
Src: Cast<Dst>,

pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,

impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,

impl<T> Dimensions for T where
T: OriginDimensions,

impl<T, U> Into<U> for T where
U: From<T>,

pub fn overflowing_as<Dst>(self) -> (Dst, bool ) where
T: OverflowingCast<Dst>,

impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,

pub fn overflowing_cast_from(src: Src) -> (Dst, bool )

pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,

impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,

pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,

impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,