Debian Codegraph @

src/asahi/layout/README

raw
1 # ail
2
3 ail is a small library for working with the image (and buffer) layouts
4 encountered with AGX hardware. Its design is inspired by isl. In
5 particular, ail strives to use isl unit suffixes and to represent
6 quantities in a canonical, API-agnostic fashion.
7
8 ail conventions differ slightly from isl. See the isl documentation in
9 mesa/docs/isl for the conventions that inspired ail, in particular
10 mesa/docs/isl/units.rst.
11
12 In ail, we have the following units:
13
14 **Bytes (B)**: 8-bits.
15
16 **Samples (sa)**: An individual sample. The number of bytes per sample depends
17 on the format.
18
19 **Pixels (px)**: The unit everything starts as from the API. A pixel contains a
20 fixed number of samples, given as the layout's `sample_count_sa`. For twiddled
21 layouts, these samples are stored together in emmory.
22
23 **Elements (el)**: For a block-compressed format, a single compression block
24 containing multiple pixels. Otherwise, equal to a single pixel.
25
26 **Tiles (tiles)**: Defined only for tiled/twiddled layouts. A group of elements
27 forming the layout-specific tile.
28
29 We do not support any multisampled block-compressed layouts, so either pixels
30 equals either samples or elements.