Struct Picture

pub struct Picture { /* private fields */ }

External images.

The Picture structure is responsible for defining and adjusting external images that will be included in the image being built. It allows for cropping, resizing, and positioning to compose the final image.

⚠️ It’s important to note that if there is both cropping and resizing on the same image, the library will always perform cropping first, and then resizing. ⚠️

Example

use image_builder::Picture;
use image::DynamicImage;

Picture::new(file_bytes)
    .resize(100, 100, FilterType::Triangle) // Resizing is specified here, but the library will first perform the cropping below, and then this resizing.
    .crop(50, 50, 200, 200);

In the example above, an image of 300x300 pixels was imported, a square of 200x200 pixels was cropped, and then this cropped portion was resized by half, resulting in an image of 100x100 pixels.

Implementations

impl Picture

pub fn new(img: DynamicImage) -> Picture

This method instantiates an external image using the file path of the image and positions it at the point (0,0) of the image being built.

Example

use image::DynamicImage;
use image_builder::Picture;

Picture::new(image);

pub fn resize(&mut self, width: u32, height: u32, filter: FilterType) -> Self

This method allows resizing an image by specifying the desired new height, width and FilterType.

Example

use image_builder::Picture;

Picture::new("/home/user/logo.png")
    .resize(200, 100, FilterType::Triangle);

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

Use this method to crop an imported image by providing the starting point of the crop (x, y), as well as the desired height and width to be cropped.

Example

use image_builder::Picture;

Picture::new("/home/user/logo.png")
    .crop(50, 50, 200, 200);

pub fn position(&mut self, x: u32, y: u32) -> Self

This method allows you to adjust the position of the imported image within the image being constructed.

Example

use image_builder::Picture;

Picture::new("/home/user/logo.png")
    .position(100, 100);

Trait Implementations

impl Clone for Picture

fn clone(&self) -> Picture

Returns a copy of the value.

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

Performs copy-assignment from source.