Struct Image

pub struct Image<'a> { /* private fields */ }

This is the structure of the image that will be created.

Use the new function to get started.

It is important to remember that the order in which elements are added to the image defines which element goes on top of which. For example, adding text that starts at point 0,0 and then adding a rectangle that also starts at the same point will cause the rectangle to cover the text. However, by reversing the order and adding the rectangle first, it will be placed underneath the text. It is essential to keep this order in mind when creating images with multiple elements to ensure that the elements are in the desired order.

Examples

let mut image = Image::new(500, 500, colors::WHITE);
image.add_text(Text::new("Image Builder"));
image.add_rect(Rect::new().size(200, 200)); // This rectangle covers the text.

let mut image = Image::new(500, 500, colors::WHITE);
image.add_rect(Rect::new().size(200, 200)); // This rectangle is in the background of the text.
image.add_text(Text::new("Image Builder"));

Implementations

impl<'a> Image<'a>

pub fn new(width: u32, height: u32, background: Color) -> Image<'a>

This method creates a new instance of an image, setting the background color, and size in pixels, and allocating memory to add fonts and elements to be drawn.

Example

use image_builder::{colors, Image};

let mut image = Image::new(400, 300, colors::GRAY);

pub fn add_custom_font(&mut self, name: &'a str, font: Vec<u8>)

The add_custom_font method requires that a .ttf font file (not provided) be loaded using fs.read, and internally linked to the provided name in a HashMap. This will allow you to use this font in your text by simply passing the font name as a parameter. Trying to use a font that has not been loaded cause the application to panic. Additionally, providing an invalid Vec will also result in a panic.

Example

use image_builder::Image;
use std::fs;
use image_builder::colors;

let mut image = Image::new(500, 500, colors::WHITE);
let roboto_bold = fs::read("fonts/Roboto/Roboto-Bold.ttf").unwrap();
image.add_custom_font("Roboto bold", roboto_bold);

pub fn add_picture(&mut self, picture: Picture)

With this method, it is possible to add an image on top of the image being built, taking into account transparent backgrounds. This means that transparent areas of the added image will not overlap areas already drawn in the main image. Please refer to the Picture for more details.

pub fn add_text(&mut self, text: Text)

This method allows for adding formatted text to the image being built. Refer to the Text for more details.

pub fn text_size(&mut self, text: &Text) -> (i32, i32)

This method can be used before add_text to reqeust the expected width and height of a text element.

pub fn add_rect(&mut self, rect: Rect)

This method allows for adding rectangular shapes to the image being built. Refer to the Rect for more details.

pub fn save(&mut self, file_name: &str)

The save method is responsible for the entire rendering process of the library. It creates the image buffer and renders the list of elements added in the order they were inserted by the user. Then, it creates the image file, adds the generated buffer, and encodes the content to save it to the disk.

Trait Implementations

impl<'a> Clone for Image<'a>

fn clone(&self) -> Image<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.