diff options
| author | Tim-Philipp Müller <tim@centricular.com> | 2018-03-08 01:01:53 +0000 |
|---|---|---|
| committer | Tim-Philipp Müller <tim@centricular.com> | 2018-03-08 01:01:53 +0000 |
| commit | 98fc23062f211ac1ffe96802bfe891869615660d (patch) | |
| tree | 1b0e4b4bf29ae4846b81c15399cdd6d21c840841 | |
| parent | ae9911617e6221ef5c6948081f226165a0a16149 (diff) | |
docs: add GstPhysMemoryAllocator to docs
| -rw-r--r-- | docs/libs/gst-plugins-base-libs-docs.sgml | 1 | ||||
| -rw-r--r-- | docs/libs/gst-plugins-base-libs-sections.txt | 20 | ||||
| -rw-r--r-- | gst-libs/gst/allocators/gstphysmemory.c | 8 |
3 files changed, 29 insertions, 0 deletions
diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index 1e950c037..23767acbd 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -30,6 +30,7 @@ </para> <xi:include href="xml/gstdmabuf.xml" /> <xi:include href="xml/gstfdmemory.xml" /> + <xi:include href="xml/gstphysmemoryallocator.xml" /> </chapter> <chapter id="gstreamer-app"> diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 53d0b0094..c2d289cba 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -48,6 +48,26 @@ GST_TYPE_FD_ALLOCATOR <SUBSECTION Private> </SECTION> +<SECTION> +<FILE>gstphysmemoryallocator</FILE> +<TITLE>GstPhysMemoryAllocator</TITLE> +<INCLUDE>gst/allocators/allocators.h</INCLUDE> +GstPhysMemoryAllocator +GstPhysMemoryAllocatorInterface +gst_is_phys_memory +gst_phys_memory_get_phys_addr +<SUBSECTION Standard> +GST_TYPE_PHYS_MEMORY_ALLOCATOR +GST_IS_PHYS_MEMORY_ALLOCATOR +GST_IS_PHYS_MEMORY_ALLOCATOR_INTERFACE +GST_PHYS_MEMORY_ALLOCATOR_GET_INTERFACE +GST_PHYS_MEMORY_ALLOCATOR +GST_PHYS_MEMORY_ALLOCATOR_INTERFACE +GST_PHYS_MEMORY_ALLOCATOR_CAST +gst_phys_memory_allocator_get_type +<SUBSECTION Private> +</SECTION> + # app <SECTION> <FILE>gstappsrc</FILE> diff --git a/gst-libs/gst/allocators/gstphysmemory.c b/gst-libs/gst/allocators/gstphysmemory.c index 4e1a898cb..db743912d 100644 --- a/gst-libs/gst/allocators/gstphysmemory.c +++ b/gst-libs/gst/allocators/gstphysmemory.c @@ -17,6 +17,14 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstphysmemoryallocator + * @title: GstPhysMemoryAllocator + * @short_description: Interface for allocators that pass around physical memory addresses + * @see_also: #GstMemory + * + * Since: 1.14 + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif |