GstGLWindow

GstGL.GLWindow

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstGL.GLWindow

GstGL.GLWindow.prototype.new

function GstGL.GLWindow.prototype.new(display: GstGL.GLDisplay): {
    // javascript wrapper for 'gst_gl_window_new'
}

Since : 1.4

GstGL.GLWindow.prototype.controls_viewport

function GstGL.GLWindow.prototype.controls_viewport(): {
    // javascript wrapper for 'gst_gl_window_controls_viewport'
}

Checks if window controls the GL viewport.

Since : 1.16

GstGL.GLWindow.prototype.draw

function GstGL.GLWindow.prototype.draw(): {
    // javascript wrapper for 'gst_gl_window_draw'
}

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

Since : 1.4

GstGL.GLWindow.prototype.get_context

function GstGL.GLWindow.prototype.get_context(): {
    // javascript wrapper for 'gst_gl_window_get_context'
}

Since : 1.4

GstGL.GLWindow.prototype.get_display

function GstGL.GLWindow.prototype.get_display(): {
    // javascript wrapper for 'gst_gl_window_get_display'
}

Since : 1.4

GstGL.GLWindow.prototype.get_surface_dimensions

function GstGL.GLWindow.prototype.get_surface_dimensions(): {
    // javascript wrapper for 'gst_gl_window_get_surface_dimensions'
}

Since : 1.6

GstGL.GLWindow.prototype.get_window_handle

function GstGL.GLWindow.prototype.get_window_handle(): {
    // javascript wrapper for 'gst_gl_window_get_window_handle'
}

Since : 1.4

GstGL.GLWindow.prototype.handle_events

function GstGL.GLWindow.prototype.handle_events(handle_events: Number): {
    // javascript wrapper for 'gst_gl_window_handle_events'
}

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.

GstGL.GLWindow.prototype.has_output_surface

function GstGL.GLWindow.prototype.has_output_surface(): {
    // javascript wrapper for 'gst_gl_window_has_output_surface'
}

Query whether window has output surface or not

Since : 1.18

GstGL.GLWindow.prototype.queue_resize

function GstGL.GLWindow.prototype.queue_resize(): {
    // javascript wrapper for 'gst_gl_window_queue_resize'
}

Queue resizing of window.

GstGL.GLWindow.prototype.quit

function GstGL.GLWindow.prototype.quit(): {
    // javascript wrapper for 'gst_gl_window_quit'
}

Quit the runloop's execution.

Since : 1.4

GstGL.GLWindow.prototype.resize

function GstGL.GLWindow.prototype.resize(width: Number, height: Number): {
    // javascript wrapper for 'gst_gl_window_resize'
}

Resize window to the given width and height.

GstGL.GLWindow.prototype.run

function GstGL.GLWindow.prototype.run(): {
    // javascript wrapper for 'gst_gl_window_run'
}

Start the execution of the runloop.

Since : 1.4

GstGL.GLWindow.prototype.send_key_event

function GstGL.GLWindow.prototype.send_key_event(event_type: String, key_str: String): {
    // javascript wrapper for 'gst_gl_window_send_key_event'
}

GstGL.GLWindow.prototype.send_message

function GstGL.GLWindow.prototype.send_message(callback: GstGL.GLWindowCB, data: Object): {
    // javascript wrapper for 'gst_gl_window_send_message'
}

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

Since : 1.4

GstGL.GLWindow.prototype.send_message_async

function GstGL.GLWindow.prototype.send_message_async(callback: GstGL.GLWindowCB, data: Object): {
    // javascript wrapper for 'gst_gl_window_send_message_async'
}

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

Since : 1.4

GstGL.GLWindow.prototype.send_mouse_event

function GstGL.GLWindow.prototype.send_mouse_event(event_type: String, button: Number, posx: Number, posy: Number): {
    // javascript wrapper for 'gst_gl_window_send_mouse_event'
}

GstGL.GLWindow.prototype.send_scroll_event

function GstGL.GLWindow.prototype.send_scroll_event(posx: Number, posy: Number, delta_x: Number, delta_y: Number): {
    // javascript wrapper for 'gst_gl_window_send_scroll_event'
}

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

Since : 1.18

GstGL.GLWindow.prototype.set_close_callback

function GstGL.GLWindow.prototype.set_close_callback(callback: GstGL.GLWindowCB, data: Object): {
    // javascript wrapper for 'gst_gl_window_set_close_callback'
}

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

Since : 1.4

GstGL.GLWindow.prototype.set_draw_callback

function GstGL.GLWindow.prototype.set_draw_callback(callback: GstGL.GLWindowCB, data: Object): {
    // javascript wrapper for 'gst_gl_window_set_draw_callback'
}

Sets the draw callback called every time GstGL.GLWindow.prototype.draw is called

Since : 1.4

GstGL.GLWindow.prototype.set_preferred_size

function GstGL.GLWindow.prototype.set_preferred_size(width: Number, height: Number): {
    // javascript wrapper for 'gst_gl_window_set_preferred_size'
}

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

Since : 1.6

GstGL.GLWindow.prototype.set_render_rectangle

function GstGL.GLWindow.prototype.set_render_rectangle(x: Number, y: Number, width: Number, height: Number): {
    // javascript wrapper for 'gst_gl_window_set_render_rectangle'
}

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

GstGL.GLWindow.prototype.set_resize_callback

function GstGL.GLWindow.prototype.set_resize_callback(callback: GstGL.GLWindowResizeCB, data: Object): {
    // javascript wrapper for 'gst_gl_window_set_resize_callback'
}

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

Since : 1.4

GstGL.GLWindow.prototype.set_window_handle

function GstGL.GLWindow.prototype.set_window_handle(handle: Number): {
    // javascript wrapper for 'gst_gl_window_set_window_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.

Since : 1.4

GstGL.GLWindow.prototype.show

function GstGL.GLWindow.prototype.show(): {
    // javascript wrapper for 'gst_gl_window_show'
}

Present the window to the screen.

Since : 1.6

key-event

function key_event_callback(self: GstGL.GLWindow, id: String, key: String, user_data: Object): {
    // javascript callback for the 'key-event' signal
}

Will be emitted when a key event is received by the GstGLwindow.

Flags: Run Last

Since : 1.6

mouse-event

function mouse_event_callback(self: GstGL.GLWindow, id: String, button: Number, x: Number, y: Number, user_data: Object): {
    // javascript callback for the 'mouse-event' signal
}

Will be emitted when a mouse event is received by the GstGLwindow.

Flags: Run Last

Since : 1.6

scroll-event

function scroll_event_callback(self: GstGL.GLWindow, x: Number, y: Number, delta_x: Number, delta_y: Number, user_data: Object): {
    // javascript callback for the 'scroll-event' signal
}

Will be emitted when a mouse scroll event is received by the GstGLwindow.

Flags: Run Last

Since : 1.18

window-handle-changed

function window_handle_changed_callback(self: GstGL.GLWindow, user_data: Object): {
    // javascript callback for the 'window-handle-changed' signal
}

Will be emitted when the window handle has been set into the native implementation, but before the context is re-activated. By using this signal, elements can refresh associated resource without relying on direct handle comparision.

Flags: Run Last

Since : 1.20

vfunc_close

function vfunc_close(window: GstGL.GLWindow): {
    // javascript implementation of the 'close' virtual method
}

close the connection to the display

vfunc_controls_viewport

function vfunc_controls_viewport(window: GstGL.GLWindow): {
    // javascript implementation of the 'controls_viewport' virtual method
}

Whether the window takes care of glViewport setup. and the user does not need to deal with viewports

vfunc_draw

function vfunc_draw(window: GstGL.GLWindow): {
    // javascript implementation of the 'draw' virtual method
}

redraw the window with the specified dimensions

vfunc_get_display

function vfunc_get_display(window: GstGL.GLWindow): {
    // javascript implementation of the 'get_display' virtual method
}

Gets the current windowing system display connection

vfunc_get_window_handle

function vfunc_get_window_handle(window: GstGL.GLWindow): {
    // javascript implementation of the 'get_window_handle' virtual method
}

Gets the current window handle that this GstGL.GLWindow is rendering into. This may return a different value to what is passed into set_window_handle

vfunc_handle_events

function vfunc_handle_events(window: GstGL.GLWindow, handle_events: Number): {
    // javascript implementation of the 'handle_events' virtual method
}

whether to handle 'extra' events from the windowing system. Basic events like surface moves and resizes are still valid things to listen for.

vfunc_has_output_surface

function vfunc_has_output_surface(window: GstGL.GLWindow): {
    // javascript implementation of the 'has_output_surface' virtual method
}

Whether the window has output surface or not. (Since: 1.18)

vfunc_open

function vfunc_open(window: GstGL.GLWindow): {
    // javascript implementation of the 'open' virtual method
}

open the connection to the display

vfunc_queue_resize

function vfunc_queue_resize(window: GstGL.GLWindow): {
    // javascript implementation of the 'queue_resize' virtual method
}

request a resize to occur when possible

vfunc_quit

function vfunc_quit(window: GstGL.GLWindow): {
    // javascript implementation of the 'quit' virtual method
}

send a quit to the mainloop

vfunc_run

function vfunc_run(window: GstGL.GLWindow): {
    // javascript implementation of the 'run' virtual method
}

run the mainloop

vfunc_send_message

function vfunc_send_message(window: GstGL.GLWindow, callback: GstGL.GLWindowCB, data: Object): {
    // javascript implementation of the 'send_message' virtual method
}

invoke a function on the window thread. Required to be reentrant.

vfunc_send_message_async

function vfunc_send_message_async(window: GstGL.GLWindow, callback: GstGL.GLWindowCB, data: Object): {
    // javascript implementation of the 'send_message_async' virtual method
}

invoke a function on the window thread. run may or may not have been called. Required to be reentrant.

vfunc_set_preferred_size

function vfunc_set_preferred_size(window: GstGL.GLWindow, width: Number, height: Number): {
    // javascript implementation of the 'set_preferred_size' virtual method
}

request that the window change surface size. The implementation is free to ignore this information.

vfunc_set_render_rectangle

function vfunc_set_render_rectangle(window: GstGL.GLWindow, x: Number, y: Number, width: Number, height: Number): {
    // javascript implementation of the 'set_render_rectangle' virtual method
}

request a rectangle to render into. See GstVideo.VideoOverlay

vfunc_set_window_handle

function vfunc_set_window_handle(window: GstGL.GLWindow, handle: Number): {
    // javascript implementation of the 'set_window_handle' virtual method
}

Set a window handle to render into

vfunc_show

function vfunc_show(window: GstGL.GLWindow): {
    // javascript implementation of the 'show' virtual method
}

request that the window be shown to the user

GstGL.prototype.gl_window_error_quark

function GstGL.prototype.gl_window_error_quark(): {
    // javascript wrapper for 'gst_gl_window_error_quark'
}

GstGL.GLWindowError

GstGL.GLWindowCB

function GstGL.GLWindowCB(data: Object): {
    // javascript wrapper for 'GstGLWindowCB'
}

GstGL.GLWindowResizeCB

function GstGL.GLWindowResizeCB(data: Object, width: Number, height: Number): {
    // javascript wrapper for 'GstGLWindowResizeCB'
}