render: document wlr_renderer_bind_buffer

1 files changed, 7 insertions, 0 deletions

diff --git a/include/render/wlr_renderer.h b/include/render/wlr_renderer.h
index 8e113ac8..9e41f86f 100644
--- a/include/render/wlr_renderer.h
+++ b/include/render/wlr_renderer.h
@@ -3,6 +3,13 @@
 
 #include <wlr/render/wlr_renderer.h>
 
+/**
+ * Bind a buffer to the renderer.
+ *
+ * All subsequent rendering operations will operate on the supplied buffer.
+ * After rendering operations are done, the caller must unbind a buffer by
+ * calling wlr_renderer_bind_buffer with a NULL buffer.
+ */
 bool wlr_renderer_bind_buffer(struct wlr_renderer *r, struct wlr_buffer *buffer);
 /**
  * Get the DMA-BUF formats supporting rendering usage. Buffers allocated with