From 2a3753412944d7f3fc95a48011fa7c388bdbcf08 Mon Sep 17 00:00:00 2001 From: Jan Schmidt Date: Fri, 15 Aug 2014 01:04:45 +1000 Subject: video: Various simple docs fixes --- docs/libs/gst-plugins-base-libs-sections.txt | 1 - gst-libs/gst/video/gstvideometa.h | 4 ++-- gst-libs/gst/video/gstvideoutils.h | 1 - gst-libs/gst/video/video-format.c | 9 +++++++++ gst-libs/gst/video/video-frame.h | 2 ++ gst-libs/gst/video/video-overlay-composition.c | 3 ++- 6 files changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index a7cbf7f42..fb34761b1 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -2592,7 +2592,6 @@ gst_video_sink_get_type gstvideodecoder GstVideoDecoder GST_VIDEO_DECODER_ERROR -GST_VIDEO_DECODER_FLOW_DROPPED GST_VIDEO_DECODER_FLOW_NEED_DATA GST_VIDEO_DECODER_MAX_ERRORS GST_VIDEO_DECODER_SINK_NAME diff --git a/gst-libs/gst/video/gstvideometa.h b/gst-libs/gst/video/gstvideometa.h index e693659c9..58dd20fc4 100644 --- a/gst-libs/gst/video/gstvideometa.h +++ b/gst-libs/gst/video/gstvideometa.h @@ -255,8 +255,8 @@ gboolean gst_video_gl_texture_upload_meta_upload (GstVideoGLTextureUploadMe * @parent_id: identifier of its parent ROI, used f.i. for ROI hierarchisation. * @x: x component of upper-left corner * @y: y component of upper-left corner - * @width: bounding box width - * @height: bounding box height + * @w: bounding box width + * @h: bounding box height * * Extra buffer metadata describing an image region of interest */ diff --git a/gst-libs/gst/video/gstvideoutils.h b/gst-libs/gst/video/gstvideoutils.h index 6349b8745..e3851032d 100644 --- a/gst-libs/gst/video/gstvideoutils.h +++ b/gst-libs/gst/video/gstvideoutils.h @@ -213,7 +213,6 @@ typedef enum * owned by the frame and references to the frame instead of the * buffer should be kept. * @deadline: Running time when the frame will be used. - * @events: Events that will be pushed downstream before this frame is pushed. * * A #GstVideoCodecFrame represents a video frame both in raw and * encoded form. diff --git a/gst-libs/gst/video/video-format.c b/gst-libs/gst/video/video-format.c index fed531400..498580979 100644 --- a/gst-libs/gst/video/video-format.c +++ b/gst-libs/gst/video/video-format.c @@ -2728,6 +2728,15 @@ gst_video_format_to_fourcc (GstVideoFormat format) return formats[format].fourcc; } +/** + * gst_video_format_to_string: + * @format: a #GstVideoFormat video format + * + * Returns a string containing a descriptive name for + * the #GstVideoFormat if there is one, or NULL otherwise. + * + * Returns: the name corresponding to @format + */ const gchar * gst_video_format_to_string (GstVideoFormat format) { diff --git a/gst-libs/gst/video/video-frame.h b/gst-libs/gst/video/video-frame.h index 670806ec8..627fab0a2 100644 --- a/gst-libs/gst/video/video-frame.h +++ b/gst-libs/gst/video/video-frame.h @@ -53,6 +53,7 @@ typedef enum { /** * GstVideoFrame: * @info: the #GstVideoInfo + * @flags: #GstVideoFrameFlags for the frame * @buffer: the mapped buffer * @meta: pointer to metadata if any * @id: id of the mapped frame. the id can for example be used to @@ -135,6 +136,7 @@ gboolean gst_video_frame_copy_plane (GstVideoFrame *dest, const GstVideoFr * @GST_VIDEO_BUFFER_FLAG_ONEFIELD: If the #GstBuffer is interlaced, then only the * first field (as defined by the %GST_VIDEO_BUFFER_TFF * flag setting) is to be displayed. + * @GST_VIDEO_BUFFER_FLAG_LAST: Offset to define more flags * * Additional video buffer flags. */ diff --git a/gst-libs/gst/video/video-overlay-composition.c b/gst-libs/gst/video/video-overlay-composition.c index 2f8815c3a..c8fa93594 100644 --- a/gst-libs/gst/video/video-overlay-composition.c +++ b/gst-libs/gst/video/video-overlay-composition.c @@ -1485,12 +1485,13 @@ gst_video_overlay_rectangle_get_global_alpha (GstVideoOverlayRectangle * /** * gst_video_overlay_rectangle_set_global_alpha: * @rectangle: a #GstVideoOverlayRectangle + * @global_alpha: Global alpha value (0 to 1.0) * * Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per- * pixel alpha values are multiplied with this value. Valid * values: 0 <= global_alpha <= 1; 1 to deactivate. * - # @rectangle must be writable, meaning its refcount must be 1. You can + * @rectangle must be writable, meaning its refcount must be 1. You can * make the rectangles inside a #GstVideoOverlayComposition writable using * gst_video_overlay_composition_make_writable() or * gst_video_overlay_composition_copy(). -- cgit v1.2.3