summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@collabora.co.uk>2012-01-16 12:24:20 +0100
committerWim Taymans <wim.taymans@collabora.co.uk>2012-01-16 12:24:20 +0100
commit0ca511572254d6ec83df33cce7aaef50a58baa63 (patch)
tree733502af36faf4802f6ad1ca33b4dde7d3ab6dc8
parentea2f87d34e72a268d5607661ebc80703b2fc8d50 (diff)
buffer: improve docs
-rw-r--r--gst/gstbuffer.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/gst/gstbuffer.c b/gst/gstbuffer.c
index cf6b1442a4..4e8ece6125 100644
--- a/gst/gstbuffer.c
+++ b/gst/gstbuffer.c
@@ -673,7 +673,9 @@ _get_memory (GstBuffer * buffer, guint idx, gboolean write)
*
* Get the memory block in @buffer at @idx for memory access in @flags.
* This function does not return a refcount to the memory block. The memory
- * block stays valid for as long as the caller has a valid reference to @buffer.
+ * block stays valid for as long as the caller has a valid reference to @buffer
+ * and as long as no operations that modify the memory blocks are called, such
+ * as gst_buffer_remove_memory_range(), gst_buffer_take_memory() and gst_buffer_resize().
*
* @buffer should be writable when @flags contains #GST_MAP_WRITE. If the memory
* at @idx is not writable, a new writable copy will be installed in @buffer and