From 95ac4d5175cc426b263825fd4cac2c6b183fc0c4 Mon Sep 17 00:00:00 2001 From: Thibault Saunier Date: Wed, 8 Mar 2017 15:01:13 -0300 Subject: [PATCH] docs: Port all docstring to gtk-doc markdown --- ext/gl/gstglbumper.c | 6 +++--- ext/gl/gstglcolorbalance.c | 6 +++--- ext/gl/gstglcolorscale.c | 14 ++++++-------- ext/gl/gstgldeinterlace.c | 6 +++--- ext/gl/gstgldifferencematte.c | 6 +++--- ext/gl/gstgleffects.c | 6 +++--- ext/gl/gstglfilterapp.c | 16 +++++++--------- ext/gl/gstglfiltercube.c | 6 +++--- ext/gl/gstglfilterglass.c | 6 +++--- ext/gl/gstglfilterreflectedscreen.c | 6 +++--- ext/gl/gstglfiltershader.c | 7 +++---- ext/gl/gstglimagesink.c | 22 +++++++++------------- ext/gl/gstglmosaic.c | 6 +++--- ext/gl/gstgloverlay.c | 6 +++--- ext/gl/gstglstereomix.c | 8 ++++---- ext/gl/gstglstereosplit.c | 6 +++--- ext/gl/gstgltestsrc.c | 16 +++++++--------- ext/gl/gstgltransformation.c | 6 +++--- ext/gl/gstglvideoflip.c | 6 +++--- ext/gl/gstglvideomixer.c | 6 +++--- ext/gl/gstglviewconvert.c | 6 +++--- ext/gl/gstopengl.c | 12 ++++++------ gst-libs/gst/gl/gstglapi.c | 1 + gst-libs/gst/gl/gstglbasememory.c | 3 ++- gst-libs/gst/gl/gstglbuffer.c | 5 +++-- gst-libs/gst/gl/gstglbufferpool.c | 3 ++- gst-libs/gst/gl/gstglcolorconvert.c | 3 ++- gst-libs/gst/gl/gstglcontext.c | 2 +- gst-libs/gst/gl/gstgldisplay.c | 16 ++++++++-------- gst-libs/gst/gl/gstglfilter.c | 3 ++- gst-libs/gst/gl/gstglformat.c | 1 + gst-libs/gst/gl/gstglmemory.c | 5 +++-- gst-libs/gst/gl/gstglmemorypbo.c | 3 ++- gst-libs/gst/gl/gstgloverlaycompositor.c | 1 + gst-libs/gst/gl/gstglquery.c | 2 +- gst-libs/gst/gl/gstglrenderbuffer.c | 5 +++-- gst-libs/gst/gl/gstglshader.c | 1 + gst-libs/gst/gl/gstglsl.c | 1 + gst-libs/gst/gl/gstglsyncmeta.c | 1 + gst-libs/gst/gl/gstglupload.c | 1 + gst-libs/gst/gl/gstglutils.c | 1 + gst-libs/gst/gl/gstglviewconvert.c | 3 ++- 42 files changed, 126 insertions(+), 120 deletions(-) diff --git a/ext/gl/gstglbumper.c b/ext/gl/gstglbumper.c index 9fdb4a0798..8dd812cb81 100644 --- a/ext/gl/gstglbumper.c +++ b/ext/gl/gstglbumper.c @@ -21,16 +21,16 @@ /** * SECTION:element-glbumper + * @title: glbumper * * Bump mapping using the normal method. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc ! glupload ! glbumper location=normalmap.bmp ! glimagesink * ]| A pipeline to test normal mapping. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglcolorbalance.c b/ext/gl/gstglcolorbalance.c index 33b5a50a3b..c2482a3d6e 100644 --- a/ext/gl/gstglcolorbalance.c +++ b/ext/gl/gstglcolorbalance.c @@ -22,16 +22,16 @@ /** * SECTION:element-glcolorbalance + * @title: glcolorbalance * * Adjusts brightness, contrast, hue, saturation on a video stream. * - * - * Example launch line + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! glupload ! glcolorbalance saturation=0.0 ! glcolorconvert ! gldownload ! ximagesink * ]| This pipeline converts the image to black and white by setting the * saturation to 0.0. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglcolorscale.c b/ext/gl/gstglcolorscale.c index 2ca5480e9b..b7b0709dc0 100644 --- a/ext/gl/gstglcolorscale.c +++ b/ext/gl/gstglcolorscale.c @@ -20,17 +20,15 @@ /** * SECTION:element-glcolorscale + * @title: glcolorscale * * video frame scaling and colorspace conversion. * - * - * Scaling and Color space conversion - * + * ## Scaling and Color space conversion + * * Equivalent to glupload ! gldownload. - * - * - * - * Examples + * + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glcolorscale ! ximagesink * ]| A pipeline to test colorspace conversion. @@ -40,7 +38,7 @@ * video/x-raw, width=320, height=240, format=YV12 ! videoconvert ! autovideosink * ]| A pipeline to test hardware scaling and colorspace conversion. * FBO and GLSL are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgldeinterlace.c b/ext/gl/gstgldeinterlace.c index 568f26702a..dbc2c24d4a 100644 --- a/ext/gl/gstgldeinterlace.c +++ b/ext/gl/gstgldeinterlace.c @@ -20,16 +20,16 @@ /** * SECTION:element-deinterlace + * @title: deinterlace * * Deinterlacing using based on fragment shaders. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! gldeinterlace ! glimagesink * ]| * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgldifferencematte.c b/ext/gl/gstgldifferencematte.c index b50e69bf74..aa1092a176 100644 --- a/ext/gl/gstgldifferencematte.c +++ b/ext/gl/gstgldifferencematte.c @@ -20,16 +20,16 @@ /** * SECTION:element-gldifferencematte. + * @title: gldifferencematte. * * Saves a background frame and replace it with a pixbuf. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink * ]| * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgleffects.c b/ext/gl/gstgleffects.c index 2af3368afa..d8a7da107d 100644 --- a/ext/gl/gstgleffects.c +++ b/ext/gl/gstgleffects.c @@ -20,16 +20,16 @@ /** * SECTION:element-gleffects. + * @title: gleffects. * * GL Shading Language effects. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! gleffects effect=5 ! glimagesink * ]| * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglfilterapp.c b/ext/gl/gstglfilterapp.c index 925373b896..fc2e6ac5e1 100644 --- a/ext/gl/gstglfilterapp.c +++ b/ext/gl/gstglfilterapp.c @@ -20,20 +20,18 @@ /** * SECTION:element-glfilterapp + * @title: glfilterapp * * The resize and redraw callbacks can be set from a client code. * - * - * CLient callbacks - * - * The graphic scene can be written from a client code through the + * ## CLient callbacks + * + * The graphic scene can be written from a client code through the * two glfilterapp properties. - * - * - * - * Examples + * + * ## Examples * see gst-plugins-gl/tests/examples/generic/recordgraphic - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglfiltercube.c b/ext/gl/gstglfiltercube.c index 735d45e5ed..427782afd9 100644 --- a/ext/gl/gstglfiltercube.c +++ b/ext/gl/gstglfiltercube.c @@ -20,11 +20,11 @@ /** * SECTION:element-glfiltercube + * @title: glfiltercube * * The resize and redraw callbacks can be set from a client code. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc ! glfiltercube ! glimagesink * ]| A pipeline to mpa textures on the 6 cube faces.. @@ -37,7 +37,7 @@ * gst-launch-1.0 -v videotestsrc ! video/x-raw, width=640, height=480 ! glfiltercube ! glimagesink * ]| Resize scene before drawing the cube. * The scene size is greater than the input video size. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglfilterglass.c b/ext/gl/gstglfilterglass.c index 254199dd5c..ea20239a47 100644 --- a/ext/gl/gstglfilterglass.c +++ b/ext/gl/gstglfilterglass.c @@ -21,11 +21,11 @@ /** * SECTION:element-glfilterglass + * @title: glfilterglass * * Map textures on moving glass. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc ! glfilterglass ! glimagesink * ]| A pipeline inspired from http://www.mdk.org.pl/2007/11/17/gl-colorspace-conversions @@ -33,7 +33,7 @@ * |[ * gst-launch-1.0 -v videotestsrc ! glfilterglass ! video/x-raw, width=640, height=480 ! glimagesink * ]| The scene is greater than the input size. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglfilterreflectedscreen.c b/ext/gl/gstglfilterreflectedscreen.c index fb15338906..62ccd9bf7d 100644 --- a/ext/gl/gstglfilterreflectedscreen.c +++ b/ext/gl/gstglfilterreflectedscreen.c @@ -20,15 +20,15 @@ /** * SECTION:element-glfilterreflectedscreen + * @title: glfilterreflectedscreen * * Map Video Texture upon a screen, on a reflecting surface * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! glfilterreflectedscreen ! glimagesink * ]| - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglfiltershader.c b/ext/gl/gstglfiltershader.c index f3434690b4..8f5a990cf4 100644 --- a/ext/gl/gstglfiltershader.c +++ b/ext/gl/gstglfiltershader.c @@ -21,11 +21,11 @@ /** * SECTION:element-glshader + * @title: glshader * * OpenGL fragment shader filter * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! glshader fragment="\"`cat myshader.frag`\"" ! glimagesink * ]| @@ -45,13 +45,12 @@ * uniform float time; * uniform float width; * uniform float height; - * + * * void main () { * gl_FragColor = texture2D( tex, v_texcoord ); * } * ]| * - * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gl/gstglimagesink.c b/ext/gl/gstglimagesink.c index 1c8d314f2c..f6a61ac920 100644 --- a/ext/gl/gstglimagesink.c +++ b/ext/gl/gstglimagesink.c @@ -23,6 +23,7 @@ /** * SECTION:element-glimagesink + * @title: glimagesink * * glimagesink renders video frames to a drawable on a local or remote * display using OpenGL. This element can receive a Window ID from the @@ -34,28 +35,23 @@ * See the #GstGLDisplay documentation for a list of environment variables that * can override window/platform detection. * - * - * Scaling - * + * ## Scaling + * * Depends on the driver, OpenGL handles hardware accelerated * scaling of video frames. This means that the element will just accept * incoming video frames no matter their geometry and will then put them to the * drawable scaling them on the fly. Using the #GstGLImageSink:force-aspect-ratio * property it is possible to enforce scaling with a constant aspect ratio, * which means drawing black borders around the video frame. - * - * - * - * Events - * + * + * ## Events + * * Through the gl thread, glimagesink handle some events coming from the drawable * to manage its appearance even when the data is not flowing (GST_STATE_PAUSED). * That means that even when the element is paused, it will receive expose events * from the drawable and draw the latest frame with correct borders/aspect-ratio. - * - * - * - * Examples + * + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glimagesink * ]| A pipeline to test hardware scaling. @@ -80,7 +76,7 @@ * ]| The graphic FPS scene can be greater than the input video FPS. * The graphic scene can be written from a client code through the * two glfilterapp properties. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglmosaic.c b/ext/gl/gstglmosaic.c index fcd4926a77..77aec599cd 100644 --- a/ext/gl/gstglmosaic.c +++ b/ext/gl/gstglmosaic.c @@ -20,14 +20,14 @@ /** * SECTION:element-glmosaic + * @title: glmosaic * * glmixer sub element. N gl sink pads to 1 source pad. * N + 1 OpenGL contexts shared together. * N <= 6 because the rendering is more a like a cube than a mosaic * Each opengl input stream is rendered on a cube face * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! video/x-raw, format=YUY2 ! queue ! glmosaic name=m ! glimagesink \ * videotestsrc pattern=12 ! video/x-raw, format=I420, framerate=5/1, width=100, height=200 ! queue ! m. \ @@ -37,7 +37,7 @@ * videotestsrc ! gleffects effect=6 ! queue ! m. * ]| * FBO (Frame Buffer Object) is required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgloverlay.c b/ext/gl/gstgloverlay.c index 8c21bac773..173d11820c 100644 --- a/ext/gl/gstgloverlay.c +++ b/ext/gl/gstgloverlay.c @@ -20,16 +20,16 @@ /** * SECTION:element-gloverlay + * @title: gloverlay * * Overlay GL video texture with a PNG image * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink * ]| * FBO (Frame Buffer Object) is required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglstereomix.c b/ext/gl/gstglstereomix.c index 18e7111a7f..78a2934fad 100644 --- a/ext/gl/gstglstereomix.c +++ b/ext/gl/gstglstereomix.c @@ -23,6 +23,7 @@ /** * SECTION:element-glstereomix + * @title: glstereomix * * Combine 2 input streams to produce a stereoscopic output * stream. Input views are taken from the left pad and right pad @@ -34,8 +35,7 @@ * The multiview representation on the output is chosen according to * the downstream caps. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 -v videotestsrc pattern=ball name=left \ * videotestsrc name=right glstereomix name=mix \ @@ -52,10 +52,10 @@ * right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \ * mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \ * glcolorconvert ! gldownload ! queue ! x264enc ! h264parse ! \ - * mp4mux ! progressreport ! filesink location=output.mp4 + * mp4mux ! progressreport ! filesink location=output.mp4 * ]| Mix the input from a camera to the left view, and videotestsrc to the right view, * and encode as a top-bottom frame packed H.264 video. - * + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/ext/gl/gstglstereosplit.c b/ext/gl/gstglstereosplit.c index 5650ab4d64..933f3c5939 100644 --- a/ext/gl/gstglstereosplit.c +++ b/ext/gl/gstglstereosplit.c @@ -20,16 +20,16 @@ /** * SECTION:element-glstereosplit + * @title: glstereosplit * * Receive a stereoscopic video stream and split into left/right * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glstereosplit name=s ! queue ! glimagesink s. ! queue ! glimagesink * ]| * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgltestsrc.c b/ext/gl/gstgltestsrc.c index 83218b4ac1..e9c7df85ac 100644 --- a/ext/gl/gstgltestsrc.c +++ b/ext/gl/gstgltestsrc.c @@ -23,21 +23,19 @@ /** * SECTION:element-gltestsrc + * @title: gltestsrc * - * - * * The gltestsrc element is used to produce test video texture. * The video test produced can be controlled with the "pattern" * property. - * - * Example launch line - * - * + * + * ## Example launch line + * + * |[ * gst-launch-1.0 -v gltestsrc pattern=smpte ! glimagesink - * + * ]| * Shows original SMPTE color bars in a window. - * - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstgltransformation.c b/ext/gl/gstgltransformation.c index f6c9e3f26e..729a9f6535 100644 --- a/ext/gl/gstgltransformation.c +++ b/ext/gl/gstgltransformation.c @@ -21,11 +21,11 @@ /** * SECTION:element-gltransformation + * @title: gltransformation * * Transforms video on the GPU. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 gltestsrc ! gltransformation rotation-z=45 ! glimagesink * ]| A pipeline to rotate by 45 degrees @@ -38,7 +38,7 @@ * |[ * gst-launch-1.0 gltestsrc ! gltransformation rotation-x=-45 ortho=True ! glimagesink * ]| Rotate the video around the X-Axis by -45° with an orthographic projection - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglvideoflip.c b/ext/gl/gstglvideoflip.c index 5d2dac5ee8..d5bb2ac57d 100644 --- a/ext/gl/gstglvideoflip.c +++ b/ext/gl/gstglvideoflip.c @@ -20,15 +20,15 @@ /** * SECTION:element-glvideo_flip + * @title: glvideo_flip * * Transforms video on the GPU. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! glvideoflip method=clockwise ! glimagesinkelement * ]| This pipeline flips the test image 90 degrees clockwise. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglvideomixer.c b/ext/gl/gstglvideomixer.c index ebd6827524..5df126d878 100644 --- a/ext/gl/gstglvideomixer.c +++ b/ext/gl/gstglvideomixer.c @@ -20,13 +20,13 @@ /** * SECTION:element-glvideomixer + * @title: glvideomixer * * Composites a number of streams into a single output scene using OpenGL in * a similar fashion to compositor and videomixer. See the compositor plugin * for documentation about the #GstGLVideoMixerPad properties. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 glvideomixer name=m ! glimagesink \ * videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \ @@ -36,7 +36,7 @@ * videotestsrc ! glupload ! glfiltercube ! queue ! m. \ * videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \ * ]| - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstglviewconvert.c b/ext/gl/gstglviewconvert.c index 617df449d1..670305c815 100644 --- a/ext/gl/gstglviewconvert.c +++ b/ext/gl/gstglviewconvert.c @@ -22,14 +22,14 @@ /** * SECTION:element-glviewconvert + * @title: glviewconvert * * Convert stereoscopic video between different representations using fragment shaders. * * The element can use either property settings or caps negotiation to choose the * input and output formats to process. * - * - * Examples + * ## Examples * |[ * gst-launch-1.0 videotestsrc ! glupload ! glviewconvert ! glimagesink * ]| Simple placebo example demonstrating identity passthrough of mono video @@ -39,7 +39,7 @@ * ]| Force re-interpretation of the input checkers pattern as a side-by-side stereoscopic * image and display in glimagesink. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/ext/gl/gstopengl.c b/ext/gl/gstopengl.c index 4a8c4d6a1b..75f8d33321 100644 --- a/ext/gl/gstopengl.c +++ b/ext/gl/gstopengl.c @@ -23,20 +23,20 @@ /** * SECTION:plugin-opengl + * @title: GstOpengl * * Cross-platform OpenGL plugin. - * - * Debugging - * - * - * Examples + * + * ## Debugging + * + * ## Examples * |[ * gst-launch-1.0 --gst-debug=gldisplay:3 videotestsrc ! glimagesink * ]| A debugging pipeline. |[ * GST_DEBUG=gl*:6 gst-launch-1.0 videotestsrc ! glimagesink * ]| A debugging pipelines related to shaders. - * + * */ #ifdef HAVE_CONFIG_H diff --git a/gst-libs/gst/gl/gstglapi.c b/gst-libs/gst/gl/gstglapi.c index 5ae9344e1a..8b2fea5052 100644 --- a/gst-libs/gst/gl/gstglapi.c +++ b/gst-libs/gst/gl/gstglapi.c @@ -20,6 +20,7 @@ /** * SECTION:gstglapi + * @title: GstGlApi * @short_description: OpenGL API specific functionality * @see_also: #GstGLDisplay, #GstGLContext * diff --git a/gst-libs/gst/gl/gstglbasememory.c b/gst-libs/gst/gl/gstglbasememory.c index 0a01dfeafc..69b1b8838b 100644 --- a/gst-libs/gst/gl/gstglbasememory.c +++ b/gst-libs/gst/gl/gstglbasememory.c @@ -28,6 +28,7 @@ /** * SECTION:gstglbasememory + * @title: GstGlBaseMemory * @short_description: memory subclass for GL buffers * @see_also: #GstMemory, #GstAllocator * @@ -523,7 +524,7 @@ gst_gl_base_memory_allocator_init (GstGLBaseMemoryAllocator * allocator) /** * gst_is_gl_base_memory: * @mem:a #GstMemory - * + * * Returns: whether the memory at @mem is a #GstGLBaseMemory * * Since: 1.8 diff --git a/gst-libs/gst/gl/gstglbuffer.c b/gst-libs/gst/gl/gstglbuffer.c index ba67e2d62f..73c4b210a9 100644 --- a/gst-libs/gst/gl/gstglbuffer.c +++ b/gst-libs/gst/gl/gstglbuffer.c @@ -29,11 +29,12 @@ /** * SECTION:gstglbuffer + * @title: GstGlBuffer * @short_description: memory subclass for GL buffers * @see_also: #GstMemory, #GstAllocator * * GstGLBuffer is a #GstMemory subclass providing support for the mapping of - * GL buffers. + * GL buffers. * * Data is uploaded or downloaded from the GPU as is necessary. */ @@ -473,7 +474,7 @@ gst_gl_buffer_init_once (void) /** * gst_is_gl_buffer: * @mem:a #GstMemory - * + * * Returns: whether the memory at @mem is a #GstGLBuffer * * Since: 1.8 diff --git a/gst-libs/gst/gl/gstglbufferpool.c b/gst-libs/gst/gl/gstglbufferpool.c index a12f750e10..e886557acf 100644 --- a/gst-libs/gst/gl/gstglbufferpool.c +++ b/gst-libs/gst/gl/gstglbufferpool.c @@ -28,6 +28,7 @@ /** * SECTION:gstglbufferpool + * @title: GstGlBufferPool * @short_description: buffer pool for #GstGLBaseMemory objects * @see_also: #GstBufferPool, #GstGLBaseMemory, #GstGLMemory * @@ -35,7 +36,7 @@ * * A #GstGLBufferPool is created with gst_gl_buffer_pool_new() * - * #GstGLBufferPool implements the VideoMeta buffer pool option + * #GstGLBufferPool implements the VideoMeta buffer pool option * %GST_BUFFER_POOL_OPTION_VIDEO_META, the VideoAligment buffer pool option * %GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT as well as the OpenGL specific * %GST_BUFFER_POOL_OPTION_GL_SYNC_META buffer pool option. diff --git a/gst-libs/gst/gl/gstglcolorconvert.c b/gst-libs/gst/gl/gstglcolorconvert.c index 4373be5d33..89edb164c6 100644 --- a/gst-libs/gst/gl/gstglcolorconvert.c +++ b/gst-libs/gst/gl/gstglcolorconvert.c @@ -31,6 +31,7 @@ /** * SECTION:gstglcolorconvert + * @title: GstGlColorConvert * @short_description: convert between video color spaces and formats * @see_also: #GstGLUpload, #GstGLMemory, #GstGLBaseMemory * @@ -1231,7 +1232,7 @@ gst_gl_color_convert_fixate_caps (GstGLContext * context, * @inbuf: (transfer none): the #GstGLMemory filled #GstBuffer to convert * * Converts the data contained by @inbuf using the formats specified by the - * #GstCaps passed to gst_gl_color_convert_set_caps() + * #GstCaps passed to gst_gl_color_convert_set_caps() * * Returns: (transfer full): a converted #GstBuffer or %NULL * diff --git a/gst-libs/gst/gl/gstglcontext.c b/gst-libs/gst/gl/gstglcontext.c index 792aac726d..9af5e1cc8c 100644 --- a/gst-libs/gst/gl/gstglcontext.c +++ b/gst-libs/gst/gl/gstglcontext.c @@ -376,7 +376,7 @@ gst_gl_context_new (GstGLDisplay * display) * @context_type: a #GstGLPlatform specifying the type of context in @handle * @available_apis: a #GstGLAPI containing the available OpenGL apis in @handle * - * Wraps an existing OpenGL context into a #GstGLContext. + * Wraps an existing OpenGL context into a #GstGLContext. * * Note: The caller is responsible for ensuring that the OpenGL context * represented by @handle stays alive while the returned #GstGLContext is diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c index 54a135d92d..b456b1fa47 100644 --- a/gst-libs/gst/gl/gstgldisplay.c +++ b/gst-libs/gst/gl/gstgldisplay.c @@ -27,7 +27,7 @@ * @title: GstGLDisplay * @see_also: #GstContext, #GstGLContext, #GstGLWindow * - * #GstGLDisplay represents a connection to the underlying windowing system. + * #GstGLDisplay represents a connection to the underlying windowing system. * Elements are required to make use of #GstContext to share and propogate * a #GstGLDisplay. * @@ -40,13 +40,13 @@ * - GST_GL_API influences the OpenGL API requested by the OpenGL platform. * Common values are 'opengl' and 'gles2'. * - * Certain window systems require a special function to be called to - * initialize threading support. As this GStreamer GL library does not preclude - * concurrent access to the windowing system, it is strongly advised that - * applications ensure that threading support has been initialized before any - * other toolkit/library functionality is accessed. Failure to do so could - * result in sudden application abortion during execution. The most notably - * example of such a function is X11's XInitThreads(). + * > Certain window systems require a special function to be called to + * > initialize threading support. As this GStreamer GL library does not preclude + * > concurrent access to the windowing system, it is strongly advised that + * > applications ensure that threading support has been initialized before any + * > other toolkit/library functionality is accessed. Failure to do so could + * > result in sudden application abortion during execution. The most notably + * > example of such a function is X11's XInitThreads\(). */ #ifdef HAVE_CONFIG_H diff --git a/gst-libs/gst/gl/gstglfilter.c b/gst-libs/gst/gl/gstglfilter.c index 61cce02868..e702a1ecfd 100644 --- a/gst-libs/gst/gl/gstglfilter.c +++ b/gst-libs/gst/gl/gstglfilter.c @@ -22,6 +22,7 @@ /** * SECTION:gstglfilter + * @title: GstGlFilter * @short_description: GstBaseTransform subclass for dealing with RGBA textures * @see_also: #GstBaseTransform, #GstGLContext, #GstGLFramebuffer * @@ -1174,7 +1175,7 @@ _unbind_buffer (GstGLFilter * filter) * gst_gl_filter_draw_fullscreen_quad: * @filter: a #GstGLFilter * - * Render a fullscreen quad using the current GL state. The only GL state this + * Render a fullscreen quad using the current GL state. The only GL state this * modifies is the necessary vertex/index buffers and, if necessary, a * Vertex Array Object for drawing a fullscreen quad. Framebuffer state, * any shaders, viewport state, etc must be setup by the caller. diff --git a/gst-libs/gst/gl/gstglformat.c b/gst-libs/gst/gl/gstglformat.c index db66f7f83b..36aecf2e3d 100644 --- a/gst-libs/gst/gl/gstglformat.c +++ b/gst-libs/gst/gl/gstglformat.c @@ -20,6 +20,7 @@ /** * SECTION:gstglformat + * @title: GstGlFormat * @short_description: utilities for dealing with OpenGL formats * @see_also: #GstGLBaseMemory, #GstGLMemory, #GstGLFramebuffer, #GstGLBuffer * diff --git a/gst-libs/gst/gl/gstglmemory.c b/gst-libs/gst/gl/gstglmemory.c index 25f67d7dc5..5e69321467 100644 --- a/gst-libs/gst/gl/gstglmemory.c +++ b/gst-libs/gst/gl/gstglmemory.c @@ -31,11 +31,12 @@ /** * SECTION:gstglmemory + * @title: GstGlMemory * @short_description: memory subclass for GL textures * @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool * * GstGLMemory is a #GstGLBaseMemory subclass providing support for the mapping of - * OpenGL textures. + * OpenGL textures. * * #GstGLMemory is created or wrapped through gst_gl_base_memory_alloc() * with #GstGLVideoAllocationParams. @@ -1092,7 +1093,7 @@ gst_gl_memory_init_once (void) /** * gst_is_gl_memory: * @mem:a #GstMemory - * + * * Returns: whether the memory at @mem is a #GstGLMemory * * Since: 1.4 diff --git a/gst-libs/gst/gl/gstglmemorypbo.c b/gst-libs/gst/gl/gstglmemorypbo.c index 7ccef27729..4ae7125a34 100644 --- a/gst-libs/gst/gl/gstglmemorypbo.c +++ b/gst-libs/gst/gl/gstglmemorypbo.c @@ -31,6 +31,7 @@ /** * SECTION:gstglmemorypbo + * @title: GstGLMemoryPBO * @short_description: memory subclass for GL textures * @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool * @@ -846,7 +847,7 @@ gst_gl_memory_pbo_init_once (void) /** * gst_is_gl_memory_pbo: * @mem:a #GstMemory - * + * * Returns: whether the memory at @mem is a #GstGLMemoryPBO * * Since: 1.8 diff --git a/gst-libs/gst/gl/gstgloverlaycompositor.c b/gst-libs/gst/gl/gstgloverlaycompositor.c index 354c1efa58..16c123cd0c 100644 --- a/gst-libs/gst/gl/gstgloverlaycompositor.c +++ b/gst-libs/gst/gl/gstgloverlaycompositor.c @@ -20,6 +20,7 @@ /** * SECTION:gstgloverlaycompositor + * @title: GstGLOverlayCompositor * @short_description: Composite multiple overlays using OpenGL * @see_also: #GstGLMemory, #GstGLContext */ diff --git a/gst-libs/gst/gl/gstglquery.c b/gst-libs/gst/gl/gstglquery.c index bae5b8cb0b..0cf0f75add 100644 --- a/gst-libs/gst/gl/gstglquery.c +++ b/gst-libs/gst/gl/gstglquery.c @@ -22,7 +22,7 @@ * SECTION:gstglquery * @short_description: OpenGL query abstraction * @title: GstGLQuery - * @see_also: + * @see_also: * * A #GstGLQuery represents and holds an OpenGL query object. Various types of * queries can be run or counters retrieved. diff --git a/gst-libs/gst/gl/gstglrenderbuffer.c b/gst-libs/gst/gl/gstglrenderbuffer.c index 154ec00496..72f95f853d 100644 --- a/gst-libs/gst/gl/gstglrenderbuffer.c +++ b/gst-libs/gst/gl/gstglrenderbuffer.c @@ -31,11 +31,12 @@ /** * SECTION:gstglrenderbuffer + * @title: GstGLRenderBuffer * @short_description: memory subclass for GL renderbuffer objects * @see_also: #GstMemory, #GstAllocator * * GstGLRenderbuffer is a #GstGLBaseMemory subclass providing support for - * OpenGL renderbuffers. + * OpenGL renderbuffers. * * #GstGLRenderbuffer is created or wrapped through gst_gl_base_memory_alloc() * with #GstGLRenderbufferAllocationParams. @@ -329,7 +330,7 @@ gst_gl_renderbuffer_init_once (void) /** * gst_is_gl_renderbuffer: * @mem:a #GstMemory - * + * * Returns: whether the memory at @mem is a #GstGLRenderbuffer * * Since: 1.10 diff --git a/gst-libs/gst/gl/gstglshader.c b/gst-libs/gst/gl/gstglshader.c index ba10563c39..c15568dbcb 100644 --- a/gst-libs/gst/gl/gstglshader.c +++ b/gst-libs/gst/gl/gstglshader.c @@ -29,6 +29,7 @@ /** * SECTION:gstglshader + * @title: GstGLShader * @short_description: object representing an OpenGL shader program * @see_also: #GstGLSLStage */ diff --git a/gst-libs/gst/gl/gstglsl.c b/gst-libs/gst/gl/gstglsl.c index 2a9fa4f234..78fc45d83b 100644 --- a/gst-libs/gst/gl/gstglsl.c +++ b/gst-libs/gst/gl/gstglsl.c @@ -29,6 +29,7 @@ /** * SECTION:gstglsl + * @title: GstGLSL * @short_description: helpers for dealing with OpenGL shaders * @see_also: #GstGLSLStage, #GstGLShader */ diff --git a/gst-libs/gst/gl/gstglsyncmeta.c b/gst-libs/gst/gl/gstglsyncmeta.c index b8822704de..f69e344d0f 100644 --- a/gst-libs/gst/gl/gstglsyncmeta.c +++ b/gst-libs/gst/gl/gstglsyncmeta.c @@ -20,6 +20,7 @@ /** * SECTION:gstglsyncmeta + * @title: GstGLSyncMeta * @short_description: synchronization primitives * @see_also: #GstGLBaseMemory, #GstGLContext * diff --git a/gst-libs/gst/gl/gstglupload.c b/gst-libs/gst/gl/gstglupload.c index f19cd6ff5e..9b81892b05 100644 --- a/gst-libs/gst/gl/gstglupload.c +++ b/gst-libs/gst/gl/gstglupload.c @@ -43,6 +43,7 @@ /** * SECTION:gstglupload + * @title: GstGLUpload * @short_description: an object that uploads to GL textures * @see_also: #GstGLDownload, #GstGLMemory * diff --git a/gst-libs/gst/gl/gstglutils.c b/gst-libs/gst/gl/gstglutils.c index 2b97111f1a..16a866eb3a 100644 --- a/gst-libs/gst/gl/gstglutils.c +++ b/gst-libs/gst/gl/gstglutils.c @@ -20,6 +20,7 @@ /** * SECTION:gstglutils + * @title: GstGLUtils * @short_description: some miscellaneous utilities for OpenGL * @see_also: #GstGLContext */ diff --git a/gst-libs/gst/gl/gstglviewconvert.c b/gst-libs/gst/gl/gstglviewconvert.c index 86f877e132..acb9c85048 100644 --- a/gst-libs/gst/gl/gstglviewconvert.c +++ b/gst-libs/gst/gl/gstglviewconvert.c @@ -22,6 +22,7 @@ /** * SECTION:gstglviewconvert + * @title: GstGLViewConvert * @short_description: convert between steroscopic/multiview video formats * @see_also: #GstGLColorConvert, #GstGLContext * @@ -1432,7 +1433,7 @@ gst_gl_view_convert_get_property (GObject * object, guint prop_id, * @inbuf: (transfer none): the #GstGLMemory filled #GstBuffer to convert * * Converts the data contained by @inbuf using the formats specified by the - * #GstCaps passed to gst_gl_view_convert_set_caps() + * #GstCaps passed to gst_gl_view_convert_set_caps() * * Returns: (transfer full): a converted #GstBuffer or %NULL *