gl: document GST_GL_* environment variables

https://bugzilla.gnome.org/show_bug.cgi?id=733245

diff --git a/ext/gl/gstglimagesink.c b/ext/gl/gstglimagesink.c
index c139d20c226afa3a6154c64676ed98dfce5746be..dc919d8310659803c23eb3d48c00873f492d46dd 100644 (file)
--- a/ext/gl/gstglimagesink.c
+++ b/ext/gl/gstglimagesink.c
@@ -30,6 +30,9 @@
  * If no Window ID was provided by the application, the element will
  * create its own internal window and render into it.
  *
+ * See the #GstGLDisplay documentation for a list of environment variables that
+ * can override window/platform detection.
+ *
  * <refsect2>
  * <title>Scaling</title>
  * <para>

diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c
index c3005f7715ced31cb788cf0384b28da2a472a913..cf8599290a8e6651a48d254e2140a6dedf2e5cdf 100644 (file)
--- a/gst-libs/gst/gl/gstgldisplay.c
+++ b/gst-libs/gst/gl/gstgldisplay.c
@@ -31,6 +31,15 @@
  * Elements are required to make use of #GstContext to share and propogate
  * a #GstGLDisplay.
  *
+ * There are a number of environment variables that influence the choice of
+ * platform and window system specific functionality.
+ * - GST_GL_WINDOW influences the window system to use.  Common values are
+ *   'x11', 'wayland', 'win32' or 'cocoa'.
+ * - GST_GL_PLATFORM influences the OpenGL platform to use.  Common values are
+ *   'egl', 'glx', 'wgl' or 'cgl'.
+ * - GST_GL_API influences the 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