mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-29 05:01:23 +00:00
c5ad1c7228
Original commit message from CVS: * gst-libs/gst/interfaces/propertyprobe.h: Remove double "interface" from doc-string. * gst-libs/gst/interfaces/xoverlay.h: Document interface. * gst-libs/gst/riff/riff.c: Add basic doc blobs.
93 lines
3.1 KiB
C
93 lines
3.1 KiB
C
/* 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
|
|
|
|
#define GST_TYPE_X_OVERLAY \
|
|
(gst_x_overlay_get_type ())
|
|
#define GST_X_OVERLAY(obj) \
|
|
(GST_IMPLEMENTS_INTERFACE_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) \
|
|
(GST_IMPLEMENTS_INTERFACE_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;
|
|
|
|
/**
|
|
* GstXOverlayClass:
|
|
* @klass: parent interface type.
|
|
* @set_xwindow_id: virtual method to configure the XWindow id
|
|
* @expose: virtual method to handle expose events
|
|
* @handle_events: virtual method to handle events
|
|
*
|
|
* #GstXOverlay interface
|
|
*/
|
|
typedef struct _GstXOverlayClass {
|
|
GTypeInterface klass;
|
|
|
|
/* virtual functions */
|
|
void (* set_xwindow_id) (GstXOverlay *overlay,
|
|
gulong xwindow_id);
|
|
|
|
void (* expose) (GstXOverlay *overlay);
|
|
|
|
void (* handle_events) (GstXOverlay *overlay,
|
|
gboolean handle_events);
|
|
|
|
/*< private >*/
|
|
gpointer _gst_reserved[GST_PADDING - 1];
|
|
} GstXOverlayClass;
|
|
|
|
GType gst_x_overlay_get_type (void);
|
|
|
|
/* virtual class function wrappers */
|
|
void gst_x_overlay_set_xwindow_id (GstXOverlay *overlay, gulong xwindow_id);
|
|
|
|
void gst_x_overlay_expose (GstXOverlay *overlay);
|
|
|
|
void gst_x_overlay_handle_events (GstXOverlay *overlay,
|
|
gboolean handle_events);
|
|
|
|
/* public methods to dispatch bus messages */
|
|
void gst_x_overlay_got_xwindow_id (GstXOverlay *overlay, gulong xwindow_id);
|
|
|
|
void gst_x_overlay_prepare_xwindow_id (GstXOverlay *overlay);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GST_X_OVERLAY_H__ */
|