mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-02 16:52:42 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: add new API to docs

Browse source
This commit is contained in:
Tim-Philipp Müller 2011-12-07 18:31:58 +00:00
parent 5037b39883
commit 6757afc0bc
4 changed files with 66 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -225,6 +225,7 @@
<filename>-lgstvideo-&GST_MAJORMINOR;</filename> to the library flags.
</para>
<xi:include href="xml/gstvideo.xml" />
<xi:include href="xml/gstvideooverlaycomposition.xml" />
<xi:include href="xml/gstvideofilter.xml" />
<xi:include href="xml/gstvideosink.xml" />
</chapter>

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

@ -2312,6 +2312,56 @@ gst_video_format_get_type
GST_TYPE_VIDEO_FORMAT
</SECTION>
<SECTION>
<FILE>gstvideooverlaycomposition</FILE>
<INCLUDE>gst/video/video-overlay-composition.h</INCLUDE>
<SUBSECTION composition>
GstVideoOverlayComposition
GstVideoOverlayCompositionClass
gst_video_overlay_composition_new
gst_video_overlay_composition_ref
gst_video_overlay_composition_unref
gst_video_overlay_composition_add_rectangle
gst_video_overlay_composition_n_rectangles
gst_video_overlay_composition_get_rectangle
gst_video_overlay_composition_get_seqnum
gst_video_overlay_composition_copy
gst_video_overlay_composition_make_writable
gst_video_overlay_composition_blend
<SUBSECTION composition-set-get>
gst_video_buffer_get_overlay_composition
gst_video_buffer_set_overlay_composition
<SUBSECTION rectangle>
GstVideoOverlayFormatFlags
GstVideoOverlayRectangle
GstVideoOverlayRectangleClass
gst_video_overlay_rectangle_new_argb
gst_video_overlay_rectangle_ref
gst_video_overlay_rectangle_unref
gst_video_overlay_rectangle_get_pixels_argb
gst_video_overlay_rectangle_get_pixels_unscaled_argb
gst_video_overlay_rectangle_get_render_rectangle
gst_video_overlay_rectangle_get_seqnum
gst_video_overlay_rectangle_set_render_rectangle
gst_video_overlay_rectangle_copy
<SUBSECTION Standard>
GST_TYPE_VIDEO_OVERLAY_COMPOSITION
GST_VIDEO_OVERLAY_COMPOSITION
GST_VIDEO_OVERLAY_COMPOSITION_CLASS
GST_VIDEO_OVERLAY_COMPOSITION_GET_CLASS
GST_IS_VIDEO_OVERLAY_COMPOSITION
GST_IS_VIDEO_VIDEO_OVERLAY_COMPOSITION_CLASS
gst_video_overlay_composition_get_type
GST_TYPE_VIDEO_OVERLAY_RECTANGLE
GST_VIDEO_OVERLAY_RECTANGLE
GST_VIDEO_OVERLAY_RECTANGLE_CLASS
GST_VIDEO_OVERLAY_RECTANGLE_GET_CLASS
GST_IS_VIDEO_OVERLAY_RECTANGLE
GST_IS_VIDEO_VIDEO_OVERLAY_RECTANGLE_CLASS
gst_video_overlay_rectangle_get_type
</SECTION>
<SECTION>
<FILE>gstvideofilter</FILE>
<INCLUDE>gst/video/gstvideofilter.h</INCLUDE>

15
gst-libs/gst/video/video-overlay-composition.c
View file

@ -20,7 +20,7 @@
*/
/**
* SECTION:video-overlay-composition
* SECTION:gstvideooverlaycomposition
* @short_description: Video Buffer Overlay Compositions (Subtitles, Logos)
*
* <refsect2>
@ -465,6 +465,19 @@ gst_video_overlay_rectangle_needs_scaling (GstVideoOverlayRectangle * r)
return (r->width != r->render_width || r->height != r->render_height);
}
/**
* gst_video_overlay_composition_blend:
* @comp: a #GstVideoOverlayComposition
* @video_buf: a #GstBuffer containing raw video data in a supported format
*
* Blends the overlay rectangles in @comp on top of the raw video data
* contained in @video_buf. The data in @video_buf must be writable. If
* needed, use gst_buffer_make_writable() before calling this function to
* ensure a buffer is writable. @video_buf must also have valid raw video
* caps set on it.
*
* Since: 0.10.36
*/
void
gst_video_overlay_composition_blend (GstVideoOverlayComposition * comp,
GstBuffer * video_buf)

2
gst-libs/gst/video/video-overlay-composition.h
View file

@ -94,7 +94,7 @@ gst_video_overlay_rectangle_unref (GstVideoOverlayRectangle * comp)
/**
* GstVideoOverlayFormatFlags:
* @GST_VIDEO_OVERLAY_RECTANGLE_FLAG_NONE: no flags
* @GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE: no flags
*
* Overlay format flags.
*