gstgl.glwindow

Module for [GLWindow] class

class GLWindow GLWindowGidBuilder GLWindowGidBuilderImpl

Types 3

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

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

GLWindow self() nothrowReturns `this`, for use in `with` statements.

GLWindowGidBuilder builder() static nothrowGet builder for [gstgl.glwindow.GLWindow] Returns: New builder object

bool controlsViewport() nothrowChecks if window controls the GL viewport. Returns: true if window controls the GL viewport, otherwise false

void draw() nothrowRedraw the window contents. Implementations should invoke the draw callback.

gstgl.glcontext.GLContext getContext() nothrow

size_t getDisplay() nothrow

void getSurfaceDimensions(out uint width, out uint height) nothrow

size_t getWindowHandle() nothrow

void handleEvents(bool handleEvents) nothrowTell 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...

bool hasOutputSurface() nothrowQuery whether window has output surface or not Returns: true if window has useable output surface

void queueResize() nothrowQueue resizing of window.

void quit() nothrowQuit the runloop's execution.

void resize(uint width, uint height) nothrowResize window to the given width and height.

void run() nothrowStart the execution of the runloop.

void sendKeyEvent(string eventType, string keyStr) nothrow

void sendMessage(gstgl.types.GLWindowCB callback) nothrowInvoke callback with data on the window thread. callback is guaranteed to have executed when this function returns.

void sendMessageAsync(gstgl.types.GLWindowCB callback) nothrowInvoke callback with data on the window thread. The callback may not have been executed when this function returns.

void sendMouseEvent(string eventType, int button, double posx, double posy) nothrow

void sendScrollEvent(double posx, double posy, double deltaX, double deltaY) nothrowNotify a window about a scroll event. A scroll signal holding the event coordinates will be emitted.

void setCloseCallback(gstgl.types.GLWindowCB callback) nothrowSets the callback called when the window is about to close.

void setDrawCallback(gstgl.types.GLWindowCB callback) nothrowSets the draw callback called every time [gstgl.glwindow.GLWindow.draw] is called

void setPreferredSize(int width, int height) nothrowSet the preferred width and height of the window. Implementations are free to ignore this information.

bool setRenderRectangle(int x, int y, int width, int height) nothrowTell a window that it should render into a specific region of the window according to the #GstVideoOverlay interface.

void setResizeCallback(gstgl.types.GLWindowResizeCB callback) nothrowSets the resize callback called every time a resize of the window occurs.

void setWindowHandle(size_t handle) nothrowSets the window that this window should render into. Some implementations require this to be called with a valid handle before drawing can commence.

void show() nothrowPresent the window to the screen.

gulong connectKeyEvent(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  string)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gstgl.glwindow.GLWindow)))
   &&  Parameters!T.length <  4)

nothrowConnect to `KeyEvent` signal.

gulong connectMouseEvent(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  string)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  int)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  double)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3]  ==  double)))
   && (Parameters!T.length <  5 || (ParameterStorageClassTuple!T[4]  ==  ParameterStorageClass.none &&  is(Parameters!T[4] :  gstgl.glwindow.GLWindow)))
   &&  Parameters!T.length <  6)

nothrowConnect to `MouseEvent` signal.

gulong connectScrollEvent(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  double)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  double)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  double)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3]  ==  double)))
   && (Parameters!T.length <  5 || (ParameterStorageClassTuple!T[4]  ==  ParameterStorageClass.none &&  is(Parameters!T[4] :  gstgl.glwindow.GLWindow)))
   &&  Parameters!T.length <  6)

nothrowConnect to `ScrollEvent` signal.

gulong connectWindowHandleChanged(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gstgl.glwindow.GLWindow)))
   &&  Parameters!T.length <  2)

nothrowConnect to `WindowHandleChanged` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this(gstgl.gldisplay.GLDisplay display)

classGLWindowGidBuilderImpl(T) : gst.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for gstgl.glwindow.GLWindow

classGLWindowGidBuilder : GLWindowGidBuilderImpl!GLWindowGidBuilder

Fluent builder for gstgl.glwindow.GLWindow

Methods

GLWindow build() nothrowCreate object from builder. Returns: New object