Struct FullsizeMapImage

pub(crate) struct FullsizeMapImage {
    image_buffer: ImageBuffer<Rgb<u8>, FileBackedBuffer>,
}

A struct representing a full-sized map image.

This struct manages the full-sized map image which includes a coverage bitmap and an image buffer backed by a memory-mapped file. It provides functionality to open and handle the image buffer efficiently.

Fields

image_buffer: ImageBuffer<Rgb<u8>, FileBackedBuffer>

The image buffer containing the pixel data, backed by a file.

Implementations

impl FullsizeMapImage

pub(crate) fn open<P: AsRef<Path>>(path: P) -> Self

Opens a full-sized map image from a file.

This function initializes a FileBackedBuffer for efficient memory-mapped file access and creates an ImageBuffer using the data in the mapped file.

Arguments

• path - The file path of the image to open.

Returns

An instance of FullsizeMapImage with the coverage bitmap initialized and the image buffer mapped to the file.

Panics

This function will panic if:

• The FileBackedBuffer cannot be created.
• The ImageBuffer cannot be created from the FileBackedBuffer.

Trait Implementations

impl GenericImageView for FullsizeMapImage

type Pixel = Rgb<u8>

The pixel type used by the image buffer, in this case, Rgba<u8>.

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

Returns the dimensions of the image buffer as a tuple (width, height).

Returns

A tuple containing the width and height of the image buffer.

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

Retrieves the pixel at the given (x, y) coordinates.

If the pixel is covered (as checked by the coverage bitmap), the corresponding pixel data from the image buffer will be returned with an alpha value of 0xFF (fully opaque). Otherwise, a transparent black pixel [0, 0, 0, 0] is returned.

Arguments

• x - The horizontal coordinate of the pixel.
• y - The vertical coordinate of the pixel.

Returns

An Rgba<u8> pixel that is either from the image buffer (if covered) or a transparent black pixel (if not covered).

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 FullsizeMapImage

type Pixel = Rgb<u8>

The pixel type for the image, in this case Rgb<u8>.

type Container = FileBackedBuffer

The container type for the pixel data, in this case FileBackedBuffer used for memory-mapped file access.

type ViewSubBuffer = FullsizeMapImage

The view type for a sub-region of the image, implemented as FullsizeMapImage.

fn mut_vec_view( &mut self, offset: Vec2D<u32>, ) -> SubBuffer<&mut ImageBuffer<Rgb<u8>, FileBackedBuffer>>

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

Arguments

• offset - The top-left corner of the region to view.

Returns

A SubBuffer containing a mutable reference to the image buffer starting from the specified offset.

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

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

Arguments

• offset - The top-left corner of the region to view.
• size - The dimensions of the region to view.

Returns

A SubBuffer containing a reference to the FullsizeMapImage starting from the specified offset and region size.

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

Returns a reference to the entire image buffer.

Returns

A reference to the ImageBuffer containing the RGB pixel data.

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.