diff options
Diffstat (limited to 'include/wlr/render/dmabuf.h')
| -rw-r--r-- | include/wlr/render/dmabuf.h | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/include/wlr/render/dmabuf.h b/include/wlr/render/dmabuf.h index 76aad629..62f8e021 100644 --- a/include/wlr/render/dmabuf.h +++ b/include/wlr/render/dmabuf.h @@ -14,10 +14,27 @@ #define WLR_DMABUF_MAX_PLANES 4 +/** + * A Linux DMA-BUF pixel buffer. + * + * If the buffer was allocated with explicit modifiers enabled, the `modifier` + * field must not be INVALID. + * + * If the buffer was allocated with explicit modifiers disabled (either because + * the driver doesn't support it, or because the user didn't specify a valid + * modifier list), the `modifier` field can have two values: INVALID means that + * an implicit vendor-defined modifier is in use, LINEAR means that the buffer + * is linear. The `modifier` field must not have any other value. + * + * When importing a DMA-BUF, users must not ignore the modifier unless it's + * INVALID or LINEAR. In particular, users must not import a DMA-BUF to a + * legacy API which doesn't support specifying an explicit modifier unless the + * modifier is set to INVALID or LINEAR. + */ struct wlr_dmabuf_attributes { int32_t width, height; - uint32_t format; - uint64_t modifier; + uint32_t format; // FourCC code, see DRM_FORMAT_* in <drm_fourcc.h> + uint64_t modifier; // see DRM_FORMAT_MOD_* in <drm_fourcc.h> int n_planes; uint32_t offset[WLR_DMABUF_MAX_PLANES]; |