Struct Image

pub struct Image<T: Type, C: Color> {
    pub meta: Meta<T, C>,
    pub data: Box<dyn ImageData<T>>,
}

Image type

Fields

meta: Meta<T, C>

Metadata

data: Box<dyn ImageData<T>>

Pixel data

Implementations

impl<T: Type, C: Color> Image<T, C>

pub fn hash(&self) -> Hash

Get image hash

impl<T: Type, C: Color> Image<T, C>

pub fn new_with_data( size: impl Into<Size>, data: impl 'static + ImageData<T>, ) -> Result<Image<T, C>, Error>

Create a new image with the given size and data, returns Err if the provided ImageData isn’t big enough for the specified dimensions

pub fn new(size: impl Into<Size>) -> Image<T, C>

Create a new image

pub fn new_like(&self) -> Image<T, C>

Create a new image with the same size, type and color

pub fn new_like_with_type<U: Type>(&self) -> Image<U, C>

Create a new image with the same size and color as an existing image with the given type

pub fn new_like_with_color<D: Color>(&self) -> Image<T, D>

Create a new image with the same size and type as an existing image with the given color

pub fn new_like_with_type_and_color<U: Type, D: Color>(&self) -> Image<U, D>

Create a new image with the same size as an existing image with the given type and color

pub fn new_mmap( filename: impl AsRef<Path>, meta: Option<Meta<T, C>>, ) -> Result<Image<T, C>, Error>

New memory mapped image - if meta is None then it is assumed the image already exists on disk otherwise it will be created

pub fn mmap(self, filename: impl AsRef<Path>) -> Result<Image<T, C>, Error>

Map an existing image to disk, this consumes the original and returns the memory mapped image

pub fn channels(&self) -> Channel

Returns the number of channels

pub fn meta(&self) -> Meta<T, C>

Get image meta

pub fn width(&self) -> usize

Image width

pub fn height(&self) -> usize

Image height

pub fn shape(&self) -> (usize, usize, Channel)

Returns (width, height, channels)

pub fn size(&self) -> Size

Get image size

pub fn with_color<D: Color>(self) -> Image<T, D>

Update the colorspace associated with an image without performing any conversion

pub fn buffer(&self) -> &[u8]

Get image data as bytes

pub fn buffer_mut(&mut self) -> &mut [u8]

Get image data as mutable bytes

pub fn get(&self, pt: impl Into<Point>) -> Data<'_, T, C>

Get data at specified index

pub fn get_mut(&mut self, pt: impl Into<Point>) -> DataMut<'_, T, C>

Get mutable data at specified index

pub fn set(&mut self, pt: impl Into<Point>, data: impl AsRef<[T]>)

Set data to specified location

pub fn in_bounds(&self, pt: impl Into<Point>) -> bool

Returns true when (x, y) is in bounds for the given image

pub fn at(&self, pt: impl Into<Point>, px: impl AsMut<[T]>) -> bool

Get image data from an image, reusing an existing data buffer big enough for a single pixel

pub fn pixel_at(&self, pt: impl Into<Point>, px: &mut Pixel<C>) -> bool

Load data from and Image into an existing Pixel structure

pub fn new_pixel(&self) -> Pixel<C>

Get an empty pixel for the image color type

pub fn get_pixel(&self, pt: impl Into<Point>) -> Pixel<C>

Get a normalized pixel from an image

pub fn set_pixel(&mut self, pt: impl Into<Point>, px: &Pixel<C>)

Set a normalized pixel to the specified location

pub fn get_f(&self, pt: impl Into<Point>, c: Channel) -> f64

Get a normalized float value

pub fn set_f(&mut self, pt: impl Into<Point>, c: Channel, f: f64)

Set normalized float value

pub fn row(&self, y: usize) -> Data<'_, T, C>

Get row

pub fn row_mut(&mut self, y: usize) -> DataMut<'_, T, C>

Get mutable row

pub fn rows(&self) -> impl ParallelIterator<Item = (usize, &[T])>

Iterate over image rows

pub fn rows_mut(&mut self) -> impl ParallelIterator<Item = (usize, &mut [T])>

Iterate over mutable image rows

pub fn row_range( &self, y: usize, height: usize, ) -> impl ParallelIterator<Item = (usize, &[T])>

Iterate over image rows

pub fn row_range_mut( &mut self, y: usize, height: usize, ) -> impl ParallelIterator<Item = (usize, &mut [T])>

Iterate over mutable image rows

pub fn open(path: impl AsRef<Path>) -> Result<Image<T, C>, Error>

Read an image from disk

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write an image to disk

pub fn iter_region_mut( &mut self, roi: Region, ) -> impl ParallelIterator<Item = (Point, DataMut<'_, T, C>)>

Iterate over part of an image with mutable data access

pub fn iter_region( &self, roi: Region, ) -> impl ParallelIterator<Item = (Point, Data<'_, T, C>)>

Iterate over part of an image

pub fn iter(&self) -> impl ParallelIterator<Item = (Point, Data<'_, T, C>)>

Get pixel iterator

pub fn iter_mut( &mut self, ) -> impl ParallelIterator<Item = (Point, DataMut<'_, T, C>)>

Get mutable pixel iterator

pub fn for_each<F: Sync + Send + Fn(Point, DataMut<'_, T, C>)>(&mut self, f: F)

Iterate over each pixel applying f to every pixel

pub fn for_each_region<F: Sync + Send + Fn(Point, DataMut<'_, T, C>)>( &mut self, roi: Region, f: F, )

Iterate over a region of pixels qpplying f to every pixel

pub fn for_each2<F: Sync + Send + Fn(Point, DataMut<'_, T, C>, Data<'_, T, C>)>( &mut self, other: &Image<T, C>, f: F, )

Iterate over each pixel of two images at once

pub fn each_pixel<F: Sync + Send + FnMut(Point, &Pixel<C>)>(&self, f: F)

Iterate over pixels, with a mutable closure

pub fn each_pixel_region<F: Sync + Send + FnMut(Point, &Pixel<C>)>( &self, region: Region, f: F, )

Iterate over pixels in region, with a mutable closure

pub fn each_pixel_mut<F: Sync + Send + FnMut(Point, &mut Pixel<C>)>( &mut self, f: F, )

Iterate over mutable pixels, with a mutable closure

pub fn each_pixel_region_mut<F: Sync + Send + FnMut(Point, &mut Pixel<C>)>( &mut self, region: Region, f: F, )

Iterate over mutable pixels in region, with a mutable closure

pub fn crop(&self, roi: Region) -> Image<T, C>

Copy a region of an image to a new image

pub fn copy_from_region( &mut self, offs: impl Into<Point>, other: &Image<T, C>, roi: Region, )

Copy into a region from another image starting at the given offset

pub fn apply<U: Type, D: Color>( &mut self, filter: impl Filter<U, D, T, C>, input: &[&Image<U, D>], ) -> &mut Self

Apply a filter using an Image as output

pub async fn apply_async<'a, U: Type, D: Color>( &mut self, mode: AsyncMode, filter: impl Filter<U, D, T, C> + Unpin, input: &[&Image<U, D>], ) -> &mut Self

Apply an async filter using an Image as output

pub fn run_in_place(&mut self, filter: impl Filter<T, C>) -> &mut Self

Run a filter using the same Image as input and output

pub fn run<U: Type, D: Color>( &self, filter: impl Filter<T, C, U, D>, output: Option<Meta<U, D>>, ) -> Image<U, D>

Run a filter using an Image as input

pub async fn run_async<'a, U: 'a + Type, D: 'a + Color>( &self, mode: AsyncMode, filter: impl Filter<T, C, U, D> + Unpin, output: Option<Meta<U, D>>, ) -> Image<U, D>

Run an async filter using an Image as input

pub fn convert<U: Type, D: Color>(&self) -> Image<U, D>

Convert image type/color

pub fn convert_to<U: Type, D: Color>(&self, dest: &mut Image<U, D>)

Convert image type/color

pub fn histogram(&self, bins: usize) -> Vec<Histogram>

Get image histogram

pub fn gamma(&mut self, value: f64)

Gamma correction

pub fn set_gamma_log(&mut self)

Convert to log RGB

pub fn set_gamma_lin(&mut self)

Convert to linear RGB

pub fn resize(&self, size: impl Into<Size>) -> Image<T, C>

Resize an image

pub fn scale(&self, width: f64, height: f64) -> Image<T, C>

Scale an image

pub fn data(&self) -> &[T]

Image data

pub fn data_mut(&mut self) -> &mut [T]

Mutable image data

impl<T: Type, C: Color> Image<T, C>

pub fn draw_text<'a>( &mut self, text: impl AsRef<str>, font: &Font<'a>, size: f32, pos: impl Into<Point>, color: &Pixel<C>, )

Draw text on image

Trait Implementations

impl<T: Type, C: Color> Clone for Image<T, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X: Into<Point>, T: Type, C: Color> Index<X> for Image<T, C>

type Output = [T]

The returned type after indexing.

fn index(&self, pt: X) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<X: Into<Point>, T: Type, C: Color> IndexMut<X> for Image<T, C>

fn index_mut(&mut self, pt: X) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Type, C: Color> PartialEq for Image<T, C>

fn eq(&self, other: &Self) -> bool

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

const 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 ToTexture<f32, Rgb> for Image<f32, Rgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_126u32

OpenGL type

fn get_meta(&self) -> &Meta<f32, Rgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<f32, Rgba> for Image<f32, Rgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_126u32

OpenGL type

fn get_meta(&self) -> &Meta<f32, Rgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<f32, Srgb> for Image<f32, Srgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_126u32

OpenGL type

fn get_meta(&self) -> &Meta<f32, Srgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<f32, Srgba> for Image<f32, Srgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_126u32

OpenGL type

fn get_meta(&self) -> &Meta<f32, Srgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<i16, Rgb> for Image<i16, Rgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_122u32

OpenGL type

fn get_meta(&self) -> &Meta<i16, Rgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<i16, Rgba> for Image<i16, Rgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_122u32

OpenGL type

fn get_meta(&self) -> &Meta<i16, Rgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<i16, Srgb> for Image<i16, Srgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_122u32

OpenGL type

fn get_meta(&self) -> &Meta<i16, Srgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<i16, Srgba> for Image<i16, Srgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_122u32

OpenGL type

fn get_meta(&self) -> &Meta<i16, Srgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u16, Rgb> for Image<u16, Rgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_123u32

OpenGL type

fn get_meta(&self) -> &Meta<u16, Rgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u16, Rgba> for Image<u16, Rgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_123u32

OpenGL type

fn get_meta(&self) -> &Meta<u16, Rgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u16, Srgb> for Image<u16, Srgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_123u32

OpenGL type

fn get_meta(&self) -> &Meta<u16, Srgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u16, Srgba> for Image<u16, Srgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_123u32

OpenGL type

fn get_meta(&self) -> &Meta<u16, Srgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u8, Rgb> for Image<u8, Rgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_121u32

OpenGL type

fn get_meta(&self) -> &Meta<u8, Rgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u8, Rgba> for Image<u8, Rgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_121u32

OpenGL type

fn get_meta(&self) -> &Meta<u8, Rgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u8, Srgb> for Image<u8, Srgb>

const COLOR: u32 = 6_407u32

OpenGL color

const KIND: u32 = 5_121u32

OpenGL type

fn get_meta(&self) -> &Meta<u8, Srgb>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer

impl ToTexture<u8, Srgba> for Image<u8, Srgba>

const COLOR: u32 = 6_408u32

OpenGL color

const KIND: u32 = 5_121u32

OpenGL type

fn get_meta(&self) -> &Meta<u8, Srgba>

Get metadata

fn get_data(&self) -> &[u8]

Get data buffer

fn internal(&self) -> Result<u32, Error>

Get internal color type

fn create_image_texture( &self, gl: &Context, ) -> Result<ImageTexture<T, C>, Error>

Create ImageTexture

fn draw_image_texture( &self, gl: &Context, image_texture: &ImageTexture<T, C>, display_size: Size, offset: Point, ) -> Result<(), Error>

Draw the texture on the framebuffer