tex-packer-core 0.2.0

Core algorithms and API for packing images into texture atlases (Skyline / MaxRects / Guillotine). Returns pages (RGBA) and metadata (JSON/Plist/templates).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

mod guillotine;
mod shelf;
mod skyline;

use self::guillotine::RuntimeGuillotine;
use self::shelf::RuntimeShelfPlacement;
use self::skyline::RuntimeSkyline;
use crate::config::PackerConfig;
use crate::geometry::PackingContext;
use crate::model::{Frame, Rect};
use crate::runtime::RuntimeStrategy;
use std::collections::HashMap;

pub(crate) struct RuntimePage {
    pub(crate) id: usize,
    pub(crate) width: u32,
    pub(crate) height: u32,
    // Used map of reserved slots (expanded by padding/extrude)
    pub(crate) used: HashMap<String, (Rect, bool, Frame<String>)>, // (reserved_slot, rotated, frame)
    allow_rotation: bool,
    placement: RuntimePlacement,
}

enum RuntimePlacement {
    Guillotine(RuntimeGuillotine),
    Shelf(RuntimeShelfPlacement),
    Skyline(RuntimeSkyline),
}

impl RuntimePlacement {
    fn free_area_and_rects(&self) -> (u64, usize) {
        match self {
            Self::Guillotine(strategy) => strategy.free_area_and_rects(),
            Self::Shelf(strategy) => strategy.free_area_and_rects(),
            Self::Skyline(strategy) => strategy.free_area_and_rects(),
        }
    }

    fn choose(&self, allow_rotation: bool, w: u32, h: u32) -> Option<(Rect, bool)> {
        match self {
            Self::Guillotine(strategy) => strategy.choose(allow_rotation, w, h),
            Self::Shelf(strategy) => strategy.choose(allow_rotation, w, h),
            Self::Skyline(strategy) => strategy.choose(allow_rotation, w, h),
        }
    }

    fn place(&mut self, slot: &Rect) {
        match self {
            Self::Guillotine(strategy) => strategy.place(slot),
            Self::Shelf(strategy) => strategy.place(slot),
            Self::Skyline(strategy) => strategy.place(slot),
        }
    }

    fn add_free(&mut self, rect: Rect) {
        match self {
            Self::Guillotine(strategy) => strategy.add_free(rect),
            Self::Shelf(strategy) => strategy.add_free(rect),
            Self::Skyline(strategy) => strategy.add_free(rect),
        }
    }
}

impl RuntimePage {
    pub(crate) fn new(
        id: usize,
        width: u32,
        height: u32,
        cfg: &PackerConfig,
        strategy: &RuntimeStrategy,
    ) -> Self {
        let ctx = PackingContext::new(cfg);
        let usable = if ctx.max_dimensions() == (width, height) {
            ctx.usable_area()
        } else {
            let pad = ctx.border_padding();
            Rect::new(
                pad,
                pad,
                width.saturating_sub(pad.saturating_mul(2)),
                height.saturating_sub(pad.saturating_mul(2)),
            )
        };
        let placement = match strategy {
            RuntimeStrategy::Guillotine => {
                RuntimePlacement::Guillotine(RuntimeGuillotine::new(usable, cfg))
            }
            RuntimeStrategy::Shelf(policy) => {
                RuntimePlacement::Shelf(RuntimeShelfPlacement::new(usable, *policy))
            }
            RuntimeStrategy::Skyline(heuristic) => {
                RuntimePlacement::Skyline(RuntimeSkyline::new(usable, heuristic.clone()))
            }
        };
        Self {
            id,
            width,
            height,
            used: HashMap::new(),
            allow_rotation: cfg.allow_rotation,
            placement,
        }
    }

    pub(crate) fn used_area(&self) -> u64 {
        self.used
            .values()
            .map(|(slot, _rot, _frame)| (slot.w as u64) * (slot.h as u64))
            .sum()
    }

    pub(crate) fn free_area_and_rects(&self) -> (u64, usize) {
        self.placement.free_area_and_rects()
    }

    pub(crate) fn choose(&self, w: u32, h: u32) -> Option<(Rect, bool)> {
        self.placement.choose(self.allow_rotation, w, h)
    }

    pub(crate) fn place(&mut self, key: &str, slot: &Rect, frame: &Frame<String>, rotated: bool) {
        self.placement.place(slot);
        self.used
            .insert(key.to_string(), (*slot, rotated, frame.clone()));
    }

    pub(crate) fn add_free(&mut self, rect: Rect) {
        self.placement.add_free(rect);
    }
}