Commit 95ac4d51 authored by Thibault Saunier's avatar Thibault Saunier Committed by Tim-Philipp Müller

docs: Port all docstring to gtk-doc markdown

parent b11df33e
......@@ -21,16 +21,16 @@
/**
* SECTION:element-glbumper
* @title: glbumper
*
* Bump mapping using the normal method.
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -22,16 +22,16 @@
/**
* SECTION:element-glcolorbalance
* @title: glcolorbalance
*
* Adjusts brightness, contrast, hue, saturation on a video stream.
*
* <refsect2>
* <title>Example launch line</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,17 +20,15 @@
/**
* SECTION:element-glcolorscale
* @title: glcolorscale
*
* video frame scaling and colorspace conversion.
*
* <refsect2>
* <title>Scaling and Color space conversion</title>
* <para>
* ## Scaling and Color space conversion
*
* Equivalent to glupload ! gldownload.
* </para>
* </refsect2>
* <refsect2>
* <title>Examples</title>
*
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-deinterlace
* @title: deinterlace
*
* Deinterlacing using based on fragment shaders.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! glupload ! gldeinterlace ! glimagesink
* ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-gldifferencematte.
* @title: gldifferencematte.
*
* Saves a background frame and replace it with a pixbuf.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! glupload ! gldifferencemate location=backgroundimagefile ! glimagesink
* ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-gleffects.
* @title: gleffects.
*
* GL Shading Language effects.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! glupload ! gleffects effect=5 ! glimagesink
* ]|
* FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,20 +20,18 @@
/**
* SECTION:element-glfilterapp
* @title: glfilterapp
*
* The resize and redraw callbacks can be set from a client code.
*
* <refsect2>
* <title>CLient callbacks</title>
* <para>
* 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.
* </para>
* </refsect2>
* <refsect2>
* <title>Examples</title>
*
* ## Examples
* see gst-plugins-gl/tests/examples/generic/recordgraphic
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,11 +20,11 @@
/**
* SECTION:element-glfiltercube
* @title: glfiltercube
*
* The resize and redraw callbacks can be set from a client code.
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -21,11 +21,11 @@
/**
* SECTION:element-glfilterglass
* @title: glfilterglass
*
* Map textures on moving glass.
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,15 +20,15 @@
/**
* SECTION:element-glfilterreflectedscreen
* @title: glfilterreflectedscreen
*
* Map Video Texture upon a screen, on a reflecting surface
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! glupload ! glfilterreflectedscreen ! glimagesink
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -21,11 +21,11 @@
/**
* SECTION:element-glshader
* @title: glshader
*
* OpenGL fragment shader filter
*
* <refsect2>
* <title>Examples</title>
* ## 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 );
* }
* ]|
*
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......
......@@ -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.
*
* <refsect2>
* <title>Scaling</title>
* <para>
* ## 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.
* </para>
* </refsect2>
* <refsect2>
* <title>Events</title>
* <para>
*
* ## 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.
* </para>
* </refsect2>
* <refsect2>
* <title>Examples</title>
*
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -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
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-gloverlay
* @title: gloverlay
*
* Overlay GL video texture with a PNG image
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! gloverlay location=image.jpg ! glimagesink
* ]|
* FBO (Frame Buffer Object) is required.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -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.
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......
......@@ -20,16 +20,16 @@
/**
* SECTION:element-glstereosplit
* @title: glstereosplit
*
* Receive a stereoscopic video stream and split into left/right
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -23,21 +23,19 @@
/**
* SECTION:element-gltestsrc
* @title: gltestsrc
*
* <refsect2>
* <para>
* The gltestsrc element is used to produce test video texture.
* The video test produced can be controlled with the "pattern"
* property.
* </para>
* <title>Example launch line</title>
* <para>
* <programlisting>
*
* ## Example launch line
*
* |[
* gst-launch-1.0 -v gltestsrc pattern=smpte ! glimagesink
* </programlisting>
* ]|
* Shows original SMPTE color bars in a window.
* </para>
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -21,11 +21,11 @@
/**
* SECTION:element-gltransformation
* @title: gltransformation
*
* Transforms video on the GPU.
*
* <refsect2>
* <title>Examples</title>
* ## 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
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,15 +20,15 @@
/**
* SECTION:element-glvideo_flip
* @title: glvideo_flip
*
* Transforms video on the GPU.
*
* <refsect2>
* <title>Examples</title>
* ## Examples
* |[
* gst-launch-1.0 videotestsrc ! glupload ! glvideoflip method=clockwise ! glimagesinkelement
* ]| This pipeline flips the test image 90 degrees clockwise.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -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.
*
* <refsect2>
* <title>Examples</title>
* ## 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 \
* ]|
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -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.
*
* <refsect2>
* <title>Examples</title>
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -23,20 +23,20 @@
/**
* SECTION:plugin-opengl
* @title: GstOpengl
*
* Cross-platform OpenGL plugin.
* <refsect2>
* <title>Debugging</title>
* </refsect2>
* <refsect2>
* <title>Examples</title>
*
* ## 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.
* </refsect2>
*
*/
#ifdef HAVE_CONFIG_H
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gstglapi
* @title: GstGlApi
* @short_description: OpenGL API specific functionality
* @see_also: #GstGLDisplay, #GstGLContext
*
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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
*
......
......@@ -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
......
......@@ -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'.
*
* <note>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().</note>
* > 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
......
......@@ -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.
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gstglformat
* @title: GstGlFormat
* @short_description: utilities for dealing with OpenGL formats
* @see_also: #GstGLBaseMemory, #GstGLMemory, #GstGLFramebuffer, #GstGLBuffer
*
......
......@@ -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
......
......@@ -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
......
......@@ -20,6 +20,7 @@
/**
* SECTION:gstgloverlaycompositor
* @title: GstGLOverlayCompositor
* @short_description: Composite multiple overlays using OpenGL
* @see_also: #GstGLMemory, #GstGLContext
*/
......
......@@ -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.
......
......@@ -31,11 +31,12 @@
/**
* SECTION:gstglrenderbuffer
* @title: GstGLRenderBuffer