From d3804ee7aa89132a23ec5e8e26c4dd0e5b746bf8 Mon Sep 17 00:00:00 2001 From: Matthew Waters Date: Fri, 1 Aug 2014 16:41:13 +1000 Subject: [PATCH] gl: document GST_GL_* environment variables https://bugzilla.gnome.org/show_bug.cgi?id=733245 --- ext/gl/gstglimagesink.c | 3 +++ gst-libs/gst/gl/gstgldisplay.c | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/ext/gl/gstglimagesink.c b/ext/gl/gstglimagesink.c index c139d20c22..dc919d8310 100644 --- 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. + * * * Scaling * diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c index c3005f7715..cf8599290a 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'. + * * 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