mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-27 20:21:24 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve memory docs

Browse source
This commit is contained in:
Wim Taymans 2012-01-06 10:39:46 +01:00
parent 960c580ae2
commit 220b324d24
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
gst/gstmemory.c
View file

@ -27,6 +27,11 @@
* GstMemory is a lightweight refcounted object that wraps a region of memory. * GstMemory is a lightweight refcounted object that wraps a region of memory.
* They are typically used to manage the data of a #GstBuffer. * They are typically used to manage the data of a #GstBuffer.
* *
* A GstMemory object has an allocated region of memory of maxsize. The maximum
* size does not change during the lifetime of the memory object. The memory
* also has an offset and size property that specifies the valid range of memory
* in the allocated region.
*
* Memory is usually created by allocators with a gst_allocator_alloc() * Memory is usually created by allocators with a gst_allocator_alloc()
* method call. When NULL is used as the allocator, the default allocator will * method call. When NULL is used as the allocator, the default allocator will
* be used. * be used.
@ -45,6 +50,7 @@
* gst_memory_get_sizes() and gst_memory_resize() respectively. * gst_memory_get_sizes() and gst_memory_resize() respectively.
* *
* Getting access to the data of the memory is performed with gst_memory_map(). * Getting access to the data of the memory is performed with gst_memory_map().
* The call will return a pointer to offset bytes into the region of memory.
* After the memory access is completed, gst_memory_unmap() should be called. * After the memory access is completed, gst_memory_unmap() should be called.
* *
* Memory can be copied with gst_memory_copy(), which will returnn a writable * Memory can be copied with gst_memory_copy(), which will returnn a writable