summaryrefslogtreecommitdiff
path: root/gst-libs/gst/gl/gstgldisplay.c
diff options
context:
space:
mode:
Diffstat (limited to 'gst-libs/gst/gl/gstgldisplay.c')
-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