isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-25 09:30:45 -05:00
Code Issues Packages Projects Releases Wiki Activity

cogl/onscreen: Add several introspection annotations

Browse Source 
Only an unowned closure is returned by the add_*_callback methods as the object
itself owns the closure.

Add array annotation when taking an array of integers.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3516>
This commit is contained in:
Corentin Noël 2024-01-11 09:38:08 +01:00 committed by Marge Bot
parent 399ffdfc88
commit cb03b46a20
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
cogl/cogl/cogl-onscreen.h
View File

@ -220,8 +220,8 @@ cogl_onscreen_get_buffer_age (CoglOnscreen *onscreen);
/** /**
* cogl_onscreen_queue_damage_region: * cogl_onscreen_queue_damage_region:
* @onscreen: A #CoglOnscreen framebuffer * @onscreen: A #CoglOnscreen framebuffer
* @rectangles: An array of integer 4-tuples representing damaged * @rectangles: (array length=n_rectangles): An array of integer 4-tuples
* rectangles as (x, y, width, height) tuples. * representing damaged rectangles as (x, y, width, height) tuples.
* @n_rectangles: The number of 4-tuples to be read from @rectangles * @n_rectangles: The number of 4-tuples to be read from @rectangles
* *
* Implementation for https://www.khronos.org/registry/EGL/extensions/KHR/EGL_KHR_partial_update.txt * Implementation for https://www.khronos.org/registry/EGL/extensions/KHR/EGL_KHR_partial_update.txt
@ -240,8 +240,8 @@ cogl_onscreen_queue_damage_region (CoglOnscreen *onscreen,
/** /**
* cogl_onscreen_swap_buffers_with_damage: * cogl_onscreen_swap_buffers_with_damage:
* @onscreen: A #CoglOnscreen framebuffer * @onscreen: A #CoglOnscreen framebuffer
* @rectangles: An array of integer 4-tuples representing damaged * @rectangles: (array length=n_rectangles): An array of integer 4-tuples
* rectangles as (x, y, width, height) tuples. * representing damaged rectangles as (x, y, width, height) tuples.
* @n_rectangles: The number of 4-tuples to be read from @rectangles * @n_rectangles: The number of 4-tuples to be read from @rectangles
* *
* Swaps the current back buffer being rendered too, to the front for * Swaps the current back buffer being rendered too, to the front for
@ -309,8 +309,8 @@ cogl_onscreen_add_frame_info (CoglOnscreen *onscreen,
/** /**
* cogl_onscreen_swap_region: * cogl_onscreen_swap_region:
* @onscreen: A #CoglOnscreen framebuffer * @onscreen: A #CoglOnscreen framebuffer
* @rectangles: An array of integer 4-tuples representing rectangles as * @rectangles: (array length=n_rectangles): An array of integer 4-tuples
* (x, y, width, height) tuples. * representing rectangles as (x, y, width, height) tuples.
* @n_rectangles: The number of 4-tuples to be read from @rectangles * @n_rectangles: The number of 4-tuples to be read from @rectangles
* *
* Swaps a region of the back buffer being rendered too, to the front for * Swaps a region of the back buffer being rendered too, to the front for
@ -436,7 +436,7 @@ GType cogl_frame_closure_get_type (void);
* wasting resources, drawing more frames than your system compositor * wasting resources, drawing more frames than your system compositor
* can display. * can display.
* *
* Return value: a #CoglFrameClosure pointer that can be used to * Returns: (transfer none): a #CoglFrameClosure pointer that can be used to
* remove the callback and associated @user_data later. * remove the callback and associated @user_data later.
*/ */
COGL_EXPORT CoglFrameClosure * COGL_EXPORT CoglFrameClosure *
@ -541,8 +541,8 @@ GType cogl_onscreen_dirty_closure_get_type (void);
* the dirty region to ensure that the framebuffer is actually ready * the dirty region to ensure that the framebuffer is actually ready
* for rendering. * for rendering.
* *
* Return value: a #CoglOnscreenDirtyClosure pointer that can be used to * Returns: (transfer none): a #CoglOnscreenDirtyClosure pointer that can be
* remove the callback and associated @user_data later. * used to remove the callback and associated @user_data later.
*/ */
COGL_EXPORT CoglOnscreenDirtyClosure * COGL_EXPORT CoglOnscreenDirtyClosure *
cogl_onscreen_add_dirty_callback (CoglOnscreen *onscreen, cogl_onscreen_add_dirty_callback (CoglOnscreen *onscreen,