buffer: document wlr_buffer_get_dmabuf DMA-BUF lifetime

1 files changed, 4 insertions, 0 deletions

diff --git a/include/wlr/types/wlr_buffer.h b/include/wlr/types/wlr_buffer.h
index 454c5ba0..14bb2a8d 100644
--- 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);