Skip to main content

Image565View

Struct Image565View 

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

A read-only view of all or part of a statically stored RGB565 image.

A view borrows the original pixels without copying or allocating. Create a full-image view with Image565Fixed::view, or select a rectangular portion with Image565Fixed::view_rect.

Coordinates passed to Image565View::pixel_at are local to the view, so (0, 0) addresses the crop’s top-left pixel rather than the original image’s top-left pixel.

Views contain only color pixels and draw opaquely. For color-key transparency, draw an Image565Fixed with a MaskFixed, as shown in the MaskFixed example.

§Example

use device_envoy_core::cyd::{
    Cyd, CydDisplay,
    display::{CydFrame, DrawItem, Image565Fixed, tga},
};
use embedded_graphics::{
    prelude::{Point, Size},
    primitives::Rectangle,
};

const IMAGE: Image565Fixed<45, 73, { 45 * 73 }> = tga!(concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/docs/assets/cyd_fill_contiguous.tga"
))
.to_565();

async fn draw<C: Cyd>(cyd: &mut C) -> Result<(), C::Error> {
    let full_view = IMAGE.view();
    let source = Rectangle::new(Point::new(2, 35), Size::new(41, 36));
    let cropped_view = IMAGE.view_rect(source);

    assert_eq!(cropped_view.size(), source.size);
    assert_eq!(
        cropped_view.pixel_at(Point::zero()),
        full_view.pixel_at(source.top_left),
    );
    assert_eq!(
        cropped_view.rgb565_iter().count(),
        source.size.width as usize * source.size.height as usize,
    );

    let display = cyd.display();
    let mut frame = display.full_frame_mut();
    DrawItem::Bitmap {
        view: full_view,
        top_left: Point::new(80, 84),
    }
    .draw(&mut frame);
    DrawItem::Bitmap {
        view: cropped_view,
        top_left: Point::new(200, 102),
    }
    .draw(&mut frame);
    frame.flush().await
}

The complete image is shown on the left and its cropped view on the right:

A complete RGB565 image beside a cropped view of the same image

Implementations§

Source§

impl Image565View

Source

pub const fn new(pixels: &'static [u16], size: Size) -> Self

Creates a full-image view from a row-major RGB565 pixel slice.

Use this when pixels are already available as packed RGB565 values. For a compile-time TGA image, prefer Image565Fixed::view, as shown in the Image565View example.

Panics if pixels.len() != size.width * size.height.

Source

pub const fn size(&self) -> Size

Returns this view’s dimensions.

For a cropped view, these are the crop dimensions rather than the full image dimensions. See the Image565View example.

Source

pub fn pixel_at(&self, point: Point) -> Rgb565

Returns the pixel at a view-local coordinate.

(0, 0) is the top-left of this view, not necessarily the top-left of the underlying image. See the Image565View example.

Panics if point is outside the view.

Source

pub fn rgb565_iter(&self) -> impl Iterator<Item = Rgb565> + '_

Iterate over the view’s pixels in row-major order as Rgb565 values.

Cropped views skip the pixels outside the view while preserving the view’s local row order.

See the Image565View example.

Trait Implementations§

Source§

impl Clone for Image565View

Source§

fn clone(&self) -> Image565View

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 Image565View

Source§

impl Debug for Image565View

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> Az for T

Source§

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

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

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§

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

Casts the value.
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> OverflowingAs for T

Source§

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§

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

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

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§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

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§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> WrappingAs for T

Source§

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§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.