Struct riddle_image::packer::ImagePacker

pub struct ImagePacker { /* fields omitted */ }

Utility for packing multiple images to a single image.

Example

let mut img1 = Image::new(2,2);
let mut img2 = Image::new(3,3);
let packed = ImagePacker::new().pack(&[&img1, &img2]).unwrap();

assert!(packed.image().dimensions().x > 3 || packed.image().dimensions().y > 3);
assert_eq!(img1.dimensions(), packed.rects()[0].dimensions);
assert_eq!(img2.dimensions(), packed.rects()[1].dimensions);

Implementations

impl ImagePacker

pub fn new() -> Self

Create the ImagePacker, with default settings.

• Size Policy: ImagePackerSizePolicy::Pow2Square
• Padding: 0

pub fn size_policy(&mut self, policy: ImagePackerSizePolicy) -> &mut Self

Set the size policy for the packer. This controls how the packing algorithm sizes the output image, and how those dimensions grow if the algorithm needs to grow the output image.

Example

let mut img1 = Image::new(2,2);
let mut img2 = Image::new(3,3);
let packed = ImagePacker::new()
    .size_policy(ImagePackerSizePolicy::Fixed(Vector2::new(10, 10)))
    .pack(&[&img1, &img2]).unwrap();

assert_eq!(Vector2::new(10, 10), packed.image().dimensions());

pub fn padding(&mut self, amount: u32) -> &mut Self

The padding around each image in pixels.The gap between images will thus be twice the padding value.

Example

let mut img1 = Image::new(2,2);
let packed = ImagePacker::new()
    .size_policy(ImagePackerSizePolicy::Pow2Square)
    .padding(1)
    .pack(&[&img1]).unwrap();

assert_eq!(Vector2::new(4,4), packed.image().dimensions());
assert_eq!(Vector2::new(1,1), packed.rects()[0].location);

pub fn pack(
    &self,
    images: &[&Image]
) -> Result<ImagePackerResult, ImagePackerError>

Pack the slice of images provides in to a single image using the settings stored in the image packer. The values in ImagePackerResult::rects() will reference images in the same order as the slice provided.

If the slice is empty an Error result will be returned

Example

let mut img1 = Image::new(2,2);
let mut img2 = Image::new(3,3);
let packed = ImagePacker::new()
    .pack(&[&img1, &img2]).unwrap();

assert_eq!(Vector2::new(2, 2), packed.rects()[0].dimensions);
assert_eq!(Vector2::new(3, 3), packed.rects()[1].dimensions);

Trait Implementations

impl Default for ImagePacker

fn default() -> ImagePacker

Returns the “default value” for a type.