From d058ce7e8802b824bdd6a3f2c9ed2bf3b1af38bb Mon Sep 17 00:00:00 2001 From: Alyssa Rosenzweig Date: Tue, 25 May 2021 17:59:46 -0400 Subject: [PATCH] docs/gallium: Document the index buffer format convention Signed-off-by: Alyssa Rosenzweig Reviewed-by: Emma Anholt Part-of: --- docs/gallium/format.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/gallium/format.rst b/docs/gallium/format.rst index 93faf4fe1b3..e4b08b6f40e 100644 --- a/docs/gallium/format.rst +++ b/docs/gallium/format.rst @@ -51,6 +51,11 @@ Format names with an embedded underscore are subsampled. ``R8G8_B8G8`` is a single 32-bit block of two pixels, where the R and B values are repeated in both pixels. +Index buffers do not have a natural format in Gallium structures. For purposes +of ``is_format_supported`` queries, the formats ``R8_UINT``, ``R16_UINT``, and +``R32_UINT`` are used with ``PIPE_BIND_INDEX_BUFFER`` for 8-bit, 16-bit, and +32-bit index buffers respectively. + References ----------