buffer: document wlr_buffer_get_dmabuf DMA-BUF lifetime

2020-06-09 11:21:09 +02:00 · 2020-06-09 11:21:09 +02:00 · a8a4a12c4b
parent 78d6eed6b3
commit a8a4a12c4b
1 changed files with 4 additions and 0 deletions
--- a/include/wlr/types/wlr_buffer.h
+++ b/include/wlr/types/wlr_buffer.h
@ -69,6 +69,10 @@ void wlr_buffer_unlock(struct wlr_buffer *buffer);
 /**
 * Reads the DMA-BUF attributes of the buffer. If this buffer isn't a DMA-BUF,
 * returns false.
+ *
+ * The returned DMA-BUF attributes are valid for the lifetime of the
+ * wlr_buffer. The caller isn't responsible for cleaning up the DMA-BUF
+ * attributes.
 */
 bool wlr_buffer_get_dmabuf(struct wlr_buffer *buffer,
 	struct wlr_dmabuf_attributes *attribs);