gl: Add/update docs for glviewconvert, glstereomix

Add some example pipelines for glstereomix, and fix up
the example pipelines for glviewconvert
This commit is contained in:
Jan Schmidt 2016-08-26 02:06:00 +10:00
parent 3ca79c93ba
commit 9e516b35e3
2 changed files with 42 additions and 4 deletions

View file

@ -21,6 +21,42 @@
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:element-glstereomix
*
* Combine 2 input streams to produce a stereoscopic output
* stream. Input views are taken from the left pad and right pad
* respectively, and mixed according to their timelines.
*
* If either input stream is stereoscopic, the approproriate view
* (left or right) is taken from each stream and placed into the output.
*
* The multiview representation on the output is chosen according to
* the downstream caps.
*
* <refsect2>
* <title>Examples</title>
* |[
* gst-launch-1.0 -v videotestsrc pattern=ball name=left \
* videotestsrc name=right glstereomix name=mix \
* left. ! vid/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=side-by-side ! \
* queue ! glimagesink output-multiview-mode=side-by-side
* ]| Mix 2 different videotestsrc patterns into a side-by-side stereo image and display it.
* |[
* gst-launch-1.0 -ev v4l2src name=left \
* videotestsrc name=right \
* glstereomix name=mix \
* left. ! video/x-raw,width=640,height=480 ! glupload ! glcolorconvert ! mix. \
* 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
* ]| 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"
#endif

View file

@ -31,11 +31,13 @@
* <refsect2>
* <title>Examples</title>
* |[
* gst-launch-1.0 videotestsrc ! glviewconvert ! glimagesink
* ]|
* gst-launch-1.0 videotestsrc ! glupload ! glviewconvert ! glimagesink
* ]| Simple placebo example demonstrating identity passthrough of mono video
* |[
* gst-launch-1.0 videotestsrc pattern=checkers-1 ! glviewconvert input-mode-override=side-by-side ! glimagesink -v
* ]|
* gst-launch-1.0 videotestsrc pattern=checkers-1 ! glupload ! \
* glviewconvert input-mode-override=side-by-side ! glimagesink -v
* ]| 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>
*/