This is the patchwork Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:31:35 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
patchworkA spritesheet packer for games.
Michael Fiano <mail@mfiano.net>
MIT
binpack (system).
mfiano-utils (system).
opticl (system).
uiop (system).
package.lisp (file).
packer.lisp (file).
unpacker.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
patchwork/packer.lisppackage.lisp (file).
patchwork (system).
make-atlas (function).
make-atlas-from-directory (function).
rect-initargs (method).
add-padding (function).
collect-files (function).
file (reader method).
make-coords (generic function).
make-id (function).
make-rects (function).
rect (function).
rect (class).
remove-padding (function).
write-atlas (function).
write-metadata (function).
patchwork/unpacker.lisppacker.lisp (file).
patchwork (system).
unpack-atlas (function).
%make-atlas-coords (generic function).
make-atlas-coords (function).
make-sprite-path (function).
unpack-sprite (function).
write-sprite (function).
Packages are listed by definition order.
patchworkcommon-lisp.
make-atlas (function).
make-atlas-from-directory (function).
unpack-atlas (function).
%make-atlas-coords (generic function).
add-padding (function).
collect-files (function).
file (generic reader).
make-atlas-coords (function).
make-coords (generic function).
make-id (function).
make-rects (function).
make-sprite-path (function).
rect (function).
rect (class).
remove-padding (function).
unpack-sprite (function).
write-atlas (function).
write-metadata (function).
write-sprite (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Pack the sprites defined by FILE-SPEC into a spritesheet.
OUT-FILE: A pathname specifying where to write the image file.
SPEC-FILE: A pathname specifying where to write the metadata file. If
unspecified, it is written to the same directory as OUT-FILE.
WIDTH: The width in pixels of the spritesheet. :AUTO to calculate width
automatically.
HEIGHT: The height in pixels of the spritesheet. :AUTO to calculate height
automatically.
NORMALIZE: Boolean specifying whether to map the metadata’s coordinates to the
[0..1] range.
FLIP-Y: Boolean specifying whether to flip the Y axis when writing the metadata.
PADDING: The padding in pixels to use around each sprite in the spritesheet.
OPTIMIZE-PACK: Calculate size automatically, and try multiple sizes to find a
better size. (ignores WIDTH, HEIGHT if set)
AUTO-SIZE-GRANULARITY-X, AUTO-SIZE-GRANULARITY-Y: Automatically generated sizes
will be multiples of these.
See MAKE-ATLAS-FROM-DIRECTORY if you want to automatically generate FILE-SPEC from the files under a given filesystem path.
Pack the sprites located under the given filesystem path, PATH.
RECURSIVE: Boolean specifying whether to scan recursively for files.
OUT-FILE: A pathname specifying where to write the image file.
SPEC-FILE: A pathname specifying where to write the metadata file. If
unspecified, it is written to the same directory as OUT-FILE.
WIDTH: The width in pixels of the spritesheet. :AUTO to calculate width
automatically.
HEIGHT: The height in pixels of the spritesheet. :AUTO to calculate height
automatically.
NORMALIZE: Boolean specifying whether to normalize the metadata’s coordinates in
the [0..1] range.
FLIP-Y: Boolean specifying whether to flip the Y axis when writing the metadata.
PADDING: The padding in pixels to use around each sprite in the spritesheet.
OPTIMIZE-PACK: Calculate size automatically, and try multiple sizes to find a
better size. (ignores WIDTH, HEIGHT if set)
AUTO-SIZE-GRANULARITY-X, AUTO-SIZE-GRANULARITY-Y: Automatically generated sizes
will be multiples of these.
See MAKE-ATLAS if you want to manually specify a file-spec, in case you want to be in control of the names chosen to identify the sprites written to the metadata file.
Unpack the sprites contained in the image, specified by the filesystem path, ATLAS-FILE. A file
of the same name with a "spec" file extension must also exist in the same directory on the
filesystem.
OUT-PATH: A pathname specifying a directory to write all the sprite images to.
| Jump to: | %
A C F G M R U W |
|---|
| Jump to: | %
A C F G M R U W |
|---|
| Jump to: | %
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| % | |||
%file: | Private classes | ||
| | |||
| S | |||
Slot, %file: | Private classes | ||
| | |||
| Jump to: | %
S |
|---|
| Jump to: | C F P R S U |
|---|
| Jump to: | C F P R S U |
|---|