Documentation Docs/en/reference/image-format/validation.md

Image Format Validation

Generated reference. Do not edit directly. Update BuildTools/ImageFormatInterface.json, then run python BuildTools/docs_image_format.py --write.

Index

Formats

Stable ID	Rule	Requirement	Why	Source
`image-format.validation.fofrm-count`	Positive FOFRM count	Reject a descriptor whose count/Count is zero or negative.	A descriptor must resolve at least one source reference before a runtime frame table can exist.	Source/Tools/ImageBaker.cpp
`image-format.validation.fofrm-directions`	Complete equal-size directions	Reject partial direction sets and any later direction whose flattened frame count differs from direction zero.	Every direction sheet shares one frame-count and timing header.	Source/Tools/ImageBaker.cpp, Source/Tests/Test_ImageBaker.cpp
`image-format.validation.fofrm-nested-shared`	No nested shared frame records	Reject a FOFRM reference whose child Main frame is already a shared record.	The flattening implementation copies concrete child pixels and does not rebase child shared indices.	Source/Tools/ImageBaker.cpp
`image-format.validation.rgba-payload`	Exact RGBA payload size	Reject every concrete frame whose byte payload is not exactly width times height times four.	The client reads a fixed RGBA8 byte count without a separate payload-length field.	Source/Tools/ImageBaker.cpp
`image-format.validation.tga-subset`	Supported TGA subset	Use no image ID, bottom-left orientation, TrueColor type 2 or 10, and 24 or 32 bpp; indexed/grayscale/other inputs are rejected or outside the implemented orientation assumptions.	The loader consumes the fixed header directly, then always flips rows and does not branch on descriptor origin.	Source/Tools/ImageBaker.cpp, Source/Tests/Test_ImageBaker.cpp
`image-format.validation.malformed-inputs`	Malformed decoder inputs	Keep focused failure coverage for corrupt PNG, TGA, FRM/FRx/RIX/ART/ZAR/TIL/MOS/BAM, SPR, and nested FOFRM inputs.	Legacy binary parsers must fail deterministically instead of emitting truncated runtime containers.	Source/Tests/Test_ImageBaker.cpp
`image-format.validation.runtime-container`	Runtime container guards	Reject invalid header/footer magic, zero frames, zero directions, unsupported direction counts, invalid single-frame shared records, and invalid shared-frame indices.	Corrupt baked bytes must not reach atlas allocation or animation updates.	Source/Common/SpriteResource.cpp, Source/Client/DefaultSprites.cpp
`image-format.validation.playback-timing`	Nonzero per-frame duration	For a playing multi-frame sheet, author timing so whole AnimTicks divided by flattened frame count is at least one millisecond; fps zero intentionally disables playback.	SpriteSheet::Update divides elapsed time by integer ticks_per_frame, while Play only guards one frame or zero whole ticks.	Source/Client/DefaultSprites.cpp
`image-format.validation.project-visible`	Embedding-project visual gate	After native and documentation checks, rebake the embedding project and inspect changed dimensions, alpha edges, mirrors, directions, cadence, offsets, hit masks, and relevant client profiles in a visible scene.	Parser and container tests cannot prove art framing, filtering, gait, or project resource-pack selection.	Source/Tests/Test_ImageBaker.cpp, Source/Tests/Test_TextureAtlas.cpp

Validation commands

python BuildTools\docs_image_format.py --check
python -m unittest BuildTools.tests.test_docs_image_format
cmake --build <build-dir> --config RelWithDebInfo --target RunUnitTests

An embedding project must also rebake affected resources and inspect every changed animation, direction, alpha edge, hit mask, and supported client profile.