diff options
author | Matthew Waters <matthew@centricular.com> | 2014-10-31 12:30:53 +1100 |
---|---|---|
committer | Tim-Philipp Müller <tim@centricular.com> | 2014-11-03 00:12:51 +0000 |
commit | c514f0514a53554533ee89ad4a28ee2fa6f6c092 (patch) | |
tree | 0fdc08ab7b1936685972c76a20b58b886e17a137 | |
parent | cdd02e9b929333a1f0f492626c3efccf562e67a3 (diff) | |
download | gstreamer-plugins-bad-c514f0514a53554533ee89ad4a28ee2fa6f6c092.tar.gz |
gl: sprinkle some Since markers
-rw-r--r-- | gst-libs/gst/gl/gstglcontext.c | 32 | ||||
-rw-r--r-- | gst-libs/gst/gl/gstgldisplay.c | 8 | ||||
-rw-r--r-- | gst-libs/gst/gl/gstglwindow.c | 30 |
3 files changed, 69 insertions, 1 deletions
diff --git a/gst-libs/gst/gl/gstglcontext.c b/gst-libs/gst/gl/gstglcontext.c index a02e810f1..a197bf18b 100644 --- a/gst-libs/gst/gl/gstglcontext.c +++ b/gst-libs/gst/gl/gstglcontext.c @@ -252,6 +252,8 @@ _init_debug (void) * Create a new #GstGLContext with the specified @display * * Returns: a new #GstGLContext + * + * Since: 1.4 */ GstGLContext * gst_gl_context_new (GstGLDisplay * display) @@ -308,6 +310,8 @@ gst_gl_context_new (GstGLDisplay * display) * Wraps an existing OpenGL context into a #GstGLContext. * * Returns: a #GstGLContext wrapping @handle + * + * Since: 1.4 */ GstGLContext * gst_gl_context_new_wrapped (GstGLDisplay * display, guintptr handle, @@ -398,6 +402,8 @@ gst_gl_context_finalize (GObject * object) * currently set window. See gst_gl_context_set_window() for details. * * Returns: Whether the activation succeeded + * + * Since: 1.4 */ gboolean gst_gl_context_activate (GstGLContext * context, gboolean activate) @@ -450,7 +456,9 @@ gst_gl_context_get_thread (GstGLContext * context) * The currently available API may be limited by the #GstGLDisplay in use and/or * the #GstGLWindow chosen. * - * Returns: the currently available OpenGL api + * Returns: the available OpenGL api + * + * Since: 1.4 */ GstGLAPI gst_gl_context_get_gl_api (GstGLContext * context) @@ -476,6 +484,8 @@ gst_gl_context_get_gl_api (GstGLContext * context) * be retreived using this method. * * Returns: a function pointer or NULL + * + * Since: 1.4 */ gpointer gst_gl_context_get_proc_address (GstGLContext * context, const gchar * name) @@ -534,6 +544,8 @@ gst_gl_context_default_get_proc_address (GstGLContext * context, * already running. * * Returns: Whether the window was successfully updated + * + * Since: 1.4 */ gboolean gst_gl_context_set_window (GstGLContext * context, GstGLWindow * window) @@ -564,6 +576,8 @@ gst_gl_context_set_window (GstGLContext * context, GstGLWindow * window) * @context: a #GstGLContext * * Returns: the currently set window + * + * Since: 1.4 */ GstGLWindow * gst_gl_context_get_window (GstGLContext * context) @@ -661,6 +675,8 @@ gst_gl_context_can_share (GstGLContext * context, GstGLContext * other_context) * Should only be called once. * * Returns: whether the context could successfully be created + * + * Since: 1.4 */ gboolean gst_gl_context_create (GstGLContext * context, @@ -985,6 +1001,8 @@ failure: * Gets the backing OpenGL context used by @context. * * Returns: The platform specific backing OpenGL context + * + * Since: 1.4 */ guintptr gst_gl_context_get_gl_context (GstGLContext * context) @@ -1008,6 +1026,8 @@ gst_gl_context_get_gl_context (GstGLContext * context) * Gets the OpenGL platform that used by @context. * * Returns: The platform specific backing OpenGL context + * + * Since: 1.4 */ GstGLPlatform gst_gl_context_get_gl_platform (GstGLContext * context) @@ -1026,6 +1046,8 @@ gst_gl_context_get_gl_platform (GstGLContext * context) * @context: a #GstGLContext: * * Returns: the #GstGLDisplay associated with this @context + * + * Since: 1.4 */ GstGLDisplay * gst_gl_context_get_display (GstGLContext * context) @@ -1059,6 +1081,8 @@ _gst_gl_context_thread_run_generic (RunGenericData * data) * Execute @func in the OpenGL thread of @context with @data * * MT-safe + * + * Since: 1.4 */ void gst_gl_context_thread_add (GstGLContext * context, @@ -1092,6 +1116,8 @@ gst_gl_context_thread_add (GstGLContext * context, * Returns the OpenGL version implemented by @context. See * gst_gl_context_get_gl_api() for retreiving the OpenGL api implemented by * @context. + * + * Since: 1.4 */ void gst_gl_context_get_gl_version (GstGLContext * context, gint * maj, gint * min) @@ -1115,6 +1141,8 @@ gst_gl_context_get_gl_version (GstGLContext * context, gint * maj, gint * min) * * Returns: whether OpenGL context implements the required api and specified * version. + * + * Since: 1.4 */ gboolean gst_gl_context_check_gl_version (GstGLContext * context, GstGLAPI api, @@ -1146,6 +1174,8 @@ gst_gl_context_check_gl_version (GstGLContext * context, GstGLAPI api, * determine their existence and so will fail if that is not the case. * * Returns: Whether @feature is supported by @context + * + * Since: 1.4 */ gboolean gst_gl_context_check_feature (GstGLContext * context, const gchar * feature) diff --git a/gst-libs/gst/gl/gstgldisplay.c b/gst-libs/gst/gl/gstgldisplay.c index c57e924fd..6b7b83554 100644 --- a/gst-libs/gst/gl/gstgldisplay.c +++ b/gst-libs/gst/gl/gstgldisplay.c @@ -124,6 +124,8 @@ gst_gl_display_finalize (GObject * object) * gst_gl_display_new: * * Returns: (transfer full): a new #GstGLDisplay + * + * Since: 1.4 */ GstGLDisplay * gst_gl_display_new (void) @@ -195,6 +197,8 @@ gst_gl_display_default_get_handle (GstGLDisplay * display) * @display: a #GstGLDisplay * * Returns: the #GstGLDisplayType of @display + * + * Since: 1.4 */ GstGLDisplayType gst_gl_display_get_handle_type (GstGLDisplay * display) @@ -210,6 +214,8 @@ gst_gl_display_get_handle_type (GstGLDisplay * display) * @display: resulting #GstGLDisplay * * Sets @display on @context + * + * Since: 1.4 */ void gst_context_set_gl_display (GstContext * context, GstGLDisplay * display) @@ -232,6 +238,8 @@ gst_context_set_gl_display (GstContext * context, GstGLDisplay * display) * @display: resulting #GstGLDisplay * * Returns: Whether @display was in @context + * + * Since: 1.4 */ gboolean gst_context_get_gl_display (GstContext * context, GstGLDisplay ** display) diff --git a/gst-libs/gst/gl/gstglwindow.c b/gst-libs/gst/gl/gstglwindow.c index 117cfa6be..a35ca05f4 100644 --- a/gst-libs/gst/gl/gstglwindow.c +++ b/gst-libs/gst/gl/gstglwindow.c @@ -138,6 +138,8 @@ gst_gl_window_class_init (GstGLWindowClass * klass) * @display: a #GstGLDisplay * * Returns: (transfer full): a new #GstGLWindow using @display's connection + * + * Since: 1.4 */ GstGLWindow * gst_gl_window_new (GstGLDisplay * display) @@ -218,6 +220,8 @@ gst_gl_window_finalize (GObject * object) * * 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 */ void gst_gl_window_set_window_handle (GstGLWindow * window, guintptr handle) @@ -239,6 +243,8 @@ gst_gl_window_set_window_handle (GstGLWindow * window, guintptr handle) * @height: requested height of the window * * Redraw the window contents. Implementations should invoke the draw callback. + * + * Since: 1.4 */ void gst_gl_window_draw_unlocked (GstGLWindow * window, guint width, guint height) @@ -259,6 +265,8 @@ gst_gl_window_draw_unlocked (GstGLWindow * window, guint width, guint height) * @height: requested height of the window * * Redraw the window contents. Implementations should invoke the draw callback. + * + * Since: 1.4 */ void gst_gl_window_draw (GstGLWindow * window, guint width, guint height) @@ -282,6 +290,8 @@ gst_gl_window_draw (GstGLWindow * window, guint width, guint height) * @window: a #GstGLWindow * * Start the execution of the runloop. + * + * Since: 1.4 */ void gst_gl_window_run (GstGLWindow * window) @@ -301,6 +311,8 @@ gst_gl_window_run (GstGLWindow * window) * @window: a #GstGLWindow * * Quit the runloop's execution. + * + * Since: 1.4 */ void gst_gl_window_quit (GstGLWindow * window) @@ -379,6 +391,8 @@ gst_gl_window_default_send_message (GstGLWindow * window, * * Invoke @callback with data on the window thread. @callback is guarenteed to * have executed when this function returns. + * + * Since: 1.4 */ void gst_gl_window_send_message (GstGLWindow * window, GstGLWindowCB callback, @@ -403,6 +417,8 @@ gst_gl_window_send_message (GstGLWindow * window, GstGLWindowCB callback, * * Invoke @callback with @data on the window thread. The callback may not * have been executed when this function returns. + * + * Since: 1.4 */ void gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback, @@ -426,6 +442,8 @@ gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback, * @destroy_notify: (destroy): called when @data is not needed any more * * Sets the draw callback called everytime gst_gl_window_draw() is called + * + * Since: 1.4 */ void gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback, @@ -453,6 +471,8 @@ gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback, * @destroy_notify: (destroy): called when @data is not needed any more * * Sets the resize callback called everytime a resize of the window occurs. + * + * Since: 1.4 */ void gst_gl_window_set_resize_callback (GstGLWindow * window, @@ -480,6 +500,8 @@ gst_gl_window_set_resize_callback (GstGLWindow * window, * @destroy_notify: (destroy): called when @data is not needed any more * * Sets the callback called when the window is about to close. + * + * Since: 1.4 */ void gst_gl_window_set_close_callback (GstGLWindow * window, GstGLWindowCB callback, @@ -504,6 +526,8 @@ gst_gl_window_set_close_callback (GstGLWindow * window, GstGLWindowCB callback, * @window: a #GstGLWindow * * Whether the runloop is running + * + * Since: 1.4 */ gboolean gst_gl_window_is_running (GstGLWindow * window) @@ -516,6 +540,8 @@ gst_gl_window_is_running (GstGLWindow * window) * @window: a #GstGLWindow * * Returns: the windowing system display handle for this @window + * + * Since: 1.4 */ guintptr gst_gl_window_get_display (GstGLWindow * window) @@ -534,6 +560,8 @@ gst_gl_window_get_display (GstGLWindow * window) * @window: a #GstGLWindow * * Returns: the window handle we are currently rendering into + * + * Since: 1.4 */ guintptr gst_gl_window_get_window_handle (GstGLWindow * window) @@ -552,6 +580,8 @@ gst_gl_window_get_window_handle (GstGLWindow * window) * @window: a #GstGLWindow * * Returns: (transfer full): the #GstGLContext associated with this @window + * + * Since: 1.4 */ GstGLContext * gst_gl_window_get_context (GstGLWindow * window) |