Struct awmpde::images::DynamicImage

pub struct DynamicImage(pub DynamicImage);

Tuple Fields

0: DynamicImage

Methods from Deref<Target = DynamicImage>

pub fn to_rgb(&self) -> ImageBuffer<Rgb<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_rgb8

Returns a copy of this image as an RGB image.

pub fn to_rgb8(&self) -> ImageBuffer<Rgb<u8>, Vec<u8, Global>>

Returns a copy of this image as an RGB image.

pub fn to_rgb16(&self) -> ImageBuffer<Rgb<u16>, Vec<u16, Global>>

Returns a copy of this image as an RGB image.

pub fn to_rgba(&self) -> ImageBuffer<Rgba<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_rgba8

Returns a copy of this image as an RGBA image.

pub fn to_rgba8(&self) -> ImageBuffer<Rgba<u8>, Vec<u8, Global>>

Returns a copy of this image as an RGBA image.

pub fn to_rgba16(&self) -> ImageBuffer<Rgba<u16>, Vec<u16, Global>>

Returns a copy of this image as an RGBA image.

pub fn to_bgr(&self) -> ImageBuffer<Bgr<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_bgr8

Returns a copy of this image as an BGR image.

pub fn to_bgr8(&self) -> ImageBuffer<Bgr<u8>, Vec<u8, Global>>

Returns a copy of this image as an BGR image.

pub fn to_bgra(&self) -> ImageBuffer<Bgra<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_bgra8

Returns a copy of this image as an BGRA image.

pub fn to_bgra8(&self) -> ImageBuffer<Bgra<u8>, Vec<u8, Global>>

Returns a copy of this image as an BGRA image.

pub fn to_luma(&self) -> ImageBuffer<Luma<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_luma8

Returns a copy of this image as a Luma image.

pub fn to_luma8(&self) -> ImageBuffer<Luma<u8>, Vec<u8, Global>>

Returns a copy of this image as a Luma image.

pub fn to_luma16(&self) -> ImageBuffer<Luma<u16>, Vec<u16, Global>>

Returns a copy of this image as a Luma image.

pub fn to_luma_alpha(&self) -> ImageBuffer<LumaA<u8>, Vec<u8, Global>>

👎 Deprecated:

replaced by to_luma_alpha8

Returns a copy of this image as a LumaA image.

pub fn to_luma_alpha8(&self) -> ImageBuffer<LumaA<u8>, Vec<u8, Global>>

Returns a copy of this image as a LumaA image.

pub fn to_luma_alpha16(&self) -> ImageBuffer<LumaA<u16>, Vec<u16, Global>>

Returns a copy of this image as a LumaA image.

pub fn crop(&mut self, x: u32, y: u32, width: u32, height: u32) -> DynamicImage

Return a cut-out of this image delimited by the bounding rectangle.

Note: this method does not modify the object, and its signature will be replaced with crop_imm()’s in the 0.24 release

pub fn crop_imm(&self, x: u32, y: u32, width: u32, height: u32) -> DynamicImage

Return a cut-out of this image delimited by the bounding rectangle.

pub fn as_rgb8(&self) -> Option<&ImageBuffer<Rgb<u8>, Vec<u8, Global>>>

Return a reference to an 8bit RGB image

pub fn as_mut_rgb8(
    &mut self
) -> Option<&mut ImageBuffer<Rgb<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit RGB image

pub fn as_bgr8(&self) -> Option<&ImageBuffer<Bgr<u8>, Vec<u8, Global>>>

Return a reference to an 8bit BGR image

pub fn as_mut_bgr8(
    &mut self
) -> Option<&mut ImageBuffer<Bgr<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit BGR image

pub fn as_rgba8(&self) -> Option<&ImageBuffer<Rgba<u8>, Vec<u8, Global>>>

Return a reference to an 8bit RGBA image

pub fn as_mut_rgba8(
    &mut self
) -> Option<&mut ImageBuffer<Rgba<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit RGBA image

pub fn as_bgra8(&self) -> Option<&ImageBuffer<Bgra<u8>, Vec<u8, Global>>>

Return a reference to an 8bit BGRA image

pub fn as_mut_bgra8(
    &mut self
) -> Option<&mut ImageBuffer<Bgra<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit RGBA image

pub fn as_luma8(&self) -> Option<&ImageBuffer<Luma<u8>, Vec<u8, Global>>>

Return a reference to an 8bit Grayscale image

pub fn as_mut_luma8(
    &mut self
) -> Option<&mut ImageBuffer<Luma<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit Grayscale image

pub fn as_luma_alpha8(&self) -> Option<&ImageBuffer<LumaA<u8>, Vec<u8, Global>>>

Return a reference to an 8bit Grayscale image with an alpha channel

pub fn as_mut_luma_alpha8(
    &mut self
) -> Option<&mut ImageBuffer<LumaA<u8>, Vec<u8, Global>>>

Return a mutable reference to an 8bit Grayscale image with an alpha channel

pub fn as_rgb16(&self) -> Option<&ImageBuffer<Rgb<u16>, Vec<u16, Global>>>

Return a reference to an 16bit RGB image

pub fn as_mut_rgb16(
    &mut self
) -> Option<&mut ImageBuffer<Rgb<u16>, Vec<u16, Global>>>

Return a mutable reference to an 16bit RGB image

pub fn as_rgba16(&self) -> Option<&ImageBuffer<Rgba<u16>, Vec<u16, Global>>>

Return a reference to an 16bit RGBA image

pub fn as_mut_rgba16(
    &mut self
) -> Option<&mut ImageBuffer<Rgba<u16>, Vec<u16, Global>>>

Return a mutable reference to an 16bit RGBA image

pub fn as_luma16(&self) -> Option<&ImageBuffer<Luma<u16>, Vec<u16, Global>>>

Return a reference to an 16bit Grayscale image

pub fn as_mut_luma16(
    &mut self
) -> Option<&mut ImageBuffer<Luma<u16>, Vec<u16, Global>>>

Return a mutable reference to an 16bit Grayscale image

pub fn as_luma_alpha16(
    &self
) -> Option<&ImageBuffer<LumaA<u16>, Vec<u16, Global>>>

Return a reference to an 16bit Grayscale image with an alpha channel

pub fn as_mut_luma_alpha16(
    &mut self
) -> Option<&mut ImageBuffer<LumaA<u16>, Vec<u16, Global>>>

Return a mutable reference to an 16bit Grayscale image with an alpha channel

pub fn as_flat_samples_u8(&self) -> Option<FlatSamples<&[u8]>>

Return a view on the raw sample buffer for 8 bit per channel images.

pub fn as_flat_samples_u16(&self) -> Option<FlatSamples<&[u16]>>

Return a view on the raw sample buffer for 16 bit per channel images.

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

Return this image’s pixels as a native endian byte slice.

pub fn to_bytes(&self) -> Vec<u8, Global>

Return a copy of this image’s pixels as a byte vector.

pub fn color(&self) -> ColorType

Return this image’s color type.

pub fn grayscale(&self) -> DynamicImage

Return a grayscale version of this image.

pub fn invert(&mut self)

Invert the colors of this image. This method operates inplace.

pub fn resize(
    &self,
    nwidth: u32,
    nheight: u32,
    filter: FilterType
) -> DynamicImage

Resize this image using the specified filter algorithm. Returns a new image. The image’s aspect ratio is preserved. The image is scaled to the maximum possible size that fits within the bounds specified by nwidth and nheight.

pub fn resize_exact(
    &self,
    nwidth: u32,
    nheight: u32,
    filter: FilterType
) -> DynamicImage

Resize this image using the specified filter algorithm. Returns a new image. Does not preserve aspect ratio. nwidth and nheight are the new image’s dimensions

pub fn thumbnail(&self, nwidth: u32, nheight: u32) -> DynamicImage

Scale this image down to fit within a specific size. Returns a new image. The image’s aspect ratio is preserved. The image is scaled to the maximum possible size that fits within the bounds specified by nwidth and nheight.

This method uses a fast integer algorithm where each source pixel contributes to exactly one target pixel. May give aliasing artifacts if new size is close to old size.

pub fn thumbnail_exact(&self, nwidth: u32, nheight: u32) -> DynamicImage

Scale this image down to a specific size. Returns a new image. Does not preserve aspect ratio. nwidth and nheight are the new image’s dimensions. This method uses a fast integer algorithm where each source pixel contributes to exactly one target pixel. May give aliasing artifacts if new size is close to old size.

pub fn resize_to_fill(
    &self,
    nwidth: u32,
    nheight: u32,
    filter: FilterType
) -> DynamicImage

Resize this image using the specified filter algorithm. Returns a new image. The image’s aspect ratio is preserved. The image is scaled to the maximum possible size that fits within the larger (relative to aspect ratio) of the bounds specified by nwidth and nheight, then cropped to fit within the other bound.

pub fn blur(&self, sigma: f32) -> DynamicImage

Performs a Gaussian blur on this image. sigma is a measure of how much to blur by.

pub fn unsharpen(&self, sigma: f32, threshold: i32) -> DynamicImage

Performs an unsharpen mask on this image. sigma is the amount to blur the image by. threshold is a control of how much to sharpen.

See https://en.wikipedia.org/wiki/Unsharp_masking#Digital_unsharp_masking

pub fn filter3x3(&self, kernel: &[f32]) -> DynamicImage

Filters this image with the specified 3x3 kernel.

pub fn adjust_contrast(&self, c: f32) -> DynamicImage

Adjust the contrast of this image. contrast is the amount to adjust the contrast by. Negative values decrease the contrast and positive values increase the contrast.

pub fn brighten(&self, value: i32) -> DynamicImage

Brighten the pixels of this image. value is the amount to brighten each pixel by. Negative values decrease the brightness and positive values increase it.

pub fn huerotate(&self, value: i32) -> DynamicImage

Hue rotate the supplied image. value is the degrees to rotate each pixel by. 0 and 360 do nothing, the rest rotates by the given degree value. just like the css webkit filter hue-rotate(180)

pub fn flipv(&self) -> DynamicImage

Flip this image vertically

pub fn fliph(&self) -> DynamicImage

Flip this image horizontally

pub fn rotate90(&self) -> DynamicImage

Rotate this image 90 degrees clockwise.

pub fn rotate180(&self) -> DynamicImage

Rotate this image 180 degrees clockwise.

pub fn rotate270(&self) -> DynamicImage

Rotate this image 270 degrees clockwise.

pub fn write_to<W, F>(&self, w: &mut W, format: F) -> Result<(), ImageError> where
    W: Write,
    F: Into<ImageOutputFormat>, 

Encode this image and write it to w

pub fn save<Q>(&self, path: Q) -> Result<(), ImageError> where
    Q: AsRef<Path>, 

Saves the buffer to a file at the path specified.

The image format is derived from the file extension.

pub fn save_with_format<Q>(
    &self,
    path: Q,
    format: ImageFormat
) -> Result<(), ImageError> where
    Q: AsRef<Path>, 

Saves the buffer to a file at the specified path in the specified format.

See save_buffer_with_format for supported types.

Trait Implementations

impl Deref for DynamicImage

type Target = DynamicImage

The resulting type after dereferencing.

pub fn deref(&self) -> &<DynamicImage as Deref>::Target

Dereferences the value.

impl DerefMut for DynamicImage

pub fn deref_mut(&mut self) -> &mut <DynamicImage as Deref>::Target

Mutably dereferences the value.

impl FromField for DynamicImage

type Error = Error

The associated error which can be returned.

type Future = Pin<Box<dyn Future<Output = Result<DynamicImage, <DynamicImage as FromField>::Error>> + 'static, Global>>

Future that resolves to a Self

pub fn from_field(field: Field) -> <DynamicImage as FromField>::Future