Merge branch 'wl-shm-format-bogus' into 'main'

Document that wl_shm.format is not authoritative

See merge request wayland/wayland!425
This commit is contained in:
Demi Marie Obenour 2026-01-30 09:03:56 -05:00
commit f6ad32bea4

View file

@ -242,7 +242,7 @@
<arg name="width" type="int" summary="buffer width, in pixels"/>
<arg name="height" type="int" summary="buffer height, in pixels"/>
<arg name="stride" type="int" summary="number of bytes from the beginning of one row to the beginning of the next row"/>
<arg name="format" type="uint" enum="wl_shm.format" summary="buffer pixel format"/>
<arg name="format" type="uint" summary="buffer pixel format"/>
</request>
<request name="destroy" type="destructor">
@ -308,6 +308,13 @@
For all wl_shm formats and unless specified in another protocol
extension, pre-multiplied alpha is used for pixel values.
Except for the first two entries (argb8888 and xrgb8888), this enum is
deprecated. Compositors and clients should use the macros in drm_fourcc.h
instead. Compositors are allowed to announce formats that are not members
of this enum. Clients may used any format that the compositor has
announced, even if it is not a member of this enum. The generated
validation function for this enum should not be used.
</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. -->
@ -475,7 +482,7 @@
can be used for buffers. Known formats include
argb8888 and xrgb8888.
</description>
<arg name="format" type="uint" enum="format" summary="buffer pixel format"/>
<arg name="format" type="uint" summary="buffer pixel format"/>
</event>
<!-- Version 2 additions -->