mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-23 14:36:24 +00:00
Code Issues 1 Projects Releases Wiki Activity

Add missing docs.

Browse source
This commit is contained in:
gb 2010-05-03 22:36:34 +00:00 committed by Gwenole Beauchesne
parent 79c34f823b
commit c2c5d79287
8 changed files with 130 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/reference/libs/Makefile.am
View file

@ -59,13 +59,24 @@ CFILE_GLOB = $(top_srcdir)/gst-libs/gst/vaapi/*.c $(srcdir)/$(DOC_MODULE).types
# Header files to ignore when scanning. # Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES = \ IGNORE_HFILES = \
gstvaapi_priv.h \
gstvaapicompat.h \
gstvaapidebug.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.h \
gstvaapiutils_glx.h \ gstvaapiutils_glx.h \
gstvaapiutils_x11.h \ gstvaapiutils_x11.h \
gstvaapivalue.h \
$(NULL) $(NULL)
EXTRA_HFILES = \ EXTRA_HFILES = \
gstvaapimarshal.c \
$(NULL) $(NULL)
# Images to copy into HTML directory. # Images to copy into HTML directory.

4
docs/reference/libs/libs-docs.xml.in
View file

@ -28,6 +28,10 @@
<xi:include href="xml/gstvaapisurfacepool.xml"/> <xi:include href="xml/gstvaapisurfacepool.xml"/>
<xi:include href="xml/gstvaapiimagepool.xml"/> <xi:include href="xml/gstvaapiimagepool.xml"/>
<xi:include href="xml/gstvaapivideobuffer.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"/> <xi:include href="xml/gstvaapivideosink.xml"/>
</chapter> </chapter>

94
docs/reference/libs/libs-sections.txt
View file

@ -22,6 +22,12 @@ GstVaapiVideoPoolClass
gst_vaapi_video_pool_get_caps gst_vaapi_video_pool_get_caps
gst_vaapi_video_pool_get_object gst_vaapi_video_pool_get_object
gst_vaapi_video_pool_put_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> <SUBSECTION Standard>
GST_VAAPI_VIDEO_POOL GST_VAAPI_VIDEO_POOL
GST_VAAPI_IS_VIDEO_POOL GST_VAAPI_IS_VIDEO_POOL
@ -181,14 +187,18 @@ GST_VAAPI_IMAGE_POOL_GET_CLASS
<TITLE>GstVaapiVideoBuffer</TITLE> <TITLE>GstVaapiVideoBuffer</TITLE>
GstVaapiVideoBuffer GstVaapiVideoBuffer
GstVaapiVideoBufferClass GstVaapiVideoBufferClass
gst_vaapi_video_buffer_new
gst_vaapi_video_buffer_new_from_pool gst_vaapi_video_buffer_new_from_pool
gst_vaapi_video_buffer_new_with_image gst_vaapi_video_buffer_new_with_image
gst_vaapi_video_buffer_new_with_surface 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_get_image
gst_vaapi_video_buffer_set_image gst_vaapi_video_buffer_set_image
gst_vaapi_video_buffer_set_image_from_pool gst_vaapi_video_buffer_set_image_from_pool
gst_vaapi_video_buffer_get_surface 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
gst_vaapi_video_buffer_set_surface_proxy
gst_vaapi_video_buffer_set_surface_from_pool gst_vaapi_video_buffer_set_surface_from_pool
<SUBSECTION Standard> <SUBSECTION Standard>
GST_VAAPI_VIDEO_BUFFER GST_VAAPI_VIDEO_BUFFER
@ -377,11 +387,14 @@ gst_vaapi_image_format_get_score
<TITLE>GstVaapiProfile</TITLE> <TITLE>GstVaapiProfile</TITLE>
GstVaapiCodec GstVaapiCodec
GstVaapiProfile GstVaapiProfile
GstVaapiEntrypoint
gst_vaapi_profile gst_vaapi_profile
gst_vaapi_profile_from_caps gst_vaapi_profile_from_caps
gst_vaapi_profile_get_va_profile gst_vaapi_profile_get_va_profile
gst_vaapi_profile_get_caps gst_vaapi_profile_get_caps
gst_vaapi_profile_get_codec gst_vaapi_profile_get_codec
gst_vaapi_entrypoint
gst_vaapi_entrypoint_get_va_entrypoint
</SECTION> </SECTION>
<SECTION> <SECTION>
@ -407,3 +420,84 @@ GST_VAAPI_TEXTURE_CLASS
GST_VAAPI_IS_TEXTURE_CLASS GST_VAAPI_IS_TEXTURE_CLASS
GST_VAAPI_TEXTURE_GET_CLASS GST_VAAPI_TEXTURE_GET_CLASS
</SECTION> </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>

4
docs/reference/libs/libs.core.types
View file

@ -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_display_get_type
gst_vaapi_image_get_type gst_vaapi_image_get_type
gst_vaapi_image_pool_get_type gst_vaapi_image_pool_get_type
@ -5,6 +8,7 @@ gst_vaapi_object_get_type
gst_vaapi_subpicture_get_type gst_vaapi_subpicture_get_type
gst_vaapi_surface_get_type gst_vaapi_surface_get_type
gst_vaapi_surface_pool_get_type gst_vaapi_surface_pool_get_type
gst_vaapi_surface_proxy_get_type
gst_vaapi_video_buffer_get_type gst_vaapi_video_buffer_get_type
gst_vaapi_video_pool_get_type gst_vaapi_video_pool_get_type
gst_vaapi_video_sink_get_type gst_vaapi_video_sink_get_type

1
docs/reference/plugins/Makefile.am
View file

@ -88,6 +88,7 @@ INCLUDES = \
GTKDOC_LIBS = \ GTKDOC_LIBS = \
$(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la \ $(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-$(GST_MAJORMINOR).la \
$(top_builddir)/gst-libs/gst/vaapi/libgstvaapi-x11-$(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/vaapiconvert/libgstvaapiconvert.la \
$(top_builddir)/gst/vaapisink/libgstvaapisink.la \ $(top_builddir)/gst/vaapisink/libgstvaapisink.la \
$(GLIB_LIBS) $(GLIB_LIBS)

1
docs/reference/plugins/plugins-docs.xml.in
View file

@ -11,6 +11,7 @@
<chapter> <chapter>
<title>gst-plugins-vaapi Plugins</title> <title>gst-plugins-vaapi Plugins</title>
<xi:include href="xml/gstvaapidecode.xml"/>
<xi:include href="xml/gstvaapiconvert.xml"/> <xi:include href="xml/gstvaapiconvert.xml"/>
<xi:include href="xml/gstvaapisink.xml"/> <xi:include href="xml/gstvaapisink.xml"/>
</chapter> </chapter>

15
docs/reference/plugins/plugins-sections.txt
View file

@ -12,6 +12,20 @@ GST_IS_VAAPISINK_CLASS
GST_VAAPISINK_GET_CLASS GST_VAAPISINK_GET_CLASS
</SECTION> </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> <SECTION>
<FILE>gstvaapiconvert</FILE> <FILE>gstvaapiconvert</FILE>
<TITLE>GstVaapiConvert</TITLE> <TITLE>GstVaapiConvert</TITLE>
@ -25,4 +39,3 @@ GST_VAAPICONVERT_CLASS
GST_IS_VAAPICONVERT_CLASS GST_IS_VAAPICONVERT_CLASS
GST_VAAPICONVERT_GET_CLASS GST_VAAPICONVERT_GET_CLASS
</SECTION> </SECTION>

1
docs/reference/plugins/plugins.types
View file

@ -1,2 +1,3 @@
gst_vaapisink_get_type gst_vaapisink_get_type
gst_vaapidecode_get_type
gst_vaapiconvert_get_type gst_vaapiconvert_get_type