gst_gl_window_error_quark ()

GQuark
gst_gl_window_error_quark (void);

GstGLWindowResizeCB ()

void
(*GstGLWindowResizeCB) (gpointer data,
                        guint width,
                        guint height);

GST_GL_WINDOW_RESIZE_CB()

#define GST_GL_WINDOW_RESIZE_CB(f)		 ((GstGLWindowResizeCB) (f))

Cast to the currect function type for window resize callbacks

GstGLWindowCB ()

void
(*GstGLWindowCB) (gpointer data);

GST_GL_WINDOW_CB()

#define GST_GL_WINDOW_CB(f)			 ((GstGLWindowCB) (f))

Cast to the currect function type for generic window callbacks

gst_gl_window_new ()

GstGLWindow *
gst_gl_window_new (GstGLDisplay *display);

Since: 1.4

gst_gl_window_draw ()

void
gst_gl_window_draw (GstGLWindow *window);

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

Since: 1.4

gst_gl_window_quit ()

void
gst_gl_window_quit (GstGLWindow *window);

Quit the runloop's execution.

Since: 1.4

gst_gl_window_run ()

void
gst_gl_window_run (GstGLWindow *window);

Start the execution of the runloop.

Since: 1.4

gst_gl_window_get_context ()

GstGLContext *
gst_gl_window_get_context (GstGLWindow *window);

Since: 1.4

gst_gl_window_get_display ()

guintptr
gst_gl_window_get_display (GstGLWindow *window);

Since: 1.4

gst_gl_window_send_message ()

void
gst_gl_window_send_message (GstGLWindow *window,
                            GstGLWindowCB callback,
                            gpointer data);

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

Since: 1.4

gst_gl_window_send_message_async ()

void
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.

Since: 1.4

gst_gl_window_set_close_callback ()

void
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.

Since: 1.4

gst_gl_window_set_draw_callback ()

void
gst_gl_window_set_draw_callback (GstGLWindow *window,
                                 GstGLWindowCB callback,
                                 gpointer data,
                                 GDestroyNotify destroy_notify);

Sets the draw callback called everytime gst_gl_window_draw() is called

Since: 1.4

gst_gl_window_set_resize_callback ()

void
gst_gl_window_set_resize_callback (GstGLWindow *window,
                                   GstGLWindowResizeCB callback,
                                   gpointer data,
                                   GDestroyNotify destroy_notify);

Sets the resize callback called everytime a resize of the window occurs.

Since: 1.4

gst_gl_window_set_window_handle ()

void
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

gst_gl_window_get_window_handle ()

guintptr
gst_gl_window_get_window_handle (GstGLWindow *window);

Since: 1.4

gst_gl_window_set_preferred_size ()

void
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

gst_gl_window_show ()

void
gst_gl_window_show (GstGLWindow *window);

Present the window to the screen.

Since: 1.6

gst_gl_window_get_surface_dimensions ()

void
gst_gl_window_get_surface_dimensions (GstGLWindow *window,
                                      guint *width,
                                      guint *height);

Since: 1.6

gst_gl_window_handle_events ()

void
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 .

gst_gl_window_queue_resize ()

void
gst_gl_window_queue_resize (GstGLWindow *window);

gst_gl_window_resize ()

void
gst_gl_window_resize (GstGLWindow *window,
                      guint width,
                      guint height);

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.

enum GstGLWindowError

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

GstGLWindow

typedef struct _GstGLWindow GstGLWindow;

GstGLWindow is an opaque struct and should only be accessed through the provided api.

GstGLWindowClass

typedef struct {
  GstObjectClass parent_class;

  guintptr (*get_display)        (GstGLWindow *window);
  void     (*set_window_handle)  (GstGLWindow *window, guintptr handle);
  guintptr (*get_window_handle)  (GstGLWindow *window);
  void     (*draw)               (GstGLWindow *window);
  void     (*run)                (GstGLWindow *window);
  void     (*quit)               (GstGLWindow *window);
  void     (*send_message)       (GstGLWindow *window, GstGLWindowCB callback, gpointer data);
  void     (*send_message_async) (GstGLWindow *window, GstGLWindowCB callback, gpointer data, GDestroyNotify destroy);

  gboolean (*open)               (GstGLWindow *window, GError **error);
  void     (*close)              (GstGLWindow *window);
  void     (*handle_events)      (GstGLWindow *window, gboolean handle_events);
  void     (*set_preferred_size) (GstGLWindow *window, gint width, gint height);
  void     (*show)               (GstGLWindow *window);
  gboolean (*set_render_rectangle)(GstGLWindow *window, gint x, gint y, gint width, gint height);
  void     (*queue_resize)       (GstGLWindow *window);
} GstGLWindowClass;

The “key-event” signal

void
user_function (GstGLWindow *object,
               gchar       *id,
               gchar       *key,
               gpointer     user_data)

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

Flags: Run Last

Since: 1.6

The “mouse-event” signal

void
user_function (GstGLWindow *object,
               gchar       *id,
               gint         button,
               gdouble      x,
               gdouble      y,
               gpointer     user_data)

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

Flags: Run Last

Since: 1.6