Struct SubBuffer

pub(crate) struct SubBuffer<T> {
    pub(crate) buffer: T,
    pub(crate) buffer_size: Vec2D<u32>,
    pub(crate) offset: Vec2D<u32>,
    pub(crate) size: Vec2D<u32>,
}

A sub-region of an image, represented as a buffer with bounds. This struct allows for accessing and modifying a subsection of the image efficiently.

Fields

buffer: T

The underlying image buffer.

buffer_size: Vec2D<u32>

The size of the entire buffer in pixels.

offset: Vec2D<u32>

The offset of this sub-buffer within the overall buffer.

size: Vec2D<u32>

The dimensions of the sub-buffer.

Trait Implementations

impl<T> GenericImage for SubBuffer<T>

where T: DerefMut, T::Target: GenericImage + Sized,

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

👎Deprecated since 0.24.0: Use get_pixel and put_pixel instead.

Fetches a mutable reference to a pixel within the sub-buffer at the specified coordinates.

Arguments

• x - The x-coordinate of the pixel to fetch.
• y - The y-coordinate of the pixel to fetch.

Returns

A mutable reference to the pixel at the specified coordinates.

fn put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

Writes a pixel to the sub-buffer at the specified coordinates.

Arguments

• x - The x-coordinate where the pixel will be written.
• y - The y-coordinate where the pixel will be written.
• pixel - The pixel to write at the specified coordinates.

fn blend_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

👎Deprecated since 0.24.0: Use iterator pixels_mut to blend the pixels directly

Blends a pixel with the pixel at the specified coordinates within the sub-buffer.

Arguments

• x - The x-coordinate where the pixel will be blended.
• y - The y-coordinate where the pixel will be blended.
• pixel - The pixel to blend at the specified coordinates.

unsafe fn unsafe_put_pixel(&mut self, x: u32, y: u32, pixel: Self::Pixel)

Puts a pixel at location (x, y). Indexed from top left.

fn copy_from<O>(&mut self, other: &O, x: u32, y: u32) -> Result<(), ImageError>

where O: GenericImageView<Pixel = Self::Pixel>,

Copies all of the pixels from another image into this image.

fn copy_within(&mut self, source: Rect, x: u32, y: u32) -> bool

Copies all of the pixels from one part of this image to another part of this image.

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

where Self: Sized,

Returns a mutable subimage that is a view into this image. If you want an immutable subimage instead, use [GenericImageView::view] The coordinates set the position of the top left corner of the SubImage.

impl<T> GenericImageView for SubBuffer<T>

where T: Deref, T::Target: GenericImageView + Sized,

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

Returns the dimensions of the sub-buffer in pixels.

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

Fetches a pixel from the sub-buffer at the specified coordinates.

Arguments

• x - The x-coordinate of the pixel to fetch.
• y - The y-coordinate of the pixel to fetch.

Returns

The pixel at the specified coordinates.

type Pixel = <<T as Deref>::Target as GenericImageView>::Pixel

The type of pixel.

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.