protocol: add a comment about the wl_shm.format script

Add a comment to wl_shm.format to advise contributors to use the automated
script (generate-shm-formats.py) instead of updating the list manually.

Signed-off-by: Simon Ser <contact@emersion.fr>
This commit is contained in:
Simon Ser 2019-09-02 20:57:08 +03:00 committed by Pekka Paalanen
parent 8854f64bae
commit e771ca91d7

View file

@ -293,10 +293,12 @@
formats are optional and may not be supported by the particular formats are optional and may not be supported by the particular
renderer in use. renderer in use.
The drm format codes match the macros defined in drm_fourcc.h. The drm format codes match the macros defined in drm_fourcc.h, except
The formats actually supported by the compositor will be argb8888 and xrgb8888. The formats actually supported by the compositor
reported by the format event. will be reported by the format event.
</description> </description>
<!-- Note to protocol writers: don't update this list manually, instead
run the automated script that keeps it in sync with drm_fourcc.h. -->
<entry name="argb8888" value="0" summary="32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian"/> <entry name="argb8888" value="0" summary="32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian"/>
<entry name="xrgb8888" value="1" summary="32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian"/> <entry name="xrgb8888" value="1" summary="32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian"/>
<entry name="c8" value="0x20203843" summary="8-bit color index format, [7:0] C"/> <entry name="c8" value="0x20203843" summary="8-bit color index format, [7:0] C"/>