Documentation
Docs/en/reference/image-format/index.md
Generated Image Format Reference
Generated reference. Do not edit directly. Update
BuildTools/ImageFormatInterface.json, then runpython BuildTools/docs_image_format.py --write.
| Index | Formats | FOFRM | Options | Baking | Runtime | Validation | Canonical JSON | Guide |
This reference describes the Engine-owned image import, FOFRM composition, baked sprite, client loading, atlas, cache, and validation contract. Project asset catalogs and visual acceptance remain project-owned.
Contract status
| Field | Value |
|---|---|
| Stability | experimental |
| Support policy | The contract is generated for a pinned Engine revision. Projects own asset catalogs, source licensing, visual style, compression policy, resource-pack precedence, animation substitutions, movement tuning, and visible acceptance. |
| Source manifest | BuildTools/ImageFormatInterface.json |
| Contract digest | 1269bc60b487ff594867d59dafb3b23b789b5a9adc8b6ac0630a163cfe8c15c4 |
| Baker | Image, order 4 |
| Baked pixels | RGBA8 |
| Runtime side | client |
| Reference | Entries | Purpose |
|---|---|---|
| Formats | 12 | Accepted source formats and their current import behavior. |
| FOFRM | 9 | Descriptor fields, aliases, directions, flattening, and timing. |
| Options | 3 | ART, SPR, and BAM filename selectors. |
| Baking | 10 | Discovery, output naming, container records, and failures. |
| Runtime | 8 | Factory coverage, sprite sheets, atlas upload, and caches. |
| Validation | 9 | Source constraints and executable checks. |
Boundary
Included:
- the twelve built-in ImageBaker source extensions and their current import behavior
- FOFRM fields, aliases, direction sections, nested references, filename options, flattening, offsets, and timing
- the versioned private RGBA/mesh frame container, per-pack SpriteInfo index, and output-renaming behavior
- default client sprite-factory coverage, SpriteSheet playback, polygon or quad atlas drawing, hit masks, caches, and diagnostics
- focused source-anchor, generator, native-test, project-bake, and visible-validation boundaries
Excluded:
- project image catalogs, resource-pack precedence, asset licenses, art direction, quality targets, and acceptance baselines
- authoritative movement and the detailed walk/run projection algorithm documented by the Sprite Root Motion guide
- particle authoring, model textures, shader effects, GUI layout, fonts, video, and audio formats
- a public compatibility promise for the private baked byte stream or unsupported third-party image formats