gstreamer/gst-libs/gst/interfaces/xoverlay.h

/* GStreamer X-based Overlay
 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
 * Copyright (C) 2003 Julien Moutte <julien@moutte.net>
 *
 * x-overlay.h: X-based overlay interface design
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GST_X_OVERLAY_H__
#define __GST_X_OVERLAY_H__

#include <gst/gst.h>

G_BEGIN_DECLS

/* FIXME 0.11: remove all CLASS bits, this is an interface */

#define GST_TYPE_X_OVERLAY \
  (gst_x_overlay_get_type ())
#define GST_X_OVERLAY(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_X_OVERLAY, GstXOverlay))
#define GST_X_OVERLAY_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_X_OVERLAY, GstXOverlayClass))
#define GST_IS_X_OVERLAY(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_X_OVERLAY))
#define GST_IS_X_OVERLAY_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_X_OVERLAY))
#define GST_X_OVERLAY_GET_CLASS(inst) \
  (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_X_OVERLAY, GstXOverlayClass))

/**
 * GstXOverlay:
 *
 * Opaque #GstXOverlay data structure.
 */
typedef struct _GstXOverlay GstXOverlay;
typedef struct _GstXOverlayClass GstXOverlayClass;

/**
 * GstXOverlayClass:
 * @klass: parent interface type.
 * @set_xwindow_id: (deprecated) virtual method to configure the XWindow handle
 * @expose: virtual method to handle expose events
 * @handle_events: virtual method to handle events
 * @set_render_rectangle: virtual method to set the render rectangle (since 0.10.29)
 * @set_window_handle: virtual method to configure the window handle
 *
 * #GstXOverlay interface
 */
struct _GstXOverlayClass {
  GTypeInterface klass;

  /* virtual functions */
#ifndef GST_DISABLE_DEPRECATED
  void (* set_xwindow_id)      (GstXOverlay *overlay,
                                gulong       xwindow_id);
#else
#ifndef __GTK_DOC_IGNORE__
  void (* set_xwindow_id_disabled) (GstXOverlay *overlay,
                                gulong       xwindow_id);
#endif
#endif /* not GST_DISABLE_DEPRECATED */

  void (* expose)              (GstXOverlay *overlay);

  void (* handle_events)       (GstXOverlay *overlay,
                                gboolean     handle_events);

  void (* set_render_rectangle) (GstXOverlay *overlay,
                                 gint x, gint y,
                                 gint width, gint height);

  void (* set_window_handle)   (GstXOverlay *overlay,
                                guintptr    handle);
    /*< private >*/
  gpointer                 _gst_reserved[GST_PADDING - 3];
};

GType   gst_x_overlay_get_type          (void);

/* virtual class function wrappers */
#ifndef GST_DISABLE_DEPRECATED
void gst_x_overlay_set_xwindow_id      (GstXOverlay *overlay,
                                        gulong xwindow_id);
#endif

gboolean gst_x_overlay_set_render_rectangle (GstXOverlay *overlay,
                                             gint x, gint y,
                                             gint width, gint height);

void gst_x_overlay_expose              (GstXOverlay *overlay);

void gst_x_overlay_handle_events       (GstXOverlay *overlay,
                                        gboolean     handle_events);

void gst_x_overlay_set_window_handle   (GstXOverlay *overlay,
                                        guintptr handle);

/* public methods to dispatch bus messages */
#ifndef GST_DISABLE_DEPRECATED
void gst_x_overlay_got_xwindow_id     (GstXOverlay *overlay, gulong xwindow_id);
#endif

void gst_x_overlay_got_window_handle  (GstXOverlay *overlay,
    guintptr handle);

void gst_x_overlay_prepare_xwindow_id (GstXOverlay *overlay);

G_END_DECLS

#endif /* __GST_X_OVERLAY_H__ */