mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 02:46:12 +00:00
Code Issues1 Projects Releases Wiki Activity

Fix a few documentation issues.

Browse source
This commit is contained in:
Gwenole Beauchesne 2012-04-02 12:52:54 +02:00
parent 7490c3500d
commit d9c57a236d
8 changed files with 96 additions and 9 deletions

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

@ -30,6 +30,10 @@
<xi:include href="xml/gstvaapivideobuffer.xml"/>
<xi:include href="xml/gstvaapicontext.xml"/>
<xi:include href="xml/gstvaapidecoder.xml"/>
<xi:include href="xml/gstvaapidecoder_mpeg2.xml"/>
<xi:include href="xml/gstvaapidecoder_mpeg4.xml"/>
<xi:include href="xml/gstvaapidecoder_h264.xml"/>
<xi:include href="xml/gstvaapidecoder_vc1.xml"/>
<xi:include href="xml/gstvaapidecoder_ffmpeg.xml"/>
<xi:include href="xml/gstvaapisurfaceproxy.xml"/>
<xi:include href="xml/gstvaapivideosink.xml"/>

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

@ -488,6 +488,70 @@ GST_VAAPI_IS_DECODER_FFMPEG_CLASS
GST_VAAPI_DECODER_FFMPEG_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_mpeg2</FILE>
<TITLE>GstVaapiDecoderMpeg2</TITLE>
GstVaapiDecoderMpeg2
GstVaapiDecoderMpeg2Class
gst_vaapi_decoder_mpeg2_new
<SUBSECTION Standard>
GST_VAAPI_DECODER_MPEG2
GST_VAAPI_IS_DECODER_MPEG2
GST_VAAPI_TYPE_DECODER_MPEG2
gst_vaapi_decoder_mpeg2_get_type
GST_VAAPI_DECODER_MPEG2_CLASS
GST_VAAPI_IS_DECODER_MPEG2_CLASS
GST_VAAPI_DECODER_MPEG2_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_mpeg4</FILE>
<TITLE>GstVaapiDecoderMpeg4</TITLE>
GstVaapiDecoderMpeg4
GstVaapiDecoderMpeg4Class
gst_vaapi_decoder_mpeg4_new
<SUBSECTION Standard>
GST_VAAPI_DECODER_MPEG4
GST_VAAPI_IS_DECODER_MPEG4
GST_VAAPI_TYPE_DECODER_MPEG4
gst_vaapi_decoder_mpeg4_get_type
GST_VAAPI_DECODER_MPEG4_CLASS
GST_VAAPI_IS_DECODER_MPEG4_CLASS
GST_VAAPI_DECODER_MPEG4_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_h264</FILE>
<TITLE>GstVaapiDecoderH264</TITLE>
GstVaapiDecoderH264
GstVaapiDecoderH264Class
gst_vaapi_decoder_h264_new
<SUBSECTION Standard>
GST_VAAPI_DECODER_H264
GST_VAAPI_IS_DECODER_H264
GST_VAAPI_TYPE_DECODER_H264
gst_vaapi_decoder_h264_get_type
GST_VAAPI_DECODER_H264_CLASS
GST_VAAPI_IS_DECODER_H264_CLASS
GST_VAAPI_DECODER_H264_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapidecoder_vc1</FILE>
<TITLE>GstVaapiDecoderVC1</TITLE>
GstVaapiDecoderVC1
GstVaapiDecoderVC1Class
gst_vaapi_decoder_vc1_new
<SUBSECTION Standard>
GST_VAAPI_DECODER_VC1
GST_VAAPI_IS_DECODER_VC1
GST_VAAPI_TYPE_DECODER_VC1
gst_vaapi_decoder_vc1_get_type
GST_VAAPI_DECODER_VC1_CLASS
GST_VAAPI_IS_DECODER_VC1_CLASS
GST_VAAPI_DECODER_VC1_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapisurfaceproxy</FILE>
<TITLE>GstVaapiSurfaceProxy</TITLE>
@ -501,6 +565,8 @@ gst_vaapi_surface_proxy_get_surface_id
gst_vaapi_surface_proxy_set_surface
gst_vaapi_surface_proxy_get_timestamp
gst_vaapi_surface_proxy_set_timestamp
gst_vaapi_surface_proxy_get_interlaced
gst_vaapi_surface_proxy_set_interlaced
gst_vaapi_surface_proxy_get_tff
gst_vaapi_surface_proxy_set_tff
<SUBSECTION Standard>

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

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

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

@ -26,6 +26,20 @@ GST_IS_VAAPIDECODE_CLASS
GST_VAAPIDECODE_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapipostproc</FILE>
<TITLE>GstVaapiPostproc</TITLE>
GstVaapiPostproc
<SUBSECTION Standard>
GST_VAAPIPOSTPROC
GST_IS_VAAPIPOSTPROC
GST_TYPE_VAAPIPOSTPROC
gst_vaapipostproc_get_type
GST_VAAPIPOSTPROC_CLASS
GST_IS_VAAPIPOSTPROC_CLASS
GST_VAAPIPOSTPROC_GET_CLASS
</SECTION>
<SECTION>
<FILE>gstvaapiupload</FILE>
<TITLE>GstVaapiUpload</TITLE>

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

@ -1,4 +1,5 @@
gst_vaapisink_get_type
gst_vaapidecode_get_type
gst_vaapidownload_get_type
gst_vaapipostproc_get_type
gst_vaapisink_get_type
gst_vaapiupload_get_type

1
gst-libs/gst/vaapi/gstvaapiimage.c
View file

@ -1189,7 +1189,6 @@ gst_vaapi_image_get_buffer(
* gst_vaapi_image_get_raw:
* @image: a #GstVaapiImage
* @dst_image: a #GstVaapiImageRaw
* @buffer: a #GstBuffer
* @rect: a #GstVaapiRectangle expressing a region, or %NULL for the
* whole image
*

12
gst-libs/gst/vaapi/gstvaapivideoconverter_glx.c
View file

@ -76,13 +76,15 @@ gst_vaapi_video_converter_glx_iface_init (GstSurfaceConverterInterface *iface) {
/**
* gst_vaapi_video_converter_glx_new:
* @
* @surface: the #GstSurfaceBuffer
* @type: type of the target buffer (must be "opengl")
* @dest: target of the conversion (must be GL texture id)
*
* Creates an empty #GstBuffer. The caller is responsible for completing
* the initialization of the buffer with the gst_vaapi_video_converter_glx_set_*()
* functions.
* Creates an empty #GstBuffer. The caller is responsible for
* completing the initialization of the buffer with the
* gst_vaapi_video_converter_glx_set_*() functions.
*
* Return value: the newly allocated #GstBuffer, or %NULL or error
* Return value: the newly allocated #GstBuffer, or %NULL on error
*/
GstSurfaceConverter *
gst_vaapi_video_converter_glx_new(GstSurfaceBuffer *surface, const gchar *type,

4
gst/vaapi/gstvaapipostproc.c
View file

@ -629,7 +629,7 @@ gst_vaapipostproc_class_init(GstVaapiPostprocClass *klass)
element_class->change_state = gst_vaapipostproc_change_state;
/**
* GstVaapiSink:deinterlace-mode:
* GstVaapiPostproc:deinterlace-mode:
*
* This selects whether the deinterlacing should always be applied or if
* they should only be applied on content that has the "interlaced" flag
@ -646,7 +646,7 @@ gst_vaapipostproc_class_init(GstVaapiPostprocClass *klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
* GstVaapiSink:deinterlace-method:
* GstVaapiPostproc:deinterlace-method:
*
* This selects the deinterlacing method to apply.
*/