GLDisplay

#GstGLDisplay represents a connection to the underlying windowing system. Elements are required to make use of #GstContext to share and propagate 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', 'surfaceless', '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 OpenGL API requested by the OpenGL platform. Common values are 'opengl', 'opengl3' 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 > applications ensure that threading support has been initialized before any > other toolkit/library functionality is accessed. Failure to do so could > result in sudden application abortion during execution. The most notably > example of such a function is X11's XInitThreads\().

class GLDisplay : ObjectGst {

this();

static gstgl.gldisplay.GLDisplay newWithType(gstgl.types.GLDisplayType type);

bool addContext(gstgl.glcontext.GLContext context);

bool createContext(gstgl.glcontext.GLContext otherContext, gstgl.glcontext.GLContext pContext);

gstgl.glwindow.GLWindow createWindow();

bool ensureContext(gstgl.glcontext.GLContext otherContext, gstgl.glcontext.GLContext context);

void filterGlApi(gstgl.types.GLAPI glApi);

gstgl.glwindow.GLWindow findWindow(void* data, glib.types.CompareFunc compareFunc);

gstgl.types.GLAPI getGlApi();

gstgl.types.GLAPI getGlApiUnlocked();

gstgl.glcontext.GLContext getGlContextForThread(glib.thread.Thread thread);

size_t getHandle();

gstgl.types.GLDisplayType getHandleType();

void removeContext(gstgl.glcontext.GLContext context);

bool removeWindow(gstgl.glwindow.GLWindow window);

gstgl.glwindow.GLWindow retrieveWindow(void* data, glib.types.CompareFunc compareFunc);

ulong connectCreateContext(T callback, Flag!"After" after);

}

Constructors

this this()

Members

Functions

addContext bool addContext(gstgl.glcontext.GLContext context)
connectCreateContext ulong connectCreateContext(T callback, Flag!"After" after): Connect to CreateContext signal.
createContext bool createContext(gstgl.glcontext.GLContext otherContext, gstgl.glcontext.GLContext pContext): It requires the display's object lock to be held.
createWindow gstgl.glwindow.GLWindow createWindow()
ensureContext bool ensureContext(gstgl.glcontext.GLContext otherContext, gstgl.glcontext.GLContext context): Ensures that the display has a valid GL context for the current thread. If context already contains a valid context, this does nothing.
filterGlApi void filterGlApi(gstgl.types.GLAPI glApi): limit the use of OpenGL to the requested gl_api. This is intended to allow application and elements to request a specific set of OpenGL API's based on what they support. See gstgl.glcontext.GLContext.getGlApi for the retrieving the API supported by a #GstGLContext.
findWindow gstgl.glwindow.GLWindow findWindow(void* data, glib.types.CompareFunc compareFunc): Execute compare_func over the list of windows stored by display. The first argument to compare_func is the #GstGLWindow being checked and the second argument is data.
getGlApi gstgl.types.GLAPI getGlApi(): see gstgl.gldisplay.GLDisplay.filterGlApi for what the returned value represents
getGlApiUnlocked gstgl.types.GLAPI getGlApiUnlocked()
getGlContextForThread gstgl.glcontext.GLContext getGlContextForThread(glib.thread.Thread thread)
getHandle size_t getHandle()
getHandleType gstgl.types.GLDisplayType getHandleType()
removeContext void removeContext(gstgl.glcontext.GLContext context): Must be called with the object lock held.
removeWindow bool removeWindow(gstgl.glwindow.GLWindow window)
retrieveWindow gstgl.glwindow.GLWindow retrieveWindow(void* data, glib.types.CompareFunc compareFunc): Execute compare_func over the list of windows stored by display. The first argument to compare_func is the #GstGLWindow being checked and the second argument is data.

Static functions

newWithType gstgl.gldisplay.GLDisplay newWithType(gstgl.types.GLDisplayType type): Will always return a #GstGLDisplay of a single type. This differs from gstgl.gldisplay.GLDisplay.new_ and the seemingly equivalent call gst_gl_display_new_with_type (GST_GL_DISPLAY_TYPE_ANY) in that the latter may return NULL.

Inherited Members

From ObjectGst

checkUniqueness bool checkUniqueness(gst.object.ObjectGst[] list, string name): Checks to see if there is any object named name in list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object.
defaultDeepNotify void defaultDeepNotify(gobject.object.ObjectG object, gst.object.ObjectGst orig, gobject.param_spec.ParamSpec pspec, string[] excludedProps): A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print.
replace bool replace(gst.object.ObjectGst oldobj, gst.object.ObjectGst newobj): Atomically modifies a pointer to point to a new object. The reference count of oldobj is decreased and the reference count of newobj is increased.
addControlBinding bool addControlBinding(gst.control_binding.ControlBinding binding): Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced.
defaultError void defaultError(glib.error.ErrorG error, string debug_): A default error function that uses glib.global.printerr to display the error message and the optional debug string..
getControlBinding gst.control_binding.ControlBinding getControlBinding(string propertyName): Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use.
getControlRate gst.types.ClockTime getControlRate(): Obtain the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
getGValueArray bool getGValueArray(string propertyName, gst.types.ClockTime timestamp, gst.types.ClockTime interval, gobject.value.Value[] values): Gets a number of #GValues for the given controlled property starting at the requested time. The array values need to hold enough space for n_values of #GValue.
getName string getName(): Returns a copy of the name of object. Caller should glib.global.gfree the return value after usage. For a nameless object, this returns null, which you can safely glib.global.gfree as well.
getParent gst.object.ObjectGst getParent(): Returns the parent of object. This function increases the refcount of the parent object so you should gst.object.ObjectGst.unref it after usage.
getPathString string getPathString(): Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging.
getValue gobject.value.Value getValue(string propertyName, gst.types.ClockTime timestamp): Gets the value for the given controlled property at the requested time.
hasActiveControlBindings bool hasActiveControlBindings(): Check if the object has active controlled properties.
hasAncestor bool hasAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsAncestor bool hasAsAncestor(gst.object.ObjectGst ancestor): Check if object has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
hasAsParent bool hasAsParent(gst.object.ObjectGst parent): Check if parent is the parent of object. E.g. a #GstElement can check if it owns a given #GstPad.
removeControlBinding bool removeControlBinding(gst.control_binding.ControlBinding binding): Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed.
setControlBindingDisabled void setControlBindingDisabled(string propertyName, bool disabled): This function is used to disable the control bindings on a property for some time, i.e. gst.object.ObjectGst.syncValues will do nothing for the property.
setControlBindingsDisabled void setControlBindingsDisabled(bool disabled): This function is used to disable all controlled properties of the object for some time, i.e. gst.object.ObjectGst.syncValues will do nothing.
setControlRate void setControlRate(gst.types.ClockTime controlRate): Change the control-rate for this object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst.object.ObjectGst.syncValues in between. The length of the processing segment should be up to control-rate nanoseconds.
setName bool setName(string name): Sets the name of object, or gives object a guaranteed unique name (if name is null). This function makes a copy of the provided name, so the caller retains ownership of the name it sent.
setParent bool setParent(gst.object.ObjectGst parent): Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst.object.ObjectGst.refSink).
suggestNextSync gst.types.ClockTime suggestNextSync(): Returns a suggestion for timestamps where buffers should be split to get best controller results.
syncValues bool syncValues(gst.types.ClockTime timestamp): Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp.
unparent void unparent(): Clear the parent of object, removing the associated reference. This function decreases the refcount of object.
connectDeepNotify ulong connectDeepNotify(string detail, T callback, Flag!"After" after): Connect to DeepNotify signal.

gstgl gldisplay classes

GLDisplay