mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-26 02:00:33 +00:00
Code Issues 1 Projects Releases Wiki Activity

allocators: Integrate into the documentation

Browse source
This commit is contained in:
Sebastian Dröge 2013-02-19 10:05:17 +01:00
parent d405dddd50
commit 26ff0ced15
4 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/libs/Makefile.am
View file

@ -57,6 +57,7 @@ extra_files =
# contains GtkObjects/GObjects and you want to document signals and properties. # contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS) GTKDOC_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
GTKDOC_LIBS = \ GTKDOC_LIBS = \
$(top_builddir)/gst-libs/gst/allocators/libgstallocators-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \ $(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \ $(top_builddir)/gst-libs/gst/fft/libgstfft-@GST_API_VERSION@.la \
$(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \ $(top_builddir)/gst-libs/gst/rtp/libgstrtp-@GST_API_VERSION@.la \

10
docs/libs/gst-plugins-base-libs-docs.sgml
View file

@ -21,6 +21,16 @@
</para> </para>
<xi:include href="compiling.sgml" /> <xi:include href="compiling.sgml" />
<chapter id="gstreamer-allocators">
<title>Allocators Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base-&GST_API_VERSION;.pc</filename> and adding
<filename>-lgstallocators-&GST_API_VERSION;</filename> to the library flags.
</para>
<xi:include href="xml/gstdmabuf.xml" />
</chapter>
<chapter id="gstreamer-app"> <chapter id="gstreamer-app">
<title>App Library</title> <title>App Library</title>
<para> <para>

14
docs/libs/gst-plugins-base-libs-sections.txt
View file

@ -1,3 +1,17 @@
# allocators
<SECTION>
<FILE>gstdmabuf</FILE>
<TITLE>dmabuf</TITLE>
<INCLUDE>gst/allocators/gstdmabuf.h</INCLUDE>
gst_dmabuf_allocator_alloc
gst_dmabuf_allocator_obtain
gst_dmabuf_memory_get_fd
gst_is_dmabuf_memory
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
# app # app
<SECTION> <SECTION>
<FILE>gstappsrc</FILE> <FILE>gstappsrc</FILE>

7
gst-libs/gst/allocators/gstdmabuf.c
View file

@ -22,6 +22,13 @@
#include "gstdmabuf.h" #include "gstdmabuf.h"
/**
* SECTION:gstdmabuf
* @short_description: Memory wrapper for Linux dmabuf memory
* @see_also: #GstMemory
*
*/
#ifdef HAVE_MMAP #ifdef HAVE_MMAP
#include <sys/mman.h> #include <sys/mman.h>
#include <unistd.h> #include <unistd.h>