Struct Image

pub struct Image<P: Pixel, U: GenericImage<Pixel = P>> { /* private fields */ }

Represents an image that can be passed to the merger. This is a wrapper around an image crate’s GenericImage and adds some additional functionality for the merger.

Type Parameters

• P - The pixel type of the underlying image.
• U - The underlying image type.

Example

use image_merger::{Image, Rgba};
use image::ImageBuffer;

let image: Image<Rgba<u8>, ImageBuffer<Rgba<u8>, Vec<u8>>> = Image::new(100, 100);
assert_eq!(image.capacity(), 100 * 100 * 4);

Note that this is for example, in practicality, you should use the BufferedImage type alias.

Implementations

impl<P: Pixel, U: GenericImage<Pixel = P>> Image<P, U>

pub fn capacity(&self) -> usize

Returns the capacity of the underlying image’s data buffer.

pub fn into_buffer(self) -> U

Consumes the image and returns the underlying image buffer.

impl<P, Container> Image<P, ImageBuffer<P, Container>>

where P: Pixel, Container: DerefMut<Target = [P::Subpixel]>,

pub fn new_from_raw( width: u32, height: u32, container: Container, ) -> Option<Self>

Creates a new image from a raw buffer. The buffer must be large enough to fit the image. Normally, you should use the new method to create a new image, as it is more idiomatic, unless you need to manually create an image from a raw buffer.

Arguments

• width - The width of the image.
• height - The height of the image.
• container - The raw buffer to create the image from.

Returns

An Image with the given pixel and buffer type. Will return None if the buffer is not large enough to fit the image.

impl<P: Pixel> Image<P, ImageBuffer<P, Vec<P::Subpixel>>>

pub fn new(width: u32, height: u32) -> Self

Creates a new image with the given width and height.

pub fn new_from_pixel(width: u32, height: u32, pixel: P) -> Self

Examples found in repository

examples/known_size_merger.rs (line 12)

fn generate_known_image() -> BufferedImage<Rgba<u8>> {
    // Create an image buffer with the given dimensions
    BufferedImage::new_from_pixel(IMAGE_WIDTH, IMAGE_HEIGHT, Rgba([255, 0, 0, 255]))
}

Trait Implementations

impl<P: Debug + Pixel, U: Debug + GenericImage<Pixel = P>> Debug for Image<P, U>

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

Formats the value using the given formatter.

impl<P: Pixel, U: GenericImage<Pixel = P>> Deref for Image<P, U>

Dereferences to the underlying image.

Type Parameters

• P - The pixel type of the underlying image.
• U - The underlying image type.

Example

use image_merger::{Image, Rgba, BufferedImage};
use image::ImageBuffer;

let image: BufferedImage<Rgba<u8>> = BufferedImage::new(100, 100);
let underlying: &ImageBuffer<Rgba<u8>, Vec<u8>> = &*image;

type Target = U

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P: Pixel, U: GenericImage<Pixel = P>> DerefMut for Image<P, U>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<P, Container> From<ImageBuffer<P, Container>> for Image<P, ImageBuffer<P, Container>>

where P: Pixel, Container: DerefMut<Target = [P::Subpixel]>,

A trait that allows the creation of an Image from a preexisting image::ImageBuffer.

Type Parameters

• P - The pixel type of the underlying image.
• Container - The underlying image buffer type. This must be dereferenceable to a slice of the underlying image’s subpixels.

Example

use image_merger::{Image, Rgba, BufferedImage};
use image::ImageBuffer;

let buf: ImageBuffer<Rgba<u8>, Vec<u8>> = ImageBuffer::new(100, 100);
let image: BufferedImage<Rgba<u8>> = BufferedImage::from(buf);

fn from(image: ImageBuffer<P, Container>) -> Self

Creates a new Image from a preexisting ImageBuffer.

Arguments

• image - The ImageBuffer to create an Image from.

impl<Container> FromWithFormat<Container> for Image<Luma<u16>, ImageBuffer<Luma<u16>, Vec<u16>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Luma, holding a subpixel type of u16 and an underlying ImageBuffer buffer that holds Vec<u16>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Luma<u8>, ImageBuffer<Luma<u8>, Vec<u8>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Luma, holding a subpixel type of u8 and an underlying ImageBuffer buffer that holds Vec<u8>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<LumaA<u16>, ImageBuffer<LumaA<u16>, Vec<u16>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of LumaA, holding a subpixel type of u16 and an underlying ImageBuffer buffer that holds Vec<u16>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<LumaA<u8>, ImageBuffer<LumaA<u8>, Vec<u8>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of LumaA, holding a subpixel type of u8 and an underlying ImageBuffer buffer that holds Vec<u8>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgb<f32>, ImageBuffer<Rgb<f32>, Vec<f32>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgb, holding a subpixel type of f32 and an underlying ImageBuffer buffer that holds Vec<f32>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgb<u16>, ImageBuffer<Rgb<u16>, Vec<u16>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgb, holding a subpixel type of u16 and an underlying ImageBuffer buffer that holds Vec<u16>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgb<u8>, ImageBuffer<Rgb<u8>, Vec<u8>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgb, holding a subpixel type of u8 and an underlying ImageBuffer buffer that holds Vec<u8>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgba<f32>, ImageBuffer<Rgba<f32>, Vec<f32>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgba, holding a subpixel type of f32 and an underlying ImageBuffer buffer that holds Vec<f32>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgba<u16>, ImageBuffer<Rgba<u16>, Vec<u16>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgba, holding a subpixel type of u16 and an underlying ImageBuffer buffer that holds Vec<u16>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<Container> FromWithFormat<Container> for Image<Rgba<u8>, ImageBuffer<Rgba<u8>, Vec<u8>>>

where Container: Deref<Target = [u8]>,

Implementation of FromWithFormat for an Image with a pixel type of Rgba, holding a subpixel type of u8 and an underlying ImageBuffer buffer that holds Vec<u8>’s.

fn from_with_format(container: Container, format: ImageFormat) -> Self

Transforms the given container and image format into an Image.

impl<P: Hash + Pixel, U: Hash + GenericImage<Pixel = P>> Hash for Image<P, U>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P: PartialEq + Pixel, U: PartialEq + GenericImage<Pixel = P>> PartialEq for Image<P, U>

fn eq(&self, other: &Image<P, U>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P: Eq + Pixel, U: Eq + GenericImage<Pixel = P>> Eq for Image<P, U>

impl<P: Pixel, U: GenericImage<Pixel = P>> StructuralPartialEq for Image<P, U>