1 /* GStreamer X-based Overlay
2 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3 * Copyright (C) 2003 Julien Moutte <julien@moutte.net>
5 * x-overlay.h: X-based overlay interface design
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #ifndef __GST_X_OVERLAY_H__
24 #define __GST_X_OVERLAY_H__
30 #define GST_TYPE_X_OVERLAY \
31 (gst_x_overlay_get_type ())
32 #define GST_X_OVERLAY(obj) \
33 (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_X_OVERLAY, \
35 #define GST_X_OVERLAY_CLASS(klass) \
36 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_X_OVERLAY, GstXOverlayClass))
37 #define GST_IS_X_OVERLAY(obj) \
38 (GST_IMPLEMENTS_INTERFACE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_X_OVERLAY))
39 #define GST_IS_X_OVERLAY_CLASS(klass) \
40 (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_X_OVERLAY))
41 #define GST_X_OVERLAY_GET_CLASS(inst) \
42 (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_X_OVERLAY, GstXOverlayClass))
47 * Opaque #GstXOverlay data structure.
49 typedef struct _GstXOverlay GstXOverlay;
50 typedef struct _GstXOverlayClass GstXOverlayClass;
54 * @klass: parent interface type.
55 * @set_xwindow_id: (deprecated) virtual method to configure the XWindow handle
56 * @expose: virtual method to handle expose events
57 * @handle_events: virtual method to handle events
58 * @set_render_rectangle: virtual method to set the render rectangle (since 0.10.29)
59 * @set_window_handle: virtual method to configure the window handle
61 * #GstXOverlay interface
63 struct _GstXOverlayClass {
66 /* virtual functions */
67 #ifndef GST_DISABLE_DEPRECATED
68 void (* set_xwindow_id) (GstXOverlay *overlay,
71 #ifndef __GTK_DOC_IGNORE__
72 void (* set_xwindow_id_disabled) (GstXOverlay *overlay,
75 #endif /* not GST_DISABLE_DEPRECATED */
77 void (* expose) (GstXOverlay *overlay);
79 void (* handle_events) (GstXOverlay *overlay,
80 gboolean handle_events);
82 void (* set_render_rectangle) (GstXOverlay *overlay,
84 gint width, gint height);
86 void (* set_window_handle) (GstXOverlay *overlay,
89 gpointer _gst_reserved[GST_PADDING - 3];
92 GType gst_x_overlay_get_type (void);
94 /* virtual class function wrappers */
95 #ifndef GST_DISABLE_DEPRECATED
96 void gst_x_overlay_set_xwindow_id (GstXOverlay *overlay,
100 gboolean gst_x_overlay_set_render_rectangle (GstXOverlay *overlay,
102 gint width, gint height);
104 void gst_x_overlay_expose (GstXOverlay *overlay);
106 void gst_x_overlay_handle_events (GstXOverlay *overlay,
107 gboolean handle_events);
109 void gst_x_overlay_set_window_handle (GstXOverlay *overlay,
112 /* public methods to dispatch bus messages */
113 #ifndef GST_DISABLE_DEPRECATED
114 void gst_x_overlay_got_xwindow_id (GstXOverlay *overlay, gulong xwindow_id);
117 void gst_x_overlay_got_window_handle (GstXOverlay *overlay,
120 void gst_x_overlay_prepare_xwindow_id (GstXOverlay *overlay);
124 #endif /* __GST_X_OVERLAY_H__ */