GLWindow

GstGLWindow represents a window that elements can render into. A window can either be a user visible window (onscreen) or hidden (offscreen).

Constructors

this
this(gstgl.gldisplay.GLDisplay display)

Members

Functions

connectKeyEvent
ulong connectKeyEvent(T callback, Flag!"After" after)

Connect to KeyEvent signal.

connectMouseEvent
ulong connectMouseEvent(T callback, Flag!"After" after)

Connect to MouseEvent signal.

connectScrollEvent
ulong connectScrollEvent(T callback, Flag!"After" after)

Connect to ScrollEvent signal.

connectWindowHandleChanged
ulong connectWindowHandleChanged(T callback, Flag!"After" after)

Connect to WindowHandleChanged signal.

controlsViewport
bool controlsViewport()

Checks if window controls the GL viewport.

draw
void draw()

Redraw the window contents. Implementations should invoke the draw callback.

getContext
gstgl.glcontext.GLContext getContext()
getDisplay
size_t getDisplay()
getSurfaceDimensions
void getSurfaceDimensions(uint width, uint height)
getWindowHandle
size_t getWindowHandle()
handleEvents
void handleEvents(bool handleEvents)

Tell a window that it should handle events from the window system. These events are forwarded upstream as navigation events. In some window systems events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely from the window.

hasOutputSurface
bool hasOutputSurface()

Query whether window has output surface or not

queueResize
void queueResize()

Queue resizing of window.

quit
void quit()

Quit the runloop's execution.

resize
void resize(uint width, uint height)

Resize window to the given width and height.

run
void run()

Start the execution of the runloop.

sendKeyEvent
void sendKeyEvent(string eventType, string keyStr)
sendMessage
void sendMessage(gstgl.types.GLWindowCB callback)

Invoke callback with data on the window thread. callback is guaranteed to have executed when this function returns.

sendMessageAsync
void sendMessageAsync(gstgl.types.GLWindowCB callback)

Invoke callback with data on the window thread. The callback may not have been executed when this function returns.

sendMouseEvent
void sendMouseEvent(string eventType, int button, double posx, double posy)
sendScrollEvent
void sendScrollEvent(double posx, double posy, double deltaX, double deltaY)

Notify a window about a scroll event. A scroll signal holding the event coordinates will be emitted.

setCloseCallback
void setCloseCallback(gstgl.types.GLWindowCB callback)

Sets the callback called when the window is about to close.

setDrawCallback
void setDrawCallback(gstgl.types.GLWindowCB callback)

Sets the draw callback called every time gstgl.glwindow.GLWindow.draw is called

setPreferredSize
void setPreferredSize(int width, int height)

Set the preferred width and height of the window. Implementations are free to ignore this information.

setRenderRectangle
bool setRenderRectangle(int x, int y, int width, int height)

Tell a window that it should render into a specific region of the window according to the #GstVideoOverlay interface.

setResizeCallback
void setResizeCallback(gstgl.types.GLWindowResizeCB callback)

Sets the resize callback called every time a resize of the window occurs.

setWindowHandle
void setWindowHandle(size_t handle)

Sets the window that this window should render into. Some implementations require this to be called with a valid handle before drawing can commence.

show
void show()

Present the window to the screen.

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.