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

//! Core library for packing textures into atlases.
//!
//! - Algorithms: Skyline (BL/MW + optional Waste Map), MaxRects (BAF/BSSF/BLSF/BL/CP), Guillotine (choice + split)
//! - Pipeline: `pack_images` takes in-memory images and returns pages + metadata
//! - Data model is serde-serializable; exporters are provided in helpers and the CLI crate.
//!
//! Quick example:
//! ```ignore
//! use image::ImageReader;
//! use tex_packer_core::{InputImage, PackerConfig, pack_images};
//! # fn main() -> anyhow::Result<()> {
//! let img1 = ImageReader::open("a.png")?.decode()?;
//! let img2 = ImageReader::open("b.png")?.decode()?;
//! let inputs = vec![
//!   InputImage { key: "a".into(), image: img1 },
//!   InputImage { key: "b".into(), image: img2 },
//! ];
//! let cfg = PackerConfig { max_width: 1024, max_height: 1024, ..Default::default() };
//! let out = pack_images(inputs, cfg)?;
//! println!("pages: {}", out.pages.len());
//! # Ok(()) }
//! ```

pub mod compositing;
pub mod config;
pub mod error;
pub mod export;
mod export_manifest;
pub mod export_plist;
mod free_space;
mod geometry;
pub mod model;
pub mod packer;
pub mod pipeline;
mod preparation;
pub mod runtime;
pub mod runtime_atlas;
mod runtime_placement;

pub use config::*;
pub use error::*;
pub use export::*;
pub use export_manifest::{TemplateContext, TemplatePage, TemplateSprite, to_template_context};
pub use export_plist::*;
pub use model::*;
pub use packer::*;
pub use pipeline::*;
pub use preparation::compute_trim_rect;

/// Convenience prelude for common types and functions.
/// Importing `tex_packer_core::prelude::*` brings the primary APIs into scope.
pub mod prelude {
    pub use crate::config::{
        AlgorithmFamily, AutoMode, GuillotineChoice, GuillotineSplit, MaxRectsHeuristic,
        PackerConfig, PackerConfigBuilder, SkylineHeuristic, SortOrder,
    };
    pub use crate::model::{Atlas, Frame, Meta, PackStats, Page, Rect};
    pub use crate::pipeline::LayoutItem;
    pub use crate::runtime::{AtlasSession, RuntimeStats, RuntimeStrategy, ShelfPolicy};
    pub use crate::runtime_atlas::{RuntimeAtlas, UpdateRegion};
    pub use crate::{
        InputImage, OutputPage, PackOutput, pack_images, pack_layout, pack_layout_items,
    };
}