Merge branch 'doc-format' into 'main'

protocol: elaborate on drm_fourcc.h and wl_shm.format codes

See merge request wayland/wayland!468
This commit is contained in:
M. Stoeckl 2026-01-14 13:29:14 +00:00
commit 4ad1b09ed2

View file

@ -304,7 +304,8 @@
The drm format codes match the macros defined in drm_fourcc.h, except The drm format codes match the macros defined in drm_fourcc.h, except
argb8888 and xrgb8888. The formats actually supported by the compositor argb8888 and xrgb8888. The formats actually supported by the compositor
will be reported by the format event. will be reported by the format event. See drm_fourcc.h for more detailed
format descriptions.
For all wl_shm formats and unless specified in another protocol For all wl_shm formats and unless specified in another protocol
extension, pre-multiplied alpha is used for pixel values. extension, pre-multiplied alpha is used for pixel values.
@ -474,6 +475,10 @@
Informs the client about a valid pixel format that Informs the client about a valid pixel format that
can be used for buffers. Known formats include can be used for buffers. Known formats include
argb8888 and xrgb8888. argb8888 and xrgb8888.
Extensions to drm_fourcc.h (or the format enum) do not require
increasing the wl_shm version; as a result, clients may receive format
codes which were not in the list at the time the client was made.
</description> </description>
<arg name="format" type="uint" enum="format" summary="buffer pixel format"/> <arg name="format" type="uint" enum="format" summary="buffer pixel format"/>
</event> </event>