diff options
author | gb <gb@5584edef-b1fe-4b99-b61b-dd2bab72e969> | 2010-05-03 22:36:34 +0000 |
---|---|---|
committer | Gwenole Beauchesne <gbeauchesne@splitted-desktop.com> | 2010-09-20 12:55:44 +0200 |
commit | c2c5d792872382cbb7ae59af52ff8c00f9f92634 (patch) | |
tree | e856965b8b12d346329434644d090dfabeff1738 /docs | |
parent | 79c34f823b426bb883cbef9042b7ca0ebba20fdb (diff) |
Add missing docs.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/libs/Makefile.am | 11 | ||||
-rw-r--r-- | docs/reference/libs/libs-docs.xml.in | 4 | ||||
-rw-r--r-- | docs/reference/libs/libs-sections.txt | 94 | ||||
-rw-r--r-- | docs/reference/libs/libs.core.types | 4 | ||||
-rw-r--r-- | docs/reference/plugins/Makefile.am | 1 | ||||
-rw-r--r-- | docs/reference/plugins/plugins-docs.xml.in | 1 | ||||
-rw-r--r-- | docs/reference/plugins/plugins-sections.txt | 15 | ||||
-rw-r--r-- | docs/reference/plugins/plugins.types | 1 |
8 files changed, 130 insertions, 1 deletions
diff --git a/docs/reference/libs/Makefile.am b/docs/reference/libs/Makefile.am index e8d18407..05f1c795 100644 --- a/docs/reference/libs/Makefile.am +++ b/docs/reference/libs/Makefile.am @@ -59,13 +59,24 @@ CFILE_GLOB = $(top_srcdir)/gst-libs/gst/vaapi/*.c $(srcdir)/$(DOC_MODULE).types # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h IGNORE_HFILES = \ + gstvaapi_priv.h \ + gstvaapicompat.h \ gstvaapidebug.h \ + gstvaapidecoder_priv.h \ + gstvaapidisplay_priv.h \ + gstvaapidisplay_glx_priv.h \ + gstvaapidisplay_x11_priv.h \ + gstvaapimarshal.h \ + gstvaapiobject_priv.h \ + gstvaapiparamspecs.h \ gstvaapiutils.h \ gstvaapiutils_glx.h \ gstvaapiutils_x11.h \ + gstvaapivalue.h \ $(NULL) EXTRA_HFILES = \ + gstvaapimarshal.c \ $(NULL) # Images to copy into HTML directory. diff --git a/docs/reference/libs/libs-docs.xml.in b/docs/reference/libs/libs-docs.xml.in index 1fc8b46b..97e19617 100644 --- a/docs/reference/libs/libs-docs.xml.in +++ b/docs/reference/libs/libs-docs.xml.in @@ -28,6 +28,10 @@ <xi:include href="xml/gstvaapisurfacepool.xml"/> <xi:include href="xml/gstvaapiimagepool.xml"/> <xi:include href="xml/gstvaapivideobuffer.xml"/> + <xi:include href="xml/gstvaapicontext.xml"/> + <xi:include href="xml/gstvaapidecoder.xml"/> + <xi:include href="xml/gstvaapidecoder_ffmpeg.xml"/> + <xi:include href="xml/gstvaapisurfaceproxy.xml"/> <xi:include href="xml/gstvaapivideosink.xml"/> </chapter> diff --git a/docs/reference/libs/libs-sections.txt b/docs/reference/libs/libs-sections.txt index 0f2389d3..c5bd0a40 100644 --- a/docs/reference/libs/libs-sections.txt +++ b/docs/reference/libs/libs-sections.txt @@ -22,6 +22,12 @@ GstVaapiVideoPoolClass gst_vaapi_video_pool_get_caps gst_vaapi_video_pool_get_object gst_vaapi_video_pool_put_object +gst_vaapi_video_pool_add_object +gst_vaapi_video_pool_add_objects +gst_vaapi_video_pool_get_capacity +gst_vaapi_video_pool_set_capacity +gst_vaapi_video_pool_get_size +gst_vaapi_video_pool_reserve <SUBSECTION Standard> GST_VAAPI_VIDEO_POOL GST_VAAPI_IS_VIDEO_POOL @@ -181,14 +187,18 @@ GST_VAAPI_IMAGE_POOL_GET_CLASS <TITLE>GstVaapiVideoBuffer</TITLE> GstVaapiVideoBuffer GstVaapiVideoBufferClass +gst_vaapi_video_buffer_new gst_vaapi_video_buffer_new_from_pool gst_vaapi_video_buffer_new_with_image gst_vaapi_video_buffer_new_with_surface +gst_vaapi_video_buffer_new_with_surface_proxy gst_vaapi_video_buffer_get_image gst_vaapi_video_buffer_set_image gst_vaapi_video_buffer_set_image_from_pool gst_vaapi_video_buffer_get_surface +gst_vaapi_video_buffer_get_surface_proxy gst_vaapi_video_buffer_set_surface +gst_vaapi_video_buffer_set_surface_proxy gst_vaapi_video_buffer_set_surface_from_pool <SUBSECTION Standard> GST_VAAPI_VIDEO_BUFFER @@ -377,11 +387,14 @@ gst_vaapi_image_format_get_score <TITLE>GstVaapiProfile</TITLE> GstVaapiCodec GstVaapiProfile +GstVaapiEntrypoint gst_vaapi_profile gst_vaapi_profile_from_caps gst_vaapi_profile_get_va_profile gst_vaapi_profile_get_caps gst_vaapi_profile_get_codec +gst_vaapi_entrypoint +gst_vaapi_entrypoint_get_va_entrypoint </SECTION> <SECTION> @@ -407,3 +420,84 @@ GST_VAAPI_TEXTURE_CLASS GST_VAAPI_IS_TEXTURE_CLASS GST_VAAPI_TEXTURE_GET_CLASS </SECTION> + +<SECTION> +<FILE>gstvaapicontext</FILE> +<TITLE>GstVaapiContext</TITLE> +GstVaapiContext +GstVaapiContextClass +gst_vaapi_context_new +gst_vaapi_context_reset +gst_vaapi_context_get_id +gst_vaapi_context_get_profile +gst_vaapi_context_set_profile +gst_vaapi_context_get_entrypoint +gst_vaapi_context_get_size +gst_vaapi_context_get_surface +gst_vaapi_context_put_surface +gst_vaapi_context_find_surface_by_id +<SUBSECTION Standard> +GST_VAAPI_CONTEXT +GST_VAAPI_IS_CONTEXT +GST_VAAPI_TYPE_CONTEXT +gst_vaapi_context_get_type +GST_VAAPI_CONTEXT_CLASS +GST_VAAPI_IS_CONTEXT_CLASS +GST_VAAPI_CONTEXT_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gstvaapidecoder</FILE> +GstVaapiDecoderStatus +<TITLE>GstVaapiDecoder</TITLE> +GstVaapiDecoder +GstVaapiDecoderClass +gst_vaapi_decoder_put_buffer +gst_vaapi_decoder_get_surface +<SUBSECTION Standard> +GST_VAAPI_DECODER +GST_VAAPI_IS_DECODER +GST_VAAPI_TYPE_DECODER +gst_vaapi_decoder_get_type +GST_VAAPI_DECODER_CLASS +GST_VAAPI_IS_DECODER_CLASS +GST_VAAPI_DECODER_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gstvaapidecoder_ffmpeg</FILE> +<TITLE>GstVaapiDecoderFfmpeg</TITLE> +GstVaapiDecoderFfmpeg +GstVaapiDecoderFfmpegClass +gst_vaapi_decoder_ffmpeg_new +<SUBSECTION Standard> +GST_VAAPI_DECODER_FFMPEG +GST_VAAPI_IS_DECODER_FFMPEG +GST_VAAPI_TYPE_DECODER_FFMPEG +gst_vaapi_decoder_ffmpeg_get_type +GST_VAAPI_DECODER_FFMPEG_CLASS +GST_VAAPI_IS_DECODER_FFMPEG_CLASS +GST_VAAPI_DECODER_FFMPEG_GET_CLASS +</SECTION> + +<SECTION> +<FILE>gstvaapisurfaceproxy</FILE> +<TITLE>GstVaapiSurfaceProxy</TITLE> +GstVaapiSurfaceProxy +GstVaapiSurfaceProxyClass +gst_vaapi_surface_proxy_new +gst_vaapi_surface_proxy_get_context +gst_vaapi_surface_proxy_set_context +gst_vaapi_surface_proxy_get_surface +gst_vaapi_surface_proxy_set_surface +gst_vaapi_surface_proxy_get_timestamp +gst_vaapi_surface_proxy_set_timestamp +<SUBSECTION Standard> +GST_VAAPI_SURFACE_PROXY +GST_VAAPI_IS_SURFACE_PROXY +GST_VAAPI_TYPE_SURFACE_PROXY +gst_vaapi_surface_proxy_get_type +GST_VAAPI_SURFACE_PROXY_CLASS +GST_VAAPI_IS_SURFACE_PROXY_CLASS +GST_VAAPI_SURFACE_PROXY_GET_CLASS +</SECTION> diff --git a/docs/reference/libs/libs.core.types b/docs/reference/libs/libs.core.types index a33c3533..34a8f2ff 100644 --- a/docs/reference/libs/libs.core.types +++ b/docs/reference/libs/libs.core.types @@ -1,3 +1,6 @@ +gst_vaapi_context_get_type +gst_vaapi_decoder_get_type +gst_vaapi_decoder_ffmpeg_get_type gst_vaapi_display_get_type gst_vaapi_image_get_type gst_vaapi_image_pool_get_type @@ -5,6 +8,7 @@ gst_vaapi_object_get_type gst_vaapi_subpicture_get_type gst_vaapi_surface_get_type gst_vaapi_surface_pool_get_type +gst_vaapi_surface_proxy_get_type gst_vaapi_video_buffer_get_type gst_vaapi_video_pool_get_type gst_vaapi_video_sink_get_type diff --git a/docs/reference/plugins/Makefile.am b/docs/reference/plugins/Makefile.am index 8f10c708..473ba988 100644 --- a/docs/reference/plugins/Makefile.am +++ b/docs/reference/plugins/Makefile.am @@ -88,6 +88,7 @@ INCLUDES = \ GTKDOC_LIBS = \ $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la \ $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-x11-$(GST_MAJORMINOR).la \ + $(top_builddir)/gst/vaapidecode/libgstvaapidecode.la \ $(top_builddir)/gst/vaapiconvert/libgstvaapiconvert.la \ $(top_builddir)/gst/vaapisink/libgstvaapisink.la \ $(GLIB_LIBS) diff --git a/docs/reference/plugins/plugins-docs.xml.in b/docs/reference/plugins/plugins-docs.xml.in index fbc2cf5a..47779996 100644 --- a/docs/reference/plugins/plugins-docs.xml.in +++ b/docs/reference/plugins/plugins-docs.xml.in @@ -11,6 +11,7 @@ <chapter> <title>gst-plugins-vaapi Plugins</title> + <xi:include href="xml/gstvaapidecode.xml"/> <xi:include href="xml/gstvaapiconvert.xml"/> <xi:include href="xml/gstvaapisink.xml"/> </chapter> diff --git a/docs/reference/plugins/plugins-sections.txt b/docs/reference/plugins/plugins-sections.txt index 8853004e..a0c0a31b 100644 --- a/docs/reference/plugins/plugins-sections.txt +++ b/docs/reference/plugins/plugins-sections.txt @@ -13,6 +13,20 @@ GST_VAAPISINK_GET_CLASS </SECTION> <SECTION> +<FILE>gstvaapidecode</FILE> +<TITLE>GstVaapiDecode</TITLE> +GstVaapiDecode +<SUBSECTION Standard> +GST_VAAPIDECODE +GST_IS_VAAPIDECODE +GST_TYPE_VAAPIDECODE +gst_vaapidecode_get_type +GST_VAAPIDECODE_CLASS +GST_IS_VAAPIDECODE_CLASS +GST_VAAPIDECODE_GET_CLASS +</SECTION> + +<SECTION> <FILE>gstvaapiconvert</FILE> <TITLE>GstVaapiConvert</TITLE> GstVaapiConvert @@ -25,4 +39,3 @@ GST_VAAPICONVERT_CLASS GST_IS_VAAPICONVERT_CLASS GST_VAAPICONVERT_GET_CLASS </SECTION> - diff --git a/docs/reference/plugins/plugins.types b/docs/reference/plugins/plugins.types index fab5f67f..db94655e 100644 --- a/docs/reference/plugins/plugins.types +++ b/docs/reference/plugins/plugins.types @@ -1,2 +1,3 @@ gst_vaapisink_get_type +gst_vaapidecode_get_type gst_vaapiconvert_get_type |