flow-texpack 0.2.2

flow-texpack is a program that will allow you to generate texture atlas from input images (BMP, HDR, JPG, PNG, TGA, TIFF, WEBP). The application generates both texture atlas and descriptions file that can be read by a game.
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

// flow-texpack: A program that will allow you to generate texture atlas.
// zlib License (see LICENSE)

//! `flow-texpack` is a program that will allow you to generate texture atlas from input images (BMP,
//! HDR, JPG, PNG, TGA, TIFF, WEBP). The application generates both texture atlas and descriptions
//! file that can be read by a game.
//!
//! ## Usage
//! Show available options:
//! ```sh
//! flow-texpack -h
//! ```
//!
//! or
//!
//! ```sh
//! flow-texpack --help
//! ```
//!
//! ## Examples
//!
//! Generate from input `data/characters` and `data/tiles`, write output to `out/atlas` and enable
//! the options: `premultiply` pixels by their alpha channel, `trim` excess transparency off the
//! textures, `remove duplicate textures` from the atlas, enable `rotation` of textures 90 degrees
//! clockwise, `pad` each texture by 2 pixels and finally enable `verbose` output mode.
//!
//! ```sh
//! flow-texpack -i data/characters data/tiles -o out/atlas -m -t -u -r -p 2 -v
//! ```
//!
//! Enable `load filter` so that only `TGA` images are included in the texture atlas:
//!
//! ```sh
//! flow-texpack -i data/tiles -o out/atlas --load-filter tga -v
//! ```
//!
//! Enable rect heuristic `AreaFit`:
//!
//! ```sh
//! flow-texpack -i data/tiles -o out/atlas --rect-heuristic area-fit -v
//! ```
//!
//! Enable output `atlas size` of **2048x2048**:
//!
//! ```sh
//! flow-texpack -i data/tiles -o out/atlas --atlas-size pot2048 -v
//! ```
//!
//! Read input files/directories from `input.txt` but exclude all in `exclude.txt`:
//!
//! ```sh
//! flow-texpack --input-file input.txt --exlude-file exclude.txt -o out/atlas -v
//! ```
//!
//! `Adjust atlas size` automatically so that texture will fit:
//!
//! ```sh
//! flow-texpack -i data/characters -o out/atlas --adjust-size -v
//! ```
//!
//! `Adjust texture size` so that it will fit given atlas size:
//!
//! ```sh
//! flow-texpack -i data/characters -o out/atlas --adjust-fit -v
//! ```

#[doc(hidden)]
pub mod texpack;

// re-export types:
#[doc(hidden)]
pub use crate::texpack::app::App;

#[doc(hidden)]
pub use crate::texpack::app::get_atlas_image_extension;

#[doc(hidden)]
pub use crate::texpack::app::create_dir_all;

#[doc(hidden)]
pub use crate::texpack::app::remove_dir_all;

#[doc(hidden)]
pub use crate::texpack::app::remove_file;

#[doc(hidden)]
pub use crate::texpack::app::exists_dir;

#[doc(hidden)]
pub use crate::texpack::app::exists_file;

#[doc(hidden)]
pub use crate::texpack::app::write_file_sync;

#[doc(hidden)]
pub use crate::texpack::packer::Packer;

#[doc(hidden)]
pub use crate::texpack::packer::PackerError;

#[doc(hidden)]
pub use crate::texpack::texture::Texture;

#[doc(hidden)]
pub use crate::texpack::texture::TextureError;