diff --git a/girs/Gst-1.0.gir b/girs/Gst-1.0.gir index 1fcbe5f280..e8134bd81f 100644 --- a/girs/Gst-1.0.gir +++ b/girs/Gst-1.0.gir @@ -447,7 +447,16 @@ use an alignment of 7. Flags for allocators. - The allocator has a custom alloc function. + The allocator has a custom alloc function. + Only elements designed to work with this allocator should be using it, + other elements should ignore it from allocation propositions. + This implies %GST_ALLOCATOR_FLAG_NO_COPY. + + + When copying a #GstMemory allocated with this allocator, the copy will +instead be allocated using the default allocator. Use this when allocating a +new memory is an heavy opperation that should only be done with a +#GstBufferPool for example. first flag that can be used for custom purposes diff --git a/girs/GstAllocators-1.0.gir b/girs/GstAllocators-1.0.gir index b18449b2e7..6828ff3b93 100644 --- a/girs/GstAllocators-1.0.gir +++ b/girs/GstAllocators-1.0.gir @@ -14,6 +14,12 @@ and/or use gtk-doc annotations. --> + + Name of this allocator, to be used for example with gst_allocator_find() and +gst_memory_is_type(). + + + Constant that defines the caps feature name for DMA buffer sharing. @@ -436,6 +442,43 @@ The memory is only mmapped on gst_buffer_map() request. + + This is a subclass of #GstFdAllocator that implements the +gst_allocator_alloc() method using `memfd_create()` when available, POSIX +`shm_open()` otherwise. Platforms not supporting any of those (Windows) will +always return %NULL. + +Note that allocating new shared memories has a significant performance cost, +it is thus recommended to keep a pool of pre-allocated #GstMemory, using +#GstBufferPool. For that reason, this allocator has the +%GST_ALLOCATOR_FLAG_NO_COPY flag set. + + + Get the #GstShmAllocator singleton previously registered with +gst_shm_allocator_init_once(). + + + a #GstAllocator or %NULL if +gst_shm_allocator_init_once() has not been previously called. + + + + + Register a #GstShmAllocator using gst_allocator_register() with the name +%GST_ALLOCATOR_SHM. This is no-op after the first call. + + + + + + + + + + Parent Class. + + + Return the file descriptor associated with @mem.