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

docs: Update more links to gi-docgen

Browse Source 
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3489>
This commit is contained in:
Bilal Elmoussaoui 2024-01-04 14:40:48 +01:00 committed by Marge Bot
parent e7a920f94d
commit 00b4d4c4bc
38 changed files with 436 additions and 438 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clutter/clutter/cally/cally-root.c
View File

@ -29,7 +29,7 @@
* Somewhat equivalent to #GailTopLevel. We consider that this class * Somewhat equivalent to #GailTopLevel. We consider that this class
* expose the a11y information of the [class@Clutter.StageManager], as the * expose the a11y information of the [class@Clutter.StageManager], as the
* children of this object are the different [class@Clutter.Stage] managed (so * children of this object are the different [class@Clutter.Stage] managed (so
* the [class@GObject.Object] used in the atk_object_initialize() is the * the [class@GObject.Object] used in the [method@Atk.Object.initialize] is the
* [class@Clutter.StageManager]). * [class@Clutter.StageManager]).
*/ */

6
clutter/clutter/cally/cally-text.c
View File

@ -735,7 +735,7 @@ pango_layout_get_line_after (PangoLayout *layout,
* *
* The @boundary_type determines the size of the returned slice of * The @boundary_type determines the size of the returned slice of
* text. For the exact semantics of this function, see * text. For the exact semantics of this function, see
* atk_text_get_text_after_offset(). * [method@Atk.Text.get_text_after_offset].
* *
* Returns: a newly allocated string containing a slice of text * Returns: a newly allocated string containing a slice of text
* from layout. Free with g_free(). * from layout. Free with g_free().
@ -834,7 +834,7 @@ _gtk_pango_get_text_at (PangoLayout *layout,
* *
* The @boundary_type determines the size of the returned slice of * The @boundary_type determines the size of the returned slice of
* text. For the exact semantics of this function, see * text. For the exact semantics of this function, see
* atk_text_get_text_before_offset(). * [method@Atk.Text.get_text_before_offset].
* *
* Returns: a newly allocated string containing a slice of text * Returns: a newly allocated string containing a slice of text
* from layout. Free with g_free(). * from layout. Free with g_free().
@ -935,7 +935,7 @@ _gtk_pango_get_text_before (PangoLayout *layout,
* *
* The @boundary_type determines the size of the returned slice of * The @boundary_type determines the size of the returned slice of
* text. For the exact semantics of this function, see * text. For the exact semantics of this function, see
* atk_text_get_text_after_offset(). * [method@Atk.Text.get_text_after_offset].
* *
* Returns: a newly allocated string containing a slice of text * Returns: a newly allocated string containing a slice of text
* from layout. Free with g_free(). * from layout. Free with g_free().

2
clutter/clutter/cally/cally-util.c
View File

@ -30,7 +30,7 @@
* includes the name "Util" it is in fact one of the most important * includes the name "Util" it is in fact one of the most important
* interfaces to be implemented in any ATK toolkit implementation. * interfaces to be implemented in any ATK toolkit implementation.
* For instance, it defines atk_get_root(), the method that returns * For instance, it defines [func@Atk.get_root], the method that returns
* the root object in the hierarchy. Without it, you don't have * the root object in the hierarchy. Without it, you don't have
* available any accessible object. * available any accessible object.
*/ */

518
clutter/clutter/clutter-actor.c
View File

File diff suppressed because it is too large Load Diff

36
clutter/clutter/clutter-actor.h
View File

@ -89,9 +89,9 @@ struct _ClutterActor
/** /**
* ClutterActorClass: * ClutterActorClass:
* @show: signal class handler for #ClutterActor::show; it must chain * @show: signal class handler for [signal@Clutter.Actor::show]; it must chain
* up to the parent's implementation * up to the parent's implementation
* @hide: signal class handler for #ClutterActor::hide; it must chain * @hide: signal class handler for [signal@Clutter.Actor::hide]; it must chain
* up to the parent's implementation * up to the parent's implementation
* @hide_all: virtual function for containers and composite actors, to * @hide_all: virtual function for containers and composite actors, to
* determine which children should be shown when calling * determine which children should be shown when calling
@ -131,26 +131,26 @@ struct _ClutterActor
* have changed, the cached transformation must be invalidated by calling * have changed, the cached transformation must be invalidated by calling
* clutter_actor_invalidate_transform(); it must chain up to the parent's * clutter_actor_invalidate_transform(); it must chain up to the parent's
* implementation * implementation
* @parent_set: signal class handler for the #ClutterActor::parent-set * @parent_set: signal class handler for the [signal@Clutter.Actor::parent-set]
* @destroy: signal class handler for #ClutterActor::destroy. It must * @destroy: signal class handler for [signal@Clutter.Actor::destroy]. It must
* chain up to the parent's implementation * chain up to the parent's implementation
* @pick: virtual function, used to draw an outline of the actor with * @pick: virtual function, used to draw an outline of the actor with
* the given color * the given color
* @event: class handler for #ClutterActor::event * @event: class handler for [signal@Clutter.Actor::event]
* @button_press_event: class handler for #ClutterActor::button-press-event * @button_press_event: class handler for [signal@Clutter.Actor::button-press-event]
* @button_release_event: class handler for * @button_release_event: class handler for
* #ClutterActor::button-release-event * [signal@Clutter.Actor::button-release-event]
* @scroll_event: signal class closure for #ClutterActor::scroll-event * @scroll_event: signal class closure for [signal@Clutter.Actor::scroll-event]
* @key_press_event: signal class closure for #ClutterActor::key-press-event * @key_press_event: signal class closure for [signal@Clutter.Actor::key-press-event]
* @key_release_event: signal class closure for * @key_release_event: signal class closure for
* #ClutterActor::key-release-event * [signal@Clutter.Actor::key-release-event]
* @motion_event: signal class closure for #ClutterActor::motion-event * @motion_event: signal class closure for [signal@Clutter.Actor::motion-event]
* @enter_event: signal class closure for #ClutterActor::enter-event * @enter_event: signal class closure for [signal@Clutter.Actor::enter-event]
* @leave_event: signal class closure for #ClutterActor::leave-event * @leave_event: signal class closure for [signal@Clutter.Actor::leave-event]
* @captured_event: signal class closure for #ClutterActor::captured-event * @captured_event: signal class closure for [signal@Clutter.Actor::captured-event]
* @key_focus_in: signal class closure for #ClutterActor::key-focus-in * @key_focus_in: signal class closure for [signal@Clutter.Actor::key-focus-in]
* @key_focus_out: signal class closure for #ClutterActor::key-focus-out * @key_focus_out: signal class closure for [signal@Clutter.Actor::key-focus-out]
* @queue_relayout: class handler for #ClutterActor::queue-relayout * @queue_relayout: class handler for [signal@Clutter.Actor::queue-relayout]
* @get_accessible: virtual function, returns the accessible object that * @get_accessible: virtual function, returns the accessible object that
* describes the actor to an assistive technology. * describes the actor to an assistive technology.
* @get_paint_volume: virtual function, for sub-classes to define their * @get_paint_volume: virtual function, for sub-classes to define their
@ -161,7 +161,7 @@ struct _ClutterActor
* clutter_actor_set_offscreen_redirect() for details. * clutter_actor_set_offscreen_redirect() for details.
* @paint_node: virtual function for creating paint nodes and attaching * @paint_node: virtual function for creating paint nodes and attaching
* them to the render tree * them to the render tree
* @touch_event: signal class closure for #ClutterActor::touch-event * @touch_event: signal class closure for [signal@Clutter.Actor::touch-event]
* *
* Base class for actors. * Base class for actors.
*/ */

6
clutter/clutter/clutter-align-constraint.c
View File

@ -501,7 +501,7 @@ clutter_align_constraint_set_align_axis (ClutterAlignConstraint *align,
* clutter_align_constraint_get_align_axis: * clutter_align_constraint_get_align_axis:
* @align: a #ClutterAlignConstraint * @align: a #ClutterAlignConstraint
* *
* Retrieves the value set using clutter_align_constraint_set_align_axis() * Retrieves the value set using [method@Clutter.AlignConstraint.set_align_axis]
* *
* Return value: the alignment axis * Return value: the alignment axis
*/ */
@ -555,7 +555,7 @@ clutter_align_constraint_set_pivot_point (ClutterAlignConstraint *align,
* @pivot_point: (out caller-allocates): return location for a #GraphenePoint * @pivot_point: (out caller-allocates): return location for a #GraphenePoint
* *
* Gets the pivot point used by the constraint set with * Gets the pivot point used by the constraint set with
* clutter_align_constraint_set_pivot_point(). If no custom pivot * [method@Clutter.AlignConstraint.set_pivot_point]. If no custom pivot
* point is set, -1 is set. * point is set, -1 is set.
*/ */
void void
@ -603,7 +603,7 @@ clutter_align_constraint_set_factor (ClutterAlignConstraint *align,
* clutter_align_constraint_get_factor: * clutter_align_constraint_get_factor:
* @align: a #ClutterAlignConstraint * @align: a #ClutterAlignConstraint
* *
* Retrieves the factor set using clutter_align_constraint_set_factor() * Retrieves the factor set using [method@Clutter.AlignConstraint.set_factor]
* *
* Return value: the alignment factor * Return value: the alignment factor
*/ */

2
clutter/clutter/clutter-animatable.c
View File

@ -151,8 +151,6 @@ clutter_animatable_set_final_state (ClutterAnimatable *animatable,
* This function should be used for every property animation * This function should be used for every property animation
* involving `ClutterAnimatable`s. * involving `ClutterAnimatable`s.
* *
* This function replaces clutter_animatable_animate_property().
*
* Return value: %TRUE if the interpolation was successful, * Return value: %TRUE if the interpolation was successful,
* and %FALSE otherwise * and %FALSE otherwise
*/ */

2
clutter/clutter/clutter-backend.c
View File

@ -442,7 +442,7 @@ clutter_backend_get_resolution (ClutterBackend *backend)
* copy the #cairo_font_options_t. * copy the #cairo_font_options_t.
* *
* If @options is %NULL, the first following call to * If @options is %NULL, the first following call to
* clutter_backend_get_font_options() will return the default font * [method@Clutter.Backend.get_font_options] will return the default font
* options for @backend. * options for @backend.
* *
* This function is intended for actors creating a Pango layout * This function is intended for actors creating a Pango layout

6
clutter/clutter/clutter-base-types.c
View File

@ -49,7 +49,7 @@
* Creates a new #ClutterMargin. * Creates a new #ClutterMargin.
* *
* Return value: (transfer full): a newly allocated #ClutterMargin. Use * Return value: (transfer full): a newly allocated #ClutterMargin. Use
* clutter_margin_free() to free the resources associated with it when * [method@Clutter.Margin.free] to free the resources associated with it when
* done. * done.
*/ */
ClutterMargin * ClutterMargin *
@ -80,8 +80,8 @@ clutter_margin_copy (const ClutterMargin *margin_)
* clutter_margin_free: * clutter_margin_free:
* @margin_: a #ClutterMargin * @margin_: a #ClutterMargin
* *
* Frees the resources allocated by clutter_margin_new() and * Frees the resources allocated by [ctor@Clutter.Margin.new] and
* clutter_margin_copy(). * [method@Clutter.Margin.copy].
*/ */
void void
clutter_margin_free (ClutterMargin *margin_) clutter_margin_free (ClutterMargin *margin_)

4
clutter/clutter/clutter-bind-constraint.c
View File

@ -532,7 +532,7 @@ clutter_bind_constraint_set_source (ClutterBindConstraint *constraint,
* clutter_bind_constraint_get_source: * clutter_bind_constraint_get_source:
* @constraint: a #ClutterBindConstraint * @constraint: a #ClutterBindConstraint
* *
* Retrieves the #ClutterActor set using clutter_bind_constraint_set_source() * Retrieves the #ClutterActor set using [method@Clutter.BindConstraint.set_source]
* *
* Return value: (transfer none): a pointer to the source actor * Return value: (transfer none): a pointer to the source actor
*/ */
@ -613,7 +613,7 @@ clutter_bind_constraint_set_offset (ClutterBindConstraint *constraint,
* clutter_bind_constraint_get_offset: * clutter_bind_constraint_get_offset:
* @constraint: a #ClutterBindConstraint * @constraint: a #ClutterBindConstraint
* *
* Retrieves the offset set using clutter_bind_constraint_set_offset() * Retrieves the offset set using [method@Clutter.BindConstraint.set_offset]
* *
* Return value: the offset, in pixels * Return value: the offset, in pixels
*/ */

46
clutter/clutter/clutter-binding-pool.c
View File

@ -336,7 +336,7 @@ clutter_binding_pool_init (ClutterBindingPool *pool)
* *
* Creates a new #ClutterBindingPool that can be used to store * Creates a new #ClutterBindingPool that can be used to store
* key bindings for an actor. The @name must be a unique identifier * key bindings for an actor. The @name must be a unique identifier
* for the binding pool, so that clutter_binding_pool_find() will * for the binding pool, so that [func@Clutter.BindingPool.find] will
* be able to return the correct binding pool. * be able to return the correct binding pool.
* *
* Return value: the newly created binding pool with the given * Return value: the newly created binding pool with the given
@ -367,14 +367,14 @@ clutter_binding_pool_new (const gchar *name)
* *
* Retrieves the #ClutterBindingPool for the given #GObject class * Retrieves the #ClutterBindingPool for the given #GObject class
* and, eventually, creates it. This function is a wrapper around * and, eventually, creates it. This function is a wrapper around
* clutter_binding_pool_new() and uses the class type name as the * [ctor@Clutter.BindingPool.new] and uses the class type name as the
* unique name for the binding pool. * unique name for the binding pool.
* *
* Calling this function multiple times will return the same * Calling this function multiple times will return the same
* #ClutterBindingPool. * #ClutterBindingPool.
* *
* A binding pool for a class can also be retrieved using * A binding pool for a class can also be retrieved using
* clutter_binding_pool_find() with the class type name: * [func@Clutter.BindingPool.find] with the class type name:
* *
* ``` * ```
* pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance)); * pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));
@ -450,11 +450,11 @@ clutter_binding_pool_find (const gchar *name)
* The same action name can be used for multiple @key_val, @modifiers * The same action name can be used for multiple @key_val, @modifiers
* pairs. * pairs.
* *
* When an action has been activated using clutter_binding_pool_activate() * When an action has been activated using [method@Clutter.BindingPool.activate]
* the passed @callback will be invoked (with @data). * the passed @callback will be invoked (with @data).
* *
* Actions can be blocked with clutter_binding_pool_block_action() * Actions can be blocked with [method@Clutter.BindingPool.block_action]
* and then unblocked using clutter_binding_pool_unblock_action(). * and then unblocked using [method@Clutter.BindingPool.unblock_action].
*/ */
void void
clutter_binding_pool_install_action (ClutterBindingPool *pool, clutter_binding_pool_install_action (ClutterBindingPool *pool,
@ -510,7 +510,7 @@ clutter_binding_pool_install_action (ClutterBindingPool *pool,
* @modifiers: bitmask of modifiers * @modifiers: bitmask of modifiers
* @closure: a #GClosure * @closure: a #GClosure
* *
* A #GClosure variant of clutter_binding_pool_install_action(). * A #GClosure variant of [method@Clutter.BindingPool.install_action].
* *
* Installs a new action inside a #ClutterBindingPool. The action * Installs a new action inside a #ClutterBindingPool. The action
* is bound to @key_val and @modifiers. * is bound to @key_val and @modifiers.
@ -518,11 +518,11 @@ clutter_binding_pool_install_action (ClutterBindingPool *pool,
* The same action name can be used for multiple @key_val, @modifiers * The same action name can be used for multiple @key_val, @modifiers
* pairs. * pairs.
* *
* When an action has been activated using clutter_binding_pool_activate() * When an action has been activated using [method@Clutter.BindingPool.activate]
* the passed @closure will be invoked. * the passed @closure will be invoked.
* *
* Actions can be blocked with clutter_binding_pool_block_action() * Actions can be blocked with [method@Clutter.BindingPool.block_action]
* and then unblocked using clutter_binding_pool_unblock_action(). * and then unblocked using [method@Clutter.BindingPool.unblock_action].
*/ */
void void
clutter_binding_pool_install_closure (ClutterBindingPool *pool, clutter_binding_pool_install_closure (ClutterBindingPool *pool,
@ -577,13 +577,13 @@ clutter_binding_pool_install_closure (ClutterBindingPool *pool,
* from the pool * from the pool
* *
* Allows overriding the action for @key_val and @modifiers inside a * Allows overriding the action for @key_val and @modifiers inside a
* #ClutterBindingPool. See clutter_binding_pool_install_action(). * #ClutterBindingPool. See [method@Clutter.BindingPool.install_action].
* *
* When an action has been activated using clutter_binding_pool_activate() * When an action has been activated using [method@Clutter.BindingPool.activate]
* the passed @callback will be invoked (with @data). * the passed @callback will be invoked (with @data).
* *
* Actions can be blocked with clutter_binding_pool_block_action() * Actions can be blocked with [method@Clutter.BindingPool.block_action]
* and then unblocked using clutter_binding_pool_unblock_action(). * and then unblocked using [method@Clutter.BindingPool.unblock_action].
*/ */
void void
clutter_binding_pool_override_action (ClutterBindingPool *pool, clutter_binding_pool_override_action (ClutterBindingPool *pool,
@ -636,16 +636,16 @@ clutter_binding_pool_override_action (ClutterBindingPool *pool,
* @modifiers: bitmask of modifiers * @modifiers: bitmask of modifiers
* @closure: a #GClosure * @closure: a #GClosure
* *
* A #GClosure variant of clutter_binding_pool_override_action(). * A #GClosure variant of [method@Clutter.BindingPool.override_action].
* *
* Allows overriding the action for @key_val and @modifiers inside a * Allows overriding the action for @key_val and @modifiers inside a
* #ClutterBindingPool. See clutter_binding_pool_install_closure(). * #ClutterBindingPool. See [method@Clutter.BindingPool.install_closure].
* *
* When an action has been activated using clutter_binding_pool_activate() * When an action has been activated using [method@Clutter.BindingPool.activate]
* the passed @callback will be invoked (with @data). * the passed @callback will be invoked (with @data).
* *
* Actions can be blocked with clutter_binding_pool_block_action() * Actions can be blocked with [method@Clutter.BindingPool.block_action]
* and then unblocked using clutter_binding_pool_unblock_action(). * and then unblocked using [method@Clutter.BindingPool.unblock_action].
*/ */
void void
clutter_binding_pool_override_closure (ClutterBindingPool *pool, clutter_binding_pool_override_closure (ClutterBindingPool *pool,
@ -820,10 +820,10 @@ clutter_binding_entry_invoke (ClutterBindingEntry *entry,
* *
* Where the #GObject instance is @gobject and the user data * Where the #GObject instance is @gobject and the user data
* is the one passed when installing the action with * is the one passed when installing the action with
* clutter_binding_pool_install_action(). * [method@Clutter.BindingPool.install_action].
* *
* If the action bound to the @key_val, @modifiers pair has been * If the action bound to the @key_val, @modifiers pair has been
* blocked using clutter_binding_pool_block_action(), the callback * blocked using [method@Clutter.BindingPool.block_action], the callback
* will not be invoked, and this function will return %FALSE. * will not be invoked, and this function will return %FALSE.
* *
* Return value: %TRUE if an action was found and was activated * Return value: %TRUE if an action was found and was activated
@ -885,8 +885,8 @@ clutter_binding_pool_block_action (ClutterBindingPool *pool,
* Unblockes all the actions with name @action_name inside @pool. * Unblockes all the actions with name @action_name inside @pool.
* *
* Unblocking an action does not cause the callback bound to it to * Unblocking an action does not cause the callback bound to it to
* be invoked in case clutter_binding_pool_activate() was called on * be invoked in case [method@Clutter.BindingPool.activate] was called on
* an action previously blocked with clutter_binding_pool_block_action(). * an action previously blocked with [method@Clutter.BindingPool.block_action].
*/ */
void void
clutter_binding_pool_unblock_action (ClutterBindingPool *pool, clutter_binding_pool_unblock_action (ClutterBindingPool *pool,

4
clutter/clutter/clutter-binding-pool.h
View File

@ -49,8 +49,8 @@ typedef struct _ClutterBindingPoolClass ClutterBindingPoolClass;
* @user_data: data passed to the function * @user_data: data passed to the function
* *
* The prototype for the callback function registered with * The prototype for the callback function registered with
* clutter_binding_pool_install_action() and invoked by * [method@Clutter.BindingPool.install_action] and invoked by
* clutter_binding_pool_activate(). * [method@Clutter.BindingPool.activate].
* *
* Return value: the function should return %TRUE if the key * Return value: the function should return %TRUE if the key
* binding has been handled, and return %FALSE otherwise * binding has been handled, and return %FALSE otherwise

2
clutter/clutter/clutter-blur-effect.c
View File

@ -200,7 +200,7 @@ clutter_blur_effect_init (ClutterBlurEffect *self)
* clutter_blur_effect_new: * clutter_blur_effect_new:
* *
* Creates a new #ClutterBlurEffect to be used with * Creates a new #ClutterBlurEffect to be used with
* clutter_actor_add_effect() * [method@Clutter.Actor.add_effect]
* *
* Return value: the newly created #ClutterBlurEffect or %NULL * Return value: the newly created #ClutterBlurEffect or %NULL
*/ */

4
clutter/clutter/clutter-blur.c
View File

@ -385,7 +385,7 @@ out:
* @blur: a #ClutterBlur * @blur: a #ClutterBlur
* *
* Applies the blur. The resulting texture can be retrieved by * Applies the blur. The resulting texture can be retrieved by
* clutter_blur_get_texture(). * [method@Clutter.Blur.get_texture].
*/ */
void void
clutter_blur_apply (ClutterBlur *blur) clutter_blur_apply (ClutterBlur *blur)
@ -402,7 +402,7 @@ clutter_blur_apply (ClutterBlur *blur)
* @blur: a #ClutterBlur * @blur: a #ClutterBlur
* *
* Retrieves the texture where the blurred contents are stored. The * Retrieves the texture where the blurred contents are stored. The
* contents are undefined until clutter_blur_apply() is called. * contents are undefined until [method@Clutter.Blur.apply] is called.
* *
* Returns: (transfer none): a #CoglTexture * Returns: (transfer none): a #CoglTexture
*/ */

16
clutter/clutter/clutter-box-layout.c
View File

@ -30,20 +30,20 @@
* *
* A layout manager arranging children on a single line * A layout manager arranging children on a single line
* *
* The #ClutterBoxLayout is a #ClutterLayoutManager implementing the * The #ClutterBoxLayout is a [class@Clutter.LayoutManager] implementing the
* following layout policy: * following layout policy:
* *
* - all children are arranged on a single line * - all children are arranged on a single line
* - the axis used is controlled by the #ClutterBoxLayout:orientation property * - the axis used is controlled by the [property@Clutter.BoxLayout:orientation] property
* - each child will be allocated to its natural size or, if #ClutterActor:x-expand or * - each child will be allocated to its natural size or, if [property@Clutter.Actor:x-expand] or
* #ClutterActor:y-expand are set, the available size * [property@Clutter.Actor:y-expand] are set, the available size
* - honours the #ClutterActor's #ClutterActor:x-align and #ClutterActor:y-align properties * - honours the #ClutterActor's [property@Clutter.Actor:x-align] and [property@Clutter.Actor:y-align] properties
* to fill the available size * to fill the available size
* - if the #ClutterBoxLayout:homogeneous boolean property is set, then all widgets will * - if the [property@Clutter.BoxLayout:homogeneous] boolean property is set, then all widgets will
* get the same size, ignoring expand settings and the preferred sizes * get the same size, ignoring expand settings and the preferred sizes
* *
* It is possible to control the spacing between children of a * It is possible to control the spacing between children of a
* #ClutterBoxLayout by using clutter_box_layout_set_spacing(). * #ClutterBoxLayout by using [method@Clutter.BoxLayout.set_spacing].
*/ */
#include "config.h" #include "config.h"
@ -1018,7 +1018,7 @@ clutter_box_layout_set_spacing (ClutterBoxLayout *layout,
* clutter_box_layout_get_spacing: * clutter_box_layout_get_spacing:
* @layout: a #ClutterBoxLayout * @layout: a #ClutterBoxLayout
* *
* Retrieves the spacing set using clutter_box_layout_set_spacing() * Retrieves the spacing set using [method@Clutter.BoxLayout.set_spacing]
* *
* Return value: the spacing between children of the #ClutterBoxLayout * Return value: the spacing between children of the #ClutterBoxLayout
*/ */

2
clutter/clutter/clutter-brightness-contrast-effect.c
View File

@ -402,7 +402,7 @@ clutter_brightness_contrast_effect_init (ClutterBrightnessContrastEffect *self)
* clutter_brightness_contrast_effect_new: * clutter_brightness_contrast_effect_new:
* *
* Creates a new #ClutterBrightnessContrastEffect to be used with * Creates a new #ClutterBrightnessContrastEffect to be used with
* clutter_actor_add_effect() * [method@Clutter.Actor.add_effect]
* *
* Return value: (transfer full): the newly created * Return value: (transfer full): the newly created
* #ClutterBrightnessContrastEffect or %NULL. Use g_object_unref() when * #ClutterBrightnessContrastEffect or %NULL. Use g_object_unref() when

17
clutter/clutter/clutter-canvas.c
View File

@ -27,16 +27,13 @@
* *
* Content for 2D painting * Content for 2D painting
* *
* The #ClutterCanvas class is a #ClutterContent implementation that allows * The #ClutterCanvas class is a [iface@Clutter.Content] implementation that allows
* drawing using the Cairo API on a 2D surface. * drawing using the Cairo API on a 2D surface.
* *
* In order to draw on a #ClutterCanvas, you should connect a handler to the * In order to draw on a #ClutterCanvas, you should connect a handler to the
* #ClutterCanvas::draw signal; the signal will receive a #cairo_t context * [signal@Clutter.Canvas::draw] signal; the signal will receive a #cairo_t context
* that can be used to draw. #ClutterCanvas will emit the #ClutterCanvas::draw * that can be used to draw. #ClutterCanvas will emit the [signal@Clutter.Canvas::draw]
* signal when invalidated using clutter_content_invalidate(). * signal when invalidated using [method@Clutter.Content.invalidate].
*
* See [canvas.c](https://git.gnome.org/browse/clutter/tree/examples/canvas.c?h=clutter-1.18)
* for an example of how to use #ClutterCanvas..
*/ */
#include "config.h" #include "config.h"
@ -478,9 +475,9 @@ clutter_content_iface_init (ClutterContentInterface *iface)
* *
* Creates a new instance of #ClutterCanvas. * Creates a new instance of #ClutterCanvas.
* *
* You should call clutter_canvas_set_size() to set the size of the canvas. * You should call [method@Clutter.Canvas.set_size] to set the size of the canvas.
* *
* You should call clutter_content_invalidate() every time you wish to * You should call [method@Clutter.Content.invalidate] every time you wish to
* draw the contents of the canvas. * draw the contents of the canvas.
* *
* Return value: (transfer full): The newly allocated instance of * Return value: (transfer full): The newly allocated instance of
@ -545,7 +542,7 @@ clutter_canvas_invalidate_internal (ClutterCanvas *canvas,
* *
* If you want to invalidate the contents of the @canvas when setting * If you want to invalidate the contents of the @canvas when setting
* the size, you can use the return value of the function to conditionally * the size, you can use the return value of the function to conditionally
* call clutter_content_invalidate(): * call [method@Clutter.Content.invalidate]:
* *
* ```c * ```c
* if (!clutter_canvas_set_size (canvas, width, height)) * if (!clutter_canvas_set_size (canvas, width, height))

7
clutter/clutter/clutter-clone.c
View File

@ -26,14 +26,13 @@
* *
* An actor that displays a clone of a source actor * An actor that displays a clone of a source actor
* *
* #ClutterClone is a #ClutterActor which draws with the paint * #ClutterClone is a [class@Clutter.Actor] which draws with the paint
* function of another actor, scaled to fit its own allocation. * function of another actor, scaled to fit its own allocation.
* *
* #ClutterClone can be used to efficiently clone any other actor. * #ClutterClone can be used to efficiently clone any other actor.
* *
* Unlike clutter_texture_new_from_actor(), #ClutterClone does not require * #ClutterClone does not require the presence of support for FBOs
* the presence of support for FBOs in the underlying GL or GLES * in the underlying GL or GLES implementation.
* implementation.
*/ */
#include "config.h" #include "config.h"

8
clutter/clutter/clutter-color.c
View File

@ -876,7 +876,7 @@ clutter_color_progress (const GValue *a,
* @color: a #ClutterColor * @color: a #ClutterColor
* *
* Makes a copy of the color structure. The result must be * Makes a copy of the color structure. The result must be
* freed using clutter_color_free(). * freed using [method@Clutter.Color.free].
* *
* Return value: (transfer full): an allocated copy of @color. * Return value: (transfer full): an allocated copy of @color.
*/ */
@ -893,7 +893,7 @@ clutter_color_copy (const ClutterColor *color)
* clutter_color_free: * clutter_color_free:
* @color: a #ClutterColor * @color: a #ClutterColor
* *
* Frees a color structure created with clutter_color_copy(). * Frees a color structure created with [method@Clutter.Color.copy].
*/ */
void void
clutter_color_free (ClutterColor *color) clutter_color_free (ClutterColor *color)
@ -918,7 +918,7 @@ clutter_color_free (ClutterColor *color)
* ``` * ```
* *
* Return value: (transfer full): the newly allocated color. * Return value: (transfer full): the newly allocated color.
* Use clutter_color_free() when done * Use [method@Clutter.Color.free] when done
*/ */
ClutterColor * ClutterColor *
clutter_color_new (guint8 red, clutter_color_new (guint8 red,
@ -939,7 +939,7 @@ clutter_color_new (guint8 red,
* Allocates a new, transparent black #ClutterColor. * Allocates a new, transparent black #ClutterColor.
* *
* Return value: (transfer full): the newly allocated #ClutterColor; use * Return value: (transfer full): the newly allocated #ClutterColor; use
* clutter_color_free() to free its resources * [method@Clutter.Color.free] to free its resources
*/ */
ClutterColor * ClutterColor *
clutter_color_alloc (void) clutter_color_alloc (void)

2
clutter/clutter/clutter-colorize-effect.c
View File

@ -242,7 +242,7 @@ clutter_colorize_effect_init (ClutterColorizeEffect *self)
* @tint: the color to be used * @tint: the color to be used
* *
* Creates a new #ClutterColorizeEffect to be used with * Creates a new #ClutterColorizeEffect to be used with
* clutter_actor_add_effect() * [method@Clutter.Actor.add_effect]
* *
* Return value: the newly created #ClutterColorizeEffect or %NULL * Return value: the newly created #ClutterColorizeEffect or %NULL
*/ */

14
clutter/clutter/clutter-constraint.c
View File

@ -34,7 +34,7 @@
* the position or size of the #ClutterActor to which it is applied, by * the position or size of the #ClutterActor to which it is applied, by
* updating the actor's allocation. Each #ClutterConstraint can change the * updating the actor's allocation. Each #ClutterConstraint can change the
* allocation of the actor to which they are applied by overriding the * allocation of the actor to which they are applied by overriding the
* #ClutterConstraintClass.update_allocation() virtual function. * [vfunc@Clutter.Constraint.update_allocation] virtual function.
* *
* ## Using Constraints * ## Using Constraints
* *
@ -48,7 +48,7 @@
* #ClutterBoxLayout lay out their children. * #ClutterBoxLayout lay out their children.
* *
* Constraints are attached to a #ClutterActor, and are available * Constraints are attached to a #ClutterActor, and are available
* for inspection using clutter_actor_get_constraints(). * for inspection using [method@Clutter.Actor.get_constraints].
* *
* Clutter provides different implementation of the #ClutterConstraint * Clutter provides different implementation of the #ClutterConstraint
* abstract class, for instance: * abstract class, for instance:
@ -69,14 +69,14 @@
* resizable stage. Only the central actor has an explicit size, and no * resizable stage. Only the central actor has an explicit size, and no
* actor has an explicit position. * actor has an explicit position.
* *
* - The #ClutterActor with #ClutterActor:name `layerA` is explicitly * - The #ClutterActor with [property@Clutter.Actor:name] `layerA` is explicitly
* sized to 100 pixels by 25 pixels, and it's added to the #ClutterStage * sized to 100 pixels by 25 pixels, and it's added to the #ClutterStage
* - two #ClutterAlignConstraints are used to anchor `layerA` to the * - two #ClutterAlignConstraints are used to anchor `layerA` to the
* center of the stage, by using 0.5 as the alignment #ClutterAlignConstraint:factor on * center of the stage, by using 0.5 as the alignment #ClutterAlignConstraint:factor on
* both the X and Y axis * both the X and Y axis
* - the #ClutterActor with #ClutterActor:name `layerB` is added to the * - the #ClutterActor with [property@Clutter.Actor:name] `layerB` is added to the
* #ClutterStage with no explicit size * #ClutterStage with no explicit size
* - the #ClutterActor:x and #ClutterActor:width of `layerB` are bound * - the [property@Clutter.Actor:x] and [property@Clutter.Actor:width] of `layerB` are bound
* to the same properties of `layerA` using two #ClutterBindConstraint * to the same properties of `layerA` using two #ClutterBindConstraint
* objects, thus keeping `layerB` aligned to `layerA` * objects, thus keeping `layerB` aligned to `layerA`
* - the top edge of `layerB` is snapped together with the bottom edge * - the top edge of `layerB` is snapped together with the bottom edge
@ -85,7 +85,7 @@
* #ClutterSnapConstraintss to allow for some padding; since `layerB` is * #ClutterSnapConstraintss to allow for some padding; since `layerB` is
* snapped between two different #ClutterActors, its height is stretched * snapped between two different #ClutterActors, its height is stretched
* to match the gap * to match the gap
* - the #ClutterActor with #ClutterActor:name `layerC` mirrors `layerB`, * - the #ClutterActor with [property@Clutter.Actor:name] `layerC` mirrors `layerB`,
* snapping the top edge of the #ClutterStage to the top edge of `layerC` * snapping the top edge of the #ClutterStage to the top edge of `layerC`
* and the top edge of `layerA` to the bottom edge of `layerC` * and the top edge of `layerA` to the bottom edge of `layerC`
* *
@ -102,7 +102,7 @@
* ## Implementing a ClutterConstraint * ## Implementing a ClutterConstraint
* *
* Creating a sub-class of #ClutterConstraint requires the * Creating a sub-class of #ClutterConstraint requires the
* implementation of the #ClutterConstraintClass.update_allocation() * implementation of the [vfunc@Clutter.Constraint.update_allocation]
* virtual function. * virtual function.
* *
* The `update_allocation()` virtual function is called during the * The `update_allocation()` virtual function is called during the

8
clutter/clutter/clutter-content.c
View File

@ -192,7 +192,7 @@ clutter_content_invalidate (ClutterContent *content)
* set to %CLUTTER_REQUEST_CONTENT_SIZE will have a relayout queued. * set to %CLUTTER_REQUEST_CONTENT_SIZE will have a relayout queued.
* *
* Attached actors with other request modes are not redrawn. To redraw them * Attached actors with other request modes are not redrawn. To redraw them
* too, use clutter_content_invalidate(). * too, use [method@Clutter.Content.invalidate].
*/ */
void void
clutter_content_invalidate_size (ClutterContent *content) clutter_content_invalidate_size (ClutterContent *content)
@ -234,7 +234,7 @@ clutter_content_invalidate_size (ClutterContent *content)
* is associated to a #ClutterContent, to set up a backpointer from * is associated to a #ClutterContent, to set up a backpointer from
* the @content to the @actor. * the @content to the @actor.
* *
* This function will invoke the #ClutterContentInterface.attached() virtual * This function will invoke the [vfunc@Clutter.Content.attached] virtual
* function. * function.
*/ */
void void
@ -268,7 +268,7 @@ _clutter_content_attached (ClutterContent *content,
* This function should be used internally every time a #ClutterActor * This function should be used internally every time a #ClutterActor
* removes the association with a #ClutterContent. * removes the association with a #ClutterContent.
* *
* This function will invoke the #ClutterContentInterface.detached() virtual * This function will invoke the [vfunc@Clutter.Content.detached] virtual
* function. * function.
*/ */
void void
@ -298,7 +298,7 @@ _clutter_content_detached (ClutterContent *content,
* *
* Creates the render tree for the @content and @actor. * Creates the render tree for the @content and @actor.
* *
* This function will invoke the #ClutterContentInterface.paint_content() * This function will invoke the [vfunc@Clutter.Content.paint_content]
* virtual function. * virtual function.
*/ */
void void

2
clutter/clutter/clutter-deform-effect.c
View File

@ -41,7 +41,7 @@
* ## Implementing ClutterDeformEffect * ## Implementing ClutterDeformEffect
* *
* Sub-classes of #ClutterDeformEffect should override the * Sub-classes of #ClutterDeformEffect should override the
* #ClutterDeformEffectClass.deform_vertex() virtual function; this function * [vfunc@Clutter.DeformEffect.deform_vertex] virtual function; this function
* is called on every vertex that needs to be deformed by the effect. * is called on every vertex that needs to be deformed by the effect.
* Each passed vertex is an in-out parameter that initially contains the * Each passed vertex is an in-out parameter that initially contains the
* position of the vertex and should be modified according to a specific * position of the vertex and should be modified according to a specific

2
clutter/clutter/clutter-desaturate-effect.c
View File

@ -245,7 +245,7 @@ clutter_desaturate_effect_init (ClutterDesaturateEffect *self)
* @factor: the desaturation factor, between 0.0 and 1.0 * @factor: the desaturation factor, between 0.0 and 1.0
* *
* Creates a new #ClutterDesaturateEffect to be used with * Creates a new #ClutterDesaturateEffect to be used with
* clutter_actor_add_effect() * [method@Clutter.Actor.add_effect]
* *
* Return value: the newly created #ClutterDesaturateEffect or %NULL * Return value: the newly created #ClutterDesaturateEffect or %NULL
*/ */

4
clutter/clutter/clutter-effect.c
View File

@ -35,12 +35,12 @@
* *
* Effects should be the preferred way to affect the paint sequence of an * Effects should be the preferred way to affect the paint sequence of an
* actor without sub-classing the actor itself and overriding the * actor without sub-classing the actor itself and overriding the
* #ClutterActorClass.paint()_ virtual function. * [vfunc@Clutter.Actor.paint] virtual function.
* *
* ## Implementing a ClutterEffect * ## Implementing a ClutterEffect
* *
* Creating a sub-class of #ClutterEffect requires overriding the * Creating a sub-class of #ClutterEffect requires overriding the
* #ClutterEffectClass.paint() method. The implementation of the function should look * [vfunc@Clutter.Effect.paint] method. The implementation of the function should look
* something like this: * something like this:
* *
* ```c * ```c

5
clutter/clutter/clutter-enums.h
View File

@ -982,8 +982,9 @@ typedef enum
* assigned to it during the allocation. * assigned to it during the allocation.
* *
* Alignment only matters if the allocated space given to an actor is * Alignment only matters if the allocated space given to an actor is
* bigger than its natural size; for example, when the #ClutterActor:x-expand * bigger than its natural size; for example, when
* or the #ClutterActor:y-expand properties of #ClutterActor are set to %TRUE. * the [property@Clutter.Actor:x-expand] or the [property@Clutter.Actor:y-expand]
* properties of #ClutterActor are set to %TRUE.
*/ */
typedef enum typedef enum
{ {

16
clutter/clutter/clutter-event.c
View File

@ -686,7 +686,7 @@ clutter_event_get_key_unicode (const ClutterEvent *event)
* *
* Returns the modifier state decomposed into independent * Returns the modifier state decomposed into independent
* pressed/latched/locked states. The effective state is a * pressed/latched/locked states. The effective state is a
* composition of these 3 states, see clutter_event_get_state(). * composition of these 3 states, see [method@Clutter.Event.get_state].
**/ **/
void void
clutter_event_get_key_state (const ClutterEvent *event, clutter_event_get_key_state (const ClutterEvent *event,
@ -762,7 +762,7 @@ clutter_event_get_device_type (const ClutterEvent *event)
* *
* Retrieves the #ClutterInputDevice for the event. * Retrieves the #ClutterInputDevice for the event.
* If you want the physical device the event originated from, use * If you want the physical device the event originated from, use
* clutter_event_get_source_device(). * [method@Clutter.Event.get_source_device].
* *
* The #ClutterInputDevice structure is completely opaque and should * The #ClutterInputDevice structure is completely opaque and should
* be cast to the platform-specific implementation. * be cast to the platform-specific implementation.
@ -1072,10 +1072,10 @@ clutter_get_current_event (void)
* *
* Retrieves the hardware device that originated the event. * Retrieves the hardware device that originated the event.
* *
* If you need the virtual device, use clutter_event_get_device(). * If you need the virtual device, use [method@Clutter.Event.get_device].
* *
* If no hardware device originated this event, this function will * If no hardware device originated this event, this function will
* return the same device as clutter_event_get_device(). * return the same device as [method@Clutter.Event.get_device].
* *
* Return value: (transfer none): a pointer to a #ClutterInputDevice * Return value: (transfer none): a pointer to a #ClutterInputDevice
* or %NULL * or %NULL
@ -1305,7 +1305,7 @@ _clutter_event_process_filters (ClutterEvent *event,
* emitted for the event and it will take precedence over any grabs. * emitted for the event and it will take precedence over any grabs.
* *
* Return value: an identifier for the event filter, to be used * Return value: an identifier for the event filter, to be used
* with clutter_event_remove_filter(). * with [func@Clutter.Event.remove_filter].
*/ */
guint guint
clutter_event_add_filter (ClutterStage *stage, clutter_event_add_filter (ClutterStage *stage,
@ -1332,10 +1332,10 @@ clutter_event_add_filter (ClutterStage *stage,
/** /**
* clutter_event_remove_filter: * clutter_event_remove_filter:
* @id: The ID of the event filter, as returned from clutter_event_add_filter() * @id: The ID of the event filter, as returned from [func@Clutter.Event.add_filter]
* *
* Removes an event filter that was previously added with * Removes an event filter that was previously added with
* clutter_event_add_filter(). * [func@Clutter.Event.add_filter].
*/ */
void void
clutter_event_remove_filter (guint id) clutter_event_remove_filter (guint id)
@ -1504,7 +1504,7 @@ clutter_event_get_gesture_motion_delta (const ClutterEvent *event,
* position in the Y axis, or %NULL * position in the Y axis, or %NULL
* *
* Returns the unaccelerated gesture motion deltas relative to the current * Returns the unaccelerated gesture motion deltas relative to the current
* pointer position. Unlike clutter_event_get_gesture_motion_delta(), * pointer position. Unlike [method@Clutter.Event.get_gesture_motion_delta],
* pointer acceleration is ignored. * pointer acceleration is ignored.
**/ **/
void void

4
clutter/clutter/clutter-event.h
View File

@ -113,10 +113,10 @@ typedef struct _ClutterIMEvent ClutterIMEvent;
* ClutterEventFilterFunc: * ClutterEventFilterFunc:
* @event: the event that is going to be emitted * @event: the event that is going to be emitted
* @event_actor: the current device actor of the events device * @event_actor: the current device actor of the events device
* @user_data: the data pointer passed to clutter_event_add_filter() * @user_data: the data pointer passed to [func@Clutter.Event.add_filter]
* *
* A function pointer type used by event filters that are added with * A function pointer type used by event filters that are added with
* clutter_event_add_filter(). * [func@Clutter.Event.add_filter].
* *
* Return value: %CLUTTER_EVENT_STOP to indicate that the event * Return value: %CLUTTER_EVENT_STOP to indicate that the event
* has been handled or %CLUTTER_EVENT_PROPAGATE otherwise. * has been handled or %CLUTTER_EVENT_PROPAGATE otherwise.

18
clutter/clutter/clutter-grid-layout.c
View File

@ -45,18 +45,18 @@
* A layout manager for a grid of actors * A layout manager for a grid of actors
* *
* #ClutterGridLayout is a layout manager which arranges its child widgets in * #ClutterGridLayout is a layout manager which arranges its child widgets in
* rows and columns. It is a very similar to #ClutterBoxLayout, but it * rows and columns. It is a very similar to [class@Clutter.BoxLayout], but it
* consistently uses #ClutterActor's alignment and expansion flags instead of * consistently uses [class@Clutter.Actor]'s alignment and expansion flags instead of
* custom child properties. * custom child properties.
* *
* Children are added using clutter_grid_layout_attach(). They can span * Children are added using [method@Clutter.GridLayout.attach]. They can span
* multiple rows or columns. It is also possible to add a child next to an * multiple rows or columns. It is also possible to add a child next to an
* existing child, using clutter_grid_layout_attach_next_to(). The behaviour of * existing child, using [method@Clutter.GridLayout.attach_next_to]. The behaviour of
* #ClutterGridLayout when several children occupy the same grid cell is undefined. * #ClutterGridLayout when several children occupy the same grid cell is undefined.
* *
* #ClutterGridLayout can be used like a #ClutterBoxLayout by just using * #ClutterGridLayout can be used like a #ClutterBoxLayout by just using
* clutter_actor_add_child(), which will place children next to each other in * [method@Clutter.Actor.add_child], which will place children next to each other in
* the direction determined by the #ClutterGridLayout:orientation property. * the direction determined by the [property@Clutter.GridLayout:orientation] property.
*/ */
#define CLUTTER_TYPE_GRID_CHILD (clutter_grid_child_get_type ()) #define CLUTTER_TYPE_GRID_CHILD (clutter_grid_child_get_type ())
@ -1713,7 +1713,7 @@ clutter_grid_layout_attach_next_to (ClutterGridLayout *layout,
* *
* #ClutterGridLayout uses the orientation as a hint when adding * #ClutterGridLayout uses the orientation as a hint when adding
* children to the #ClutterActor using it as a layout manager via * children to the #ClutterActor using it as a layout manager via
* clutter_actor_add_child(); changing this value will not have * [method@Clutter.Actor.add_child]; changing this value will not have
* any effect on children that are already part of the layout. * any effect on children that are already part of the layout.
*/ */
void void
@ -1982,7 +1982,7 @@ clutter_grid_layout_set_row_spacing (ClutterGridLayout *layout,
* clutter_grid_layout_get_row_spacing: * clutter_grid_layout_get_row_spacing:
* @layout: a #ClutterGridLayout * @layout: a #ClutterGridLayout
* *
* Retrieves the spacing set using clutter_grid_layout_set_row_spacing() * Retrieves the spacing set using [method@Clutter.GridLayout.set_row_spacing]
* *
* Return value: the spacing between rows of @layout * Return value: the spacing between rows of @layout
*/ */
@ -2029,7 +2029,7 @@ clutter_grid_layout_set_column_spacing (ClutterGridLayout *layout,
* clutter_grid_layout_get_column_spacing: * clutter_grid_layout_get_column_spacing:
* @layout: a #ClutterGridLayout * @layout: a #ClutterGridLayout
* *
* Retrieves the spacing set using clutter_grid_layout_set_column_spacing() * Retrieves the spacing set using [method@Clutter.GridLayout.set_column_spacing]
* *
* Return value: the spacing between coluns of @layout * Return value: the spacing between coluns of @layout
*/ */

4
clutter/clutter/clutter-image.c
View File

@ -339,7 +339,7 @@ clutter_image_set_bytes (ClutterImage *image,
* If the @image does not have any image data set when this function is * If the @image does not have any image data set when this function is
* called, a new texture will be created with the size of the width and * called, a new texture will be created with the size of the width and
* height of the rectangle, i.e. calling this function on a newly created * height of the rectangle, i.e. calling this function on a newly created
* #ClutterImage will be the equivalent of calling clutter_image_set_data(). * #ClutterImage will be the equivalent of calling [method@Clutter.Image.set_data].
* *
* If the image data was successfully loaded, the @image will be invalidated. * If the image data was successfully loaded, the @image will be invalidated.
* *
@ -411,7 +411,7 @@ clutter_image_set_area (ClutterImage *image,
* Retrieves a pointer to the Cogl texture used by @image. * Retrieves a pointer to the Cogl texture used by @image.
* *
* If you change the contents of the returned Cogl texture you will need * If you change the contents of the returned Cogl texture you will need
* to manually invalidate the @image with clutter_content_invalidate() * to manually invalidate the @image with [method@Clutter.Content.invalidate]
* in order to update the actors using @image as their content. * in order to update the actors using @image as their content.
* *
* Return value: (transfer none): a pointer to the Cogl texture, or %NULL * Return value: (transfer none): a pointer to the Cogl texture, or %NULL

18
clutter/clutter/clutter-interval.c
View File

@ -813,11 +813,11 @@ clutter_interval_set_initial_value (ClutterInterval *interval,
* @interval: a #ClutterInterval * @interval: a #ClutterInterval
* @...: the initial value of the interval. * @...: the initial value of the interval.
* *
* Variadic arguments version of clutter_interval_set_initial_value(). * Variadic arguments version of [method@Clutter.Interval.set_initial_value].
* *
* This function is meant as a convenience for the C API. * This function is meant as a convenience for the C API.
* *
* Language bindings should use clutter_interval_set_initial_value() * Language bindings should use [method@Clutter.Interval.set_initial_value]
* instead. * instead.
*/ */
void void
@ -916,11 +916,11 @@ clutter_interval_get_final_value (ClutterInterval *interval,
* @interval: a #ClutterInterval * @interval: a #ClutterInterval
* @...: the final value of the interval * @...: the final value of the interval
* *
* Variadic arguments version of clutter_interval_set_final_value(). * Variadic arguments version of [method@Clutter.Interval.set_final_value].
* *
* This function is meant as a convenience for the C API. * This function is meant as a convenience for the C API.
* *
* Language bindings should use clutter_interval_set_final_value() instead. * Language bindings should use [method@Clutter.Interval.set_final_value] instead.
*/ */
void void
clutter_interval_set_final (ClutterInterval *interval, clutter_interval_set_final (ClutterInterval *interval,
@ -958,8 +958,8 @@ clutter_interval_peek_final_value (ClutterInterval *interval)
* @interval: a #ClutterInterval * @interval: a #ClutterInterval
* @...: the initial and final values of the interval * @...: the initial and final values of the interval
* *
* Variable arguments wrapper for clutter_interval_set_initial_value() * Variable arguments wrapper for [method@Clutter.Interval.set_initial_value]
* and clutter_interval_set_final_value() that avoids using the * and [method@Clutter.Interval.set_final_value] that avoids using the
* #GValue arguments: * #GValue arguments:
* *
* ```c * ```c
@ -997,8 +997,8 @@ out:
* @...: return locations for the initial and final values of * @...: return locations for the initial and final values of
* the interval * the interval
* *
* Variable arguments wrapper for clutter_interval_get_initial_value() * Variable arguments wrapper for [method@Clutter.Interval.get_initial_value]
* and clutter_interval_get_final_value() that avoids using the * and [method@Clutter.Interval.get_final_value] that avoids using the
* #GValue arguments: * #GValue arguments:
* *
* ```c * ```c
@ -1075,7 +1075,7 @@ clutter_interval_compute_value (ClutterInterval *interval,
* Computes the value between the @interval boundaries given the * Computes the value between the @interval boundaries given the
* progress @factor * progress @factor
* *
* Unlike clutter_interval_compute_value(), this function will * Unlike [method@Clutter.Interval.compute_value], this function will
* return a const pointer to the computed value * return a const pointer to the computed value
* *
* You should use this function if you immediately pass the computed * You should use this function if you immediately pass the computed

8
clutter/clutter/clutter-keyframe-transition.c
View File

@ -48,7 +48,7 @@
* 0.5, 128, CLUTTER_EASE_IN_OUT_CUBIC); * 0.5, 128, CLUTTER_EASE_IN_OUT_CUBIC);
* ``` * ```
* *
* The example above sets up a keyframe transition for the #ClutterActor:opacity * The example above sets up a keyframe transition for the [property@Clutter.Actor:opacity]
* property of a #ClutterActor; the transition starts and sets the value of the * property of a #ClutterActor; the transition starts and sets the value of the
* property to fully transparent; between the start of the transition and its mid * property to fully transparent; between the start of the transition and its mid
* point, it will animate the property to half opacity, using an easy in/easy out * point, it will animate the property to half opacity, using an easy in/easy out
@ -540,9 +540,9 @@ clutter_keyframe_transition_set_modes (ClutterKeyframeTransition *transition,
* Sets the key frames of the @transition. * Sets the key frames of the @transition.
* *
* This variadic arguments function is a convenience for C developers; * This variadic arguments function is a convenience for C developers;
* language bindings should use clutter_keyframe_transition_set_key_frames(), * language bindings should use [method@Clutter.KeyframeTransition.set_key_frames],
* clutter_keyframe_transition_set_modes(), and * [method@Clutter.KeyframeTransition.set_modes], and
* clutter_keyframe_transition_set_values() instead. * [method@Clutter.KeyframeTransition.set_values] instead.
*/ */
void void
clutter_keyframe_transition_set (ClutterKeyframeTransition *transition, clutter_keyframe_transition_set (ClutterKeyframeTransition *transition,

38
clutter/clutter/clutter-layout-manager.c
View File

@ -32,17 +32,17 @@
* container actor: it controls the preferred size of the actor to which * container actor: it controls the preferred size of the actor to which
* it has been paired, and it controls the allocation of its children. * it has been paired, and it controls the allocation of its children.
* *
* Any composite or container #ClutterActor subclass can delegate the * Any composite or container [class@Clutter.Actor] subclass can delegate the
* layouting of its children to a #ClutterLayoutManager. * layouting of its children to a #ClutterLayoutManager.
* *
* Clutter provides some simple #ClutterLayoutManager sub-classes, like * Clutter provides some simple #ClutterLayoutManager sub-classes, like
* #ClutterFlowLayout and #ClutterBinLayout. * [class@Clutter.FlowLayout] and [class@Clutter.BinLayout].
* *
* ## Implementing a ClutterLayoutManager * ## Implementing a ClutterLayoutManager
* The implementation of a layout manager does not differ from the * The implementation of a layout manager does not differ from the
* implementation of the size requisition and allocation bits of * implementation of the size requisition and allocation bits of
* #ClutterActor, so you should read the relative documentation * [class@Clutter.Actor], so you should read the relative documentation
* for subclassing #ClutterActor. * for subclassing [class@Clutter.Actor].
* *
* The layout manager implementation can hold a back pointer to the container * The layout manager implementation can hold a back pointer to the container
* [type@Clutter.Actor] by implementing the * [type@Clutter.Actor] by implementing the
@ -52,8 +52,8 @@
* cycles. * cycles.
* *
* If a layout manager has properties affecting the layout policies then it should * If a layout manager has properties affecting the layout policies then it should
* emit the #ClutterLayoutManager::layout-changed signal on itself by using the * emit the [signal@Clutter.LayoutManager::layout-changed] signal on itself by using the
* clutter_layout_manager_layout_changed() function whenever one of these properties * [method@Clutter.LayoutManager.layout_changed] function whenever one of these properties
* changes. * changes.
* *
* ## Layout Properties * ## Layout Properties
@ -61,12 +61,12 @@
* If a layout manager has layout properties, that is properties that * If a layout manager has layout properties, that is properties that
* should exist only as the result of the presence of a specific (layout * should exist only as the result of the presence of a specific (layout
* manager, container actor, child actor) combination, and it wishes to store * manager, container actor, child actor) combination, and it wishes to store
* those properties inside a #ClutterLayoutMeta, then it should override the * those properties inside a [class@Clutter.LayoutMeta], then it should override the
* #ClutterLayoutManagerClass.get_child_meta_type() virtual function to return * [vfunc@Clutter.LayoutManager.get_child_meta_type] virtual function to return
* the #GType of the #ClutterLayoutMeta sub-class used to store the layout * the #GType of the [class@Clutter.LayoutMeta] sub-class used to store the layout
* properties; optionally, the #ClutterLayoutManager sub-class might also * properties; optionally, the #ClutterLayoutManager sub-class might also
* override the #ClutterLayoutManagerClass.create_child_meta() virtual function * override the [vfunc@Clutter.LayoutManager.create_child_meta] virtual function
* to control how the #ClutterLayoutMeta instance is created, otherwise the * to control how the [class@Clutter.LayoutMeta] instance is created, otherwise the
* default implementation will be equivalent to: * default implementation will be equivalent to:
* *
* ```c * ```c
@ -84,8 +84,8 @@
* ``` * ```
* *
* Where `manager` is the #ClutterLayoutManager, `container` is the * Where `manager` is the #ClutterLayoutManager, `container` is the
* #ClutterActor using the #ClutterLayoutManager, and `actor` is * [class@Clutter.Actor] using the #ClutterLayoutManager, and `actor` is
* the #ClutterActor child of the #ClutterActor. * the [class@Clutter.Actor] child of the [class@Clutter.Actor].
*/ */
#include "config.h" #include "config.h"
@ -295,7 +295,7 @@ clutter_layout_manager_class_init (ClutterLayoutManagerClass *klass)
* Sub-classes of #ClutterLayoutManager that implement a layout that * Sub-classes of #ClutterLayoutManager that implement a layout that
* can be controlled or changed using parameters should emit the * can be controlled or changed using parameters should emit the
* ::layout-changed signal whenever one of the parameters changes, * ::layout-changed signal whenever one of the parameters changes,
* by using clutter_layout_manager_layout_changed(). * by using [method@Clutter.LayoutManager.layout_changed].
*/ */
manager_signals[LAYOUT_CHANGED] = manager_signals[LAYOUT_CHANGED] =
g_signal_new (I_("layout-changed"), g_signal_new (I_("layout-changed"),
@ -325,7 +325,7 @@ clutter_layout_manager_init (ClutterLayoutManager *manager)
* Computes the minimum and natural widths of the @container according * Computes the minimum and natural widths of the @container according
* to @manager. * to @manager.
* *
* See also clutter_actor_get_preferred_width() * See also [method@Clutter.Actor.get_preferred_width]
*/ */
void void
clutter_layout_manager_get_preferred_width (ClutterLayoutManager *manager, clutter_layout_manager_get_preferred_width (ClutterLayoutManager *manager,
@ -358,7 +358,7 @@ clutter_layout_manager_get_preferred_width (ClutterLayoutManager *manager,
* Computes the minimum and natural heights of the @container according * Computes the minimum and natural heights of the @container according
* to @manager. * to @manager.
* *
* See also clutter_actor_get_preferred_height() * See also [method@Clutter.Actor.get_preferred_height]
*/ */
void void
clutter_layout_manager_get_preferred_height (ClutterLayoutManager *manager, clutter_layout_manager_get_preferred_height (ClutterLayoutManager *manager,
@ -387,7 +387,7 @@ clutter_layout_manager_get_preferred_height (ClutterLayoutManager *manager,
* *
* Allocates the children of @container given an area * Allocates the children of @container given an area
* *
* See also clutter_actor_allocate() * See also [method@Clutter.Actor.allocate]
*/ */
void void
clutter_layout_manager_allocate (ClutterLayoutManager *manager, clutter_layout_manager_allocate (ClutterLayoutManager *manager,
@ -408,7 +408,7 @@ clutter_layout_manager_allocate (ClutterLayoutManager *manager,
* clutter_layout_manager_layout_changed: * clutter_layout_manager_layout_changed:
* @manager: a #ClutterLayoutManager * @manager: a #ClutterLayoutManager
* *
* Emits the #ClutterLayoutManager::layout-changed signal on @manager * Emits the [signal@Clutter.LayoutManager::layout-changed] signal on @manager
* *
* This function should only be called by implementations of the * This function should only be called by implementations of the
* #ClutterLayoutManager class * #ClutterLayoutManager class
@ -590,7 +590,7 @@ layout_get_property_internal (ClutterLayoutManager *manager,
* Sets a list of properties and their values on the #ClutterLayoutMeta * Sets a list of properties and their values on the #ClutterLayoutMeta
* associated by @manager to a child of @container * associated by @manager to a child of @container
* *
* Languages bindings should use clutter_layout_manager_child_set_property() * Languages bindings should use [method@Clutter.LayoutManager.child_set_property]
* instead * instead
*/ */
void void

2
clutter/clutter/clutter-types.h
View File

@ -340,7 +340,7 @@ void clutter_margin_free (ClutterMargin *margin_);
* *
* This function will be called by #ClutterInterval if the * This function will be called by #ClutterInterval if the
* type of the values of the interval was registered using * type of the values of the interval was registered using
* clutter_interval_register_progress_func(). * [func@Clutter.Interval.register_progress_func].
* *
* Return value: %TRUE if the function successfully computed * Return value: %TRUE if the function successfully computed
* the value and stored it inside @retval * the value and stored it inside @retval

6
cogl/cogl/cogl-bitmap.h
View File

@ -102,7 +102,7 @@ cogl_bitmap_new_from_buffer (CoglBuffer *buffer,
* *
* The data for the bitmap will be stored in a newly created * The data for the bitmap will be stored in a newly created
* #CoglPixelBuffer. You can get a pointer to the pixel buffer using * #CoglPixelBuffer. You can get a pointer to the pixel buffer using
* cogl_bitmap_get_buffer(). The #CoglBuffer API can then be * [method@Cogl.Bitmap.get_buffer]. The #CoglBuffer API can then be
* used to fill the bitmap with data. * used to fill the bitmap with data.
* *
* Cogl will try its best to provide a hardware array you can * Cogl will try its best to provide a hardware array you can
@ -111,7 +111,7 @@ cogl_bitmap_new_from_buffer (CoglBuffer *buffer,
* reasons, such arrays are likely to have a stride larger than width * reasons, such arrays are likely to have a stride larger than width
* * bytes_per_pixel. The user must take the stride into account when * * bytes_per_pixel. The user must take the stride into account when
* writing into it. The stride can be retrieved with * writing into it. The stride can be retrieved with
* cogl_bitmap_get_rowstride(). * [method@Cogl.Bitmap.get_rowstride].
* *
* Return value: (transfer full): a #CoglPixelBuffer representing the * Return value: (transfer full): a #CoglPixelBuffer representing the
* newly created array or %NULL on failure * newly created array or %NULL on failure
@ -135,7 +135,7 @@ cogl_bitmap_new_with_size (CoglContext *context,
* Creates a bitmap using some existing data. The data is not copied * Creates a bitmap using some existing data. The data is not copied
* so the application must keep the buffer alive for the lifetime of * so the application must keep the buffer alive for the lifetime of
* the #CoglBitmap. This can be used for example with * the #CoglBitmap. This can be used for example with
* cogl_framebuffer_read_pixels_into_bitmap() to read data directly * [method@Cogl.Framebuffer.read_pixels_into_bitmap] to read data directly
* into an application buffer with the specified rowstride. * into an application buffer with the specified rowstride.
* *
* Return value: (transfer full): A new #CoglBitmap. * Return value: (transfer full): A new #CoglBitmap.

12
cogl/cogl/cogl-buffer.h
View File

@ -48,8 +48,8 @@ G_BEGIN_DECLS
* Common buffer functions, including data upload APIs * Common buffer functions, including data upload APIs
* *
* The CoglBuffer API provides a common interface to manipulate * The CoglBuffer API provides a common interface to manipulate
* buffers that have been allocated either via cogl_pixel_buffer_new() * buffers that have been allocated either via `cogl_pixel_buffer_new()`
* or cogl_attribute_buffer_new(). The API allows you to upload data * or `cogl_attribute_buffer_new()`. The API allows you to upload data
* to these buffers and define usage hints that help Cogl manage your * to these buffers and define usage hints that help Cogl manage your
* buffer optimally. * buffer optimally.
* *
@ -141,7 +141,7 @@ cogl_buffer_set_update_hint (CoglBuffer *buffer,
* cogl_buffer_get_update_hint: * cogl_buffer_get_update_hint:
* @buffer: a buffer object * @buffer: a buffer object
* *
* Retrieves the update hints set using cogl_buffer_set_update_hint() * Retrieves the update hints set using [method@Cogl.Buffer.set_update_hint]
* *
* Return value: the #CoglBufferUpdateHint currently used by the buffer * Return value: the #CoglBufferUpdateHint currently used by the buffer
*/ */
@ -155,7 +155,7 @@ cogl_buffer_get_update_hint (CoglBuffer *buffer);
* @COGL_BUFFER_ACCESS_READ_WRITE: the buffer will be used for both reading and * @COGL_BUFFER_ACCESS_READ_WRITE: the buffer will be used for both reading and
* writing * writing
* *
* The access hints for cogl_buffer_set_update_hint() * The access hints for [method@Cogl.Buffer.set_update_hint]
*/ */
typedef enum /*< prefix=COGL_BUFFER_ACCESS >*/ typedef enum /*< prefix=COGL_BUFFER_ACCESS >*/
{ {
@ -206,7 +206,7 @@ typedef enum /*< prefix=COGL_BUFFER_BIND_TARGET >*/
* the data will be modified once mapped. * the data will be modified once mapped.
* *
* Maps the buffer into the application address space for direct * Maps the buffer into the application address space for direct
* access. This is equivalent to calling cogl_buffer_map_range() with * access. This is equivalent to calling [method@Cogl.Buffer.map_range] with
* zero as the offset and the size of the entire buffer as the size. * zero as the offset and the size of the entire buffer as the size.
* *
* It is strongly recommended that you pass * It is strongly recommended that you pass
@ -269,7 +269,7 @@ cogl_buffer_map_range (CoglBuffer *buffer,
* cogl_buffer_unmap: * cogl_buffer_unmap:
* @buffer: a buffer object * @buffer: a buffer object
* *
* Unmaps a buffer previously mapped by cogl_buffer_map(). * Unmaps a buffer previously mapped by [method@Cogl.Buffer.map].
*/ */
COGL_EXPORT void COGL_EXPORT void
cogl_buffer_unmap (CoglBuffer *buffer); cogl_buffer_unmap (CoglBuffer *buffer);

10
cogl/cogl/deprecated/cogl-shader.h
View File

@ -253,7 +253,7 @@ cogl_program_get_uniform_location (CoglProgram *program,
* cogl_program_set_uniform_1f: * cogl_program_set_uniform_1f:
* @program: A linked program * @program: A linked program
* @uniform_location: the uniform location retrieved from * @uniform_location: the uniform location retrieved from
* cogl_program_get_uniform_location(). * [method@Program.get_uniform_location].
* @value: the new value of the uniform. * @value: the new value of the uniform.
* *
* Changes the value of a floating point uniform for the given linked * Changes the value of a floating point uniform for the given linked
@ -270,7 +270,7 @@ cogl_program_set_uniform_1f (CoglProgram *program,
* cogl_program_set_uniform_1i: * cogl_program_set_uniform_1i:
* @program: A linked program * @program: A linked program
* @uniform_location: the uniform location retrieved from * @uniform_location: the uniform location retrieved from
* cogl_program_get_uniform_location(). * [method@Program.get_uniform_location].
* @value: the new value of the uniform. * @value: the new value of the uniform.
* *
* Changes the value of an integer uniform for the given linked * Changes the value of an integer uniform for the given linked
@ -287,7 +287,7 @@ cogl_program_set_uniform_1i (CoglProgram *program,
* cogl_program_set_uniform_float: * cogl_program_set_uniform_float:
* @program: A linked program * @program: A linked program
* @uniform_location: the uniform location retrieved from * @uniform_location: the uniform location retrieved from
* cogl_program_get_uniform_location(). * [method@Program.get_uniform_location].
* @n_components: The number of components for the uniform. For * @n_components: The number of components for the uniform. For
* example with glsl you'd use 3 for a vec3 or 4 for a vec4. * example with glsl you'd use 3 for a vec3 or 4 for a vec4.
* @count: For uniform arrays this is the array length otherwise just * @count: For uniform arrays this is the array length otherwise just
@ -310,7 +310,7 @@ cogl_program_set_uniform_float (CoglProgram *program,
* cogl_program_set_uniform_int: * cogl_program_set_uniform_int:
* @program: A linked program * @program: A linked program
* @uniform_location: the uniform location retrieved from * @uniform_location: the uniform location retrieved from
* cogl_program_get_uniform_location(). * [method@Program.get_uniform_location].
* @n_components: The number of components for the uniform. For * @n_components: The number of components for the uniform. For
* example with glsl you'd use 3 for a vec3 or 4 for a vec4. * example with glsl you'd use 3 for a vec3 or 4 for a vec4.
* @count: For uniform arrays this is the array length otherwise just * @count: For uniform arrays this is the array length otherwise just
@ -333,7 +333,7 @@ cogl_program_set_uniform_int (CoglProgram *program,
* cogl_program_set_uniform_matrix: * cogl_program_set_uniform_matrix:
* @program: A linked program * @program: A linked program
* @uniform_location: the uniform location retrieved from * @uniform_location: the uniform location retrieved from
* cogl_program_get_uniform_location(). * [method@Program.get_uniform_location].
* @dimensions: The dimensions of the matrix. So for for example pass * @dimensions: The dimensions of the matrix. So for for example pass
* 2 for a 2x2 matrix or 3 for 3x3. * 2 for a 2x2 matrix or 3 for 3x3.
* @count: For uniform arrays this is the array length otherwise just * @count: For uniform arrays this is the array length otherwise just

11
src/backends/meta-backend.c
View File

@ -26,13 +26,14 @@
* Handles monitor config, modesetting, cursor sprites, ... * Handles monitor config, modesetting, cursor sprites, ...
* *
* MetaBackend is the abstraction that deals with several things like: * MetaBackend is the abstraction that deals with several things like:
*
* - Modesetting (depending on the backend, this can be done either by X or KMS) * - Modesetting (depending on the backend, this can be done either by X or KMS)
* - Initializing the #MetaSettings * - Initializing the [struct@Meta.Settings]
* - Setting up Monitor configuration * - Setting up Monitor configuration
* - Input device configuration (using the #ClutterDeviceManager) * - Input device configuration (using the #ClutterDeviceManager)
* - Creating the #MetaRenderer * - Creating the #MetaRenderer
* - Setting up the stage of the scene graph (using #MetaStage) * - Setting up the stage of the scene graph (using [class@Meta.Stage])
* - Creating the object that deals with the cursor (using #MetaCursorTracker) * - Creating the object that deals with the cursor (using [class@Meta.CursorTracker])
* and its possible pointer constraint (using #MetaPointerConstraint) * and its possible pointer constraint (using #MetaPointerConstraint)
* - Setting the cursor sprite (using #MetaCursorRenderer) * - Setting the cursor sprite (using #MetaCursorRenderer)
* - Interacting with logind (using the appropriate D-Bus interface) * - Interacting with logind (using the appropriate D-Bus interface)
@ -40,8 +41,8 @@
* - Setup Remote Desktop / Screencasting (#MetaRemoteDesktop) * - Setup Remote Desktop / Screencasting (#MetaRemoteDesktop)
* - Setup the #MetaEgl object * - Setup the #MetaEgl object
* *
* Note that the #MetaBackend is not a subclass of #ClutterBackend. It is * Note that the #MetaBackend is not a subclass of [class@Clutter.Backend].
* responsible for creating the correct one, based on the backend that is * It is responsible for creating the correct one, based on the backend that is
* used (#MetaBackendNative or #MetaBackendX11). * used (#MetaBackendNative or #MetaBackendX11).
*/ */