mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

gl/gi: some annotation updates for called functions

Browse source 
With scope, closure, destroy annotations
This commit is contained in:
Matthew Waters 2016-11-03 16:14:37 +11:00
parent 61a3c55d55
commit 23e147f619
8 changed files with 20 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
gst-libs/gst/gl/gstglbasememory.c
View file

@ -636,8 +636,8 @@ gst_gl_allocation_params_init (GstGLAllocationParams * params,
* gst_gl_allocation_params_copy: * gst_gl_allocation_params_copy:
* @src: the #GstGLAllocationParams to initialize * @src: the #GstGLAllocationParams to initialize
* *
* Returns: a copy of the #GstGLAllocationParams specified by @src or %NULL on * Returns: (transfer full): a copy of the #GstGLAllocationParams specified by
* failure * @src or %NULL on failure
* *
* Since: 1.8 * Since: 1.8
*/ */

6
gst-libs/gst/gl/gstglcontext.c
View file

@ -916,7 +916,7 @@ gst_gl_context_set_window (GstGLContext * context, GstGLWindow * window)
* gst_gl_context_get_window: * gst_gl_context_get_window:
* @context: a #GstGLContext * @context: a #GstGLContext
* *
* Returns: the currently set window * Returns: (transfer full) (nullable): the currently set window
* *
* Since: 1.4 * Since: 1.4
*/ */
@ -1510,7 +1510,7 @@ _gst_gl_context_thread_run_generic (RunGenericData * data)
/** /**
* gst_gl_context_thread_add: * gst_gl_context_thread_add:
* @context: a #GstGLContext * @context: a #GstGLContext
* @func: a #GstGLContextThreadFunc * @func: (scope call): a #GstGLContextThreadFunc
* @data: (closure): user data to call @func with * @data: (closure): user data to call @func with
* *
* Execute @func in the OpenGL thread of @context with @data * Execute @func in the OpenGL thread of @context with @data
@ -1646,7 +1646,7 @@ gst_gl_context_check_feature (GstGLContext * context, const gchar * feature)
* *
* See also gst_gl_context_activate(). * See also gst_gl_context_activate().
* *
* Returns: the #GstGLContext active in the current thread or %NULL * Returns: (transfer none): the #GstGLContext active in the current thread or %NULL
* *
* Since: 1.6 * Since: 1.6
*/ */

13
gst-libs/gst/gl/gstgldisplay.c
View file

@ -112,13 +112,13 @@ gst_gl_display_class_init (GstGLDisplayClass * klass)
/** /**
* GstGLDisplay::create-context: * GstGLDisplay::create-context:
* @object: the #GstGLDisplay * @object: the #GstGLDisplay
* @context: other context to share resources with. * @context: (transfer none): other context to share resources with.
* *
* Overrides the @GstGLContext creation mechanism. * Overrides the @GstGLContext creation mechanism.
* It can be called in any thread and it is emitted with * It can be called in any thread and it is emitted with
* display's object lock held. * display's object lock held.
* *
* Returns: the new context. * Returns: (transfer full): the new context.
*/ */
gst_gl_display_signals[CREATE_CONTEXT] = gst_gl_display_signals[CREATE_CONTEXT] =
g_signal_new ("create-context", G_TYPE_FROM_CLASS (klass), g_signal_new ("create-context", G_TYPE_FROM_CLASS (klass),
@ -378,9 +378,9 @@ gst_context_get_gl_display (GstContext * context, GstGLDisplay ** display)
/** /**
* gst_gl_display_create_context: * gst_gl_display_create_context:
* @display: a #GstGLDisplay * @display: a #GstGLDisplay
* @other_context: other #GstGLContext to share resources with. * @other_context: (transfer none): other #GstGLContext to share resources with.
* @p_context: resulting #GstGLContext * @p_context: (transfer full) (out): resulting #GstGLContext
* @error: resulting #GError * @error: (allow-none): resulting #GError
* *
* It requires the display's object lock to be held. * It requires the display's object lock to be held.
* *
@ -397,8 +397,7 @@ gst_gl_display_create_context (GstGLDisplay * display,
g_return_val_if_fail (display != NULL, FALSE); g_return_val_if_fail (display != NULL, FALSE);
g_return_val_if_fail (p_context != NULL, FALSE); g_return_val_if_fail (p_context != NULL, FALSE);
g_return_val_if_fail (error != NULL, FALSE); g_return_val_if_fail (error == NULL || *error != NULL, FALSE);
g_return_val_if_fail (*error == NULL, FALSE);
g_signal_emit (display, gst_gl_display_signals[CREATE_CONTEXT], 0, g_signal_emit (display, gst_gl_display_signals[CREATE_CONTEXT], 0,
other_context, &context); other_context, &context);

4
gst-libs/gst/gl/gstglfilter.c
View file

@ -1028,8 +1028,8 @@ _glcb (gpointer data)
* @filter: a #GstGLFilter * @filter: a #GstGLFilter
* @input: the input texture * @input: the input texture
* @output: the output texture * @output: the output texture
* @func: the function to transform @input into @output. called with @data * @func: (scope call): the function to transform @input into @output. called with @data
* @data: the data associated with @func * @data: (allow-none): the data associated with @func
* *
* Transforms @input into @output using @func on through FBO. * Transforms @input into @output using @func on through FBO.
* *

2
gst-libs/gst/gl/gstglframebuffer.c
View file

@ -248,7 +248,7 @@ gst_gl_framebuffer_new_with_default_depth (GstGLContext * context, guint width,
* gst_gl_framebuffer_draw_to_texture: * gst_gl_framebuffer_draw_to_texture:
* @fb: a #GstGLFramebuffer * @fb: a #GstGLFramebuffer
* @mem: the #GstGLMemory to draw to * @mem: the #GstGLMemory to draw to
* @func: the function to run * @func: (scope call): the function to run
* @user_data: data to pass to @func * @user_data: data to pass to @func
* *
* Perform the steps necessary to have the output of a glDraw* command in * Perform the steps necessary to have the output of a glDraw* command in

3
gst-libs/gst/gl/gstglmemory.c
View file

@ -1412,7 +1412,8 @@ gst_gl_memory_setup_buffer (GstGLMemoryAllocator * allocator,
* gst_gl_memory_allocator_get_default: * gst_gl_memory_allocator_get_default:
* @context: a #GstGLContext * @context: a #GstGLContext
* *
* Returns: the default #GstGLMemoryAllocator supported by @context * Returns: (transfer full): the default #GstGLMemoryAllocator supported by
* @context
* *
* Since: 1.8 * Since: 1.8
*/ */

2
gst-libs/gst/gl/gstglupload.c
View file

@ -1405,8 +1405,6 @@ gst_gl_upload_set_caps (GstGLUpload * upload, GstCaps * in_caps,
* @upload: a #GstGLUpload * @upload: a #GstGLUpload
* @in_caps: (transfer full) (allow-none) (out): the input #GstCaps * @in_caps: (transfer full) (allow-none) (out): the input #GstCaps
* @out_caps: (transfer full) (allow-none) (out): the output #GstCaps * @out_caps: (transfer full) (allow-none) (out): the output #GstCaps
*
* Returns: (transfer none): The #GstCaps set by gst_gl_upload_set_caps()
*/ */
void void
gst_gl_upload_get_caps (GstGLUpload * upload, GstCaps ** in_caps, gst_gl_upload_get_caps (GstGLUpload * upload, GstCaps ** in_caps,

8
gst-libs/gst/gl/gstglwindow.c
View file

@ -710,7 +710,7 @@ gst_gl_window_default_send_message_async (GstGLWindow * window,
* @window: a #GstGLWindow * @window: a #GstGLWindow
* @callback: (scope async): function to invoke * @callback: (scope async): function to invoke
* @data: (closure): data to invoke @callback with * @data: (closure): data to invoke @callback with
* @destroy: (destroy): called when @data is not needed anymore * @destroy: called when @data is not needed anymore
* *
* Invoke @callback with @data on the window thread. The callback may not * Invoke @callback with @data on the window thread. The callback may not
* have been executed when this function returns. * have been executed when this function returns.
@ -736,7 +736,7 @@ gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback,
* @window: a #GstGLWindow * @window: a #GstGLWindow
* @callback: (scope notified): function to invoke * @callback: (scope notified): function to invoke
* @data: (closure): data to invoke @callback with * @data: (closure): data to invoke @callback with
* @destroy_notify: (destroy): called when @data is not needed any more * @destroy_notify: called when @data is not needed any more
* *
* Sets the draw callback called everytime gst_gl_window_draw() is called * Sets the draw callback called everytime gst_gl_window_draw() is called
* *
@ -765,7 +765,7 @@ gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback,
* @window: a #GstGLWindow * @window: a #GstGLWindow
* @callback: (scope notified): function to invoke * @callback: (scope notified): function to invoke
* @data: (closure): data to invoke @callback with * @data: (closure): data to invoke @callback with
* @destroy_notify: (destroy): called when @data is not needed any more * @destroy_notify: called when @data is not needed any more
* *
* Sets the resize callback called everytime a resize of the window occurs. * Sets the resize callback called everytime a resize of the window occurs.
* *
@ -794,7 +794,7 @@ gst_gl_window_set_resize_callback (GstGLWindow * window,
* @window: a #GstGLWindow * @window: a #GstGLWindow
* @callback: (scope notified): function to invoke * @callback: (scope notified): function to invoke
* @data: (closure): data to invoke @callback with * @data: (closure): data to invoke @callback with
* @destroy_notify: (destroy): called when @data is not needed any more * @destroy_notify: called when @data is not needed any more
* *
* Sets the callback called when the window is about to close. * Sets the callback called when the window is about to close.
* *