Enum ikon::Image

pub enum Image {
    Raster(DynamicImage),
    Svg(Tree),
}

A uniun type for raster and vector graphics.

Variants

Raster(DynamicImage)

A generic raster image.

Svg(Tree)

A svg-encoded vector image.

Methods

impl Image

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Attempts to create a Image from a given path.

Return Value

• Returns Ok(src) if the file indicated by the path argument could be successfully parsed into an image.
• Returns Err(io::Error::from(io::ErrorKind::Other)) if the image allocation failed or if the file was not able to be accessed.
• Returns Err(io::Error::from(io::ErrorKind::InvalidInput)) if the image format is not supported by ikon.
• Returns Err(io::Error::from(io::ErrorKind::InvalidData)) otherwise.

pub fn load<R: Read + Seek>(read: R) -> Result<Self, Error>

Attempts to create a Image from a byte stream.

Return Value

• Returns Ok(src) if the stram indicated by the read argument could be successfully parsed into an image.
• Returns Err(io::Error::from(io::ErrorKind::Other)) if the image allocation failed.
• Returns Err(io::Error::from(io::ErrorKind::InvalidInput)) if the image format is not supported by ikon.
• Returns Err(io::Error::from(io::ErrorKind::InvalidData)) otherwise.

pub fn rasterize<F: FnMut(&DynamicImage, (u32, u32)) -> Result<DynamicImage>>(
    &self,
    filter: F,
    size: (u32, u32)
) -> Result<DynamicImage, ResampleError>

Rasterizes the Image to a DynamicImage.

For raster graphics the moethod simply applies the resampling filter specified by the filter argument. For vector graphics, the method rasterizes the image to fit the dimensions specified size using linear interpolation and anti-aliasing.

pub fn width(&self) -> f64

Returns the width of the image in pixel units.

pub fn height(&self) -> f64

Returns the height of the image in pixel units.

pub fn dimensions(&self) -> (f64, f64)

Returns the dimensions of the image in pixel units.

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<DynamicImage> for Image

fn from(bit: DynamicImage) -> Self

Performs the conversion.

impl From<Tree> for Image

fn from(svg: Tree) -> Self

Performs the conversion.

impl Send for Image

impl Sync for Image