mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-27 02:30:35 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: update xoverlay docs for api addition and deprecation

Browse source
This commit is contained in:
Stefan Kost 2011-05-23 23:41:56 +03:00
parent 269205b1ad
commit deeae48a03
2 changed files with 43 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
gst-libs/gst/interfaces/xoverlay.c
View file

@ -333,12 +333,12 @@ gst_x_overlay_base_init (gpointer g_class)
/** /**
* gst_x_overlay_set_xwindow_id: * gst_x_overlay_set_xwindow_id:
* @overlay: a #GstXOverlay to set the XWindow on. * @overlay: a #GstXOverlay to set the window on.
* @xwindow_id: a #XID referencing the XWindow. * @xwindow_id: a XID referencing the XWindow.
* *
* This will call the video overlay's set_xwindow_id method. You should * This will call the video overlay's set_xwindow_id method. You should
* use this method to tell to a XOverlay to display video output to a * use this method to tell to a XOverlay to display video output to a
* specific XWindow. Passing 0 as the xwindow_id will tell the overlay to * specific XWindow. Passing 0 as the @xwindow_id will tell the overlay to
* stop using that window and create an internal one. * stop using that window and create an internal one.
* *
* Deprecated: Use gst_x_overlay_set_window_handle() instead. * Deprecated: Use gst_x_overlay_set_window_handle() instead.
@ -358,13 +358,13 @@ gst_x_overlay_set_xwindow_id (GstXOverlay * overlay, gulong xwindow_id)
/** /**
* gst_x_overlay_set_window_handle: * gst_x_overlay_set_window_handle:
* @overlay: a #GstXOverlay to set the XWindow on. * @overlay: a #GstXOverlay to set the window on.
* @xwindow_id: a #XID referencing the XWindow. * @handle: a handle referencing the window.
* *
* This will call the video overlay's set_window_handle method. You * This will call the video overlay's set_window_handle method. You
* should use this method to tell to a XOverlay to display video output to a * should use this method to tell to a XOverlay to display video output to a
* specific XWindow. Passing 0 as the xwindow_id will tell the overlay to * specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
* stop using that window and create an internal one. * tell the overlay to stop using that window and create an internal one.
* *
* Since: 0.10.31 * Since: 0.10.31
*/ */

5
gst-libs/gst/interfaces/xoverlay.h
View file

@ -52,10 +52,11 @@ typedef struct _GstXOverlayClass GstXOverlayClass;
/** /**
* GstXOverlayClass: * GstXOverlayClass:
* @klass: parent interface type. * @klass: parent interface type.
* @set_xwindow_id: virtual method to configure the XWindow id * @set_xwindow_id: (deprecated) virtual method to configure the XWindow handle
* @expose: virtual method to handle expose events * @expose: virtual method to handle expose events
* @handle_events: virtual method to handle events * @handle_events: virtual method to handle events
* @set_render_rectangle: virtual method to set the render rectangle (since 0.10.29) * @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 * #GstXOverlay interface
*/ */
@ -67,8 +68,10 @@ struct _GstXOverlayClass {
void (* set_xwindow_id) (GstXOverlay *overlay, void (* set_xwindow_id) (GstXOverlay *overlay,
gulong xwindow_id); gulong xwindow_id);
#else #else
#ifndef __GTK_DOC_IGNORE__
void (* set_xwindow_id_disabled) (GstXOverlay *overlay, void (* set_xwindow_id_disabled) (GstXOverlay *overlay,
gulong xwindow_id); gulong xwindow_id);
#endif
#endif /* not GST_DISABLE_DEPRECATED */ #endif /* not GST_DISABLE_DEPRECATED */
void (* expose) (GstXOverlay *overlay); void (* expose) (GstXOverlay *overlay);