glfiltershader: expand the docs slightly
authorMatthew Waters <matthew@centricular.com>
Tue, 8 Nov 2016 02:35:33 +0000 (13:35 +1100)
committerMatthew Waters <matthew@centricular.com>
Tue, 8 Nov 2016 04:14:27 +0000 (15:14 +1100)
Add an example OpenGL shader

ext/gl/gstglfiltershader.c

index bff3c44..f343469 100644 (file)
  * |[
  * gst-launch-1.0 videotestsrc ! glupload ! glshader fragment="\"`cat myshader.frag`\"" ! glimagesink
  * ]|
- * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required. A #version header is required
+ * FBO (Frame Buffer Object) and GLSL (OpenGL Shading Language) are required.
+ * Depending on the exact OpenGL version chosen and the exact requirements of
+ * the OpenGL implementation, a #version header may be required.
+ *
+ * The following is a simple OpenGL ES (also usable with OpenGL 3 core contexts)
+ * passthrough shader with the required inputs.
+ * |[
+ * #version 100
+ * #ifdef GL_ES
+ * precision mediump float;
+ * #endif
+ * varying vec2 v_texcoord;
+ * uniform sampler2D tex;
+ * uniform float time;
+ * uniform float width;
+ * uniform float height;
+ * 
+ * void main () {
+ *   gl_FragColor = texture2D( tex, v_texcoord );
+ * }
+ * ]|
+ *
  * </refsect2>
  */
 #ifdef HAVE_CONFIG_H