Add info about how to order layers depending on z-index in the specs

This commit is contained in:
David Capello 2023-05-08 12:14:45 -03:00
parent 8e91d22b70
commit 943f0df625

View File

@ -210,7 +210,7 @@ This chunk determine where to put a cel in the specified layer/frame.
1 - Linked Cel 1 - Linked Cel
2 - Compressed Image 2 - Compressed Image
3 - Compressed Tilemap 3 - Compressed Tilemap
SHORT Z-Index SHORT Z-Index (see NOTE.5)
0 = default layer ordering 0 = default layer ordering
+N = show this cel N layers later +N = show this cel N layers later
-N = show this cel N layers back -N = show this cel N layers back
@ -553,6 +553,37 @@ uses `aseprite/Attachment-System`.
This string will be used in a future to automatically link to the This string will be used in a future to automatically link to the
extension URL in the [Aseprite Store](https://github.com/aseprite/aseprite/issues/1928). extension URL in the [Aseprite Store](https://github.com/aseprite/aseprite/issues/1928).
#### NOTE.5
In case that you read and render an `.aseprite` file in your game
engine/software, you are going to need to process the z-index field
for each cel with a specific algorithm. This is a possible C++ code
about how to order layers for a specific frame (the `zIndex` must be
set depending on the active frame/cel):
```c++
struct Layer {
int layerIndex; // See the "layer index" in NOTE.2
int zIndex; // The z-index value for a specific cel in this layer/frame
int order() const {
return layerIndex + zIndex;
}
// Function to order with std::sort() by operator<(),
// which establish the render order from back to front.
bool operator<(const Layer& b) const {
return (order() < b.order()) ||
(order() == b.order() && (zIndex < b.zIndex));
}
};
```
Basically we first compare `layerIndex + zIndex` of each cel, and then
if this value is the same, we compare the specific `zIndex` value to
disambiguate some scenarios. An example of this implementation can be
found in the [RenderPlan code](https://github.com/aseprite/aseprite/blob/8e91d22b704d6d1e95e1482544318cee9f166c4d/src/doc/render_plan.cpp#L77).
## File Format Changes ## File Format Changes
1. The first change from the first release of the new .ase format, 1. The first change from the first release of the new .ase format,