mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-09-28 23:02:22 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Port all docstring to gtk-doc markdown

Browse source
This commit is contained in:
Thibault Saunier 2017-03-08 15:01:13 -03:00 committed by Tim-Philipp Müller
parent b11df33ee2
commit 95ac4d5175
42 changed files with 126 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ext/gl/gstglbumper.c
View file

@ -21,16 +21,16 @@
/** /**
* SECTION:element-glbumper * SECTION:element-glbumper
* @title: glbumper
* *
* Bump mapping using the normal method. * Bump mapping using the normal method.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc ! glupload ! glbumper location=normalmap.bmp ! glimagesink * gst-launch-1.0 -v videotestsrc ! glupload ! glbumper location=normalmap.bmp ! glimagesink
* ]| A pipeline to test normal mapping. * ]| A pipeline to test normal mapping.
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglcolorbalance.c
View file

@ -22,16 +22,16 @@
/** /**
* SECTION:element-glcolorbalance * SECTION:element-glcolorbalance
* @title: glcolorbalance
* *
* Adjusts brightness, contrast, hue, saturation on a video stream. * Adjusts brightness, contrast, hue, saturation on a video stream.
* *
* <refsect2> * ## Example launch line
* <title>Example launch line</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! glcolorbalance saturation=0.0 ! glcolorconvert ! gldownload ! ximagesink * 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 * ]| This pipeline converts the image to black and white by setting the
* saturation to 0.0. * saturation to 0.0.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

14
ext/gl/gstglcolorscale.c
View file

@ -20,17 +20,15 @@
/** /**
* SECTION:element-glcolorscale * SECTION:element-glcolorscale
* @title: glcolorscale
* *
* video frame scaling and colorspace conversion. * video frame scaling and colorspace conversion.
* *
* <refsect2> * ## Scaling and Color space conversion
* <title>Scaling and Color space conversion</title> *
* <para>
* Equivalent to glupload ! gldownload. * Equivalent to glupload ! gldownload.
* </para> *
* </refsect2> * ## Examples
* <refsect2>
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc ! video/x-raw ! glcolorscale ! ximagesink * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glcolorscale ! ximagesink
* ]| A pipeline to test colorspace conversion. * ]| A pipeline to test colorspace conversion.
@ -40,7 +38,7 @@
* video/x-raw, width=320, height=240, format=YV12 ! videoconvert ! autovideosink * video/x-raw, width=320, height=240, format=YV12 ! videoconvert ! autovideosink
* ]| A pipeline to test hardware scaling and colorspace conversion. * ]| A pipeline to test hardware scaling and colorspace conversion.
* FBO and GLSL are required. * FBO and GLSL are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstgldeinterlace.c
View file

@ -20,16 +20,16 @@
/** /**
* SECTION:element-deinterlace * SECTION:element-deinterlace
* @title: deinterlace
* *
* Deinterlacing using based on fragment shaders. * Deinterlacing using based on fragment shaders.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! gldeinterlace ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! gldeinterlace ! glimagesink
* ]| * ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstgldifferencematte.c
View file

@ -20,16 +20,16 @@
/** /**
* SECTION:element-gldifferencematte. * SECTION:element-gldifferencematte.
* @title: gldifferencematte.
* *
* Saves a background frame and replace it with a pixbuf. * Saves a background frame and replace it with a pixbuf.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink
* ]| * ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstgleffects.c
View file

@ -20,16 +20,16 @@
/** /**
* SECTION:element-gleffects. * SECTION:element-gleffects.
* @title: gleffects.
* *
* GL Shading Language effects. * GL Shading Language effects.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! gleffects effect=5 ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! gleffects effect=5 ! glimagesink
* ]| * ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

16
ext/gl/gstglfilterapp.c
View file

@ -20,20 +20,18 @@
/** /**
* SECTION:element-glfilterapp * SECTION:element-glfilterapp
* @title: glfilterapp
* *
* The resize and redraw callbacks can be set from a client code. * The resize and redraw callbacks can be set from a client code.
* *
* <refsect2> * ## CLient callbacks
* <title>CLient callbacks</title> *
* <para> * The graphic scene can be written from a client code through the
* The graphic scene can be written from a client code through the
* two glfilterapp properties. * two glfilterapp properties.
* </para> *
* </refsect2> * ## Examples
* <refsect2>
* <title>Examples</title>
* see gst-plugins-gl/tests/examples/generic/recordgraphic * see gst-plugins-gl/tests/examples/generic/recordgraphic
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglfiltercube.c
View file

@ -20,11 +20,11 @@
/** /**
* SECTION:element-glfiltercube * SECTION:element-glfiltercube
* @title: glfiltercube
* *
* The resize and redraw callbacks can be set from a client code. * The resize and redraw callbacks can be set from a client code.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc ! glfiltercube ! glimagesink * gst-launch-1.0 -v videotestsrc ! glfiltercube ! glimagesink
* ]| A pipeline to mpa textures on the 6 cube faces.. * ]| 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 * gst-launch-1.0 -v videotestsrc ! video/x-raw, width=640, height=480 ! glfiltercube ! glimagesink
* ]| Resize scene before drawing the cube. * ]| Resize scene before drawing the cube.
* The scene size is greater than the input video size. * The scene size is greater than the input video size.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglfilterglass.c
View file

@ -21,11 +21,11 @@
/** /**
* SECTION:element-glfilterglass * SECTION:element-glfilterglass
* @title: glfilterglass
* *
* Map textures on moving glass. * Map textures on moving glass.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc ! glfilterglass ! glimagesink * gst-launch-1.0 -v videotestsrc ! glfilterglass ! glimagesink
* ]| A pipeline inspired from http://www.mdk.org.pl/2007/11/17/gl-colorspace-conversions * ]| 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 * gst-launch-1.0 -v videotestsrc ! glfilterglass ! video/x-raw, width=640, height=480 ! glimagesink
* ]| The scene is greater than the input size. * ]| The scene is greater than the input size.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglfilterreflectedscreen.c
View file

@ -20,15 +20,15 @@
/** /**
* SECTION:element-glfilterreflectedscreen * SECTION:element-glfilterreflectedscreen
* @title: glfilterreflectedscreen
* *
* Map Video Texture upon a screen, on a reflecting surface * Map Video Texture upon a screen, on a reflecting surface
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! glfilterreflectedscreen ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! glfilterreflectedscreen ! glimagesink
* ]| * ]|
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

7
ext/gl/gstglfiltershader.c
View file

@ -21,11 +21,11 @@
/** /**
* SECTION:element-glshader * SECTION:element-glshader
* @title: glshader
* *
* OpenGL fragment shader filter * OpenGL fragment shader filter
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! glshader fragment="\"`cat myshader.frag`\"" ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! glshader fragment="\"`cat myshader.frag`\"" ! glimagesink
* ]| * ]|
@ -45,13 +45,12 @@
* uniform float time; * uniform float time;
* uniform float width; * uniform float width;
* uniform float height; * uniform float height;
* *
* void main () { * void main () {
* gl_FragColor = texture2D( tex, v_texcoord ); * gl_FragColor = texture2D( tex, v_texcoord );
* } * }
* ]| * ]|
* *
* </refsect2>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"

22
ext/gl/gstglimagesink.c
View file

@ -23,6 +23,7 @@
/** /**
* SECTION:element-glimagesink * SECTION:element-glimagesink
* @title: glimagesink
* *
* glimagesink renders video frames to a drawable on a local or remote * glimagesink renders video frames to a drawable on a local or remote
* display using OpenGL. This element can receive a Window ID from the * 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 * See the #GstGLDisplay documentation for a list of environment variables that
* can override window/platform detection. * can override window/platform detection.
* *
* <refsect2> * ## Scaling
* <title>Scaling</title> *
* <para>
* Depends on the driver, OpenGL handles hardware accelerated * Depends on the driver, OpenGL handles hardware accelerated
* scaling of video frames. This means that the element will just accept * 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 * 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 * drawable scaling them on the fly. Using the #GstGLImageSink:force-aspect-ratio
* property it is possible to enforce scaling with a constant aspect ratio, * property it is possible to enforce scaling with a constant aspect ratio,
* which means drawing black borders around the video frame. * which means drawing black borders around the video frame.
* </para> *
* </refsect2> * ## Events
* <refsect2> *
* <title>Events</title>
* <para>
* Through the gl thread, glimagesink handle some events coming from the drawable * 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). * 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 * 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. * from the drawable and draw the latest frame with correct borders/aspect-ratio.
* </para> *
* </refsect2> * ## Examples
* <refsect2>
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc ! video/x-raw ! glimagesink * gst-launch-1.0 -v videotestsrc ! video/x-raw ! glimagesink
* ]| A pipeline to test hardware scaling. * ]| A pipeline to test hardware scaling.
@ -80,7 +76,7 @@
* ]| The graphic FPS scene can be greater than the input video FPS. * ]| The graphic FPS scene can be greater than the input video FPS.
* The graphic scene can be written from a client code through the * The graphic scene can be written from a client code through the
* two glfilterapp properties. * two glfilterapp properties.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglmosaic.c
View file

@ -20,14 +20,14 @@
/** /**
* SECTION:element-glmosaic * SECTION:element-glmosaic
* @title: glmosaic
* *
* glmixer sub element. N gl sink pads to 1 source pad. * glmixer sub element. N gl sink pads to 1 source pad.
* N + 1 OpenGL contexts shared together. * N + 1 OpenGL contexts shared together.
* N <= 6 because the rendering is more a like a cube than a mosaic * N <= 6 because the rendering is more a like a cube than a mosaic
* Each opengl input stream is rendered on a cube face * Each opengl input stream is rendered on a cube face
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! video/x-raw, format=YUY2 ! queue ! glmosaic name=m ! glimagesink \ * 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. \ * 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. * videotestsrc ! gleffects effect=6 ! queue ! m.
* ]| * ]|
* FBO (Frame Buffer Object) is required. * FBO (Frame Buffer Object) is required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstgloverlay.c
View file

@ -20,16 +20,16 @@
/** /**
* SECTION:element-gloverlay * SECTION:element-gloverlay
* @title: gloverlay
* *
* Overlay GL video texture with a PNG image * Overlay GL video texture with a PNG image
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink * gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink
* ]| * ]|
* FBO (Frame Buffer Object) is required. * FBO (Frame Buffer Object) is required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

8
ext/gl/gstglstereomix.c
View file

@ -23,6 +23,7 @@
/** /**
* SECTION:element-glstereomix * SECTION:element-glstereomix
* @title: glstereomix
* *
* Combine 2 input streams to produce a stereoscopic output * Combine 2 input streams to produce a stereoscopic output
* stream. Input views are taken from the left pad and right pad * 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 multiview representation on the output is chosen according to
* the downstream caps. * the downstream caps.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 -v videotestsrc pattern=ball name=left \ * gst-launch-1.0 -v videotestsrc pattern=ball name=left \
* videotestsrc name=right glstereomix name=mix \ * videotestsrc name=right glstereomix name=mix \
@ -52,10 +52,10 @@
* right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \ * right. ! video/x-raw,width=640,height=480 ! glupload ! mix. \
* mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \ * mix. ! video/x-raw'(memory:GLMemory)',multiview-mode=top-bottom ! \
* glcolorconvert ! gldownload ! queue ! x264enc ! h264parse ! \ * 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, * ]| 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. * and encode as a top-bottom frame packed H.264 video.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
#include "config.h" #include "config.h"

6
ext/gl/gstglstereosplit.c
View file

@ -20,16 +20,16 @@
/** /**
* SECTION:element-glstereosplit * SECTION:element-glstereosplit
* @title: glstereosplit
* *
* Receive a stereoscopic video stream and split into left/right * Receive a stereoscopic video stream and split into left/right
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glstereosplit name=s ! queue ! glimagesink s. ! queue ! glimagesink * gst-launch-1.0 videotestsrc ! glstereosplit name=s ! queue ! glimagesink s. ! queue ! glimagesink
* ]| * ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

16
ext/gl/gstgltestsrc.c
View file

@ -23,21 +23,19 @@
/** /**
* SECTION:element-gltestsrc * SECTION:element-gltestsrc
* @title: gltestsrc
* *
* <refsect2>
* <para>
* The gltestsrc element is used to produce test video texture. * The gltestsrc element is used to produce test video texture.
* The video test produced can be controlled with the "pattern" * The video test produced can be controlled with the "pattern"
* property. * property.
* </para> *
* <title>Example launch line</title> * ## Example launch line
* <para> *
* <programlisting> * |[
* gst-launch-1.0 -v gltestsrc pattern=smpte ! glimagesink * gst-launch-1.0 -v gltestsrc pattern=smpte ! glimagesink
* </programlisting> * ]|
* Shows original SMPTE color bars in a window. * Shows original SMPTE color bars in a window.
* </para> *
* </refsect2>
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstgltransformation.c
View file

@ -21,11 +21,11 @@
/** /**
* SECTION:element-gltransformation * SECTION:element-gltransformation
* @title: gltransformation
* *
* Transforms video on the GPU. * Transforms video on the GPU.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 gltestsrc ! gltransformation rotation-z=45 ! glimagesink * gst-launch-1.0 gltestsrc ! gltransformation rotation-z=45 ! glimagesink
* ]| A pipeline to rotate by 45 degrees * ]| A pipeline to rotate by 45 degrees
@ -38,7 +38,7 @@
* |[ * |[
* gst-launch-1.0 gltestsrc ! gltransformation rotation-x=-45 ortho=True ! glimagesink * 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 * ]| Rotate the video around the X-Axis by -45° with an orthographic projection
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglvideoflip.c
View file

@ -20,15 +20,15 @@
/** /**
* SECTION:element-glvideo_flip * SECTION:element-glvideo_flip
* @title: glvideo_flip
* *
* Transforms video on the GPU. * Transforms video on the GPU.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! glvideoflip method=clockwise ! glimagesinkelement * gst-launch-1.0 videotestsrc ! glupload ! glvideoflip method=clockwise ! glimagesinkelement
* ]| This pipeline flips the test image 90 degrees clockwise. * ]| This pipeline flips the test image 90 degrees clockwise.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglvideomixer.c
View file

@ -20,13 +20,13 @@
/** /**
* SECTION:element-glvideomixer * SECTION:element-glvideomixer
* @title: glvideomixer
* *
* Composites a number of streams into a single output scene using OpenGL in * Composites a number of streams into a single output scene using OpenGL in
* a similar fashion to compositor and videomixer. See the compositor plugin * a similar fashion to compositor and videomixer. See the compositor plugin
* for documentation about the #GstGLVideoMixerPad properties. * for documentation about the #GstGLVideoMixerPad properties.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 glvideomixer name=m ! glimagesink \ * gst-launch-1.0 glvideomixer name=m ! glimagesink \
* videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \ * videotestsrc ! video/x-raw, format=YUY2 ! glupload ! glcolorconvert ! m. \
@ -36,7 +36,7 @@
* videotestsrc ! glupload ! glfiltercube ! queue ! m. \ * videotestsrc ! glupload ! glfiltercube ! queue ! m. \
* videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \ * videotestsrc ! glupload ! gleffects effect=6 ! queue ! m.gst-launch-1.0 glvideomixer name=m ! glimagesink \
* ]| * ]|
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

6
ext/gl/gstglviewconvert.c
View file

@ -22,14 +22,14 @@
/** /**
* SECTION:element-glviewconvert * SECTION:element-glviewconvert
* @title: glviewconvert
* *
* Convert stereoscopic video between different representations using fragment shaders. * Convert stereoscopic video between different representations using fragment shaders.
* *
* The element can use either property settings or caps negotiation to choose the * The element can use either property settings or caps negotiation to choose the
* input and output formats to process. * input and output formats to process.
* *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 videotestsrc ! glupload ! glviewconvert ! glimagesink * gst-launch-1.0 videotestsrc ! glupload ! glviewconvert ! glimagesink
* ]| Simple placebo example demonstrating identity passthrough of mono video * ]| 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 * ]| Force re-interpretation of the input checkers pattern as a side-by-side stereoscopic
* image and display in glimagesink. * image and display in glimagesink.
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

12
ext/gl/gstopengl.c
View file

@ -23,20 +23,20 @@
/** /**
* SECTION:plugin-opengl * SECTION:plugin-opengl
* @title: GstOpengl
* *
* Cross-platform OpenGL plugin. * Cross-platform OpenGL plugin.
* <refsect2> *
* <title>Debugging</title> * ## Debugging
* </refsect2> *
* <refsect2> * ## Examples
* <title>Examples</title>
* |[ * |[
* gst-launch-1.0 --gst-debug=gldisplay:3 videotestsrc ! glimagesink * gst-launch-1.0 --gst-debug=gldisplay:3 videotestsrc ! glimagesink
* ]| A debugging pipeline. * ]| A debugging pipeline.
|[ |[
* GST_DEBUG=gl*:6 gst-launch-1.0 videotestsrc ! glimagesink * GST_DEBUG=gl*:6 gst-launch-1.0 videotestsrc ! glimagesink
* ]| A debugging pipelines related to shaders. * ]| A debugging pipelines related to shaders.
* </refsect2> *
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

1
gst-libs/gst/gl/gstglapi.c
View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gstglapi * SECTION:gstglapi
* @title: GstGlApi
* @short_description: OpenGL API specific functionality * @short_description: OpenGL API specific functionality
* @see_also: #GstGLDisplay, #GstGLContext * @see_also: #GstGLDisplay, #GstGLContext
* *

3
gst-libs/gst/gl/gstglbasememory.c
View file

@ -28,6 +28,7 @@
/** /**
* SECTION:gstglbasememory * SECTION:gstglbasememory
* @title: GstGlBaseMemory
* @short_description: memory subclass for GL buffers * @short_description: memory subclass for GL buffers
* @see_also: #GstMemory, #GstAllocator * @see_also: #GstMemory, #GstAllocator
* *
@ -523,7 +524,7 @@ gst_gl_base_memory_allocator_init (GstGLBaseMemoryAllocator * allocator)
/** /**
* gst_is_gl_base_memory: * gst_is_gl_base_memory:
* @mem:a #GstMemory * @mem:a #GstMemory
* *
* Returns: whether the memory at @mem is a #GstGLBaseMemory * Returns: whether the memory at @mem is a #GstGLBaseMemory
* *
* Since: 1.8 * Since: 1.8

5
gst-libs/gst/gl/gstglbuffer.c
View file

@ -29,11 +29,12 @@
/** /**
* SECTION:gstglbuffer * SECTION:gstglbuffer
* @title: GstGlBuffer
* @short_description: memory subclass for GL buffers * @short_description: memory subclass for GL buffers
* @see_also: #GstMemory, #GstAllocator * @see_also: #GstMemory, #GstAllocator
* *
* GstGLBuffer is a #GstMemory subclass providing support for the mapping of * 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. * 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: * gst_is_gl_buffer:
* @mem:a #GstMemory * @mem:a #GstMemory
* *
* Returns: whether the memory at @mem is a #GstGLBuffer * Returns: whether the memory at @mem is a #GstGLBuffer
* *
* Since: 1.8 * Since: 1.8

3
gst-libs/gst/gl/gstglbufferpool.c
View file

@ -28,6 +28,7 @@
/** /**
* SECTION:gstglbufferpool * SECTION:gstglbufferpool
* @title: GstGlBufferPool
* @short_description: buffer pool for #GstGLBaseMemory objects * @short_description: buffer pool for #GstGLBaseMemory objects
* @see_also: #GstBufferPool, #GstGLBaseMemory, #GstGLMemory * @see_also: #GstBufferPool, #GstGLBaseMemory, #GstGLMemory
* *
@ -35,7 +36,7 @@
* *
* A #GstGLBufferPool is created with gst_gl_buffer_pool_new() * 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_META, the VideoAligment buffer pool option
* %GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT as well as the OpenGL specific * %GST_BUFFER_POOL_OPTION_VIDEO_ALIGNMENT as well as the OpenGL specific
* %GST_BUFFER_POOL_OPTION_GL_SYNC_META buffer pool option. * %GST_BUFFER_POOL_OPTION_GL_SYNC_META buffer pool option.

3
gst-libs/gst/gl/gstglcolorconvert.c
View file

@ -31,6 +31,7 @@
/** /**
* SECTION:gstglcolorconvert * SECTION:gstglcolorconvert
* @title: GstGlColorConvert
* @short_description: convert between video color spaces and formats * @short_description: convert between video color spaces and formats
* @see_also: #GstGLUpload, #GstGLMemory, #GstGLBaseMemory * @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 * @inbuf: (transfer none): the #GstGLMemory filled #GstBuffer to convert
* *
* Converts the data contained by @inbuf using the formats specified by the * 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 * Returns: (transfer full): a converted #GstBuffer or %NULL
* *

2
gst-libs/gst/gl/gstglcontext.c
View file

@ -376,7 +376,7 @@ gst_gl_context_new (GstGLDisplay * display)
* @context_type: a #GstGLPlatform specifying the type of context in @handle * @context_type: a #GstGLPlatform specifying the type of context in @handle
* @available_apis: a #GstGLAPI containing the available OpenGL apis 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 * Note: The caller is responsible for ensuring that the OpenGL context
* represented by @handle stays alive while the returned #GstGLContext is * represented by @handle stays alive while the returned #GstGLContext is

16
gst-libs/gst/gl/gstgldisplay.c
View file

@ -27,7 +27,7 @@
* @title: GstGLDisplay * @title: GstGLDisplay
* @see_also: #GstContext, #GstGLContext, #GstGLWindow * @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 * Elements are required to make use of #GstContext to share and propogate
* a #GstGLDisplay. * a #GstGLDisplay.
* *
@ -40,13 +40,13 @@
* - GST_GL_API influences the OpenGL API requested by the OpenGL platform. * - GST_GL_API influences the OpenGL API requested by the OpenGL platform.
* Common values are 'opengl' and 'gles2'. * Common values are 'opengl' and 'gles2'.
* *
* <note>Certain window systems require a special function to be called to * > Certain window systems require a special function to be called to
* initialize threading support. As this GStreamer GL library does not preclude * > initialize threading support. As this GStreamer GL library does not preclude
* concurrent access to the windowing system, it is strongly advised that * > concurrent access to the windowing system, it is strongly advised that
* applications ensure that threading support has been initialized before any * > applications ensure that threading support has been initialized before any
* other toolkit/library functionality is accessed. Failure to do so could * > other toolkit/library functionality is accessed. Failure to do so could
* result in sudden application abortion during execution. The most notably * > result in sudden application abortion during execution. The most notably
* example of such a function is X11's XInitThreads().</note> * > example of such a function is X11's XInitThreads\().
*/ */
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H

3
gst-libs/gst/gl/gstglfilter.c
View file

@ -22,6 +22,7 @@
/** /**
* SECTION:gstglfilter * SECTION:gstglfilter
* @title: GstGlFilter
* @short_description: GstBaseTransform subclass for dealing with RGBA textures * @short_description: GstBaseTransform subclass for dealing with RGBA textures
* @see_also: #GstBaseTransform, #GstGLContext, #GstGLFramebuffer * @see_also: #GstBaseTransform, #GstGLContext, #GstGLFramebuffer
* *
@ -1174,7 +1175,7 @@ _unbind_buffer (GstGLFilter * filter)
* gst_gl_filter_draw_fullscreen_quad: * gst_gl_filter_draw_fullscreen_quad:
* @filter: a #GstGLFilter * @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 * modifies is the necessary vertex/index buffers and, if necessary, a
* Vertex Array Object for drawing a fullscreen quad. Framebuffer state, * Vertex Array Object for drawing a fullscreen quad. Framebuffer state,
* any shaders, viewport state, etc must be setup by the caller. * any shaders, viewport state, etc must be setup by the caller.

1
gst-libs/gst/gl/gstglformat.c
View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gstglformat * SECTION:gstglformat
* @title: GstGlFormat
* @short_description: utilities for dealing with OpenGL formats * @short_description: utilities for dealing with OpenGL formats
* @see_also: #GstGLBaseMemory, #GstGLMemory, #GstGLFramebuffer, #GstGLBuffer * @see_also: #GstGLBaseMemory, #GstGLMemory, #GstGLFramebuffer, #GstGLBuffer
* *

5
gst-libs/gst/gl/gstglmemory.c
View file

@ -31,11 +31,12 @@
/** /**
* SECTION:gstglmemory * SECTION:gstglmemory
* @title: GstGlMemory
* @short_description: memory subclass for GL textures * @short_description: memory subclass for GL textures
* @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool * @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool
* *
* GstGLMemory is a #GstGLBaseMemory subclass providing support for the mapping of * 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() * #GstGLMemory is created or wrapped through gst_gl_base_memory_alloc()
* with #GstGLVideoAllocationParams. * with #GstGLVideoAllocationParams.
@ -1092,7 +1093,7 @@ gst_gl_memory_init_once (void)
/** /**
* gst_is_gl_memory: * gst_is_gl_memory:
* @mem:a #GstMemory * @mem:a #GstMemory
* *
* Returns: whether the memory at @mem is a #GstGLMemory * Returns: whether the memory at @mem is a #GstGLMemory
* *
* Since: 1.4 * Since: 1.4

3
gst-libs/gst/gl/gstglmemorypbo.c
View file

@ -31,6 +31,7 @@
/** /**
* SECTION:gstglmemorypbo * SECTION:gstglmemorypbo
* @title: GstGLMemoryPBO
* @short_description: memory subclass for GL textures * @short_description: memory subclass for GL textures
* @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool * @see_also: #GstMemory, #GstAllocator, #GstGLBufferPool
* *
@ -846,7 +847,7 @@ gst_gl_memory_pbo_init_once (void)
/** /**
* gst_is_gl_memory_pbo: * gst_is_gl_memory_pbo:
* @mem:a #GstMemory * @mem:a #GstMemory
* *
* Returns: whether the memory at @mem is a #GstGLMemoryPBO * Returns: whether the memory at @mem is a #GstGLMemoryPBO
* *
* Since: 1.8 * Since: 1.8

1
gst-libs/gst/gl/gstgloverlaycompositor.c
View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gstgloverlaycompositor * SECTION:gstgloverlaycompositor
* @title: GstGLOverlayCompositor
* @short_description: Composite multiple overlays using OpenGL * @short_description: Composite multiple overlays using OpenGL
* @see_also: #GstGLMemory, #GstGLContext * @see_also: #GstGLMemory, #GstGLContext
*/ */

2
gst-libs/gst/gl/gstglquery.c
View file

@ -22,7 +22,7 @@
* SECTION:gstglquery * SECTION:gstglquery
* @short_description: OpenGL query abstraction * @short_description: OpenGL query abstraction
* @title: GstGLQuery * @title: GstGLQuery
* @see_also: * @see_also:
* *
* A #GstGLQuery represents and holds an OpenGL query object. Various types of * A #GstGLQuery represents and holds an OpenGL query object. Various types of
* queries can be run or counters retrieved. * queries can be run or counters retrieved.

5
gst-libs/gst/gl/gstglrenderbuffer.c
View file

@ -31,11 +31,12 @@
/** /**
* SECTION:gstglrenderbuffer * SECTION:gstglrenderbuffer
* @title: GstGLRenderBuffer
* @short_description: memory subclass for GL renderbuffer objects * @short_description: memory subclass for GL renderbuffer objects
* @see_also: #GstMemory, #GstAllocator * @see_also: #GstMemory, #GstAllocator
* *
* GstGLRenderbuffer is a #GstGLBaseMemory subclass providing support for * GstGLRenderbuffer is a #GstGLBaseMemory subclass providing support for
* OpenGL renderbuffers. * OpenGL renderbuffers.
* *
* #GstGLRenderbuffer is created or wrapped through gst_gl_base_memory_alloc() * #GstGLRenderbuffer is created or wrapped through gst_gl_base_memory_alloc()
* with #GstGLRenderbufferAllocationParams. * with #GstGLRenderbufferAllocationParams.
@ -329,7 +330,7 @@ gst_gl_renderbuffer_init_once (void)
/** /**
* gst_is_gl_renderbuffer: * gst_is_gl_renderbuffer:
* @mem:a #GstMemory * @mem:a #GstMemory
* *
* Returns: whether the memory at @mem is a #GstGLRenderbuffer * Returns: whether the memory at @mem is a #GstGLRenderbuffer
* *
* Since: 1.10 * Since: 1.10

1
gst-libs/gst/gl/gstglshader.c
View file

@ -29,6 +29,7 @@
/** /**
* SECTION:gstglshader * SECTION:gstglshader
* @title: GstGLShader
* @short_description: object representing an OpenGL shader program * @short_description: object representing an OpenGL shader program
* @see_also: #GstGLSLStage * @see_also: #GstGLSLStage
*/ */

1
gst-libs/gst/gl/gstglsl.c
View file

@ -29,6 +29,7 @@
/** /**
* SECTION:gstglsl * SECTION:gstglsl
* @title: GstGLSL
* @short_description: helpers for dealing with OpenGL shaders * @short_description: helpers for dealing with OpenGL shaders
* @see_also: #GstGLSLStage, #GstGLShader * @see_also: #GstGLSLStage, #GstGLShader
*/ */

1
gst-libs/gst/gl/gstglsyncmeta.c
View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gstglsyncmeta * SECTION:gstglsyncmeta
* @title: GstGLSyncMeta
* @short_description: synchronization primitives * @short_description: synchronization primitives
* @see_also: #GstGLBaseMemory, #GstGLContext * @see_also: #GstGLBaseMemory, #GstGLContext
* *

1
gst-libs/gst/gl/gstglupload.c
View file

@ -43,6 +43,7 @@
/** /**
* SECTION:gstglupload * SECTION:gstglupload
* @title: GstGLUpload
* @short_description: an object that uploads to GL textures * @short_description: an object that uploads to GL textures
* @see_also: #GstGLDownload, #GstGLMemory * @see_also: #GstGLDownload, #GstGLMemory
* *

1
gst-libs/gst/gl/gstglutils.c
View file

@ -20,6 +20,7 @@
/** /**
* SECTION:gstglutils * SECTION:gstglutils
* @title: GstGLUtils
* @short_description: some miscellaneous utilities for OpenGL * @short_description: some miscellaneous utilities for OpenGL
* @see_also: #GstGLContext * @see_also: #GstGLContext
*/ */

3
gst-libs/gst/gl/gstglviewconvert.c
View file

@ -22,6 +22,7 @@
/** /**
* SECTION:gstglviewconvert * SECTION:gstglviewconvert
* @title: GstGLViewConvert
* @short_description: convert between steroscopic/multiview video formats * @short_description: convert between steroscopic/multiview video formats
* @see_also: #GstGLColorConvert, #GstGLContext * @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 * @inbuf: (transfer none): the #GstGLMemory filled #GstBuffer to convert
* *
* Converts the data contained by @inbuf using the formats specified by the * 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 * Returns: (transfer full): a converted #GstBuffer or %NULL
* *