buffer: document wlr_buffer_get_dmabuf DMA-BUF lifetime

This commit is contained in:
Simon Ser 2020-06-09 11:21:09 +02:00 committed by Drew DeVault
parent 78d6eed6b3
commit a8a4a12c4b

View file

@ -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, * Reads the DMA-BUF attributes of the buffer. If this buffer isn't a DMA-BUF,
* returns false. * 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, bool wlr_buffer_get_dmabuf(struct wlr_buffer *buffer,
struct wlr_dmabuf_attributes *attribs); struct wlr_dmabuf_attributes *attribs);