Add missing wl_shm_pool::error enum

Existing implementations are using wl_shm::error for errors that apply to both
wl_shm and wl_shm_pool. The existing error values are assigned to the new
enum so existing code will continue to work but it will now be clearer what
errors can be emitted. wl_shm::error::invalid_format is now unused.

Signed-off-by: Robert Ancell <robert.ancell@canonical.com>
This commit is contained in:
Robert Ancell 2026-04-22 16:33:00 +12:00
parent 25da99a7e5
commit 02853609ac
No known key found for this signature in database
GPG key ID: 5A4D9816CA519FBD

View file

@ -220,7 +220,7 @@
</request>
</interface>
<interface name="wl_shm_pool" version="2">
<interface name="wl_shm_pool" version="3">
<description summary="a shared memory pool">
The wl_shm_pool object encapsulates a piece of memory shared
between the compositor and client. Through the wl_shm_pool
@ -231,6 +231,14 @@
a surface or for many small buffers.
</description>
<enum name="error" since="3">
<description summary="wl_shm_pool error values">
These errors can be emitted in response to wl_shm_pool requests.
</description>
<entry name="invalid_format" value="0" summary="buffer format is not known"/>
<entry name="invalid_stride" value="1" summary="invalid size or stride during buffer creation"/>
</enum>
<request name="create_buffer">
<description summary="create a buffer from the pool">
Create a wl_buffer object from the pool.
@ -280,7 +288,7 @@
</request>
</interface>
<interface name="wl_shm" version="2">
<interface name="wl_shm" version="3">
<description summary="shared memory support">
A singleton global object that provides support for shared
memory.
@ -293,12 +301,12 @@
that can be used for buffers.
</description>
<enum name="error">
<enum name="error" since="3">
<description summary="wl_shm error values">
These errors can be emitted in response to wl_shm requests.
</description>
<entry name="invalid_format" value="0" summary="buffer format is not known"/>
<entry name="invalid_stride" value="1" summary="invalid size or stride during pool or buffer creation"/>
<entry name="invalid_format" value="0" summary="buffer format is not known" deprecated-since="3"/>
<entry name="invalid_stride" value="1" summary="invalid size or stride during pool creation"/>
<entry name="invalid_fd" value="2" summary="mmapping the file descriptor failed"/>
</enum>