GstGLWindow
GstGLWindow represents a window that elements can render into. A window can either be a user visible window (onscreen) or hidden (offscreen).
GstGLWindow
GObject ╰──GInitiallyUnowned ╰──GstObject ╰──GstGLWindow
GstGLWindow is an opaque struct and should only be accessed through the provided api.
Class structure
GstGLWindow
GObject ╰──GInitiallyUnowned ╰──GstObject ╰──GstGLWindow
GstGLWindow is an opaque struct and should only be accessed through the provided api.
GstGLWindow
GObject ╰──GInitiallyUnowned ╰──GstObject ╰──GstGLWindow
GstGLWindow is an opaque struct and should only be accessed through the provided api.
Constructors
gst_gl_window_new
GstGLWindow * gst_gl_window_new (GstGLDisplay * display)
Parameters:
display
–
a new GstGLWindow using display's connection
Since : 1.4
GstGL.GLWindow.prototype.new
function GstGL.GLWindow.prototype.new(display: GstGL.GLDisplay): {
// javascript wrapper for 'gst_gl_window_new'
}
Parameters:
display
(
GstGL.GLDisplay
)
–
a new GstGL.GLWindow using display's connection
Since : 1.4
GstGL.GLWindow.new
def GstGL.GLWindow.new (display):
#python wrapper for 'gst_gl_window_new'
Parameters:
display
(
GstGL.GLDisplay
)
–
a new GstGL.GLWindow using display's connection
Since : 1.4
Methods
gst_gl_window_controls_viewport
gboolean gst_gl_window_controls_viewport (GstGLWindow * window)
Checks if window controls the GL viewport.
Parameters:
window
–
Since : 1.16
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.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.16
GstGL.GLWindow.controls_viewport
def GstGL.GLWindow.controls_viewport (self):
#python wrapper for 'gst_gl_window_controls_viewport'
Checks if window controls the GL viewport.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.16
gst_gl_window_draw
gst_gl_window_draw (GstGLWindow * window)
Redraw the window contents. Implementations should invoke the draw callback.
Parameters:
window
–
Since : 1.4
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.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
GstGL.GLWindow.draw
def GstGL.GLWindow.draw (self):
#python wrapper for 'gst_gl_window_draw'
Redraw the window contents. Implementations should invoke the draw callback.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
gst_gl_window_get_context
GstGLContext * gst_gl_window_get_context (GstGLWindow * window)
Parameters:
window
–
the GstGLContext associated with this window
Since : 1.4
GstGL.GLWindow.prototype.get_context
function GstGL.GLWindow.prototype.get_context(): {
// javascript wrapper for 'gst_gl_window_get_context'
}
Parameters:
window
(
GstGL.GLWindow
)
–
the GstGL.GLContext associated with this window
Since : 1.4
GstGL.GLWindow.get_context
def GstGL.GLWindow.get_context (self):
#python wrapper for 'gst_gl_window_get_context'
Parameters:
window
(
GstGL.GLWindow
)
–
the GstGL.GLContext associated with this window
Since : 1.4
gst_gl_window_get_display
guintptr gst_gl_window_get_display (GstGLWindow * window)
Parameters:
window
–
the windowing system display handle for this window
Since : 1.4
GstGL.GLWindow.prototype.get_display
function GstGL.GLWindow.prototype.get_display(): {
// javascript wrapper for 'gst_gl_window_get_display'
}
Parameters:
window
(
GstGL.GLWindow
)
–
the windowing system display handle for this window
Since : 1.4
GstGL.GLWindow.get_display
def GstGL.GLWindow.get_display (self):
#python wrapper for 'gst_gl_window_get_display'
Parameters:
window
(
GstGL.GLWindow
)
–
the windowing system display handle for this window
Since : 1.4
gst_gl_window_get_surface_dimensions
gst_gl_window_get_surface_dimensions (GstGLWindow * window, guint * width, guint * height)
Parameters:
window
–
width
(
[out]
)
–
resulting surface width
height
(
[out]
)
–
resulting surface height
Since : 1.6
GstGL.GLWindow.prototype.get_surface_dimensions
function GstGL.GLWindow.prototype.get_surface_dimensions(): {
// javascript wrapper for 'gst_gl_window_get_surface_dimensions'
}
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.6
GstGL.GLWindow.get_surface_dimensions
def GstGL.GLWindow.get_surface_dimensions (self):
#python wrapper for 'gst_gl_window_get_surface_dimensions'
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.6
gst_gl_window_get_window_handle
guintptr gst_gl_window_get_window_handle (GstGLWindow * window)
Parameters:
window
–
the window handle we are currently rendering into
Since : 1.4
GstGL.GLWindow.prototype.get_window_handle
function GstGL.GLWindow.prototype.get_window_handle(): {
// javascript wrapper for 'gst_gl_window_get_window_handle'
}
Parameters:
window
(
GstGL.GLWindow
)
–
the window handle we are currently rendering into
Since : 1.4
GstGL.GLWindow.get_window_handle
def GstGL.GLWindow.get_window_handle (self):
#python wrapper for 'gst_gl_window_get_window_handle'
Parameters:
window
(
GstGL.GLWindow
)
–
the window handle we are currently rendering into
Since : 1.4
gst_gl_window_handle_events
gst_gl_window_handle_events (GstGLWindow * window, gboolean 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.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.
Parameters:
window
(
GstGL.GLWindow
)
–
GstGL.GLWindow.handle_events
def GstGL.GLWindow.handle_events (self, handle_events):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
gst_gl_window_has_output_surface
gboolean gst_gl_window_has_output_surface (GstGLWindow * window)
Query whether window has output surface or not
Parameters:
window
–
TRUE if window has useable output surface
Since : 1.18
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
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.18
GstGL.GLWindow.has_output_surface
def GstGL.GLWindow.has_output_surface (self):
#python wrapper for 'gst_gl_window_has_output_surface'
Query whether window has output surface or not
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.18
gst_gl_window_queue_resize
gst_gl_window_queue_resize (GstGLWindow * window)
Queue resizing of window.
Parameters:
window
–
GstGL.GLWindow.prototype.queue_resize
function GstGL.GLWindow.prototype.queue_resize(): {
// javascript wrapper for 'gst_gl_window_queue_resize'
}
Queue resizing of window.
Parameters:
window
(
GstGL.GLWindow
)
–
GstGL.GLWindow.queue_resize
def GstGL.GLWindow.queue_resize (self):
#python wrapper for 'gst_gl_window_queue_resize'
Queue resizing of window.
Parameters:
window
(
GstGL.GLWindow
)
–
gst_gl_window_quit
gst_gl_window_quit (GstGLWindow * window)
Quit the runloop's execution.
Parameters:
window
–
Since : 1.4
GstGL.GLWindow.prototype.quit
function GstGL.GLWindow.prototype.quit(): {
// javascript wrapper for 'gst_gl_window_quit'
}
Quit the runloop's execution.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
GstGL.GLWindow.quit
def GstGL.GLWindow.quit (self):
#python wrapper for 'gst_gl_window_quit'
Quit the runloop's execution.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
gst_gl_window_resize
gst_gl_window_resize (GstGLWindow * window, guint width, guint height)
Resize window to the given width and height.
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.resize
def GstGL.GLWindow.resize (self, width, height):
#python wrapper for 'gst_gl_window_resize'
Resize window to the given width and height.
gst_gl_window_run
gst_gl_window_run (GstGLWindow * window)
Start the execution of the runloop.
Parameters:
window
–
Since : 1.4
GstGL.GLWindow.prototype.run
function GstGL.GLWindow.prototype.run(): {
// javascript wrapper for 'gst_gl_window_run'
}
Start the execution of the runloop.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
GstGL.GLWindow.run
def GstGL.GLWindow.run (self):
#python wrapper for 'gst_gl_window_run'
Start the execution of the runloop.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.4
gst_gl_window_send_key_event
gst_gl_window_send_key_event (GstGLWindow * window, const char* event_type, const char* key_str)
Parameters:
window
–
event_type
–
key_str
–
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'
}
Parameters:
window
(
GstGL.GLWindow
)
–
event_type
(
String
)
–
key_str
(
String
)
–
GstGL.GLWindow.send_key_event
def GstGL.GLWindow.send_key_event (self, event_type, key_str):
#python wrapper for 'gst_gl_window_send_key_event'
Parameters:
window
(
GstGL.GLWindow
)
–
event_type
(
str
)
–
key_str
(
str
)
–
gst_gl_window_send_message
gst_gl_window_send_message (GstGLWindow * window, GstGLWindowCB callback, gpointer data)
Invoke callback with data on the window thread. callback is guaranteed to have executed when this function returns.
Parameters:
window
–
callback
(
[scope async]
)
–
function to invoke
data
(
[closure]
)
–
data to invoke callback with
Since : 1.4
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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
Object
)
–
data to invoke callback with
Since : 1.4
GstGL.GLWindow.send_message
def GstGL.GLWindow.send_message (self, callback, *data):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
variadic
)
–
data to invoke callback with
Since : 1.4
gst_gl_window_send_message_async
gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback, gpointer data, GDestroyNotify destroy)
Invoke callback with data on the window thread. The callback may not have been executed when this function returns.
Parameters:
window
–
callback
(
[scope async]
)
–
function to invoke
data
(
[closure]
)
–
data to invoke callback with
destroy
–
called when data is not needed anymore
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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
Object
)
–
data to invoke callback with
Since : 1.4
GstGL.GLWindow.send_message_async
def GstGL.GLWindow.send_message_async (self, callback, *data):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
variadic
)
–
data to invoke callback with
Since : 1.4
gst_gl_window_send_mouse_event
gst_gl_window_send_mouse_event (GstGLWindow * window, const char* event_type, int button, double posx, double posy)
Parameters:
window
–
event_type
–
button
–
posx
–
posy
–
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'
}
Parameters:
window
(
GstGL.GLWindow
)
–
event_type
(
String
)
–
button
(
Number
)
–
posx
(
Number
)
–
posy
(
Number
)
–
GstGL.GLWindow.send_mouse_event
def GstGL.GLWindow.send_mouse_event (self, event_type, button, posx, posy):
#python wrapper for 'gst_gl_window_send_mouse_event'
Parameters:
window
(
GstGL.GLWindow
)
–
event_type
(
str
)
–
button
(
int
)
–
posx
(
float
)
–
posy
(
float
)
–
gst_gl_window_send_scroll_event
gst_gl_window_send_scroll_event (GstGLWindow * window, double posx, double posy, double delta_x, double delta_y)
Notify a window about a scroll event. A scroll signal holding the event coordinates will be emitted.
Parameters:
window
–
posx
–
x position of the mouse cursor
posy
–
y position of the mouse cursor
delta_x
–
the x offset of the scroll event
delta_y
–
the y offset of the scroll event
Since : 1.18
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.
Parameters:
window
(
GstGL.GLWindow
)
–
posx
(
Number
)
–
x position of the mouse cursor
posy
(
Number
)
–
y position of the mouse cursor
delta_x
(
Number
)
–
the x offset of the scroll event
delta_y
(
Number
)
–
the y offset of the scroll event
Since : 1.18
GstGL.GLWindow.send_scroll_event
def GstGL.GLWindow.send_scroll_event (self, posx, posy, delta_x, delta_y):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
posx
(
float
)
–
x position of the mouse cursor
posy
(
float
)
–
y position of the mouse cursor
delta_x
(
float
)
–
the x offset of the scroll event
delta_y
(
float
)
–
the y offset of the scroll event
Since : 1.18
gst_gl_window_set_close_callback
gst_gl_window_set_close_callback (GstGLWindow * window, GstGLWindowCB callback, gpointer data, GDestroyNotify destroy_notify)
Sets the callback called when the window is about to close.
Parameters:
window
–
callback
(
[scope notified]
)
–
function to invoke
data
(
[closure]
)
–
data to invoke callback with
destroy_notify
–
called when data is not needed any more
Since : 1.4
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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
Object
)
–
data to invoke callback with
Since : 1.4
GstGL.GLWindow.set_close_callback
def GstGL.GLWindow.set_close_callback (self, callback, *data):
#python wrapper for 'gst_gl_window_set_close_callback'
Sets the callback called when the window is about to close.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
variadic
)
–
data to invoke callback with
Since : 1.4
gst_gl_window_set_draw_callback
gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback, gpointer data, GDestroyNotify destroy_notify)
Sets the draw callback called every time gst_gl_window_draw is called
Parameters:
window
–
callback
(
[scope notified]
)
–
function to invoke
data
(
[closure]
)
–
data to invoke callback with
destroy_notify
–
called when data is not needed any more
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
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
Object
)
–
data to invoke callback with
Since : 1.4
GstGL.GLWindow.set_draw_callback
def GstGL.GLWindow.set_draw_callback (self, callback, *data):
#python wrapper for 'gst_gl_window_set_draw_callback'
Sets the draw callback called every time GstGL.GLWindow.draw is called
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
function to invoke
data
(
variadic
)
–
data to invoke callback with
Since : 1.4
gst_gl_window_set_preferred_size
gst_gl_window_set_preferred_size (GstGLWindow * window, gint width, gint height)
Set the preferred width and height of the window. Implementations are free to ignore this information.
Since : 1.6
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.
Parameters:
window
(
GstGL.GLWindow
)
–
width
(
Number
)
–
new preferred width
height
(
Number
)
–
new preferred height
Since : 1.6
GstGL.GLWindow.set_preferred_size
def GstGL.GLWindow.set_preferred_size (self, width, height):
#python wrapper for 'gst_gl_window_set_preferred_size'
Set the preferred width and height of the window. Implementations are free to ignore this information.
Parameters:
window
(
GstGL.GLWindow
)
–
width
(
int
)
–
new preferred width
height
(
int
)
–
new preferred height
Since : 1.6
gst_gl_window_set_render_rectangle
gboolean gst_gl_window_set_render_rectangle (GstGLWindow * window, gint x, gint y, gint width, gint height)
Tell a window that it should render into a specific region of the window according to the GstVideoOverlay interface.
whether the specified region could be set
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.
Parameters:
window
(
GstGL.GLWindow
)
–
x
(
Number
)
–
x position
y
(
Number
)
–
y position
width
(
Number
)
–
width
height
(
Number
)
–
height
whether the specified region could be set
GstGL.GLWindow.set_render_rectangle
def GstGL.GLWindow.set_render_rectangle (self, x, y, width, height):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
x
(
int
)
–
x position
y
(
int
)
–
y position
width
(
int
)
–
width
height
(
int
)
–
height
whether the specified region could be set
gst_gl_window_set_resize_callback
gst_gl_window_set_resize_callback (GstGLWindow * window, GstGLWindowResizeCB callback, gpointer data, GDestroyNotify destroy_notify)
Sets the resize callback called every time a resize of the window occurs.
Parameters:
window
–
callback
(
[scope notified]
)
–
function to invoke
data
(
[closure]
)
–
data to invoke callback with
destroy_notify
–
called when data is not needed any more
Since : 1.4
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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowResizeCB
)
–
function to invoke
data
(
Object
)
–
data to invoke callback with
Since : 1.4
GstGL.GLWindow.set_resize_callback
def GstGL.GLWindow.set_resize_callback (self, callback, *data):
#python wrapper for 'gst_gl_window_set_resize_callback'
Sets the resize callback called every time a resize of the window occurs.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowResizeCB
)
–
function to invoke
data
(
variadic
)
–
data to invoke callback with
Since : 1.4
gst_gl_window_set_window_handle
gst_gl_window_set_window_handle (GstGLWindow * window, guintptr 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.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.set_window_handle
def GstGL.GLWindow.set_window_handle (self, handle):
#python 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
gst_gl_window_show
gst_gl_window_show (GstGLWindow * window)
Present the window to the screen.
Parameters:
window
–
Since : 1.6
GstGL.GLWindow.prototype.show
function GstGL.GLWindow.prototype.show(): {
// javascript wrapper for 'gst_gl_window_show'
}
Present the window to the screen.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.6
GstGL.GLWindow.show
def GstGL.GLWindow.show (self):
#python wrapper for 'gst_gl_window_show'
Present the window to the screen.
Parameters:
window
(
GstGL.GLWindow
)
–
Since : 1.6
Signals
key-event
key_event_callback (GstGLWindow * self, gchar * id, gchar * key, gpointer user_data)
Will be emitted when a key event is received by the GstGLwindow.
Parameters:
self
–
id
–
the name of the event
key
–
the id of the key pressed
user_data
–
Flags: Run Last
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.
Parameters:
self
(
GstGL.GLWindow
)
–
id
(
String
)
–
the name of the event
key
(
String
)
–
the id of the key pressed
user_data
(
Object
)
–
Flags: Run Last
Since : 1.6
key-event
def key_event_callback (self, id, key, *user_data):
#python callback for the 'key-event' signal
Will be emitted when a key event is received by the GstGLwindow.
Parameters:
self
(
GstGL.GLWindow
)
–
id
(
str
)
–
the name of the event
key
(
str
)
–
the id of the key pressed
user_data
(
variadic
)
–
Flags: Run Last
Since : 1.6
mouse-event
mouse_event_callback (GstGLWindow * self, gchar * id, gint button, gdouble x, gdouble y, gpointer user_data)
Will be emitted when a mouse event is received by the GstGLwindow.
Parameters:
self
–
id
–
the name of the event
button
–
the id of the button
x
–
the x coordinate of the mouse event
y
–
the y coordinate of the mouse event
user_data
–
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.
Parameters:
self
(
GstGL.GLWindow
)
–
id
(
String
)
–
the name of the event
button
(
Number
)
–
the id of the button
x
(
Number
)
–
the x coordinate of the mouse event
y
(
Number
)
–
the y coordinate of the mouse event
user_data
(
Object
)
–
Flags: Run Last
Since : 1.6
mouse-event
def mouse_event_callback (self, id, button, x, y, *user_data):
#python callback for the 'mouse-event' signal
Will be emitted when a mouse event is received by the GstGLwindow.
Parameters:
self
(
GstGL.GLWindow
)
–
id
(
str
)
–
the name of the event
button
(
int
)
–
the id of the button
x
(
float
)
–
the x coordinate of the mouse event
y
(
float
)
–
the y coordinate of the mouse event
user_data
(
variadic
)
–
Flags: Run Last
Since : 1.6
scroll-event
scroll_event_callback (GstGLWindow * self, gdouble x, gdouble y, gdouble delta_x, gdouble delta_y, gpointer user_data)
Will be emitted when a mouse scroll event is received by the GstGLwindow.
Parameters:
self
–
x
–
the x coordinate of the mouse event
y
–
the y coordinate of the mouse event
delta_x
–
the x offset of the scroll event
delta_y
–
the y offset of the scroll event
user_data
–
Flags: Run Last
Since : 1.18
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.
Parameters:
self
(
GstGL.GLWindow
)
–
x
(
Number
)
–
the x coordinate of the mouse event
y
(
Number
)
–
the y coordinate of the mouse event
delta_x
(
Number
)
–
the x offset of the scroll event
delta_y
(
Number
)
–
the y offset of the scroll event
user_data
(
Object
)
–
Flags: Run Last
Since : 1.18
scroll-event
def scroll_event_callback (self, x, y, delta_x, delta_y, *user_data):
#python callback for the 'scroll-event' signal
Will be emitted when a mouse scroll event is received by the GstGLwindow.
Parameters:
self
(
GstGL.GLWindow
)
–
x
(
float
)
–
the x coordinate of the mouse event
y
(
float
)
–
the y coordinate of the mouse event
delta_x
(
float
)
–
the x offset of the scroll event
delta_y
(
float
)
–
the y offset of the scroll event
user_data
(
variadic
)
–
Flags: Run Last
Since : 1.18
Virtual Methods
close
close (GstGLWindow * window)
close the connection to the display
Parameters:
window
–
close
function close(window: GstGL.GLWindow): {
// javascript implementation of the 'close' virtual method
}
close the connection to the display
Parameters:
window
(
GstGL.GLWindow
)
–
close
def close (window):
#python implementation of the 'close' virtual method
close the connection to the display
Parameters:
window
(
GstGL.GLWindow
)
–
controls_viewport
gboolean controls_viewport (GstGLWindow * window)
Whether the window takes care of glViewport setup. and the user does not need to deal with viewports
Parameters:
window
–
controls_viewport
function 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
Parameters:
window
(
GstGL.GLWindow
)
–
controls_viewport
def controls_viewport (window):
#python 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
Parameters:
window
(
GstGL.GLWindow
)
–
draw
draw (GstGLWindow * window)
redraw the window with the specified dimensions
Parameters:
window
–
draw
function draw(window: GstGL.GLWindow): {
// javascript implementation of the 'draw' virtual method
}
redraw the window with the specified dimensions
Parameters:
window
(
GstGL.GLWindow
)
–
draw
def draw (window):
#python implementation of the 'draw' virtual method
redraw the window with the specified dimensions
Parameters:
window
(
GstGL.GLWindow
)
–
get_display
guintptr get_display (GstGLWindow * window)
Gets the current windowing system display connection
Parameters:
window
–
get_display
function get_display(window: GstGL.GLWindow): {
// javascript implementation of the 'get_display' virtual method
}
Gets the current windowing system display connection
Parameters:
window
(
GstGL.GLWindow
)
–
get_display
def get_display (window):
#python implementation of the 'get_display' virtual method
Gets the current windowing system display connection
Parameters:
window
(
GstGL.GLWindow
)
–
get_window_handle
guintptr get_window_handle (GstGLWindow * window)
Gets the current window handle that this GstGLWindow is rendering into. This may return a different value to what is passed into set_window_handle
Parameters:
window
–
get_window_handle
function get_window_handle(window: GstGL.GLWindow): {
// javascript implementation of the 'get_window_handle' virtual method
}
Gets the current window handle that this GstGLWindow is rendering into. This may return a different value to what is passed into set_window_handle
Parameters:
window
(
GstGL.GLWindow
)
–
get_window_handle
def get_window_handle (window):
#python implementation of the 'get_window_handle' virtual method
Gets the current window handle that this GstGLWindow is rendering into. This may return a different value to what is passed into set_window_handle
Parameters:
window
(
GstGL.GLWindow
)
–
handle_events
handle_events (GstGLWindow * window, gboolean handle_events)
whether to handle 'extra' events from the windowing system. Basic events like surface moves and resizes are still valid things to listen for.
Parameters:
window
–
handle_events
–
handle_events
function 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.
Parameters:
window
(
GstGL.GLWindow
)
–
handle_events
(
Number
)
–
handle_events
def handle_events (window, handle_events):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
handle_events
(
bool
)
–
has_output_surface
gboolean has_output_surface (GstGLWindow * window)
Whether the window has output surface or not. (Since: 1.18)
Parameters:
window
–
has_output_surface
function 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)
Parameters:
window
(
GstGL.GLWindow
)
–
has_output_surface
def has_output_surface (window):
#python implementation of the 'has_output_surface' virtual method
Whether the window has output surface or not. (Since: 1.18)
Parameters:
window
(
GstGL.GLWindow
)
–
open
gboolean open (GstGLWindow * window, GError ** error)
open the connection to the display
Parameters:
window
–
error
–
open
function open(window: GstGL.GLWindow): {
// javascript implementation of the 'open' virtual method
}
open the connection to the display
Parameters:
window
(
GstGL.GLWindow
)
–
open
def open (window):
#python implementation of the 'open' virtual method
open the connection to the display
Parameters:
window
(
GstGL.GLWindow
)
–
queue_resize
queue_resize (GstGLWindow * window)
request a resize to occur when possible
Parameters:
window
–
queue_resize
function queue_resize(window: GstGL.GLWindow): {
// javascript implementation of the 'queue_resize' virtual method
}
request a resize to occur when possible
Parameters:
window
(
GstGL.GLWindow
)
–
queue_resize
def queue_resize (window):
#python implementation of the 'queue_resize' virtual method
request a resize to occur when possible
Parameters:
window
(
GstGL.GLWindow
)
–
quit
quit (GstGLWindow * window)
send a quit to the mainloop
Parameters:
window
–
quit
function quit(window: GstGL.GLWindow): {
// javascript implementation of the 'quit' virtual method
}
send a quit to the mainloop
Parameters:
window
(
GstGL.GLWindow
)
–
quit
def quit (window):
#python implementation of the 'quit' virtual method
send a quit to the mainloop
Parameters:
window
(
GstGL.GLWindow
)
–
run
function run(window: GstGL.GLWindow): {
// javascript implementation of the 'run' virtual method
}
run the mainloop
Parameters:
window
(
GstGL.GLWindow
)
–
run
def run (window):
#python implementation of the 'run' virtual method
run the mainloop
Parameters:
window
(
GstGL.GLWindow
)
–
send_message
send_message (GstGLWindow * window, GstGLWindowCB callback, gpointer data)
invoke a function on the window thread. Required to be reentrant.
Parameters:
window
–
callback
–
data
–
send_message
function 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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
data
(
Object
)
–
send_message
def send_message (window, callback, *data):
#python implementation of the 'send_message' virtual method
invoke a function on the window thread. Required to be reentrant.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
data
(
variadic
)
–
send_message_async
send_message_async (GstGLWindow * window, GstGLWindowCB callback, gpointer data, GDestroyNotify destroy)
invoke a function on the window thread. run may or may not have been called. Required to be reentrant.
Parameters:
window
–
callback
–
data
–
destroy
–
send_message_async
function 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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
data
(
Object
)
–
send_message_async
def send_message_async (window, callback, *data):
#python 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.
Parameters:
window
(
GstGL.GLWindow
)
–
callback
(
GstGL.GLWindowCB
)
–
data
(
variadic
)
–
set_preferred_size
set_preferred_size (GstGLWindow * window, gint width, gint height)
request that the window change surface size. The implementation is free to ignore this information.
Parameters:
window
–
width
–
height
–
set_preferred_size
function 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.
Parameters:
window
(
GstGL.GLWindow
)
–
width
(
Number
)
–
height
(
Number
)
–
set_preferred_size
def set_preferred_size (window, width, height):
#python implementation of the 'set_preferred_size' virtual method
request that the window change surface size. The implementation is free to ignore this information.
Parameters:
window
(
GstGL.GLWindow
)
–
width
(
int
)
–
height
(
int
)
–
set_render_rectangle
gboolean set_render_rectangle (GstGLWindow * window, gint x, gint y, gint width, gint height)
request a rectangle to render into. See GstVideoOverlay
Parameters:
window
–
x
–
y
–
width
–
height
–
set_render_rectangle
function 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 GstVideoOverlay
Parameters:
window
(
GstGL.GLWindow
)
–
x
(
Number
)
–
y
(
Number
)
–
width
(
Number
)
–
height
(
Number
)
–
set_render_rectangle
def set_render_rectangle (window, x, y, width, height):
#python implementation of the 'set_render_rectangle' virtual method
request a rectangle to render into. See GstVideoOverlay
Parameters:
window
(
GstGL.GLWindow
)
–
x
(
int
)
–
y
(
int
)
–
width
(
int
)
–
height
(
int
)
–
set_window_handle
set_window_handle (GstGLWindow * window, guintptr handle)
Set a window handle to render into
Parameters:
window
–
handle
–
set_window_handle
function set_window_handle(window: GstGL.GLWindow, handle: Number): {
// javascript implementation of the 'set_window_handle' virtual method
}
Set a window handle to render into
Parameters:
window
(
GstGL.GLWindow
)
–
handle
(
Number
)
–
set_window_handle
def set_window_handle (window, handle):
#python implementation of the 'set_window_handle' virtual method
Set a window handle to render into
Parameters:
window
(
GstGL.GLWindow
)
–
handle
(
int
)
–
show
show (GstGLWindow * window)
request that the window be shown to the user
Parameters:
window
–
show
function show(window: GstGL.GLWindow): {
// javascript implementation of the 'show' virtual method
}
request that the window be shown to the user
Parameters:
window
(
GstGL.GLWindow
)
–
show
def show (window):
#python implementation of the 'show' virtual method
request that the window be shown to the user
Parameters:
window
(
GstGL.GLWindow
)
–
Functions
gst_gl_window_error_quark
GQuark gst_gl_window_error_quark ()
the quark used for GstGLWindow in GError's
GstGL.GLWindowError.prototype.quark
function GstGL.GLWindowError.prototype.quark(): {
// javascript wrapper for 'gst_gl_window_error_quark'
}
the quark used for GstGL.GLWindow in GLib.Error's
GstGL.GLWindowError.quark
def GstGL.GLWindowError.quark ():
#python wrapper for 'gst_gl_window_error_quark'
the quark used for GstGL.GLWindow in GLib.Error's
Function Macros
GST_GL_WINDOW_CB
#define GST_GL_WINDOW_CB(f) ((GstGLWindowCB) (f))
Cast to the current function type for generic window callbacks
Parameters:
f
–
the function to cast
GST_GL_WINDOW_GET_LOCK
#define GST_GL_WINDOW_GET_LOCK(w) (&GST_GL_WINDOW(w)->lock)
GST_GL_WINDOW_LOCK
#define GST_GL_WINDOW_LOCK(w) g_mutex_lock(&GST_GL_WINDOW(w)->lock)
GST_GL_WINDOW_RESIZE_CB
#define GST_GL_WINDOW_RESIZE_CB(f) ((GstGLWindowResizeCB) (f))
Cast to the current function type for window resize callbacks
Parameters:
f
–
the function to cast
GST_GL_WINDOW_UNLOCK
#define GST_GL_WINDOW_UNLOCK(w) g_mutex_unlock(&GST_GL_WINDOW(w)->lock)
Enumerations
GstGLWindowError
Members
GST_GL_WINDOW_ERROR_FAILED
(0)
–
failed for a unspecified reason
GST_GL_WINDOW_ERROR_OLD_LIBS
(1)
–
the implementation is too old
GST_GL_WINDOW_ERROR_RESOURCE_UNAVAILABLE
(2)
–
no such resource was found
GstGL.GLWindowError
Members
GstGL.GLWindowError.FAILED
(0)
–
failed for a unspecified reason
GstGL.GLWindowError.OLD_LIBS
(1)
–
the implementation is too old
GstGL.GLWindowError.RESOURCE_UNAVAILABLE
(2)
–
no such resource was found
GstGL.GLWindowError
Members
GstGL.GLWindowError.FAILED
(0)
–
failed for a unspecified reason
GstGL.GLWindowError.OLD_LIBS
(1)
–
the implementation is too old
GstGL.GLWindowError.RESOURCE_UNAVAILABLE
(2)
–
no such resource was found
Constants
GST_GL_WINDOW_ERROR
#define GST_GL_WINDOW_ERROR (gst_gl_window_error_quark ())
Error domain for GStreamer's GL window module. Errors in this domain will be from the GstGLWindowError enumeration
Callbacks
GstGL.GLWindowCB
function GstGL.GLWindowCB(data: Object): {
// javascript wrapper for 'GstGLWindowCB'
}
Parameters:
data
(
Object
)
–
GstGL.GLWindowCB
def GstGL.GLWindowCB (data):
#python wrapper for 'GstGLWindowCB'
Parameters:
data
(
object
)
–
GstGLWindowResizeCB
(*GstGLWindowResizeCB) (gpointer data, guint width, guint height)
Parameters:
data
–
width
–
height
–
The results of the search are