Struct OffsetZonedObjectiveImage

pub(crate) struct OffsetZonedObjectiveImage {
    offset: Vec2D<u32>,
    image_buffer: ImageBuffer<Rgb<u8>, Vec<u8>>,
}

Fields

offset: Vec2D<u32>

image_buffer: ImageBuffer<Rgb<u8>, Vec<u8>>

Implementations

impl OffsetZonedObjectiveImage

pub fn new(offset: Vec2D<u32>, dimensions: Vec2D<u32>) -> Self

pub fn update_area<I: GenericImageView<Pixel = Rgb<u8>>>( &mut self, offset: Vec2D<u32>, image: &I, )

fn export_as_png(&self) -> Result<EncodedImageExtract, Box<dyn Error>>

Trait Implementations

impl GenericImageView for OffsetZonedObjectiveImage

type Pixel = Rgb<u8>

The type of pixel.

fn dimensions(&self) -> (u32, u32)

The width and height of this image.

fn get_pixel(&self, x: u32, y: u32) -> Self::Pixel

Returns the pixel located at (x, y). Indexed from top left.

fn width(&self) -> u32

The width of this image.

fn height(&self) -> u32

The height of this image.

fn in_bounds(&self, x: u32, y: u32) -> bool

Returns true if this x, y coordinate is contained inside the image.

unsafe fn unsafe_get_pixel(&self, x: u32, y: u32) -> Self::Pixel

Returns the pixel located at (x, y). Indexed from top left.

fn pixels(&self) -> Pixels<'_, Self>

where Self: Sized,

Returns an Iterator over the pixels of this image. The iterator yields the coordinates of each pixel along with their value

fn view(&self, x: u32, y: u32, width: u32, height: u32) -> SubImage<&Self>

where Self: Sized,

Returns a subimage that is an immutable view into this image. You can use [GenericImage::sub_image] if you need a mutable view instead. The coordinates set the position of the top left corner of the view.

impl MapImage for OffsetZonedObjectiveImage

type Pixel = Rgb<u8>

The type of the pixels in the image.

type Container = Vec<u8>

The container for the pixel data.

type ViewSubBuffer = OffsetZonedObjectiveImage

A view of a sub-region of the image.

fn mut_vec_view( &mut self, offset: Vec2D<u32>, ) -> SubBuffer<&mut ImageBuffer<Self::Pixel, Self::Container>>

Provides a mutable view of the image at the specified offset.

fn vec_view( &self, offset: Vec2D<u32>, size: Vec2D<u32>, ) -> SubBuffer<&Self::ViewSubBuffer>

Provides a view of a sub-region of the image.

fn buffer(&self) -> &ImageBuffer<Self::Pixel, Self::Container>

Returns a reference to the entire image buffer.

fn export_as_png(&self) -> Result<EncodedImageExtract, Box<dyn Error>>

where [<Self::Pixel as Pixel>::Subpixel]: EncodableLayout,

Exports the entire image buffer as a PNG.

fn export_area_as_png( &self, offset: Vec2D<u32>, size: Vec2D<u32>, ) -> Result<EncodedImageExtract, Box<dyn Error>>

where [<<Self::ViewSubBuffer as GenericImageView>::Pixel as Pixel>::Subpixel]: EncodableLayout,

Exports a specific sub-region of the image as a PNG.

fn create_snapshot<P: AsRef<Path>>(&self, path: P) -> Result<(), Box<dyn Error>>

where [<Self::Pixel as Pixel>::Subpixel]: EncodableLayout,

Saves the current image buffer as a snapshot in PNG format.

fn update_area<I: GenericImageView<Pixel = Self::Pixel>>( &mut self, offset: Vec2D<u32>, image: &I, )

Updates a specific sub-region of the image with the given data.