summaryrefslogtreecommitdiff
path: root/gst-libs/gst/gl
diff options
context:
space:
mode:
authorMatthew Waters <ystreet00@gmail.com>2014-08-01 16:41:13 +1000
committerMatthew Waters <ystreet00@gmail.com>2014-08-01 16:43:47 +1000
commit707cb5800490a654e16ca683e104c1fb9ea3eb87 (patch)
tree85b536c0edf39f098ba376773a478ca489d360f5 /gst-libs/gst/gl
parent81e71aa01b19df208058036c60acb9d62dedb961 (diff)
gl: document GST_GL_* environment variables
https://bugzilla.gnome.org/show_bug.cgi?id=733245
Diffstat (limited to 'gst-libs/gst/gl')
-rw-r--r--gst-libs/gst/gl/gstgldisplay.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c
index c3005f771..cf8599290 100644
--- 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