[cluttermm] documentation update
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [cluttermm] documentation update
- Date: Fri, 21 Mar 2014 09:58:14 +0000 (UTC)
commit 309b0f49fa0d2e63edf0fd16576f5b7139a63928
Author: Ian Martin <martin_id vodafone co nz>
Date: Fri Mar 21 07:37:11 2014 +1300
documentation update
clutter_docs.xml updated against clutter-1.8
clutter/src/clutter_docs.xml |38183 +++++++++++++++++++++++++++++++-----------
1 files changed, 28613 insertions(+), 9570 deletions(-)
---
diff --git a/clutter/src/clutter_docs.xml b/clutter/src/clutter_docs.xml
index d3d4173..f145439 100644
--- a/clutter/src/clutter_docs.xml
+++ b/clutter/src/clutter_docs.xml
@@ -1,1722 +1,5145 @@
<root>
-<function name="clutter_do_event">
+<signal name="ClutterActor::allocation-changed">
<description>
-Processes an event. This function should never be called by applications.
+The ::allocation-changed signal is emitted when the
+#ClutterActor:allocation property changes. Usually, application
+code should just use the notifications for the :allocation property
+but if you want to track the allocation flags as well, for instance
+to know whether the absolute origin of @actor changed, then you might
+want use this signal instead.
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent.
+<parameter name="actor">
+<parameter_description> the #ClutterActor that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox with the new allocation
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #ClutterAllocationFlags for the allocation
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_alpha_register_func">
+<signal name="ClutterActor::button-press-event">
<description>
-Registers a global alpha function and returns its logical id
-to be used by clutter_alpha_set_mode() or by #ClutterAnimation.
-
-The logical id is always greater than %CLUTTER_ANIMATION_LAST.
+The ::button-press-event signal is emitted each time a mouse button
+is pressed on @actor.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a #ClutterAlphaFunc
+<parameter name="actor">
+<parameter_description> the actor which received the event
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
+<parameter name="event">
+<parameter_description> a #ClutterButtonEvent
</parameter_description>
</parameter>
</parameters>
-<return> the logical id of the alpha function
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="cogl_pango_font_map_create_context">
+<signal name="ClutterActor::button-release-event">
<description>
-Creates a new #PangoContext from the passed font map.
+The ::button-release-event signal is emitted each time a mouse button
+is released on @actor.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="fm">
-<parameter_description> a #CoglPangoFontMap
+<parameter name="actor">
+<parameter_description> the actor which received the event
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterButtonEvent
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #PangoContext
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_knot_free">
+<signal name="ClutterActor::captured-event">
<description>
-Frees the memory of an allocated knot.
+The ::captured-event signal is emitted when an event is captured
+by Clutter. This signal will be emitted starting from the top-level
+container (the #ClutterStage) to the actor which received the event
+going down the hierarchy. This signal can be used to intercept every
+event before the specialized events (like
+ClutterActor::button-press-event or ::key-released-event) are
+emitted.
-Since: 0.2
+Since: 0.6
</description>
<parameters>
-<parameter name="knot">
-<parameter_description> a #ClutterKnot
+<parameter name="actor">
+<parameter_description> the actor which received the signal
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
-<function name="clutter_actor_animate_with_timeline">
+</return>
+</signal>
+
+<signal name="ClutterActor::destroy">
<description>
-Animates the given list of properties of @actor between the current
-value for each property and a new final value. The animation has a
-definite duration given by @timeline and a speed given by the @mode.
+The ::destroy signal notifies that all references held on the
+actor which emitted it should be released.
-See clutter_actor_animate() for further details.
+The ::destroy signal should be used by all holders of a reference
+on @actor.
-This function is useful if you want to use an existing timeline
-to animate @actor.
+This signal might result in the finalization of the #ClutterActor
+if all references are released.
-Since: 1.0
+Composite actors and actors implementing the #ClutterContainer
+interface should override the default implementation of the
+class handler of this signal and call clutter_actor_destroy() on
+their children. When overriding the default class handler, it is
+required to chain up to the parent's implementation.
+
+Since: 0.2
</description>
<parameters>
<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter_description> the #ClutterActor which emitted the signal
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an animation mode logical id
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::enter-event">
+<description>
+The ::enter-event signal is emitted when the pointer enters the @actor
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor which the pointer has entered.
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="event">
+<parameter_description> a #ClutterCrossingEvent
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of a property
+</parameters>
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
+
+</return>
+</signal>
+
+<signal name="ClutterActor::event">
+<description>
+The ::event signal is emitted each time an event is received
+by the @actor. This signal will be emitted on every actor,
+following the hierarchy chain, until it reaches the top-level
+container (the #ClutterStage).
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor which received the event
</parameter_description>
</parameter>
-<parameter name="VarArgs">
-<parameter_description> a %NULL terminated list of property names and
-property values
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAnimation object. The object is
-owned by the #ClutterActor and should not be unreferenced with
-g_object_unref()
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_event_get">
+<signal name="ClutterActor::hide">
<description>
-Pops an event off the event queue. Applications should not need to call
-this.
+The ::hide signal is emitted when an actor is no longer rendered
+on the stage.
-Since: 0.4
+Since: 0.2
</description>
<parameters>
+<parameter name="actor">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
</parameters>
-<return> A #ClutterEvent or NULL if queue empty
-
-</return>
-</function>
+<return></return>
+</signal>
-<function name="clutter_score_append">
+<signal name="ClutterActor::key-focus-in">
<description>
-Appends a timeline to another one existing in the score; the newly
-appended timeline will be started when @parent is complete.
+The ::key-focus-in signal is emitted when @actor receives key focus.
-If @parent is %NULL, the new #ClutterTimeline will be started when
-clutter_score_start() is called.
+Since: 0.6
-#ClutterScore will take a reference on @timeline.
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor which now has key focus
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::key-focus-out">
+<description>
+The ::key-focus-out signal is emitted when @actor loses key focus.
Since: 0.6
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="actor">
+<parameter_description> the actor which now has key focus
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> a #ClutterTimeline in the score, or %NULL
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::key-press-event">
+<description>
+The ::key-press-event signal is emitted each time a keyboard button
+is pressed while @actor has key focus (see clutter_stage_set_key_focus()).
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor which received the event
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="event">
+<parameter_description> a #ClutterKeyEvent
</parameter_description>
</parameter>
</parameters>
-<return> the id of the #ClutterTimeline inside the score, or
-0 on failure. The returned id can be used with clutter_score_remove()
-or clutter_score_get_timeline().
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_actor_get_shader">
+<signal name="ClutterActor::key-release-event">
<description>
-Queries the currently set #ClutterShader on @self.
+The ::key-release-event signal is emitted each time a keyboard button
+is released while @actor has key focus (see
+clutter_stage_set_key_focus()).
Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="actor">
+<parameter_description> the actor which received the event
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterKeyEvent
</parameter_description>
</parameter>
</parameters>
-<return> The currently set #ClutterShader
-or %NULL if no shader is set.
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_animator_new">
+<signal name="ClutterActor::leave-event">
<description>
-Creates a new #ClutterAnimator instance
+The ::leave-event signal is emitted when the pointer leaves the @actor.
-Since: 1.2
+Since: 0.6
</description>
<parameters>
+<parameter name="actor">
+<parameter_description> the actor which the pointer has left
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterCrossingEvent
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #ClutterAnimator.
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_animator_key_get_mode">
+<signal name="ClutterActor::motion-event">
<description>
-Retrieves the mode of a #ClutterAnimator key, for the first key of a
-property for an object this represents the whether the animation is
-open ended and or curved for the remainding keys for the property it
-represents the easing mode.
+The ::motion-event signal is emitted each time the mouse pointer is
+moved over @actor.
-Since: 1.2
+Since: 0.6
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="actor">
+<parameter_description> the actor which received the event
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterMotionEvent
</parameter_description>
</parameter>
</parameters>
-<return> the mode of a #ClutterAnimatorKey
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
</return>
-</function>
+</signal>
-<function name="clutter_path_to_cairo_path">
+<signal name="ClutterActor::paint">
<description>
-Add the nodes of the ClutterPath to the path in the Cairo context.
+The ::paint signal is emitted each time an actor is being painted.
+
+Subclasses of #ClutterActor should override the #ClutterActorClass.paint
+virtual function paint themselves in that function.
+
+<warning>It is strongly discouraged to connect a signal handler to
+the #ClutterActor::paint signal; if you want to change the paint
+sequence of an existing #ClutterActor instance, either create a new
+#ClutterActor class and override the #ClutterActorClass.paint virtual
+function, or use a #ClutterEffect. The #ClutterActor::paint signal
+will be removed in a future version of Clutter.</warning>
+
+Since: 0.8
+
+Deprecated: 1.12: Override the #ClutterActorClass.paint virtual
+function, use a #ClutterContent implementation, or a #ClutterEffect
+instead of connecting to this signal.
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the #ClutterActor that received the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::parent-set">
+<description>
+This signal is emitted when the parent of the actor changes.
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="old_parent">
+<parameter_description> the previous parent of the actor, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::pick">
+<description>
+The ::pick signal is emitted each time an actor is being painted
+in "pick mode". The pick mode is used to identify the actor during
+the event handling phase, or by clutter_stage_get_actor_at_pos().
+The actor should paint its shape using the passed @pick_color.
+
+Subclasses of #ClutterActor should override the class signal handler
+and paint themselves in that function.
+
+It is possible to connect a handler to the ::pick signal in order
+to set up some custom aspect of a paint in pick mode.
Since: 1.0
+Deprecated: 1.12: Override the #ClutterActorClass.pick virtual function
+instead.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="actor">
+<parameter_description> the #ClutterActor that received the signal
</parameter_description>
</parameter>
-<parameter name="cr">
-<parameter_description> a Cairo context
+<parameter name="color">
+<parameter_description> the #ClutterColor to be used when picking
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_units_from_mm">
+<signal name="ClutterActor::queue-redraw">
<description>
-Stores a value in millimiters inside @units
+The ::queue_redraw signal is emitted when clutter_actor_queue_redraw()
+is called on @origin.
+
+The default implementation for #ClutterActor chains up to the
+parent actor and queues a redraw on the parent, thus "bubbling"
+the redraw queue up through the actor graph. The default
+implementation for #ClutterStage queues a clutter_stage_ensure_redraw()
+in a main loop idle handler.
+
+Note that the @origin actor may be the stage, or a container; it
+does not have to be a leaf node in the actor graph.
+
+Toolkits embedding a #ClutterStage which require a redraw and
+relayout cycle can stop the emission of this signal using the
+GSignal API, redraw the UI and then call clutter_stage_ensure_redraw()
+themselves, like:
+
+|[
+static void
+on_redraw_complete (gpointer data)
+{
+ClutterStage *stage = data;
+
+/ * execute the Clutter drawing pipeline * /
+clutter_stage_ensure_redraw (stage);
+}
+
+static void
+on_stage_queue_redraw (ClutterStage *stage)
+{
+/ * this prevents the default handler to run * /
+g_signal_stop_emission_by_name (stage, "queue-redraw");
+
+/ * queue a redraw with the host toolkit and call
+* a function when the redraw has been completed
+* /
+queue_a_redraw (G_CALLBACK (on_redraw_complete), stage);
+}
+]|
+
+<note><para>This signal is emitted before the Clutter paint
+pipeline is executed. If you want to know when the pipeline has
+been completed you should connect to the ::paint signal on the
+Stage with g_signal_connect_after().</para></note>
Since: 1.0
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="actor">
+<parameter_description> the actor we're bubbling the redraw request through
</parameter_description>
</parameter>
-<parameter name="mm">
-<parameter_description> millimeters
+<parameter name="origin">
+<parameter_description> the actor which initiated the redraw request
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_value_set_shader_matrix">
+<signal name="ClutterActor::queue-relayout">
<description>
-Sets @matrix as the contents of @value. The passed #GValue
-must have been initialized using %CLUTTER_TYPE_SHADER_MATRIX.
+The ::queue_layout signal is emitted when clutter_actor_queue_relayout()
+is called on an actor.
+
+The default implementation for #ClutterActor chains up to the
+parent actor and queues a relayout on the parent, thus "bubbling"
+the relayout queue up through the actor graph.
+
+The main purpose of this signal is to allow relayout to be propagated
+properly in the procense of #ClutterClone actors. Applications will
+not normally need to connect to this signal.
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor being queued for relayout
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::realize">
+<description>
+The ::realize signal is emitted each time an actor is being
+realized.
Since: 0.8
+Deprecated: 1.16: The signal should not be used in newly
+written code
+
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="actor">
+<parameter_description> the #ClutterActor that received the signal
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> number of floating point values in @floats
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::scroll-event">
+<description>
+The ::scroll-event signal is emitted each time the mouse is
+scrolled on @actor
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the actor which received the event
</parameter_description>
</parameter>
-<parameter name="matrix">
-<parameter_description> a matrix of floating point values
+<parameter name="event">
+<parameter_description> a #ClutterScrollEvent
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the event has been handled by the actor,
+or %FALSE to continue the emission.
+
+</return>
+</signal>
+
+<signal name="ClutterActor::show">
+<description>
+The ::show signal is emitted when an actor is visible and
+rendered on the stage.
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_timeout_pool_remove">
+<signal name="ClutterActor::touch-event">
<description>
-Removes a timeout function with @id from the timeout pool. The id
-is the same returned when adding a function to the timeout pool with
-clutter_timeout_pool_add().
+The ::touch-event signal is emitted each time a touch
+begin/end/update/cancel event.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterTimeoutPool
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="id">
-<parameter_description> the id of the timeout to remove
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+</parameters>
+<return> %CLUTTER_EVENT_STOP if the event has been handled by
+the actor, or %CLUTTER_EVENT_PROPAGATE to continue the emission.
+
+</return>
+</signal>
+
+<signal name="ClutterActor::transition-stopped">
+<description>
+The ::transition-stopped signal is emitted once a transition
+is stopped; a transition is stopped once it reached its total
+duration (including eventual repeats), it has been stopped
+using clutter_timeline_stop(), or it has been removed from the
+transitions applied on @actor, using clutter_actor_remove_transition().
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the transition
+</parameter_description>
+</parameter>
+<parameter name="is_finished">
+<parameter_description> whether the transition was finished, or stopped
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_timeline_remove_marker">
+<signal name="ClutterActor::transitions-completed">
<description>
-Removes @marker_name, if found, from @timeline.
+The ::transitions-completed signal is emitted once all transitions
+involving @actor are complete.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterActor::unrealize">
+<description>
+The ::unrealize signal is emitted each time an actor is being
+unrealized.
Since: 0.8
+Deprecated: 1.16: The signal should not be used in newly
+written code
+
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="actor">
+<parameter_description> the #ClutterActor that received the signal
</parameter_description>
</parameter>
-<parameter name="marker_name">
-<parameter_description> the name of the marker to remove
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterActorAlign">
+<description>
+Controls how a #ClutterActor should align itself inside the extra space
+assigned to it during the allocation.
+
+Alignment only matters if the allocated space given to an actor is
+bigger than its natural size; for example, when the #ClutterActor:x-expand
+or the #ClutterActor:y-expand properties of #ClutterActor are set to %TRUE.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ACTOR_ALIGN_FILL">
+<parameter_description> Stretch to cover the whole allocated space
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_ALIGN_START">
+<parameter_description> Snap to left or top side, leaving space
+to the right or bottom. For horizontal layouts, in right-to-left
+locales this should be reversed.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_ALIGN_CENTER">
+<parameter_description> Center the actor inside the allocation
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_ALIGN_END">
+<parameter_description> Snap to right or bottom side, leaving space
+to the left or top. For horizontal layouts, in right-to-left locales
+this should be reversed.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterActorFlags">
+<description>
+Flags used to signal the state of an actor.
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ACTOR_MAPPED">
+<parameter_description> the actor will be painted (is visible, and inside
+a toplevel, and all parents visible)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_REALIZED">
+<parameter_description> the resources associated to the actor have been
+allocated
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_REACTIVE">
+<parameter_description> the actor 'reacts' to mouse events emmitting event
+signals
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_VISIBLE">
+<parameter_description> the actor has been shown by the application program
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ACTOR_NO_LAYOUT">
+<parameter_description> the actor provides an explicit layout management
+policy for its children; this flag will prevent Clutter from automatic
+queueing of relayout and will defer all layouting to the actor itself
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterAlignAxis">
+<description>
+Specifies the axis on which #ClutterAlignConstraint should maintain
+the alignment.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ALIGN_X_AXIS">
+<parameter_description> Maintain the alignment on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ALIGN_Y_AXIS">
+<parameter_description> Maintain the alignment on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ALIGN_BOTH">
+<parameter_description> Maintain the alignment on both the X and Y axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterAllocationFlags">
+<description>
+Flags passed to the #ClutterActorClass.allocate() virtual function
+and to the clutter_actor_allocate() function.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ALLOCATION_NONE">
+<parameter_description> No flag set
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ABSOLUTE_ORIGIN_CHANGED">
+<parameter_description> Whether the absolute origin of the
+actor has changed; this implies that any ancestor of the actor has
+been moved.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_DELEGATE_LAYOUT">
+<parameter_description> Whether the allocation should be delegated
+to the #ClutterLayoutManager instance stored inside the
+#ClutterActor:layout-manager property of #ClutterActor. This flag
+should only be used if you are subclassing #ClutterActor and
+overriding the #ClutterActorClass.allocate() virtual function, but
+you wish to use the default implementation of the virtual function
+inside #ClutterActor. Added in Clutter 1.10.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterAnimation::completed">
+<description>
+The ::completed signal is emitted once the animation has
+been completed.
+
+The @animation instance is guaranteed to be valid for the entire
+duration of the signal emission chain.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
+
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> the animation that emitted the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_actor_get_scale_gravity">
+<signal name="ClutterAnimation::started">
<description>
-Retrieves the scale center as a compass direction. If the scale
-center was specified in pixels or units this will return
-%CLUTTER_GRAVITY_NONE.
+The ::started signal is emitted once the animation has been
+started
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="animation">
+<parameter_description> the animation that emitted the signal
</parameter_description>
</parameter>
</parameters>
-<return> the scale gravity
+<return></return>
+</signal>
-</return>
-</function>
+<enum name="ClutterAnimationMode">
+<description>
+The animation modes used by #ClutterAlpha and #ClutterAnimation. This
+enumeration can be expanded in later versions of Clutter.
-<function name="clutter_glx_texture_pixmap_new_with_window">
+<figure id="easing-modes">
+<title>Easing modes provided by Clutter</title>
+<graphic fileref="easing-modes.png" format="PNG"/>
+</figure>
+
+Every global alpha function registered using clutter_alpha_register_func()
+or clutter_alpha_register_closure() will have a logical id greater than
+%CLUTTER_ANIMATION_LAST.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="CLUTTER_CUSTOM_MODE">
+<parameter_description> custom progress function
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_LINEAR">
+<parameter_description> linear tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_QUAD">
+<parameter_description> quadratic tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_QUAD">
+<parameter_description> quadratic tweening, inverse of
+%CLUTTER_EASE_IN_QUAD
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_QUAD">
+<parameter_description> quadratic tweening, combininig
+%CLUTTER_EASE_IN_QUAD and %CLUTTER_EASE_OUT_QUAD
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_CUBIC">
+<parameter_description> cubic tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_CUBIC">
+<parameter_description> cubic tweening, invers of
+%CLUTTER_EASE_IN_CUBIC
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_CUBIC">
+<parameter_description> cubic tweening, combining
+%CLUTTER_EASE_IN_CUBIC and %CLUTTER_EASE_OUT_CUBIC
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_QUART">
+<parameter_description> quartic tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_QUART">
+<parameter_description> quartic tweening, inverse of
+%CLUTTER_EASE_IN_QUART
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_QUART">
+<parameter_description> quartic tweening, combining
+%CLUTTER_EASE_IN_QUART and %CLUTTER_EASE_OUT_QUART
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_QUINT">
+<parameter_description> quintic tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_QUINT">
+<parameter_description> quintic tweening, inverse of
+%CLUTTER_EASE_IN_QUINT
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_QUINT">
+<parameter_description> fifth power tweening, combining
+%CLUTTER_EASE_IN_QUINT and %CLUTTER_EASE_OUT_QUINT
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_SINE">
+<parameter_description> sinusoidal tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_SINE">
+<parameter_description> sinusoidal tweening, inverse of
+%CLUTTER_EASE_IN_SINE
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_SINE">
+<parameter_description> sine wave tweening, combining
+%CLUTTER_EASE_IN_SINE and %CLUTTER_EASE_OUT_SINE
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_EXPO">
+<parameter_description> exponential tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_EXPO">
+<parameter_description> exponential tweening, inverse of
+%CLUTTER_EASE_IN_EXPO
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_EXPO">
+<parameter_description> exponential tweening, combining
+%CLUTTER_EASE_IN_EXPO and %CLUTTER_EASE_OUT_EXPO
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_CIRC">
+<parameter_description> circular tweening
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_CIRC">
+<parameter_description> circular tweening, inverse of
+%CLUTTER_EASE_IN_CIRC
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_CIRC">
+<parameter_description> circular tweening, combining
+%CLUTTER_EASE_IN_CIRC and %CLUTTER_EASE_OUT_CIRC
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_ELASTIC">
+<parameter_description> elastic tweening, with offshoot on start
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_ELASTIC">
+<parameter_description> elastic tweening, with offshoot on end
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_ELASTIC">
+<parameter_description> elastic tweening with offshoot on both ends
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_BACK">
+<parameter_description> overshooting cubic tweening, with
+backtracking on start
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_BACK">
+<parameter_description> overshooting cubic tweening, with
+backtracking on end
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_BACK">
+<parameter_description> overshooting cubic tweening, with
+backtracking on both ends
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_BOUNCE">
+<parameter_description> exponentially decaying parabolic (bounce)
+tweening, with bounce on start
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT_BOUNCE">
+<parameter_description> exponentially decaying parabolic (bounce)
+tweening, with bounce on end
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT_BOUNCE">
+<parameter_description> exponentially decaying parabolic (bounce)
+tweening, with bounce on both ends
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STEPS">
+<parameter_description> parametrized step function; see clutter_timeline_set_step_progress()
+for further details. (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STEP_START">
+<parameter_description> equivalent to %CLUTTER_STEPS with a number of steps
+equal to 1, and a step mode of %CLUTTER_STEP_MODE_START. (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STEP_END">
+<parameter_description> equivalent to %CLUTTER_STEPS with a number of steps
+equal to 1, and a step mode of %CLUTTER_STEP_MODE_END. (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CUBIC_BEZIER">
+<parameter_description> cubic bezier between (0, 0) and (1, 1) with two
+control points; see clutter_timeline_set_cubic_bezier_progress(). (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE">
+<parameter_description> equivalent to %CLUTTER_CUBIC_BEZIER with control points
+in (0.25, 0.1) and (0.25, 1.0). (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN">
+<parameter_description> equivalent to %CLUTTER_CUBIC_BEZIER with control points
+in (0.42, 0) and (1.0, 1.0). (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_OUT">
+<parameter_description> equivalent to %CLUTTER_CUBIC_BEZIER with control points
+in (0, 0) and (0.58, 1.0). (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EASE_IN_OUT">
+<parameter_description> equivalent to %CLUTTER_CUBIC_BEZIER with control points
+in (0.42, 0) and (0.58, 1.0). (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ANIMATION_LAST">
+<parameter_description> last animation mode, used as a guard for
+registered global alpha functions
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterBackend::font-changed">
<description>
-Creates a new #ClutterGLXTexturePixmap for @window
+The ::font-changed signal is emitted each time the font options
+have been changed through #ClutterSettings.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="window">
-<parameter_description> the X window to which this texture should be bound
+<parameter name="backend">
+<parameter_description> the #ClutterBackend that emitted the signal
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterGLXTexturePixmap bound to the given X window
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterBackend::resolution-changed">
+<description>
+The ::resolution-changed signal is emitted each time the font
+resolutions has been changed through #ClutterSettings.
-<function name="clutter_box_layout_set_easing_duration">
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> the #ClutterBackend that emitted the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterBackend::settings-changed">
<description>
-Sets the duration of the animations used by @layout when animating changes
-in the layout properties
+The ::settings-changed signal is emitted each time the #ClutterSettings
+properties have been changed.
-Use clutter_box_layout_set_use_animations() to enable and disable the
-animations
+Since: 1.4
-Since: 1.2
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> the #ClutterBackend that emitted the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterBehaviour::applied">
+<description>
+The ::apply signal is emitted each time the behaviour is applied
+to an actor.
+
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="behaviour">
+<parameter_description> the #ClutterBehaviour that received the signal
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> the duration of the animations, in milliseconds
+<parameter name="actor">
+<parameter_description> the actor the behaviour was applied to.
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="cogl_pango_font_map_clear_glyph_cache">
+<signal name="ClutterBehaviour::removed">
<description>
-Clears the glyph cache for @fm.
+The ::removed signal is emitted each time a behaviour is not applied
+to an actor anymore.
-Since: 1.0
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="fm">
-<parameter_description> a #CoglPangoFontMap
+<parameter name="behaviour">
+<parameter_description> the #ClutterBehaviour that received the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the removed actor
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_animator_property_get_ease_in">
+<signal name="ClutterBehaviourPath::knot-reached">
<description>
-Checks if a property value is to be eased into the animation.
+This signal is emitted each time a node defined inside the path
+is reached.
+
+Since: 0.2
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="pathb">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="knot_num">
+<parameter_description> the index of the #ClutterKnot reached
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterBinAlignment">
+<description>
+The alignment policies available on each axis for #ClutterBinLayout
Since: 1.2
+Deprecated: 1.12: Use #ClutterActorAlign and the #ClutterActor
+API instead
+
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="CLUTTER_BIN_ALIGNMENT_FIXED">
+<parameter_description> Fixed position alignment; the
+#ClutterBinLayout will honour the fixed position provided
+by the actors themselves when allocating them
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+<parameter name="CLUTTER_BIN_ALIGNMENT_FILL">
+<parameter_description> Fill the allocation size
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of a property on object
+<parameter name="CLUTTER_BIN_ALIGNMENT_START">
+<parameter_description> Position the actors at the top
+or left side of the container, depending on the axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIN_ALIGNMENT_END">
+<parameter_description> Position the actors at the bottom
+or right side of the container, depending on the axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIN_ALIGNMENT_CENTER">
+<parameter_description> Position the actors at the
+center of the container, depending on the axis
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the property is eased in
+</enum>
+
+<enum name="ClutterBindCoordinate">
+<description>
+Specifies which property should be used in a binding
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_BIND_X">
+<parameter_description> Bind the X coordinate
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_Y">
+<parameter_description> Bind the Y coordinate
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_WIDTH">
+<parameter_description> Bind the width
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_HEIGHT">
+<parameter_description> Bind the height
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_POSITION">
+<parameter_description> Equivalent to to %CLUTTER_BIND_X and
+%CLUTTER_BIND_Y (added in Clutter 1.6)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_SIZE">
+<parameter_description> Equivalent to %CLUTTER_BIND_WIDTH and
+%CLUTTER_BIND_HEIGHT (added in Clutter 1.6)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BIND_ALL">
+<parameter_description> Equivalent to %CLUTTER_BIND_POSITION and
+%CLUTTER_BIND_SIZE (added in Clutter 1.10)
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterBoxAlignment">
+<description>
+The alignment policies available on each axis of the #ClutterBoxLayout
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_BOX_ALIGNMENT_START">
+<parameter_description> Align the child to the top or to
+to the left, depending on the used axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BOX_ALIGNMENT_CENTER">
+<parameter_description> Align the child to the center
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BOX_ALIGNMENT_END">
+<parameter_description> Align the child to the bottom or to
+the right, depending on the used axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterCairoTexture::create-surface">
+<description>
+The ::create-surface signal is emitted when a #ClutterCairoTexture
+news its surface (re)created, which happens either when the Cairo
+context is created with clutter_cairo_texture_create() or
+clutter_cairo_texture_create_region(), or when the surface is resized
+through clutter_cairo_texture_set_surface_size().
+
+The first signal handler that returns a non-%NULL, valid surface will
+stop any further signal emission, and the returned surface will be
+the one used.
+
+Since: 1.6
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> the #ClutterCairoTexture that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the surface to create
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the surface to create
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #cairo_surface_t for the texture
</return>
-</function>
+</signal>
-<function name="clutter_animator_key_get_value">
+<signal name="ClutterCairoTexture::draw">
<description>
-Retrieves a copy of the value for a #ClutterAnimatorKey.
+The ::draw signal is emitted each time a #ClutterCairoTexture has
+been invalidated.
-The passed in #GValue needs to be already initialized for the value
-type of the key or to a type that allow transformation from the value
-type of the key.
+The passed Cairo context passed will be clipped to the invalidated
+area.
-Use g_value_unset() when done.
+It is safe to connect multiple callbacks to this signals; the state
+of the Cairo context passed to each callback is automatically saved
+and restored, so it's not necessary to call cairo_save() and
+cairo_restore().
-Since: 1.2
+Since: 1.8
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="texture">
+<parameter_description> the #ClutterCairoTexture that emitted the signal
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue initialized with the correct type for the animator key
+<parameter name="cr">
+<parameter_description> the Cairo context to use to draw
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the passed #GValue was successfully set, and
-%FALSE otherwise
+<return> %TRUE if the signal emission should stop, and %FALSE
+to continue
</return>
-</function>
+</signal>
-<function name="clutter_event_get_flags">
+<signal name="ClutterCanvas::draw">
<description>
-Retrieves the #ClutterEventFlags of @event
+The #ClutterCanvas::draw signal is emitted each time a canvas is
+invalidated.
-Since: 1.0
+It is safe to connect multiple handlers to this signal: each
+handler invocation will be automatically protected by cairo_save()
+and cairo_restore() pairs.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="canvas">
+<parameter_description> the #ClutterCanvas that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="cr">
+<parameter_description> the Cairo context used to draw
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the @canvas
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the @canvas
</parameter_description>
</parameter>
</parameters>
-<return> the event flags
+<return> %TRUE if the signal emission should stop, and
+%FALSE otherwise
</return>
-</function>
+</signal>
-<function name="json_parser_load_from_data">
+<enum name="ClutterCex100BufferingMode">
<description>
-Loads a JSON stream from a buffer and parses it. You can call this function
-multiple times with the same #JsonParser object, but the contents of the
-parser will be destroyed each time.
+Enum passed to clutter_cex100_set_buffering_mode().
+Since: 1.6
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #JsonParser
+<parameter name="CLUTTER_CEX100_DOUBLE_BUFFERING">
+<parameter_description> The GDL plane will be double buffered
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the buffer to parse
+<parameter name="CLUTTER_CEX100_TRIPLE_BUFFERING">
+<parameter_description> The GDL plane will be triple buffered
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of the buffer, or -1
+</parameters>
+</enum>
+
+<signal name="ClutterClickAction::clicked">
+<description>
+The ::clicked signal is emitted when the #ClutterActor to which
+a #ClutterClickAction has been applied should respond to a
+pointer button press and release events
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterClickAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the buffer was succesfully parser. In case
-of error, @error is set accordingly and %FALSE is returned
+<return></return>
+</signal>
+
+<signal name="ClutterClickAction::long-press">
+<description>
+The ::long-press signal is emitted during the long press gesture
+handling.
+
+This signal can be emitted multiple times with different states.
+
+The %CLUTTER_LONG_PRESS_QUERY state will be emitted on button presses,
+and its return value will determine whether the long press handling
+should be initiated. If the signal handlers will return %TRUE, the
+%CLUTTER_LONG_PRESS_QUERY state will be followed either by a signal
+emission with the %CLUTTER_LONG_PRESS_ACTIVATE state if the long press
+constraints were respected, or by a signal emission with the
+%CLUTTER_LONG_PRESS_CANCEL state if the long press was cancelled.
+
+It is possible to forcibly cancel a long press detection using
+clutter_click_action_release().
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterClickAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> the long press state
+</parameter_description>
+</parameter>
+</parameters>
+<return> Only the %CLUTTER_LONG_PRESS_QUERY state uses the
+returned value of the handler; other states will ignore it
+
</return>
-</function>
+</signal>
-<function name="clutter_container_get_children">
+<signal name="ClutterContainer::actor-added">
<description>
-Retrieves all the children of @container.
+The ::actor-added signal is emitted each time an actor
+has been added to @container.
Since: 0.4
</description>
<parameters>
<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter_description> the actor which received the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the new child that has been added to @container
</parameter_description>
</parameter>
</parameters>
-<return> a list
-of #ClutterActor<!-- -->s. Use g_list_free() on the returned
-list when done.
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterContainer::actor-removed">
+<description>
+The ::actor-removed signal is emitted each time an actor
+is removed from @container.
-<function name="clutter_stage_get_use_fog">
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> the actor which received the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the child that has been removed from @container
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterContainer::child-notify">
<description>
-Gets whether the depth cueing effect is enabled on @stage.
+The ::child-notify signal is emitted each time a property is
+being set through the clutter_container_child_set() and
+clutter_container_child_set_property() calls.
-Since: 0.6
+Since: 0.8
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="container">
+<parameter_description> the container which received the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the child that has had a property set
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec of the property set
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the the depth cueing effect is enabled
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterContent::attached">
+<description>
+This signal is emitted each time a #ClutterContent implementation is
+assigned to a #ClutterActor.
-<function name="clutter_flow_layout_set_homogeneous">
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="content">
+<parameter_description> the object that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterContent::detached">
<description>
-Sets whether the @layout should allocate the same space for
-each child
+This signal is emitted each time a #ClutterContent implementation is
+removed from a #ClutterActor.
-Since: 1.2
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="content">
+<parameter_description> the object that emitted the signal
</parameter_description>
</parameter>
-<parameter name="homogeneous">
-<parameter_description> whether the layout should be homogeneous or not
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_layout_manager_find_child_property">
+<enum name="ClutterContentGravity">
<description>
-Retrieves the #GParamSpec for the layout property @name inside
-the #ClutterLayoutMeta sub-class used by @manager
+Controls the alignment of the #ClutterContent inside a #ClutterActor.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="CLUTTER_CONTENT_GRAVITY_TOP_LEFT">
+<parameter_description> Align the content to the top left corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_TOP">
+<parameter_description> Align the content to the top edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_TOP_RIGHT">
+<parameter_description> Align the content to the top right corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_LEFT">
+<parameter_description> Align the content to the left edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_CENTER">
+<parameter_description> Align the content to the center
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_RIGHT">
+<parameter_description> Align the content to the right edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_BOTTOM_LEFT">
+<parameter_description> Align the content to the bottom left corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_BOTTOM">
+<parameter_description> Align the content to the bottom edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_BOTTOM_RIGHT">
+<parameter_description> Align the content to the bottom right corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_RESIZE_FILL">
+<parameter_description> Resize the content to fill the allocation
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CONTENT_GRAVITY_RESIZE_ASPECT">
+<parameter_description> Resize the content to remain within the
+allocation, while maintaining the aspect ratio
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterContentRepeat">
+<description>
+Content repeat modes.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="CLUTTER_REPEAT_NONE">
+<parameter_description> No repeat
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REPEAT_X_AXIS">
+<parameter_description> Repeat the content on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REPEAT_Y_AXIS">
+<parameter_description> Repeat the content on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REPEAT_BOTH">
+<parameter_description> Repeat the content on both axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterDeviceManager::device-added">
+<description>
+The ::device-added signal is emitted each time a device has been
+added to the #ClutterDeviceManager
Since: 1.2
</description>
<parameters>
<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter_description> the #ClutterDeviceManager that emitted the signal
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the property
+<parameter name="device">
+<parameter_description> the newly added #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return> a #GParamSpec describing the property,
-or %NULL if no property with that name exists. The returned
-#GParamSpec is owned by the layout manager and should not be
-modified or freed
-
-</return>
-</function>
+<return></return>
+</signal>
-<function name="clutter_box_layout_get_spacing">
+<signal name="ClutterDeviceManager::device-removed">
<description>
-Retrieves the spacing set using clutter_box_layout_set_spacing()
+The ::device-removed signal is emitted each time a device has been
+removed from the #ClutterDeviceManager
Since: 1.2
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="manager">
+<parameter_description> the #ClutterDeviceManager that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="device">
+<parameter_description> the removed #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return> the spacing between children of the #ClutterBoxLayout
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterDragAction::drag-begin">
+<description>
+The ::drag-begin signal is emitted when the #ClutterDragAction
+starts the dragging
-<function name="clutter_value_set_fixed">
+The emission of this signal can be delayed by using the
+#ClutterDragAction:x-drag-threshold and
+#ClutterDragAction:y-drag-threshold properties
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterDragAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the action
+</parameter_description>
+</parameter>
+<parameter name="event_x">
+<parameter_description> the X coordinate (in stage space) of the press event
+</parameter_description>
+</parameter>
+<parameter name="event_y">
+<parameter_description> the Y coordinate (in stage space) of the press event
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> the modifiers of the press event
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterDragAction::drag-end">
<description>
-Sets @value to @fixed_.
+The ::drag-end signal is emitted at the end of the dragging,
+when the pointer button's is released
-Since: 0.8
+This signal is emitted if and only if the #ClutterDragAction::drag-begin
+signal has been emitted first
+
+Since: 1.4
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue initialized to %COGL_TYPE_FIXED
+<parameter name="action">
+<parameter_description> the #ClutterDragAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="fixed_">
-<parameter_description> the fixed point value to set
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the action
+</parameter_description>
+</parameter>
+<parameter name="event_x">
+<parameter_description> the X coordinate (in stage space) of the release event
+</parameter_description>
+</parameter>
+<parameter name="event_y">
+<parameter_description> the Y coordinate (in stage space) of the release event
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> the modifiers of the release event
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_path_replace_node">
+<signal name="ClutterDragAction::drag-motion">
<description>
-Replaces the node at offset @index_ with @node.
+The ::drag-motion signal is emitted for each motion event after
+the #ClutterDragAction::drag-begin signal has been emitted.
-Since: 1.0
+The components of the distance between the press event and the
+latest motion event are computed in the actor's coordinate space,
+to take into account eventual transformations. If you want the
+stage coordinates of the latest motion event you can use
+clutter_drag_action_get_motion_coords().
+
+The default handler of the signal will call clutter_actor_move_by()
+either on @actor or, if set, of #ClutterDragAction:drag-handle using
+the @delta_x and @delta_y components of the dragging motion. If you
+want to override the default behaviour, you can connect to the
+#ClutterDragAction::drag-progress signal and return %FALSE from the
+handler.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="action">
+<parameter_description> the #ClutterDragAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> index to the existing node
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the action
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the replacement node
+<parameter name="delta_x">
+<parameter_description> the X component of the distance between the press event
+that began the dragging and the current position of the pointer,
+as of the latest motion event
+</parameter_description>
+</parameter>
+<parameter name="delta_y">
+<parameter_description> the Y component of the distance between the press event
+that began the dragging and the current position of the pointer,
+as of the latest motion event
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_clone_new">
+<signal name="ClutterDragAction::drag-progress">
<description>
-Creates a new #ClutterActor which clones @source/
+The ::drag-progress signal is emitted for each motion event after
+the #ClutterDragAction::drag-begin signal has been emitted.
-Since: 1.0
+The components of the distance between the press event and the
+latest motion event are computed in the actor's coordinate space,
+to take into account eventual transformations. If you want the
+stage coordinates of the latest motion event you can use
+clutter_drag_action_get_motion_coords().
+
+The default handler will emit #ClutterDragAction::drag-motion,
+if #ClutterDragAction::drag-progress emission returns %TRUE.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #ClutterActor, or %NULL
+<parameter name="action">
+<parameter_description> the #ClutterDragAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the action
+</parameter_description>
+</parameter>
+<parameter name="delta_x">
+<parameter_description> the X component of the distance between the press event
+that began the dragging and the current position of the pointer,
+as of the latest motion event
+</parameter_description>
+</parameter>
+<parameter name="delta_y">
+<parameter_description> the Y component of the distance between the press event
+that began the dragging and the current position of the pointer,
+as of the latest motion event
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterClone
+<return> %TRUE if the drag should continue, and %FALSE
+if it should be stopped.
</return>
-</function>
+</signal>
-<function name="clutter_container_child_get_property">
+<enum name="ClutterDragAxis">
<description>
-Gets a container specific property of a child of @container, In general,
-a copy is made of the property contents and the caller is responsible for
-freeing the memory by calling g_value_unset().
+The axis of the constraint that should be applied on the
+dragging action
-Note that clutter_container_child_set_property() is really intended for
-language bindings, clutter_container_child_set() is much more convenient
-for C programming.
+Since: 1.4
-Since: 0.8
+</description>
+<parameters>
+<parameter name="CLUTTER_DRAG_AXIS_NONE">
+<parameter_description> No constraint
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_DRAG_X_AXIS">
+<parameter_description> Set a constraint on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_DRAG_Y_AXIS">
+<parameter_description> Set a constraint on the Y axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterDropAction::can-drop">
+<description>
+The ::can-drop signal is emitted when the dragged actor is dropped
+on @actor. The return value of the ::can-drop signal will determine
+whether or not the #ClutterDropAction::drop signal is going to be
+emitted on @action.
+
+The default implementation of #ClutterDropAction returns %TRUE for
+this signal.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="action">
+<parameter_description> the #ClutterDropAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #ClutterActor that is a child of @container.
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
-<parameter name="property">
-<parameter_description> the name of the property to set.
+<parameter name="event_x">
+<parameter_description> the X coordinate (in stage space) of the drop event
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value.
+<parameter name="event_y">
+<parameter_description> the Y coordinate (in stage space) of the drop event
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the drop is accepted, and %FALSE otherwise
+
+</return>
+</signal>
+
+<signal name="ClutterDropAction::drop">
+<description>
+The ::drop signal is emitted when the dragged actor is dropped
+on @actor. This signal is only emitted if at least an handler of
+#ClutterDropAction::can-drop returns %TRUE.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterDropAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="event_x">
+<parameter_description> the X coordinate (in stage space) of the drop event
+</parameter_description>
+</parameter>
+<parameter name="event_y">
+<parameter_description> the Y coordinate (in stage space) of the drop event
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_path_new">
+<signal name="ClutterDropAction::drop-cancel">
<description>
-Creates a new #ClutterPath instance with no nodes.
+The ::drop-cancel signal is emitted when the drop is refused
+by an emission of the #ClutterDropAction::can-drop signal.
-The object has a floating reference so if you add it to a
-#ClutterBehaviourPath then you do not need to unref it.
+After the ::drop-cancel signal is fired the active drag is
+terminated.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterDropAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="event_x">
+<parameter_description> the X coordinate (in stage space) of the drop event
+</parameter_description>
+</parameter>
+<parameter name="event_y">
+<parameter_description> the Y coordinate (in stage space) of the drop event
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterPath
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterDropAction::over-in">
+<description>
+The ::over-in signal is emitted when the dragged actor crosses
+into @actor.
-<function name="clutter_get_keyboard_grab">
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterDropAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterDropAction::over-out">
<description>
-Queries the current keyboard grab of clutter.
+The ::over-out signal is emitted when the dragged actor crosses
+outside @actor.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterDropAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterEffectPaintFlags">
+<description>
+Flags passed to the ‘paint’ or ‘pick’ method of #ClutterEffect.
+
+</description>
+<parameters>
+<parameter name="CLUTTER_EFFECT_PAINT_ACTOR_DIRTY">
+<parameter_description> The actor or one of its children
+has queued a redraw before this paint. This implies that the effect
+should call clutter_actor_continue_paint() to chain to the next
+effect and can not cache any results from a previous paint.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterEventFlags">
+<description>
+Flags for the #ClutterEvent
Since: 0.6
</description>
<parameters>
+<parameter name="CLUTTER_EVENT_NONE">
+<parameter_description> No flag set
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EVENT_FLAG_SYNTHETIC">
+<parameter_description> Synthetic event
+</parameter_description>
+</parameter>
</parameters>
-<return> the actor currently holding the keyboard grab, or NULL if there is no grab.
+</enum>
-</return>
-</function>
+<enum name="ClutterEventType">
+<description>
+Types of events.
-<function name="clutter_timeout_pool_new">
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_NOTHING">
+<parameter_description> Empty event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_KEY_PRESS">
+<parameter_description> Key press event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_KEY_RELEASE">
+<parameter_description> Key release event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOTION">
+<parameter_description> Pointer motion event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ENTER">
+<parameter_description> Actor enter event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_LEAVE">
+<parameter_description> Actor leave event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON_PRESS">
+<parameter_description> Pointer button press event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON_RELEASE">
+<parameter_description> Pointer button release event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL">
+<parameter_description> Pointer scroll event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STAGE_STATE">
+<parameter_description> Stage state change event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_DESTROY_NOTIFY">
+<parameter_description> Destroy notification event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CLIENT_MESSAGE">
+<parameter_description> Client message event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_DELETE">
+<parameter_description> Stage delete event
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCH_BEGIN">
+<parameter_description> A new touch event sequence has started;
+event added in 1.10
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCH_UPDATE">
+<parameter_description> A touch event sequence has been updated;
+event added in 1.10
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCH_END">
+<parameter_description> A touch event sequence has finished;
+event added in 1.10
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCH_CANCEL">
+<parameter_description> A touch event sequence has been canceled;
+event added in 1.10
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EVENT_LAST">
+<parameter_description> Marks the end of the #ClutterEventType enumeration;
+added in 1.10
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterFeatureFlags">
<description>
-Creates a new timeout pool source. A timeout pool should be used when
-multiple timeout functions, running at the same priority, are needed and
-the g_timeout_add() API might lead to starvation of the time slice of
-the main loop. A timeout pool allocates a single time slice of the main
-loop and runs every timeout function inside it. The timeout pool is
-always sorted, so that the extraction of the next timeout function is
-a constant time operation.
+Runtime flags indicating specific features available via Clutter window
+sysytem and graphics backend.
Since: 0.4
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the timeout pool. Typically this will
-be #G_PRIORITY_DEFAULT
+<parameter name="CLUTTER_FEATURE_TEXTURE_NPOT">
+<parameter_description> Set if NPOTS textures supported.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_SYNC_TO_VBLANK">
+<parameter_description> Set if vblank syncing supported.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_TEXTURE_YUV">
+<parameter_description> Set if YUV based textures supported.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_TEXTURE_READ_PIXELS">
+<parameter_description> Set if texture pixels can be read.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_STAGE_STATIC">
+<parameter_description> Set if stage size if fixed (i.e framebuffer)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_STAGE_USER_RESIZE">
+<parameter_description> Set if stage is able to be user resized.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_STAGE_CURSOR">
+<parameter_description> Set if stage has a graphical cursor.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_SHADERS_GLSL">
+<parameter_description> Set if the backend supports GLSL shaders.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_OFFSCREEN">
+<parameter_description> Set if the backend supports offscreen rendering.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_STAGE_MULTIPLE">
+<parameter_description> Set if multiple stages are supported.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FEATURE_SWAP_EVENTS">
+<parameter_description> Set if the GLX_INTEL_swap_event is supported.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterTimeoutPool. The created pool
-is owned by the GLib default context and will be automatically
-destroyed when the context is destroyed. It is possible to force
-the destruction of the timeout pool using g_source_destroy()
+</enum>
-</return>
-</function>
+<enum name="ClutterFlowOrientation">
+<description>
+The direction of the arrangement of the children inside
+a #ClutterFlowLayout
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_FLOW_HORIZONTAL">
+<parameter_description> Arrange the children of the flow layout
+horizontally first
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FLOW_VERTICAL">
+<parameter_description> Arrange the children of the flow layout
+vertically first
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
-<function name="json_object_get_values">
+<enum name="ClutterFontFlags">
<description>
-Retrieves all the values of the members of a #JsonObject.
+Runtime flags to change the font quality. To be used with
+clutter_set_font_flags().
+Since: 1.0
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="CLUTTER_FONT_MIPMAPPING">
+<parameter_description> Set to use mipmaps for the glyph cache textures.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_FONT_HINTING">
+<parameter_description> Set to enable hinting on the glyphs.
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of #JsonNode<!-- -->s. The content of the
-list is owned by the #JsonObject and should never be modified
-or freed. When you have finished using the returned list, use
-g_list_free() to free the resources it has allocated.
+</enum>
+
+<signal name="ClutterGestureAction::gesture-begin">
+<description>
+The ::gesture_begin signal is emitted when the #ClutterActor to which
+a #ClutterGestureAction has been applied starts receiving a gesture.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterGestureAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the gesture should start, and %FALSE if
+the gesture should be ignored.
+
</return>
-</function>
+</signal>
-<function name="clutter_texture_set_filter_quality">
+<signal name="ClutterGestureAction::gesture-cancel">
<description>
-Sets the filter quality when scaling a texture. The quality is an
-enumeration currently the following values are supported:
-%CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour
-interpolation. %CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a
-bit more expensive (bilinear interpolation), and
-%CLUTTER_TEXTURE_QUALITY_HIGH which uses extra texture memory resources to
-improve scaled down rendering as well (by using mipmaps). The default value
-is %CLUTTER_TEXTURE_QUALITY_MEDIUM.
+The ::gesture-cancel signal is emitted when the ongoing gesture gets
+cancelled from the #ClutterGestureAction::gesture-progress signal handler.
-Since: 0.8
+This signal is emitted if and only if the #ClutterGestureAction::gesture-begin
+signal has been emitted first.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="action">
+<parameter_description> the #ClutterGestureAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="filter_quality">
-<parameter_description> new filter quality value
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_x11_get_visual_info">
+<signal name="ClutterGestureAction::gesture-end">
<description>
-Retrieves the <structname>XVisualInfo</structname> used by the Clutter X11
-backend.
+The ::gesture-end signal is emitted at the end of the gesture gesture,
+when the pointer's button is released
-Since: 1.2
+This signal is emitted if and only if the #ClutterGestureAction::gesture-begin
+signal has been emitted first.
+
+Since: 1.8
</description>
<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterGestureAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
</parameters>
-<return> a <structname>XVisualInfo</structname>, or
-<varname>None</varname>. The returned value should be freed using XFree()
-when done
+<return></return>
+</signal>
+
+<signal name="ClutterGestureAction::gesture-progress">
+<description>
+The ::gesture-progress signal is emitted for each motion event after
+the #ClutterGestureAction::gesture-begin signal has been emitted.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterGestureAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the gesture should continue, and %FALSE if
+the gesture should be cancelled.
</return>
-</function>
+</signal>
-<function name="clutter_input_device_get_device_type">
+<enum name="ClutterGestureTriggerEdge">
<description>
-Retrieves the type of @device
+Enum passed to the clutter_gesture_action_set_threshold_trigger_edge()
+function.
-Since: 1.0
+Since: 1.18
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice
+<parameter name="CLUTTER_GESTURE_TRIGGER_EDGE_NONE">
+<parameter_description> Tell #ClutterGestureAction that
+the gesture must begin immediately and there's no drag limit that
+will cause its cancellation;
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GESTURE_TRIGGER_EDGE_AFTER">
+<parameter_description> Tell #ClutterGestureAction that
+it needs to wait until the drag threshold has been exceeded before
+considering that the gesture has begun;
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GESTURE_TRIGGER_EDGE_BEFORE">
+<parameter_description> Tell #ClutterGestureAction that
+the gesture must begin immediately and that it must be cancelled
+once the drag exceed the configured threshold.
</parameter_description>
</parameter>
</parameters>
-<return> the type of the device
+</enum>
-</return>
-</function>
+<enum name="ClutterGravity">
+<description>
+Gravity of the scaling operations. When a gravity different than
+%CLUTTER_GRAVITY_NONE is used, an actor is scaled keeping the position
+of the specified portion at the same coordinates.
-<function name="clutter_behaviour_ellipse_get_height">
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_GRAVITY_NONE">
+<parameter_description> Do not apply any gravity
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_NORTH">
+<parameter_description> Scale from topmost downwards
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_NORTH_EAST">
+<parameter_description> Scale from the top right corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_EAST">
+<parameter_description> Scale from the right side
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_SOUTH_EAST">
+<parameter_description> Scale from the bottom right corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_SOUTH">
+<parameter_description> Scale from the bottom upwards
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_SOUTH_WEST">
+<parameter_description> Scale from the bottom left corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_WEST">
+<parameter_description> Scale from the left side
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_NORTH_WEST">
+<parameter_description> Scale from the top left corner
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRAVITY_CENTER">
+<parameter_description> Scale from the center.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterGridPosition">
<description>
-Gets the height of the elliptical path.
+Grid position modes.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="CLUTTER_GRID_POSITION_LEFT">
+<parameter_description> left position
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRID_POSITION_RIGHT">
+<parameter_description> right position
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRID_POSITION_TOP">
+<parameter_description> top position
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_GRID_POSITION_BOTTOM">
+<parameter_description> bottom position
</parameter_description>
</parameter>
</parameters>
-<return> the height of the path
+</enum>
-</return>
-</function>
+<enum name="ClutterImageError">
+<description>
+Error enumeration for #ClutterImage.
-<function name="clutter_actor_box_get_x">
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="CLUTTER_IMAGE_ERROR_INVALID_DATA">
+<parameter_description> Invalid data passed to the
+clutter_image_set_data() function.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterInitError">
<description>
-Retrieves the X coordinate of the origin of @box
+Error conditions returned by clutter_init() and clutter_init_with_args().
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_INIT_SUCCESS">
+<parameter_description> Initialisation successful
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INIT_ERROR_UNKNOWN">
+<parameter_description> Unknown error
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INIT_ERROR_THREADS">
+<parameter_description> Thread initialisation failed
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INIT_ERROR_BACKEND">
+<parameter_description> Backend initialisation failed
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INIT_ERROR_INTERNAL">
+<parameter_description> Internal error
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterInputAxis">
+<description>
+The type of axes Clutter recognizes on a #ClutterInputDevice
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="CLUTTER_INPUT_AXIS_IGNORE">
+<parameter_description> Unused axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_X">
+<parameter_description> The position on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_Y">
+<parameter_description> The position of the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_PRESSURE">
+<parameter_description> The pressure information
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_XTILT">
+<parameter_description> The tilt on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_YTILT">
+<parameter_description> The tile on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_WHEEL">
+<parameter_description> A wheel
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_DISTANCE">
+<parameter_description> Distance (Since 1.12)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_AXIS_LAST">
+<parameter_description> Last value of the enumeration; this value is
+useful when iterating over the enumeration values (Since 1.12)
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterInputDeviceType">
+<description>
+The types of input devices available.
+
+The #ClutterInputDeviceType enumeration can be extended at later
+date; not every platform supports every input device type.
Since: 1.0
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="CLUTTER_POINTER_DEVICE">
+<parameter_description> A pointer device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_KEYBOARD_DEVICE">
+<parameter_description> A keyboard device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_EXTENSION_DEVICE">
+<parameter_description> A generic extension device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_JOYSTICK_DEVICE">
+<parameter_description> A joystick device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TABLET_DEVICE">
+<parameter_description> A tablet device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCHPAD_DEVICE">
+<parameter_description> A touchpad device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TOUCHSCREEN_DEVICE">
+<parameter_description> A touch screen device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PEN_DEVICE">
+<parameter_description> A pen device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ERASER_DEVICE">
+<parameter_description> An eraser device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_CURSOR_DEVICE">
+<parameter_description> A cursor device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_N_DEVICE_TYPES">
+<parameter_description> The number of device types
</parameter_description>
</parameter>
</parameters>
-<return> the X coordinate of the origin
+</enum>
-</return>
-</function>
+<enum name="ClutterInputMode">
+<description>
+The mode for input devices available.
-<function name="clutter_alpha_new">
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="CLUTTER_INPUT_MODE_MASTER">
+<parameter_description> A master, virtual device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_MODE_SLAVE">
+<parameter_description> A slave, physical device, attached to
+a master device
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INPUT_MODE_FLOATING">
+<parameter_description> A slave, physical device, not attached
+to a master device
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterInterpolation">
<description>
-Creates a new #ClutterAlpha instance. You must set a function
-to compute the alpha value using clutter_alpha_set_func() and
-bind a #ClutterTimeline object to the #ClutterAlpha instance
-using clutter_alpha_set_timeline().
+The mode of interpolation between key frames
-You should use the newly created #ClutterAlpha instance inside
-a #ClutterBehaviour object.
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_INTERPOLATION_LINEAR">
+<parameter_description> linear interpolation
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_INTERPOLATION_CUBIC">
+<parameter_description> cubic interpolation
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterLayoutManager::layout-changed">
+<description>
+The ::layout-changed signal is emitted each time a layout manager
+has been changed. Every #ClutterActor using the @manager instance
+as a layout manager should connect a handler to the ::layout-changed
+signal and queue a relayout on themselves:
+
+|[
+static void layout_changed (ClutterLayoutManager *manager,
+ClutterActor *self)
+{
+clutter_actor_queue_relayout (self);
+}
+...
+self->manager = g_object_ref_sink (manager);
+g_signal_connect (self->manager, "layout-changed",
+G_CALLBACK (layout_changed),
+self);
+]|
+
+Sub-classes of #ClutterLayoutManager that implement a layout that
+can be controlled or changed using parameters should emit the
+::layout-changed signal whenever one of the parameters changes,
+by using clutter_layout_manager_layout_changed().
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> the #ClutterLayoutManager that emitted the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterLongPressState">
+<description>
+The states for the #ClutterClickAction::long-press signal.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="CLUTTER_LONG_PRESS_QUERY">
+<parameter_description> Queries the action whether it supports
+long presses
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_LONG_PRESS_ACTIVATE">
+<parameter_description> Activates the action on a long press
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_LONG_PRESS_CANCEL">
+<parameter_description> The long press was cancelled
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterMedia::eos">
+<description>
+The ::eos signal is emitted each time the media stream ends.
Since: 0.2
+Deprecated: 1.12
+
</description>
<parameters>
+<parameter name="media">
+<parameter_description> the #ClutterMedia instance that received the signal
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created empty #ClutterAlpha instance.
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterMedia::error">
+<description>
+The ::error signal is emitted each time an error occurred.
-<function name="clutter_threads_add_repaint_func">
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> the #ClutterMedia instance that received the signal
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> the #GError
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterModel::filter-changed">
<description>
-Adds a function to be called whenever Clutter is repainting a Stage.
-If the function returns %FALSE it is automatically removed from the
-list of repaint functions and will not be called again.
+The ::filter-changed signal is emitted when a new filter has been applied
-This function is guaranteed to be called from within the same thread
-that called clutter_main(), and while the Clutter lock is being held.
+Since: 0.6
-A repaint function is useful to ensure that an update of the scenegraph
-is performed before the scenegraph is repainted; for instance, uploading
-a frame from a video into a #ClutterTexture.
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> the #ClutterModel on which the signal is emitted
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
-When the repaint function is removed (either because it returned %FALSE
-or because clutter_threads_remove_repaint_func() has been called) the
- notify function will be called, if any is set.
+<signal name="ClutterModel::row-added">
+<description>
+The ::row-added signal is emitted when a new row has been added.
+The data on the row has already been set when the ::row-added signal
+has been emitted.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="func">
-<parameter_description> the function to be called within the paint cycle
+<parameter name="model">
+<parameter_description> the #ClutterModel on which the signal is emitted
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to be passed to the function, or %NULL
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter pointing to the new row
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to be called when removing the repaint
-function, or %NULL
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterModel::row-changed">
+<description>
+The ::row-removed signal is emitted when a row has been changed.
+The data on the row has already been updated when the ::row-changed
+signal has been emitted.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> the #ClutterModel on which the signal is emitted
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter pointing to the changed row
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the repaint function. You
-can use the returned integer to remove the repaint function by
-calling clutter_threads_remove_repaint_func().
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterModel::row-removed">
+<description>
+The ::row-removed signal is emitted when a row has been removed.
+The data on the row pointed by the passed iterator is still valid
+when the ::row-removed signal has been emitted.
-<function name="clutter_check_version">
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> the #ClutterModel on which the signal is emitted
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter pointing to the removed row
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterModel::sort-changed">
<description>
-Run-time version check, to check the version the Clutter library
-that an application is currently linked against
+The ::sort-changed signal is emitted after the model has been sorted
-This is the run-time equivalent of the compile-time %CLUTTER_CHECK_VERSION
-pre-processor macro
+Since: 0.6
-Since: 1.2
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> the #ClutterModel on which the signal is emitted
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterModifierType">
+<description>
+Masks applied to a #ClutterEvent by modifiers.
+
+Note that Clutter may add internal values to events which include
+reserved values such as %CLUTTER_MODIFIER_RESERVED_13_MASK. Your code
+should preserve and ignore them. You can use %CLUTTER_MODIFIER_MASK to
+remove all reserved values.
+
+Since: 0.4
</description>
<parameters>
-<parameter name="major">
-<parameter_description> major version, like 1 in 1.2.3
+<parameter name="CLUTTER_SHIFT_MASK">
+<parameter_description> Mask applied by the Shift key
</parameter_description>
</parameter>
-<parameter name="minor">
-<parameter_description> minor version, like 2 in 1.2.3
+<parameter name="CLUTTER_LOCK_MASK">
+<parameter_description> Mask applied by the Caps Lock key
</parameter_description>
</parameter>
-<parameter name="micro">
-<parameter_description> micro version, like 3 in 1.2.3
+<parameter name="CLUTTER_CONTROL_MASK">
+<parameter_description> Mask applied by the Control key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOD1_MASK">
+<parameter_description> Mask applied by the first Mod key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOD2_MASK">
+<parameter_description> Mask applied by the second Mod key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOD3_MASK">
+<parameter_description> Mask applied by the third Mod key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOD4_MASK">
+<parameter_description> Mask applied by the fourth Mod key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MOD5_MASK">
+<parameter_description> Mask applied by the fifth Mod key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON1_MASK">
+<parameter_description> Mask applied by the first pointer button
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON2_MASK">
+<parameter_description> Mask applied by the second pointer button
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON3_MASK">
+<parameter_description> Mask applied by the third pointer button
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON4_MASK">
+<parameter_description> Mask applied by the fourth pointer button
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_BUTTON5_MASK">
+<parameter_description> Mask applied by the fifth pointer button
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SUPER_MASK">
+<parameter_description> Mask applied by the Super key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_HYPER_MASK">
+<parameter_description> Mask applied by the Hyper key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_META_MASK">
+<parameter_description> Mask applied by the Meta key
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_RELEASE_MASK">
+<parameter_description> Mask applied during release
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_MODIFIER_MASK">
+<parameter_description> A mask covering all modifier types
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the version of the Clutter library is
-greater than (@major, @minor, @micro), and %FALSE otherwise
+</enum>
+
+<enum name="ClutterOffscreenRedirect">
+<description>
+Possible flags to pass to clutter_actor_set_offscreen_redirect().
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="CLUTTER_OFFSCREEN_REDIRECT_AUTOMATIC_FOR_OPACITY">
+<parameter_description> Only redirect
+the actor if it is semi-transparent and its has_overlaps()
+virtual returns %TRUE. This is the default.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_OFFSCREEN_REDIRECT_ALWAYS">
+<parameter_description> Always redirect the actor to an
+offscreen buffer even if it is fully opaque.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterOrientation">
+<description>
+Represents the orientation of actors or layout managers.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ORIENTATION_HORIZONTAL">
+<parameter_description> An horizontal orientation
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ORIENTATION_VERTICAL">
+<parameter_description> A vertical orientation
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterPanAction::pan">
+<description>
+The ::pan signal is emitted to keep track of the motion during
+a pan gesture. @is_interpolated is set to %TRUE during the
+interpolation phase of the pan, after the drag has ended and
+the :interpolate property was set to %TRUE.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterPanAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="is_interpolated">
+<parameter_description> if the event is the result of interpolating
+the motion velocity at the end of the drag
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the pan should continue, and %FALSE if
+the pan should be cancelled.
</return>
-</function>
+</signal>
-<function name="clutter_box_layout_set_vertical">
+<signal name="ClutterPanAction::pan-stopped">
<description>
-Sets whether @layout should arrange its children vertically alongside
-the Y axis, instead of horizontally alongside the X axis
+The ::pan-stopped signal is emitted at the end of the interpolation
+phase of the pan action, only when :interpolate is set to %TRUE.
-Since: 1.2
+Since: 1.12
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="action">
+<parameter_description> the #ClutterPanAction that emitted the signal
</parameter_description>
</parameter>
-<parameter name="vertical">
-<parameter_description> %TRUE if the layout should be vertical
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_actor_set_scale">
+<enum name="ClutterPanAxis">
<description>
-Scales an actor with the given factors. The scaling is relative to
-the scale center and the anchor point. The scale center is
-unchanged by this function and defaults to 0,0.
+The axis of the constraint that should be applied on the
+panning action
-Since: 0.2
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="CLUTTER_PAN_AXIS_NONE">
+<parameter_description> No constraint
</parameter_description>
</parameter>
-<parameter name="scale_x">
-<parameter_description> double factor to scale actor by horizontally.
+<parameter name="CLUTTER_PAN_X_AXIS">
+<parameter_description> Set a constraint on the X axis
</parameter_description>
</parameter>
-<parameter name="scale_y">
-<parameter_description> double factor to scale actor by vertically.
+<parameter name="CLUTTER_PAN_Y_AXIS">
+<parameter_description> Set a constraint on the Y axis
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+</enum>
-<function name="json_node_free">
+<signal name="ClutterPathConstraint::node-reached">
<description>
-Frees the resources allocated by @node.
+The ::node-reached signal is emitted each time a
+#ClutterPathConstraint:offset value results in the actor
+passing a #ClutterPathNode
+
+Since: 1.6
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="constraint">
+<parameter_description> the #ClutterPathConstraint that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor using the @constraint
+</parameter_description>
+</parameter>
+<parameter name="index">
+<parameter_description> the index of the node that has been reached
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_layout_manager_child_set">
+<enum name="ClutterPathNodeType">
<description>
-Sets a list of properties and their values on the #ClutterLayoutMeta
-associated by @manager to a child of @container
+Types of nodes in a #ClutterPath.
-Languages bindings should use clutter_layout_manager_child_set_property()
-instead
+Since: 1.0
-Since: 1.2
+</description>
+<parameters>
+<parameter name="CLUTTER_PATH_MOVE_TO">
+<parameter_description> jump to the given position
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_LINE_TO">
+<parameter_description> create a line from the last node to the
+given position
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_CURVE_TO">
+<parameter_description> bezier curve using the last position and
+three control points.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_CLOSE">
+<parameter_description> create a line from the last node to the last
+%CLUTTER_PATH_MOVE_TO node.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_REL_MOVE_TO">
+<parameter_description> same as %CLUTTER_PATH_MOVE_TO but with
+coordinates relative to the last node.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_REL_LINE_TO">
+<parameter_description> same as %CLUTTER_PATH_LINE_TO but with
+coordinates relative to the last node.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PATH_REL_CURVE_TO">
+<parameter_description> same as %CLUTTER_PATH_CURVE_TO but with
+coordinates relative to the last node.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterPickMode">
+<description>
+Controls the paint cycle of the scene graph when in pick mode
+
+Since: 1.0
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="CLUTTER_PICK_NONE">
+<parameter_description> Do not paint any actor
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> a #ClutterContainer using @manager
+<parameter name="CLUTTER_PICK_REACTIVE">
+<parameter_description> Paint only the reactive actors
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_PICK_ALL">
+<parameter_description> Paint all actors
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterRepaintFlags">
+<description>
+Flags to pass to clutter_threads_add_repaint_func_full().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="CLUTTER_REPAINT_FLAGS_PRE_PAINT">
+<parameter_description> Run the repaint function prior to
+painting the stages
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REPAINT_FLAGS_POST_PAINT">
+<parameter_description> Run the repaint function after
+painting the stages
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REPAINT_FLAGS_QUEUE_REDRAW_ON_ADD">
+<parameter_description> Ensure that a new frame
+is queued after adding the repaint function
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterRequestMode">
+<description>
+Specifies the type of requests for a #ClutterActor.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="CLUTTER_REQUEST_HEIGHT_FOR_WIDTH">
+<parameter_description> Height for width requests
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_REQUEST_WIDTH_FOR_HEIGHT">
+<parameter_description> Width for height requests
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterRotateAction::rotate">
+<description>
+The ::rotate signal is emitted when a rotate gesture is
+recognized on the attached actor and when the gesture is
+cancelled (in this case with an angle value of 0).
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterRotateAction that emitted the signal
</parameter_description>
</parameter>
<parameter name="actor">
-<parameter_description> a #ClutterActor child of @container
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
-<parameter name="first_property">
-<parameter_description> the first property name
+<parameter name="angle">
+<parameter_description> the difference of angle of rotation between the initial
+rotation and the current rotation
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of property name and value pairs
+</parameters>
+<return> %TRUE if the rotation should continue, and %FALSE if
+the rotation should be cancelled.
+
+</return>
+</signal>
+
+<enum name="ClutterRotateAxis">
+<description>
+Axis of a rotation.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_X_AXIS">
+<parameter_description> Rotate around the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_Y_AXIS">
+<parameter_description> Rotate around the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_Z_AXIS">
+<parameter_description> Rotate around the Z axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterRotateDirection">
+<description>
+Direction of a rotation.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_ROTATE_CW">
+<parameter_description> Clockwise rotation
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ROTATE_CCW">
+<parameter_description> Counter-clockwise rotation
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterScalingFilter">
+<description>
+The scaling filters to be used with the #ClutterActor:minification-filter
+and #ClutterActor:magnification-filter properties.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="CLUTTER_SCALING_FILTER_LINEAR">
+<parameter_description> Linear interpolation filter
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCALING_FILTER_NEAREST">
+<parameter_description> Nearest neighbor interpolation filter
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCALING_FILTER_TRILINEAR">
+<parameter_description> Trilinear minification filter, with
+mipmap generation; this filter linearly interpolates on every axis,
+as well as between mipmap levels.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterScore::completed">
+<description>
+The ::completed signal is emitted each time a #ClutterScore terminates.
+
+Since: 0.6
+Deprecated: 1.8
+
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> the score which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_x11_add_filter">
+<signal name="ClutterScore::paused">
<description>
-Adds an event filter function.
+The ::paused signal is emitted each time a #ClutterScore
+is paused.
Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a filter function
+<parameter name="score">
+<parameter_description> the score which received the signal
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to be passed to the filter function, or %NULL
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterScore::started">
+<description>
+The ::started signal is emitted each time a #ClutterScore starts playing.
+
+Since: 0.6
+Deprecated: 1.8
+
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> the score which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="json_node_take_object">
+<signal name="ClutterScore::timeline-completed">
<description>
-Sets @object inside @node. The reference count of @object is not increased.
+The ::timeline-completed signal is emitted each time a timeline
+inside a #ClutterScore terminates.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="score">
+<parameter_description> the score which received the signal
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="timeline">
+<parameter_description> the completed timeline
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="json_array_get_element">
+<signal name="ClutterScore::timeline-started">
<description>
-Retrieves the #JsonNode containing the value of the element at @index_
-inside a #JsonArray.
+The ::timeline-started signal is emitted each time a new timeline
+inside a #ClutterScore starts playing.
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="score">
+<parameter_description> the score which received the signal
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="timeline">
+<parameter_description> the current timeline
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the #JsonNode at the requested index
-</return>
-</function>
+<return></return>
+</signal>
-<function name="clutter_interval_get_final_value">
+<enum name="ClutterScriptError">
<description>
-Retrieves the final value of @interval and copies
-it into @value.
+#ClutterScript error enumeration.
-The passed #GValue must be initialized to the value held by
-the #ClutterInterval.
+Since: 0.6
-Since: 1.0
+</description>
+<parameters>
+<parameter name="CLUTTER_SCRIPT_ERROR_INVALID_TYPE_FUNCTION">
+<parameter_description> Type function not found
+or invalid
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCRIPT_ERROR_INVALID_PROPERTY">
+<parameter_description> Property not found or invalid
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCRIPT_ERROR_INVALID_VALUE">
+<parameter_description> Invalid value
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterScrollDirection">
+<description>
+Direction of a pointer scroll event.
+
+The %CLUTTER_SCROLL_SMOOTH value implies that the #ClutterScrollEvent
+has precise scrolling delta information.
+
+Since: 0.4
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="CLUTTER_SCROLL_UP">
+<parameter_description> Scroll up
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="CLUTTER_SCROLL_DOWN">
+<parameter_description> Scroll down
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_LEFT">
+<parameter_description> Scroll left
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_RIGHT">
+<parameter_description> Scroll right
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_SMOOTH">
+<parameter_description> Precise scrolling delta (available in 1.10)
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+</enum>
-<function name="clutter_box_pack_before">
+<enum name="ClutterScrollMode">
<description>
-Adds @actor to @box, placing it before @sibling, and sets layout
-properties at the same time, if the #ClutterLayoutManager used by
- box supports them
+Scroll modes.
-If @sibling is %NULL then @actor is placed at the beginning of the
-list of children, to be allocated and painted below every other child
+Since: 1.12
-This function is a wrapper around clutter_container_add_actor(),
-clutter_container_lower_child() and clutter_layout_manager_child_set()
+</description>
+<parameters>
+<parameter name="CLUTTER_SCROLL_NONE">
+<parameter_description> Ignore scrolling
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_HORIZONTALLY">
+<parameter_description> Scroll only horizontally
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_VERTICALLY">
+<parameter_description> Scroll only vertically
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SCROLL_BOTH">
+<parameter_description> Scroll in both directions
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
-Since: 1.2
+<enum name="ClutterShaderError">
+<description>
+#ClutterShader error enumeration
+
+Since: 0.6
+
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="CLUTTER_SHADER_ERROR_NO_ASM">
+<parameter_description> No ASM shaders support
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="CLUTTER_SHADER_ERROR_NO_GLSL">
+<parameter_description> No GLSL shaders support
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> a #ClutterActor or %NULL
+<parameter name="CLUTTER_SHADER_ERROR_COMPILE">
+<parameter_description> Compilation error
</parameter_description>
</parameter>
-<parameter name="first_property">
-<parameter_description> the name of the first property to set, or %NULL
+</parameters>
+</enum>
+
+<enum name="ClutterShaderType">
+<description>
+The type of GLSL shader program
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_VERTEX_SHADER">
+<parameter_description> a vertex shader
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of property name and value pairs, terminated by %NULL
+<parameter name="CLUTTER_FRAGMENT_SHADER">
+<parameter_description> a fragment shader
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterSnapEdge">
+<description>
+The edge to snap
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="CLUTTER_SNAP_EDGE_TOP">
+<parameter_description> the top edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SNAP_EDGE_RIGHT">
+<parameter_description> the right edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SNAP_EDGE_BOTTOM">
+<parameter_description> the bottom edge
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SNAP_EDGE_LEFT">
+<parameter_description> the left edge
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterStage::activate">
+<description>
+The ::activate signal is emitted when the stage receives key focus
+from the underlying window system.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the stage which was activated
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_scriptable_get_id">
+<signal name="ClutterStage::deactivate">
<description>
-Retrieves the id of @scriptable set using clutter_scriptable_set_id().
+The ::activate signal is emitted when the stage loses key focus
+from the underlying window system.
Since: 0.6
</description>
<parameters>
-<parameter name="scriptable">
-<parameter_description> a #ClutterScriptable
+<parameter name="stage">
+<parameter_description> the stage which was deactivated
</parameter_description>
</parameter>
</parameters>
-<return> the id of the object. The returned string is owned by
-the scriptable object and should never be modified of freed
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterStage::delete-event">
+<description>
+The ::delete-event signal is emitted when the user closes a
+#ClutterStage window using the window controls.
-<function name="clutter_behaviour_remove_all">
+Clutter by default will call clutter_main_quit() if @stage is
+the default stage, and clutter_actor_destroy() for any other
+stage.
+
+It is possible to override the default behaviour by connecting
+a new handler and returning %TRUE there.
+
+<note>This signal is emitted only on Clutter backends that
+embed #ClutterStage in native windows. It is not emitted for
+backends that use a static frame buffer.</note>
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the stage that received the event
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_DELETE
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterStage::fullscreen">
<description>
-Removes every actor from the list that @behave holds.
+The ::fullscreen signal is emitted when the stage is made fullscreen.
-Since: 0.4
+Since: 0.6
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="stage">
+<parameter_description> the stage which was fullscreened
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_ungrab_pointer">
+<signal name="ClutterStage::unfullscreen">
<description>
-Removes an existing grab of the pointer.
+The ::unfullscreen signal is emitted when the stage leaves a fullscreen
+state.
Since: 0.6
</description>
<parameters>
+<parameter name="stage">
+<parameter_description> the stage which has left a fullscreen state.
+</parameter_description>
+</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_set_font_flags">
+<signal name="ClutterStageManager::stage-added">
<description>
-Sets the font quality options for subsequent text rendering
-operations.
+The ::stage-added signal is emitted each time a new #ClutterStage
+has been added to the stage manager.
-Using mipmapped textures will improve the quality for scaled down
-text but will use more texture memory.
+Since: 0.8
-Enabling hinting improves text quality for static text but may
-introduce some artifacts if the text is animated.
+</description>
+<parameters>
+<parameter name="stage_manager">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="stage">
+<parameter_description> the added stage
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
-Since: 1.0
+<signal name="ClutterStageManager::stage-removed">
+<description>
+The ::stage-removed signal is emitted each time a #ClutterStage
+has been removed from the stage manager.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="flags">
-<parameter_description> The new flags
+<parameter name="stage_manager">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="stage">
+<parameter_description> the removed stage
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_event_peek">
+<enum name="ClutterStageState">
<description>
-Returns a pointer to the first event from the event queue but
-does not remove it.
+Stage state masks, used by the #ClutterEvent of type %CLUTTER_STAGE_STATE.
Since: 0.4
</description>
<parameters>
+<parameter name="CLUTTER_STAGE_STATE_FULLSCREEN">
+<parameter_description> Fullscreen mask
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STAGE_STATE_OFFSCREEN">
+<parameter_description> Offscreen mask (deprecated)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STAGE_STATE_ACTIVATED">
+<parameter_description> Activated mask
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterState::completed">
+<description>
+The ::completed signal is emitted when a #ClutterState reaches
+the target state specified by clutter_state_set_state() or
+clutter_state_warp_to_state().
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
+
+</description>
+<parameters>
+<parameter name="state">
+<parameter_description> the #ClutterState that emitted the signal
+</parameter_description>
+</parameter>
</parameters>
-<return> A #ClutterEvent or NULL if queue empty.
+<return></return>
+</signal>
+
+<enum name="ClutterStaticColor">
+<description>
+Named colors, for accessing global colors defined by Clutter
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="CLUTTER_COLOR_WHITE">
+<parameter_description> White color (ffffffff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_BLACK">
+<parameter_description> Black color (000000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_RED">
+<parameter_description> Red color (ff0000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_RED">
+<parameter_description> Dark red color (800000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_GREEN">
+<parameter_description> Green color (00ff00ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_GREEN">
+<parameter_description> Dark green color (008000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_BLUE">
+<parameter_description> Blue color (0000ffff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_BLUE">
+<parameter_description> Dark blue color (000080ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CYAN">
+<parameter_description> Cyan color (00ffffff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_CYAN">
+<parameter_description> Dark cyan color (008080ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_MAGENTA">
+<parameter_description> Magenta color (ff00ffff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_MAGENTA">
+<parameter_description> Dark magenta color (800080ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_YELLOW">
+<parameter_description> Yellow color (ffff00ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_YELLOW">
+<parameter_description> Dark yellow color (808000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_GRAY">
+<parameter_description> Gray color (a0a0a4ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_DARK_GRAY">
+<parameter_description> Dark Gray color (808080ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_LIGHT_GRAY">
+<parameter_description> Light gray color (c0c0c0ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_BUTTER">
+<parameter_description> Butter color (edd400ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_BUTTER_LIGHT">
+<parameter_description> Light butter color (fce94fff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_BUTTER_DARK">
+<parameter_description> Dark butter color (c4a000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ORANGE">
+<parameter_description> Orange color (f57900ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ORANGE_LIGHT">
+<parameter_description> Light orange color (fcaf3fff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ORANGE_DARK">
+<parameter_description> Dark orange color (ce5c00ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHOCOLATE">
+<parameter_description> Chocolate color (c17d11ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHOCOLATE_LIGHT">
+<parameter_description> Light chocolate color (e9b96eff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHOCOLATE_DARK">
+<parameter_description> Dark chocolate color (8f5902ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHAMELEON">
+<parameter_description> Chameleon color (73d216ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHAMELEON_LIGHT">
+<parameter_description> Light chameleon color (8ae234ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_CHAMELEON_DARK">
+<parameter_description> Dark chameleon color (4e9a06ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SKY_BLUE">
+<parameter_description> Sky color (3465a4ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SKY_BLUE_LIGHT">
+<parameter_description> Light sky color (729fcfff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SKY_BLUE_DARK">
+<parameter_description> Dark sky color (204a87ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_PLUM">
+<parameter_description> Plum color (75507bff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_PLUM_LIGHT">
+<parameter_description> Light plum color (ad7fa8ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_PLUM_DARK">
+<parameter_description> Dark plum color (5c3566ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SCARLET_RED">
+<parameter_description> Scarlet red color (cc0000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SCARLET_RED_LIGHT">
+<parameter_description> Light scarlet red color (ef2929ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_SCARLET_RED_DARK">
+<parameter_description> Dark scarlet red color (a40000ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_1">
+<parameter_description> Aluminium, first variant (eeeeecff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_2">
+<parameter_description> Aluminium, second variant (d3d7cfff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_3">
+<parameter_description> Aluminium, third variant (babdb6ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_4">
+<parameter_description> Aluminium, fourth variant (888a85ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_5">
+<parameter_description> Aluminium, fifth variant (555753ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_ALUMINIUM_6">
+<parameter_description> Aluminium, sixth variant (2e3436ff)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_COLOR_TRANSPARENT">
+<parameter_description> Transparent color (00000000)
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterStepMode">
+<description>
+Change the value transition of a step function.
+
+See clutter_timeline_set_step_progress().
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="CLUTTER_STEP_MODE_START">
+<parameter_description> The change in the value of a
+%CLUTTER_STEP progress mode should occur at the start of
+the transition
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_STEP_MODE_END">
+<parameter_description> The change in the value of a
+%CLUTTER_STEP progress mode should occur at the end of
+the transition
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterSwipeAction::swept">
+<description>
+The ::swept signal is emitted when a swipe gesture is recognized on the
+attached actor.
+
+Deprecated: 1.14: Use the ::swipe signal instead.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterSwipeAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> the main direction of the swipe gesture
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterSwipeAction::swipe">
+<description>
+The ::swipe signal is emitted when a swipe gesture is recognized on the
+attached actor.
+
+Since: 1.14
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterSwipeAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the @action
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> the main direction of the swipe gesture
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the swipe should continue, and %FALSE if
+the swipe should be cancelled.
</return>
-</function>
+</signal>
-<function name="clutter_layout_manager_child_get_property">
+<enum name="ClutterSwipeDirection">
<description>
-Gets a property on the #ClutterLayoutMeta created by @manager and
-attached to a child of @container
+The main direction of the swipe gesture
-The #GValue must already be initialized to the type of the property
-and has to be unset with g_value_unset() after extracting the real
-value out of it
+Since: 1.8
-Since: 1.2
+</description>
+<parameters>
+<parameter name="CLUTTER_SWIPE_DIRECTION_UP">
+<parameter_description> Upwards swipe gesture
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SWIPE_DIRECTION_DOWN">
+<parameter_description> Downwards swipe gesture
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SWIPE_DIRECTION_LEFT">
+<parameter_description> Leftwards swipe gesture
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_SWIPE_DIRECTION_RIGHT">
+<parameter_description> Rightwards swipe gesture
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterTableAlignment">
+<description>
+The alignment policies available on each axis of the #ClutterTableLayout
+
+Since: 1.4
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="CLUTTER_TABLE_ALIGNMENT_START">
+<parameter_description> Align the child to the top or to the
+left of a cell in the table, depending on the axis
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> a #ClutterContainer using @manager
+<parameter name="CLUTTER_TABLE_ALIGNMENT_CENTER">
+<parameter_description> Align the child to the center of
+a cell in the table
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TABLE_ALIGNMENT_END">
+<parameter_description> Align the child to the bottom or to the
+right of a cell in the table, depending on the axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterTapAction::tap">
+<description>
+The ::tap signal is emitted when the tap gesture is complete.
+
+Since: 1.14
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterTapAction that emitted the signal
</parameter_description>
</parameter>
<parameter name="actor">
-<parameter_description> a #ClutterActor child of @container
+<parameter_description> the #ClutterActor attached to the @action
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property to get
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterText::activate">
+<description>
+The ::activate signal is emitted each time the actor is 'activated'
+by the user, normally by pressing the 'Enter' key. The signal is
+emitted only if #ClutterText:activatable is set to %TRUE.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue with the value of the property to get
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterText::cursor-changed">
+<description>
+The ::cursor-changed signal is emitted whenever the cursor
+position or size changes.
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_vertex_equal">
+<signal name="ClutterText::cursor-event">
<description>
-Compares @vertex_a and @vertex_b for equality
+The ::cursor-event signal is emitted whenever the cursor position
+changes inside a #ClutterText actor. Inside @geometry it is stored
+the current position and size of the cursor, relative to the actor
+itself.
Since: 1.0
+Deprecated: 1.16: Use the #ClutterText::cursor-changed signal instead
+
</description>
<parameters>
-<parameter name="vertex_a">
-<parameter_description> a #ClutterVertex
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
</parameter_description>
</parameter>
-<parameter name="vertex_b">
-<parameter_description> a #ClutterVertex
+<parameter name="geometry">
+<parameter_description> the coordinates of the cursor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the passed #ClutterVertex are equal
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterText::delete-text">
+<description>
+This signal is emitted when text is deleted from the actor by
+the user. It is emitted before @self text changes.
-<function name="clutter_fixed_layout_new">
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="start_pos">
+<parameter_description> the starting position
+</parameter_description>
+</parameter>
+<parameter name="end_pos">
+<parameter_description> the end position
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterText::insert-text">
<description>
-Creates a new #ClutterFixedLayout
+This signal is emitted when text is inserted into the actor by
+the user. It is emitted before @self text changes.
Since: 1.2
</description>
<parameters>
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="new_text">
+<parameter_description> the new text to insert
+</parameter_description>
+</parameter>
+<parameter name="new_text_length">
+<parameter_description> the length of the new text, in bytes, or -1 if
+new_text is nul-terminated
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position, in characters, at which to insert the
+new text. this is an in-out parameter. After the signal
+emission is finished, it should point after the newly
+inserted text.
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterFixedLayout
+<return></return>
+</signal>
-</return>
-</function>
+<signal name="ClutterText::text-changed">
+<description>
+The ::text-changed signal is emitted after @actor's text changes
-<function name="clutter_actor_get_allocation_vertices">
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> the #ClutterText that emitted the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTextBuffer::deleted-text">
<description>
-Calculates the transformed coordinates of the four corners of the
-actor in the plane of @ancestor. The returned vertices relate to
-the #ClutterActorBox coordinates as follows:
-<itemizedlist>
-<listitem><para>@verts[0] contains (x1, y1)</para></listitem>
-<listitem><para>@verts[1] contains (x2, y1)</para></listitem>
-<listitem><para>@verts[2] contains (x1, y2)</para></listitem>
-<listitem><para>@verts[3] contains (x2, y2)</para></listitem>
-</itemizedlist>
+This signal is emitted after text is deleted from the buffer.
-If @ancestor is %NULL the ancestor will be the #ClutterStage. In
-this case, the coordinates returned will be the coordinates on
-the stage before the projection is applied. This is different from
-the behaviour of clutter_actor_get_abs_allocation_vertices().
+Since: 1.10
-Since: 0.6
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position the text was deleted at.
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> The number of characters that were deleted.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTextBuffer::inserted-text">
+<description>
+This signal is emitted after text is inserted into the buffer.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
-<parameter name="ancestor">
-<parameter_description> A #ClutterActor to calculate the vertices
-against, or %NULL to use the default #ClutterStage
+<parameter name="position">
+<parameter_description> the position the text was inserted at.
</parameter_description>
</parameter>
-<parameter name="verts">
-<parameter_description> return location for an array of
-4 #ClutterVertex in which to store the result.
+<parameter name="chars">
+<parameter_description> The text that was inserted.
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> The number of characters that were inserted.
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_path_add_curve_to">
+<enum name="ClutterTextDirection">
<description>
-Adds a %CLUTTER_PATH_CURVE_TO type node to the path. This causes
-the actor to follow a bezier from the last node to (@x_3, @y_3) using
-(@x_1, @y_1) and (@x_2,@y_2) as control points.
+The text direction to be used by #ClutterActor<!-- -->s
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="CLUTTER_TEXT_DIRECTION_DEFAULT">
+<parameter_description> Use the default setting, as returned
+by clutter_get_default_text_direction()
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXT_DIRECTION_LTR">
+<parameter_description> Use left-to-right text direction
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXT_DIRECTION_RTL">
+<parameter_description> Use right-to-left text direction
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterTexture::load-finished">
+<description>
+The ::load-finished signal is emitted when a texture load has
+completed. If there was an error during loading, @error will
+be set, otherwise it will be %NULL
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="texture">
+<parameter_description> the texture which received the signal
</parameter_description>
</parameter>
-<parameter name="x_1">
-<parameter_description> the x coordinate of the first control point
+<parameter name="error">
+<parameter_description> A set error, or %NULL
</parameter_description>
</parameter>
-<parameter name="y_1">
-<parameter_description> the y coordinate of the first control point
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTexture::pick-with-alpha">
+<description>
+Determines whether a #ClutterTexture should have it's shape defined
+by its alpha channel when picking.
+
+Be aware that this is a bit more costly than the default picking
+due to the texture lookup, extra test against the alpha value and
+the fact that it will also interrupt the batching of geometry
+done internally.
+
+Also there is currently no control over the threshold used to
+determine what value of alpha is considered pickable, and so
+only fully opaque parts of the texture will react to picking.
+
+Since: 1.4
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTexture::pixbuf-change">
+<description>
+The ::pixbuf-change signal is emitted each time the pixbuf
+used by @texture changes.
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> the texture which received the signal
</parameter_description>
</parameter>
-<parameter name="x_2">
-<parameter_description> the x coordinate of the second control point
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTexture::size-change">
+<description>
+The ::size-change signal is emitted each time the size of the
+pixbuf used by @texture changes. The new size is given as
+argument to the callback.
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> the texture which received the signal
</parameter_description>
</parameter>
-<parameter name="y_2">
-<parameter_description> the y coordinate of the second control point
+<parameter name="width">
+<parameter_description> the width of the new texture
</parameter_description>
</parameter>
-<parameter name="x_3">
-<parameter_description> the x coordinate of the third control point
+<parameter name="height">
+<parameter_description> the height of the new texture
</parameter_description>
</parameter>
-<parameter name="y_3">
-<parameter_description> the y coordinate of the third control point
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterTextureError">
+<description>
+Error enumeration for #ClutterTexture
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY">
+<parameter_description> OOM condition
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_ERROR_NO_YUV">
+<parameter_description> YUV operation attempted but no YUV support
+found
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_ERROR_BAD_FORMAT">
+<parameter_description> The requested format for
+clutter_texture_set_from_rgb_data or
+clutter_texture_set_from_yuv_data is unsupported.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterTextureFlags">
+<description>
+Flags for clutter_texture_set_from_rgb_data() and
+clutter_texture_set_from_yuv_data().
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="CLUTTER_TEXTURE_NONE">
+<parameter_description> No flags
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_RGB_FLAG_BGR">
+<parameter_description> FIXME
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_RGB_FLAG_PREMULT">
+<parameter_description> FIXME
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_YUV_FLAG_YUV2">
+<parameter_description> FIXME
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterTextureQuality">
+<description>
+Enumaration controlling the texture quality.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="CLUTTER_TEXTURE_QUALITY_LOW">
+<parameter_description> fastest rendering will use nearest neighbour
+interpolation when rendering. good setting.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_QUALITY_MEDIUM">
+<parameter_description> higher quality rendering without using
+extra resources.
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TEXTURE_QUALITY_HIGH">
+<parameter_description> render the texture with the best quality
+available using extra memory.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterTimeline::completed">
+<description>
+The #ClutterTimeline::completed signal is emitted when the timeline's
+elapsed time reaches the value of the #ClutterTimeline:duration
+property.
+
+This signal will be emitted even if the #ClutterTimeline is set to be
+repeating.
+
+If you want to get notification on whether the #ClutterTimeline has
+been stopped or has finished its run, including its eventual repeats,
+you should use the #ClutterTimeline::stopped signal instead.
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_text_set_editable">
+<signal name="ClutterTimeline::marker-reached">
<description>
-Sets whether the #ClutterText actor should be editable.
+The ::marker-reached signal is emitted each time a timeline
+reaches a marker set with
+clutter_timeline_add_marker_at_time(). This signal is detailed
+with the name of the marker as well, so it is possible to connect
+a callback to the ::marker-reached signal for a specific marker
+with:
-An editable #ClutterText with key focus set using
-clutter_actor_grab_key_focus() or clutter_stage_take_key_focus()
-will receive key events and will update its contents accordingly.
+<informalexample><programlisting>
+clutter_timeline_add_marker_at_time (timeline, "foo", 500);
+clutter_timeline_add_marker_at_time (timeline, "bar", 750);
+
+g_signal_connect (timeline, "marker-reached",
+G_CALLBACK (each_marker_reached), NULL);
+g_signal_connect (timeline, "marker-reached::foo",
+G_CALLBACK (foo_marker_reached), NULL);
+g_signal_connect (timeline, "marker-reached::bar",
+G_CALLBACK (bar_marker_reached), NULL);
+</programlisting></informalexample>
-Since: 1.0
+In the example, the first callback will be invoked for both
+the "foo" and "bar" marker, while the second and third callbacks
+will be invoked for the "foo" or "bar" markers, respectively.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline which received the signal
</parameter_description>
</parameter>
-<parameter name="editable">
-<parameter_description> whether the #ClutterText should be editable
+<parameter name="marker_name">
+<parameter_description> the name of the marker reached
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> the elapsed time
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_set_motion_events_enabled">
+<signal name="ClutterTimeline::new-frame">
<description>
-Sets whether per-actor motion events should be enabled or not (the
-default is to enable them).
+The ::new-frame signal is emitted for each timeline running
+timeline before a new frame is drawn to give animations a chance
+to update the scene.
-If @enable is %FALSE the following events will not work:
-<itemizedlist>
-<listitem><para>ClutterActor::motion-event, unless on the
-#ClutterStage</para></listitem>
-<listitem><para>ClutterActor::enter-event</para></listitem>
-<listitem><para>ClutterActor::leave-event</para></listitem>
-</itemizedlist>
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> the timeline which received the signal
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> the elapsed time between 0 and duration
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
-Since: 0.6
+<signal name="ClutterTimeline::paused">
+<description>
+The ::paused signal is emitted when clutter_timeline_pause() is invoked.
</description>
<parameters>
-<parameter name="enable">
-<parameter_description> %TRUE to enable per-actor motion events
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline which received the signal
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_texture_set_keep_aspect_ratio">
+<signal name="ClutterTimeline::started">
<description>
-Sets whether @texture should have a preferred size maintaining
-the aspect ratio of the underlying image
+The ::started signal is emitted when the timeline starts its run.
+This might be as soon as clutter_timeline_start() is invoked or
+after the delay set in the ClutterTimeline:delay property has
+expired.
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline which received the signal
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterTimeline::stopped">
+<description>
+The #ClutterTimeline::stopped signal is emitted when the timeline
+has been stopped, either because clutter_timeline_stop() has been
+called, or because it has been exhausted.
+
+This is different from the #ClutterTimeline::completed signal,
+which gets emitted after every repeat finishes.
+
+If the #ClutterTimeline has is marked as infinitely repeating,
+this signal will never be emitted.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="is_finished">
+<parameter_description> %TRUE if the signal was emitted at the end of the
+timeline.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<enum name="ClutterTimelineDirection">
+<description>
+The direction of a #ClutterTimeline
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="CLUTTER_TIMELINE_FORWARD">
+<parameter_description> forward direction for a timeline
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_TIMELINE_BACKWARD">
+<parameter_description> backward direction for a timeline
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<enum name="ClutterUnitType">
+<description>
+The type of unit in which a value is expressed
+
+This enumeration might be expanded at later date
Since: 1.0
</description>
<parameters>
+<parameter name="CLUTTER_UNIT_PIXEL">
+<parameter_description> Unit expressed in pixels (with subpixel precision)
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_UNIT_EM">
+<parameter_description> Unit expressed in em
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_UNIT_MM">
+<parameter_description> Unit expressed in millimeters
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_UNIT_POINT">
+<parameter_description> Unit expressed in points
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_UNIT_CM">
+<parameter_description> Unit expressed in centimeters
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
+<signal name="ClutterWaylandSurface::queue-damage-redraw">
+<description>
+::queue-damage-redraw is emitted to notify that some sub-region
+of the texture has been changed. This usually means a redraw
+needs to be queued for the actor.
+
+The default handler will queue a clipped redraw in response to
+the damage, using the assumption that the pixmap is being painted
+to a rectangle covering the transformed allocation of the actor.
+If you sub-class and change the paint method so this isn't true
+then you must also provide your own damage signal handler to
+queue a redraw that blocks this default behaviour.
+
+Since: 1.10
+
+</description>
+<parameters>
<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
-<parameter name="keep_aspect">
-<parameter_description> %TRUE to maintain aspect ratio
+<parameter name="x">
+<parameter_description> The top left x position of the damage region
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The top left y position of the damage region
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> The width of the damage region
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> The height of the damage region
</parameter_description>
</parameter>
</parameters>
<return></return>
-</function>
+</signal>
-<function name="clutter_model_get_column_type">
+<enum name="ClutterX11FilterReturn">
<description>
-Retrieves the type of the @column.
+Return values for the #ClutterX11FilterFunc function.
Since: 0.6
</description>
<parameters>
-<parameter name="model">
-<parameter_description> #ClutterModel
+<parameter name="CLUTTER_X11_FILTER_CONTINUE">
+<parameter_description> The event was not handled, continues the
+processing
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> the column number
+<parameter name="CLUTTER_X11_FILTER_TRANSLATE">
+<parameter_description> Native event translated into a Clutter
+event, stops the processing
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_X11_FILTER_REMOVE">
+<parameter_description> Remove the event, stops the processing
</parameter_description>
</parameter>
</parameters>
-<return> the type of the column.
+</enum>
-</return>
-</function>
+<signal name="ClutterX11TexturePixmap::queue-damage-redraw">
+<description>
+::queue-damage-redraw is emitted to notify that some sub-region
+of the texture has been changed (either by an automatic damage
+update or by an explicit call to
+clutter_x11_texture_pixmap_update_area). This usually means a
+redraw needs to be queued for the actor.
-<function name="clutter_path_node_equal">
+The default handler will queue a clipped redraw in response to
+the damage, using the assumption that the pixmap is being painted
+to a rectangle covering the transformed allocation of the actor.
+If you sub-class and change the paint method so this isn't true
+then you must also provide your own damage signal handler to
+queue a redraw that blocks this default behaviour.
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> the object which received the signal
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> The top left x position of the damage region
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The top left y position of the damage region
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> The width of the damage region
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> The height of the damage region
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="ClutterX11TexturePixmap::update-area">
<description>
-Compares two nodes and checks if they are the same type with the
-same coordinates.
+The ::update-area signal is emitted to ask the texture to update its
+content from its source pixmap.
-Since: 1.0
+Since: 0.8
</description>
<parameters>
-<parameter name="node_a">
-<parameter_description> First node
+<parameter name="texture">
+<parameter_description> the object which received the signal
</parameter_description>
</parameter>
-<parameter name="node_b">
-<parameter_description> Second node
+<parameter name="x">
+<parameter_description> X coordinate of the area to update
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate of the area to update
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the area to update
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the area to update
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the nodes are the same.
+<return></return>
+</signal>
+
+<signal name="ClutterZoomAction::zoom">
+<description>
+The ::zoom signal is emitted for each series of touch events that
+change the distance and focal point between the touch points.
+
+The default handler of the signal will call
+clutter_actor_set_scale() on @actor using the ratio of the first
+distance between the touch points and the current distance. To
+override the default behaviour, connect to this signal and return
+%FALSE.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the #ClutterZoomAction that emitted the signal
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the #ClutterActor attached to the action
+</parameter_description>
+</parameter>
+<parameter name="focal_point">
+<parameter_description> the focal point of the zoom
+</parameter_description>
+</parameter>
+<parameter name="factor">
+<parameter_description> the initial distance between the 2 touch points
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the zoom should continue, and %FALSE if
+the zoom should be cancelled.
</return>
-</function>
+</signal>
-<function name="clutter_actor_set_text_direction">
+<enum name="ClutterZoomAxis">
<description>
-Sets the #ClutterTextDirection for an actor
+The axis of the constraint that should be applied by the
+zooming action.
-The passed text direction must not be %CLUTTER_TEXT_DIRECTION_DEFAULT
+Since: 1.12
-If @self implements #ClutterContainer then this function will recurse
-inside all the children of @self (including the internal ones).
+</description>
+<parameters>
+<parameter name="CLUTTER_ZOOM_X_AXIS">
+<parameter_description> Scale only on the X axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ZOOM_Y_AXIS">
+<parameter_description> Scale only on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="CLUTTER_ZOOM_BOTH">
+<parameter_description> Scale on both axis
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
-Composite actors not implementing #ClutterContainer, or actors requiring
-special handling when the text direction changes, should connect to
-the #GObject::notify signal for the #ClutterActor:text-direction property
+<function name="cally_accessibility_init">
+<description>
+Initializes the accessibility support.
-Since: 1.2
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+</parameters>
+<return> %TRUE if accessibility support has been correctly
+initialized.
+
+</return>
+</function>
+
+<function name="cally_actor_add_action">
+<description>
+Adds a new action to be accessed with the #AtkAction interface.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="cally_actor">
+<parameter_description> a #CallyActor
</parameter_description>
</parameter>
-<parameter name="text_dir">
-<parameter_description> the text direction for @self
+<parameter name="action_name">
+<parameter_description> the action name
+</parameter_description>
+</parameter>
+<parameter name="action_description">
+<parameter_description> the action description
+</parameter_description>
+</parameter>
+<parameter name="action_keybinding">
+<parameter_description> the action keybinding
+</parameter_description>
+</parameter>
+<parameter name="action_func">
+<parameter_description> the callback of the action, to be executed with do_action
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> added action id, or -1 if failure
+
+</return>
</function>
-<function name="json_parser_get_current_pos">
+<function name="cally_actor_add_action_full">
<description>
-Retrieves the current position inside the current line, starting
-from 0.
+Adds a new action to be accessed with the #AtkAction interface.
+Since: 1.6
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #JsonParser
+<parameter name="cally_actor">
+<parameter_description> a #CallyActor
+</parameter_description>
+</parameter>
+<parameter name="action_name">
+<parameter_description> the action name
+</parameter_description>
+</parameter>
+<parameter name="action_description">
+<parameter_description> the action description
+</parameter_description>
+</parameter>
+<parameter name="action_keybinding">
+<parameter_description> the action keybinding
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the callback of the action
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to be passed to @callback
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when removing the action
</parameter_description>
</parameter>
</parameters>
-<return> the position in the current line
+<return> added action id, or -1 if failure
+
</return>
</function>
-<function name="clutter_actor_has_clip">
+<function name="cally_actor_new">
<description>
-Determines whether the actor has a clip area set or not.
+Creates a new #CallyActor for the given @actor
-Since: 0.1.1
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
+<parameter name="actor">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor has a clip area set.
+<return> the newly created #AtkObject
</return>
</function>
-<function name="clutter_animation_set_loop">
+<function name="cally_actor_remove_action">
<description>
-Sets whether @animation should loop over itself once finished.
+Removes a action, using the @action_id returned by cally_actor_add_action()
-A looping #ClutterAnimation will not emit the #ClutterAnimation::completed
-signal when finished.
+Since: 1.4
-This function will set #ClutterAnimation:alpha and
-#ClutterAnimation:timeline if needed.
+</description>
+<parameters>
+<parameter name="cally_actor">
+<parameter_description> a #CallyActor
+</parameter_description>
+</parameter>
+<parameter name="action_id">
+<parameter_description> the action id
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the operation was succesful, %FALSE otherwise
-Since: 1.0
+</return>
+</function>
+
+<function name="cally_actor_remove_action_by_name">
+<description>
+Removes an action, using the @action_name used when the action was added
+with cally_actor_add_action()
+
+Since: 1.4
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="cally_actor">
+<parameter_description> a #CallyActor
</parameter_description>
</parameter>
-<parameter name="loop">
-<parameter_description> %TRUE if the animation should loop
+<parameter name="action_name">
+<parameter_description> the name of the action to remove
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the operation was succesful, %FALSE otherwise
+
+</return>
</function>
-<function name="clutter_behaviour_path_new">
+<function name="cally_clone_new">
<description>
-Creates a new path behaviour. You can use this behaviour to drive
-actors along the nodes of a path, described by @path.
+Creates a new #CallyClone for the given @actor. @actor must be a
+#ClutterClone.
-This will claim the floating reference on the #ClutterPath so you
-do not need to unref if it.
+Since: 1.4
-Since: 0.2
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #AtkObject
+
+</return>
+</function>
+
+<function name="cally_get_cally_initialized">
+<description>
+Returns if the accessibility support using cally is enabled.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha, or %NULL
+</parameters>
+<return> %TRUE if accessibility support has been correctly
+initialized.
+
+</return>
+</function>
+
+<function name="cally_group_new">
+<description>
+Creates a #CallyGroup for @actor
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterGroup
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #ClutterPath or %NULL for an empty path
+</parameters>
+<return> the newly created #CallyGroup
+
+</return>
+</function>
+
+<function name="cally_rectangle_new">
+<description>
+Creates a new #CallyRectangle for the given @actor. @actor must be
+a #ClutterRectangle.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterBehaviour
+<return> the newly created #AtkObject
</return>
</function>
-<function name="clutter_color_from_string">
+<function name="cally_root_new">
<description>
-Parses a string definition of a color, filling the
-<structfield>red</structfield>, <structfield>green</structfield>,
-<structfield>blue</structfield> and <structfield>alpha</structfield>
-channels of @color. If alpha is not specified it will be set full opaque.
+Creates a new #CallyRoot object.
-The @color is not allocated.
+Since: 1.4
-The color may be defined by any of the formats understood by
-pango_color_from_string(); these include literal color names, like
-<literal>Red</literal> or <literal>DarkSlateGray</literal>, or
-hexadecimal specifications like <literal>3050b2</literal> or
-<literal>333</literal>.
+</description>
+<parameters>
+</parameters>
+<return> the newly created #AtkObject
-Since: 1.0
+</return>
+</function>
+
+<function name="cally_stage_new">
+<description>
+Creates a new #CallyStage for the given @actor. @actor should be a
+#ClutterStage.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> a string specifiying a color (named color or #RRGGBBAA)
+</parameters>
+<return> the newly created #AtkObject
+
+</return>
+</function>
+
+<function name="cally_text_new">
+<description>
+Creates a new #CallyText for the given @actor. @actor must be a
+#ClutterText.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if parsing succeeded.
+<return> the newly created #AtkObject
</return>
</function>
-<function name="clutter_actor_allocate_preferred_size">
+<function name="cally_texture_new">
<description>
-Allocates the natural size of @self.
+Creates a new #CallyTexture for the given @actor. @actor must be
+a #ClutterTexture.
-This function is a utility call for #ClutterActor implementations
-that allocates the actor's preferred natural size. It can be used
-by fixed layout managers (like #ClutterGroup or so called
-'composite actors') inside the ClutterActor::allocate
-implementation to give each child exactly how much space it
-requires.
+Since: 1.4
-This function is not meant to be used by applications. It is also
-not meant to be used outside the implementation of the
-ClutterActor::allocate virtual function.
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #AtkObject
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_actor_add_action">
+<description>
+Adds @action to the list of actions applied to @self
+
+A #ClutterAction can only belong to one actor at a time
+
+The #ClutterActor will hold a reference on @action until either
+clutter_actor_remove_action() or clutter_actor_clear_actions()
+is called
+
+Since: 1.4
</description>
<parameters>
@@ -1724,292 +5147,608 @@ Since: 0.8
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags controlling the allocation
+<parameter name="action">
+<parameter_description> a #ClutterAction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_get_value">
+<function name="clutter_actor_add_action_with_name">
<description>
-Sets an initializes @value to that at @column. When done with @value,
-g_value_unset() needs to be called to free any allocated memory.
+A convenience function for setting the name of a #ClutterAction
+while adding it to the list of actions applied to @self
-Since: 0.6
+This function is the logical equivalent of:
+
+|[
+clutter_actor_meta_set_name (CLUTTER_ACTOR_META (action), name);
+clutter_actor_add_action (self, action);
+]|
+
+Since: 1.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> column number to retrieve the value from
+<parameter name="name">
+<parameter_description> the name to set on the action
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an empty #GValue to set
+<parameter name="action">
+<parameter_description> a #ClutterAction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animator_key_get_property_name">
+<function name="clutter_actor_add_child">
<description>
-Retrieves the name of the property a key applies to.
+Adds @child to the children of @self.
-Since: 1.2
+This function will acquire a reference on @child that will only
+be released when calling clutter_actor_remove_child().
+
+This function will take into consideration the #ClutterActor:depth
+of @child, and will keep the list of children sorted.
+
+This function will emit the #ClutterContainer::actor-added signal
+on @self.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the name of the property an animator_key exist for.
-
-</return>
+<return></return>
</function>
-<function name="clutter_feature_available">
+<function name="clutter_actor_add_constraint">
<description>
-Checks whether @feature is available. @feature can be a logical
-OR of #ClutterFeatureFlags.
+Adds @constraint to the list of #ClutterConstraint<!-- -->s applied
+to @self
-Since: 0.1.1
+The #ClutterActor will hold a reference on the @constraint until
+either clutter_actor_remove_constraint() or
+clutter_actor_clear_constraints() is called.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="feature">
-<parameter_description> a #ClutterFeatureFlags
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="constraint">
+<parameter_description> a #ClutterConstraint
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a feature is available
-
-</return>
+<return></return>
</function>
-<function name="clutter_container_sort_depth_order">
+<function name="clutter_actor_add_constraint_with_name">
<description>
-Sorts a container's children using their depth. This function should not
-be normally used by applications.
+A convenience function for setting the name of a #ClutterConstraint
+while adding it to the list of constraints applied to @self
-Since: 0.6
+This function is the logical equivalent of:
+
+|[
+clutter_actor_meta_set_name (CLUTTER_ACTOR_META (constraint), name);
+clutter_actor_add_constraint (self, constraint);
+]|
+
+Since: 1.4
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name to set on the constraint
+</parameter_description>
+</parameter>
+<parameter name="constraint">
+<parameter_description> a #ClutterConstraint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_knot_copy">
+<function name="clutter_actor_add_effect">
<description>
-Makes an allocated copy of a knot.
+Adds @effect to the list of #ClutterEffect<!-- -->s applied to @self
-Since: 0.2
+The #ClutterActor will hold a reference on the @effect until either
+clutter_actor_remove_effect() or clutter_actor_clear_effects() is
+called.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="knot">
-<parameter_description> a #ClutterKnot
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="effect">
+<parameter_description> a #ClutterEffect
</parameter_description>
</parameter>
</parameters>
-<return> the copied knot.
-
-</return>
+<return></return>
</function>
-<function name="clutter_timeline_clone">
+<function name="clutter_actor_add_effect_with_name">
<description>
-Create a new #ClutterTimeline instance which has property values
-matching that of supplied timeline. The cloned timeline will not
-be started and will not be positioned to the current position of
- timeline: you will have to start it with clutter_timeline_start().
+A convenience function for setting the name of a #ClutterEffect
+while adding it to the list of effectss applied to @self
-Since: 0.4
+This function is the logical equivalent of:
+
+|[
+clutter_actor_meta_set_name (CLUTTER_ACTOR_META (effect), name);
+clutter_actor_add_effect (self, effect);
+]|
+
+Since: 1.4
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> #ClutterTimeline to duplicate.
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name to set on the effect
+</parameter_description>
+</parameter>
+<parameter name="effect">
+<parameter_description> a #ClutterEffect
</parameter_description>
</parameter>
</parameters>
-<return> a new #ClutterTimeline, cloned from @timeline
-
-</return>
+<return></return>
</function>
-<function name="clutter_container_raise_child">
+<function name="clutter_actor_add_transition">
<description>
-Raises @actor to @sibling level, in the depth ordering.
+Adds a @transition to the #ClutterActor's list of animations.
-Since: 0.6
+The @name string is a per-actor unique identifier of the @transition: only
+one #ClutterTransition can be associated to the specified @name.
+
+The @transition will be started once added.
+
+This function will take a reference on the @transition.
+
+This function is usually called implicitly when modifying an animatable
+property.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> the actor to raise
+<parameter name="name">
+<parameter_description> the name of the transition to add
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> the sibling to raise to, or %NULL to raise to the top
+<parameter name="transition">
+<parameter_description> the #ClutterTransition to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_get_null_member">
+<function name="clutter_actor_allocate">
<description>
-Convenience function that checks whether the value
-stored in @member_name of @object is null
+Assigns the size of a #ClutterActor from the given @box.
+
+This function should only be called on the children of an actor when
+overriding the #ClutterActorClass.allocate() virtual function.
+
+This function will adjust the stored allocation to take into account
+the alignment flags set in the #ClutterActor:x-align and
+#ClutterActor:y-align properties, as well as the margin values set in
+the #ClutterActor:margin-top, #ClutterActor:margin-right,
+#ClutterActor:margin-bottom, and #ClutterActor:margin-left properties.
+
+This function will respect the easing state of the #ClutterActor and
+interpolate between the current allocation and the new one if the
+easing state duration is a positive value.
-See also: json_object_get_member()
+Actors can know from their allocation box whether they have moved
+with respect to their parent actor. The @flags parameter describes
+additional information about the allocation, for instance whether
+the parent has moved with respect to the stage, for example because
+a grandparent's origin has moved.
Since: 0.8
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="box">
+<parameter_description> new allocation of the actor, in parent-relative coordinates
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="flags">
+<parameter_description> flags that control the allocation
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the value is null
-
-</return>
+<return></return>
</function>
-<function name="clutter_get_input_device_for_id">
+<function name="clutter_actor_allocate_align_fill">
<description>
-Retrieves the #ClutterInputDevice from its @id. This is a convenience
-wrapper for clutter_device_manager_get_device() and it is functionally
-equivalent to:
+Allocates @self by taking into consideration the available allocation
+area; an alignment factor on either axis; and whether the actor should
+fill the allocation on either axis.
-|[
-ClutterDeviceManager *manager;
-ClutterInputDevice *device;
+The @box should contain the available allocation width and height;
+if the x1 and y1 members of #ClutterActorBox are not set to 0, the
+allocation will be offset by their value.
-manager = clutter_device_manager_get_default ();
-device = clutter_device_manager_get_device (manager, id);
-]|
+This function takes into consideration the geometry request specified by
+the #ClutterActor:request-mode property, and the text direction.
-Since: 0.8
+This function is useful for fluid layout managers using legacy alignment
+flags. Newly written layout managers should use the #ClutterActor:x-align
+and #ClutterActor:y-align properties, instead, and just call
+clutter_actor_allocate() inside their #ClutterActorClass.allocate()
+implementation.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="id">
-<parameter_description> the unique id for a device
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox, containing the available width and height
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> the horizontal alignment, between 0 and 1
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> the vertical alignment, between 0 and 1
+</parameter_description>
+</parameter>
+<parameter name="x_fill">
+<parameter_description> whether the actor should fill horizontally
+</parameter_description>
+</parameter>
+<parameter name="y_fill">
+<parameter_description> whether the actor should fill vertically
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> allocation flags to be passed to clutter_actor_allocate()
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterInputDevice, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_get_animation">
+<function name="clutter_actor_allocate_available_size">
<description>
-Retrieves the #ClutterAnimation used by @actor, if clutter_actor_animate()
-has been called on @actor.
+Allocates @self taking into account the #ClutterActor<!-- -->'s
+preferred size, but limiting it to the maximum available width
+and height provided.
+
+This function will do the right thing when dealing with the
+actor's request mode.
+
+The implementation of this function is equivalent to:
+
+|[
+if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH)
+{
+clutter_actor_get_preferred_width (self, available_height,
+&min_width,
+&natural_width);
+width = CLAMP (natural_width, min_width, available_width);
+
+clutter_actor_get_preferred_height (self, width,
+&min_height,
+&natural_height);
+height = CLAMP (natural_height, min_height, available_height);
+}
+else
+{
+clutter_actor_get_preferred_height (self, available_width,
+&min_height,
+&natural_height);
+height = CLAMP (natural_height, min_height, available_height);
+
+clutter_actor_get_preferred_width (self, height,
+&min_width,
+&natural_width);
+width = CLAMP (natural_width, min_width, available_width);
+}
+
+box.x1 = x; box.y1 = y;
+box.x2 = box.x1 + available_width;
+box.y2 = box.y1 + available_height;
+clutter_actor_allocate (self, &box, flags);
+]|
+
+This function can be used by fluid layout managers to allocate
+an actor's preferred size without making it bigger than the area
+available for the container.
Since: 1.0
</description>
<parameters>
-<parameter name="actor">
+<parameter name="self">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
+<parameter name="x">
+<parameter_description> the actor's X coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the actor's Y coordinate
+</parameter_description>
+</parameter>
+<parameter name="available_width">
+<parameter_description> the maximum available width, or -1 to use the
+actor's natural width
+</parameter_description>
+</parameter>
+<parameter name="available_height">
+<parameter_description> the maximum available height, or -1 to use the
+actor's natural height
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags controlling the allocation
+</parameter_description>
+</parameter>
</parameters>
-<return> a #ClutterAnimation, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="clutter_media_set_uri">
+<function name="clutter_actor_allocate_preferred_size">
<description>
-Sets the URI of @media to @uri.
+Allocates the natural size of @self.
-Since: 0.2
+This function is a utility call for #ClutterActor implementations
+that allocates the actor's preferred natural size. It can be used
+by fixed layout managers (like #ClutterGroup or so called
+'composite actors') inside the ClutterActor::allocate
+implementation to give each child exactly how much space it
+requires, regardless of the size of the parent.
+
+This function is not meant to be used by applications. It is also
+not meant to be used outside the implementation of the
+#ClutterActorClass.allocate virtual function.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> the URI of the media stream
+<parameter name="flags">
+<parameter_description> flags controlling the allocation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeout_pool_add">
+<function name="clutter_actor_animate">
<description>
-Sets a function to be called at regular intervals, and puts it inside
-the @pool. The function is repeatedly called until it returns %FALSE,
-at which point the timeout is automatically destroyed and the function
-won't be called again. If @notify is not %NULL, the @notify function
-will be called. The first call to @func will be at the end of @interval.
+Animates the given list of properties of @actor between the current
+value for each property and a new final value. The animation has a
+definite duration and a speed given by the @mode.
-Since Clutter 0.8 this will try to compensate for delays. For
-example, if @func takes half the interval time to execute then the
-function will be called again half the interval time after it
-finished. Before version 0.8 it would not fire until a full
-interval after the function completes so the delay between calls
-would be @interval * 1.5. This function does not however try to
-invoke the function multiple times to catch up missing frames if
- func takes more than @interval ms to execute.
+For example, this:
-Since: 0.4
+|[
+clutter_actor_animate (rectangle, CLUTTER_LINEAR, 250,
+"width", 100.0,
+"height", 100.0,
+NULL);
+]|
+
+will make width and height properties of the #ClutterActor "rectangle"
+grow linearly between the current value and 100 pixels, in 250 milliseconds.
+
+The animation @mode is a logical id, either from the #ClutterAnimationMode
+enumeration of from clutter_alpha_register_func().
+
+All the properties specified will be animated between the current value
+and the final value. If a property should be set at the beginning of
+the animation but not updated during the animation, it should be prefixed
+by the "fixed::" string, for instance:
+
+|[
+clutter_actor_animate (actor, CLUTTER_EASE_IN_SINE, 100,
+"rotation-angle-z", 360.0,
+"fixed::rotation-center-z", &center,
+NULL);
+]|
+
+Will animate the "rotation-angle-z" property between the current value
+and 360 degrees, and set the "rotation-center-z" property to the fixed
+value of the #ClutterVertex "center".
+
+This function will implicitly create a #ClutterAnimation object which
+will be assigned to the @actor and will be returned to the developer
+to control the animation or to know when the animation has been
+completed.
+
+If a name argument starts with "signal::", "signal-after::",
+"signal-swapped::" or "signal-swapped-after::" the two following arguments
+are used as callback function and data for a signal handler installed on
+the #ClutterAnimation object for the specified signal name, for instance:
+
+|[
+
+static void
+on_animation_completed (ClutterAnimation *animation,
+ClutterActor *actor)
+{
+clutter_actor_hide (actor);
+}
+
+clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 100,
+"opacity", 0,
+"signal::completed", on_animation_completed, actor,
+NULL);
+]|
+
+or, to automatically destroy an actor at the end of the animation:
+
+|[
+clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 100,
+"opacity", 0,
+"signal-swapped-after::completed",
+clutter_actor_destroy,
+actor,
+NULL);
+]|
+
+The "signal::" modifier is the equivalent of using g_signal_connect();
+the "signal-after::" modifier is the equivalent of using
+g_signal_connect_after() or g_signal_connect_data() with the
+%G_CONNECT_AFTER; the "signal-swapped::" modifier is the equivalent
+of using g_signal_connect_swapped() or g_signal_connect_data() with the
+%G_CONNECT_SWAPPED flah; finally, the "signal-swapped-after::" modifier
+is the equivalent of using g_signal_connect_data() with both the
+%G_CONNECT_AFTER and %G_CONNECT_SWAPPED flags. The clutter_actor_animate()
+function will not keep track of multiple connections to the same signal,
+so it is your responsability to avoid them when calling
+clutter_actor_animate() multiple times on the same actor.
+
+Calling this function on an actor that is already being animated
+will cause the current animation to change with the new final values,
+the new easing mode and the new duration - that is, this code:
+
+|[
+clutter_actor_animate (actor, CLUTTER_LINEAR, 250,
+"width", 100.0,
+"height", 100.0,
+NULL);
+clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 500,
+"x", 100.0,
+"y", 100.0,
+"width", 200.0,
+NULL);
+]|
+
+is the equivalent of:
+
+|[
+clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 500,
+"x", 100.0,
+"y", 100.0,
+"width", 200.0,
+"height", 100.0,
+NULL);
+]|
+
+<note>Unless the animation is looping, the #ClutterAnimation created by
+clutter_actor_animate() will become invalid as soon as it is
+complete.</note>
+
+Since the created #ClutterAnimation instance attached to @actor
+is guaranteed to be valid throughout the #ClutterAnimation::completed
+signal emission chain, you will not be able to create a new animation
+using clutter_actor_animate() on the same @actor from within the
+#ClutterAnimation::completed signal handler unless you use
+g_signal_connect_after() to connect the callback function, for instance:
+
+|[
+static void
+on_animation_completed (ClutterAnimation *animation,
+ClutterActor *actor)
+{
+clutter_actor_animate (actor, CLUTTER_EASE_OUT_CUBIC, 250,
+"x", 500.0,
+"y", 500.0,
+NULL);
+}
+
+...
+animation = clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 250,
+"x", 100.0,
+"y", 100.0,
+NULL);
+g_signal_connect (animation, "completed",
+G_CALLBACK (on_animation_completed),
+actor);
+...
+]|
+
+Since: 1.0
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead.
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterTimeoutPool
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="fps">
-<parameter_description> the time between calls to the function, in frames per second
+<parameter name="mode">
+<parameter_description> an animation mode logical id
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+<parameter name="duration">
+<parameter_description> duration of the animation, in milliseconds
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function, or %NULL
+<parameter name="first_property_name">
+<parameter_description> the name of a property
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout is removed, or %NULL
+<parameter name="Varargs">
+<parameter_description> a %NULL terminated list of property names and
+property values
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the timeout inside the pool.
-Use clutter_timeout_pool_remove() to stop the timeout.
+<return> a #ClutterAnimation object. The object is
+owned by the #ClutterActor and should not be unreferenced with
+g_object_unref()
</return>
</function>
@@ -2027,6 +5766,8 @@ to animate @actor.
Since: 1.0
+Deprecated: 1.10: Use clutter_actor_animate_with_timeline() instead
+
</description>
<parameters>
<parameter name="actor">
@@ -2041,7 +5782,7 @@ Since: 1.0
<parameter_description> the name of a property
</parameter_description>
</parameter>
-<parameter name="VarArgs">
+<parameter name="Varargs">
<parameter_description> a %NULL terminated list of property names and
property values
</parameter_description>
@@ -2053,129 +5794,256 @@ property values
</return>
</function>
-<function name="clutter_shader_release">
+<function name="clutter_actor_animate_with_alphav">
<description>
-Frees up any GL context resources held by the shader.
+Animates the given list of properties of @actor between the current
+value for each property and a new final value. The animation has a
+definite behaviour given by the passed @alpha.
-Since: 0.6
+See clutter_actor_animate() for further details.
+
+This function is useful if you want to use an existing #ClutterAlpha
+to animate @actor.
+
+This is the vector-based variant of clutter_actor_animate_with_alpha(),
+useful for language bindings.
+
+<warning>Unlike clutter_actor_animate_with_alpha(), this function will
+not allow you to specify "signal::" names and callbacks.</warning>
+
+Since: 1.0
+
+Deprecated: 1.10: Use clutter_actor_animate_with_timelinev() instead
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha
+</parameter_description>
+</parameter>
+<parameter name="n_properties">
+<parameter_description> number of property names and values
+</parameter_description>
+</parameter>
+<parameter name="properties">
+<parameter_description> a vector
+containing the property names to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the
+property values to set
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterAnimation object. The object is owned by the
+#ClutterActor and should not be unreferenced with g_object_unref()
+
+</return>
</function>
-<function name="clutter_list_model_new">
+<function name="clutter_actor_animate_with_timeline">
<description>
-Creates a new default model with @n_columns columns with the types
-and names passed in.
-
-For example:
-
-<informalexample><programlisting>
-model = clutter_list_model_new (3,
-G_TYPE_INT, "Score",
-G_TYPE_STRING, "Team",
-GDK_TYPE_PIXBUF, "Logo");
-</programlisting></informalexample>
+Animates the given list of properties of @actor between the current
+value for each property and a new final value. The animation has a
+definite duration given by @timeline and a speed given by the @mode.
-will create a new #ClutterModel with three columns of type int,
-string and #GdkPixbuf respectively.
+See clutter_actor_animate() for further details.
-Note that the name of the column can be set to %NULL, in which case
-the canonical name of the type held by the column will be used as
-the title.
+This function is useful if you want to use an existing timeline
+to animate @actor.
-Since: 0.6
+Since: 1.0
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead.
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the model
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> an animation mode logical id
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> the name of a property
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> @n_columns number of #GType and string pairs
+<parameter_description> a %NULL terminated list of property names and
+property values
</parameter_description>
</parameter>
</parameters>
-<return> a new #ClutterListModel
+<return> a #ClutterAnimation object. The object is
+owned by the #ClutterActor and should not be unreferenced with
+g_object_unref()
</return>
</function>
-<function name="clutter_box_pack_at">
+<function name="clutter_actor_animate_with_timelinev">
<description>
-Adds @actor to @box, placing it at @position, and sets layout
-properties at the same time, if the #ClutterLayoutManager used by
- box supports them
+Animates the given list of properties of @actor between the current
+value for each property and a new final value. The animation has a
+definite duration given by @timeline and a speed given by the @mode.
-If @position is a negative number, or is larger than the number of
-children of @box, the new child is added at the end of the list of
-children
+See clutter_actor_animate() for further details.
-Since: 1.2
+This function is useful if you want to use an existing timeline
+to animate @actor.
+
+This is the vector-based variant of clutter_actor_animate_with_timeline(),
+useful for language bindings.
+
+<warning>Unlike clutter_actor_animate_with_timeline(), this function
+will not allow you to specify "signal::" names and callbacks.</warning>
+
+Since: 1.0
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead.
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> an animation mode logical id
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="n_properties">
+<parameter_description> number of property names and values
+</parameter_description>
+</parameter>
+<parameter name="properties">
+<parameter_description> a vector
+containing the property names to set
</parameter_description>
</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the
+property values to set
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterAnimation object. The object is
+owned by the #ClutterActor and should not be unreferenced with
+g_object_unref()
+
+</return>
+</function>
+
+<function name="clutter_actor_animatev">
+<description>
+Animates the given list of properties of @actor between the current
+value for each property and a new final value. The animation has a
+definite duration and a speed given by the @mode.
+
+This is the vector-based variant of clutter_actor_animate(), useful
+for language bindings.
+
+<warning>Unlike clutter_actor_animate(), this function will not
+allow you to specify "signal::" names and callbacks.</warning>
+
+Since: 1.0
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead.
+
+</description>
+<parameters>
<parameter name="actor">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the position to insert the @actor at
+<parameter name="mode">
+<parameter_description> an animation mode logical id
</parameter_description>
</parameter>
-<parameter name="first_property">
-<parameter_description> the name of the first property to set, or %NULL
+<parameter name="duration">
+<parameter_description> duration of the animation, in milliseconds
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of property name and value pairs, terminated by %NULL
+<parameter name="n_properties">
+<parameter_description> number of property names and values
+</parameter_description>
+</parameter>
+<parameter name="properties">
+<parameter_description> a vector
+containing the property names to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the
+property values to set
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterAnimation object. The object is
+owned by the #ClutterActor and should not be unreferenced with
+g_object_unref()
+
+</return>
</function>
-<function name="clutter_text_set_line_wrap_mode">
+<function name="clutter_actor_apply_relative_transform_to_point">
<description>
-If line wrapping is enabled (see clutter_text_set_line_wrap()) this
-function controls how the line wrapping is performed. The default is
-%PANGO_WRAP_WORD which means wrap on word boundaries.
+Transforms @point in coordinates relative to the actor into
+ancestor-relative coordinates using the relevant transform
+stack (i.e. scale, rotation, etc).
-Since: 1.0
+If @ancestor is %NULL the ancestor will be the #ClutterStage. In
+this case, the coordinates returned will be the coordinates on
+the stage before the projection is applied. This is different from
+the behaviour of clutter_actor_apply_transform_to_point().
+
+Since: 0.6
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="wrap_mode">
-<parameter_description> the line wrapping mode
+<parameter name="ancestor">
+<parameter_description> A #ClutterActor ancestor, or %NULL to use the
+default #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> A point as #ClutterVertex
+</parameter_description>
+</parameter>
+<parameter name="vertex">
+<parameter_description> The translated #ClutterVertex
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_raise">
+<function name="clutter_actor_apply_transform_to_point">
<description>
-Puts @self above @below.
-
-Both actors must have the same parent, and the parent must implement
-the #ClutterContainer interface
+Transforms @point in coordinates relative to the actor
+into screen-relative coordinates with the current actor
+transformation (i.e. scale, rotation, etc)
-This function is the equivalent of clutter_container_raise_child().
+Since: 0.4
</description>
<parameters>
@@ -2183,227 +6051,628 @@ This function is the equivalent of clutter_container_raise_child().
<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="below">
-<parameter_description> A #ClutterActor to raise above.
+<parameter name="point">
+<parameter_description> A point as #ClutterVertex
+</parameter_description>
+</parameter>
+<parameter name="vertex">
+<parameter_description> The translated #ClutterVertex
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_device_manager_get_default">
+<function name="clutter_actor_box_alloc">
<description>
-Retrieves the device manager singleton
+Allocates a new #ClutterActorBox.
-Since: 1.2
+Since: 1.12
</description>
<parameters>
</parameters>
-<return> the #ClutterDeviceManager singleton.
-The returned instance is owned by Clutter and it should not be
-modified or freed
+<return> the newly allocated #ClutterActorBox.
+Use clutter_actor_box_free() to free its resources
</return>
</function>
-<function name="clutter_x11_get_use_argb_visual">
+<function name="clutter_actor_box_clamp_to_pixel">
<description>
-Retrieves whether the Clutter X11 backend is using ARGB visuals by default
+Clamps the components of @box to the nearest integer
Since: 1.2
</description>
<parameters>
+<parameter name="box">
+<parameter_description> the #ClutterActorBox to clamp
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if ARGB visuals are queried by default
+<return></return>
+</function>
+
+<function name="clutter_actor_box_contains">
+<description>
+Checks whether a point with @x, @y coordinates is contained
+withing @box
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate of the point
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate of the point
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the point is contained by the #ClutterActorBox
</return>
</function>
-<function name="json_object_get_object_member">
+<function name="clutter_actor_box_copy">
<description>
-Convenience function that retrieves the object
-stored in @member_name of @object
+Copies @box
+
+Since: 1.0
-See also: json_object_get_member()
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+</parameters>
+<return> a newly allocated copy of #ClutterActorBox. Use
+clutter_actor_box_free() to free the allocated resources
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_actor_box_equal">
+<description>
+Checks @box_a and @box_b for equality
+
+Since: 1.0
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="box_a">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="box_b">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
</parameters>
-<return> the object inside the object's member
+<return> %TRUE if the passed #ClutterActorBox are equal
</return>
</function>
-<function name="clutter_container_create_child_meta">
+<function name="clutter_actor_box_free">
<description>
-Creates the #ClutterChildMeta wrapping @actor inside the
- container, if the #ClutterContainerIface::child_meta_type
-class member is not set to %G_TYPE_INVALID.
+Frees a #ClutterActorBox allocated using clutter_actor_box_new()
+or clutter_actor_box_copy()
-This function is only useful when adding a #ClutterActor to
-a #ClutterContainer implementation outside of the
-#ClutterContainer::add() virtual function implementation.
+Since: 1.0
-Applications should not call this function.
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.2
+<function name="clutter_actor_box_from_vertices">
+<description>
+Calculates the bounding box represented by the four vertices; for details
+of the vertex array see clutter_actor_get_abs_allocation_vertices().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="verts">
+<parameter_description> array of four #ClutterVertex
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_node_copy">
+<function name="clutter_actor_box_get_area">
<description>
-Makes an allocated copy of a node.
+Retrieves the area of @box
Since: 1.0
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #ClutterPathNode
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
</parameters>
-<return> the copied node.
+<return> the area of a #ClutterActorBox, in pixels
</return>
</function>
-<function name="clutter_stage_get_default">
+<function name="clutter_actor_box_get_height">
<description>
-Returns the main stage. The default #ClutterStage is a singleton,
-so the stage will be created the first time this function is
-called (typically, inside clutter_init()); all the subsequent
-calls to clutter_stage_get_default() will return the same instance.
+Retrieves the height of the @box
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+</parameters>
+<return> the height of the box
-Clutter guarantess the existence of the default stage.
+</return>
+</function>
+<function name="clutter_actor_box_get_origin">
+<description>
+Retrieves the origin of @box
+
+Since: 1.0
</description>
<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return location for the X coordinate, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for the Y coordinate, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> the main #ClutterStage. You should never
-destroy or unref the returned actor.
+<return></return>
+</function>
+
+<function name="clutter_actor_box_get_size">
+<description>
+Retrieves the size of @box
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> return location for the width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the height, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_box_get_width">
+<description>
+Retrieves the width of the @box
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+</parameters>
+<return> the width of the box
+
</return>
</function>
-<function name="clutter_container_foreach">
+<function name="clutter_actor_box_get_x">
<description>
-Calls @callback for each child of @container that was added
-by the application (with clutter_container_add_actor()). Does
-not iterate over "internal" children that are part of the
-container's own implementation, if any.
+Retrieves the X coordinate of the origin of @box
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> a function to be called for each child
+</parameters>
+<return> the X coordinate of the origin
+
+</return>
+</function>
+
+<function name="clutter_actor_box_get_y">
+<description>
+Retrieves the Y coordinate of the origin of @box
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to be passed to the function, or %NULL
+</parameters>
+<return> the Y coordinate of the origin
+
+</return>
+</function>
+
+<function name="clutter_actor_box_init">
+<description>
+Initializes @box with the given coordinates.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x_1">
+<parameter_description> X coordinate of the top left point
+</parameter_description>
+</parameter>
+<parameter name="y_1">
+<parameter_description> Y coordinate of the top left point
+</parameter_description>
+</parameter>
+<parameter name="x_2">
+<parameter_description> X coordinate of the bottom right point
+</parameter_description>
+</parameter>
+<parameter name="y_2">
+<parameter_description> Y coordinate of the bottom right point
+</parameter_description>
+</parameter>
+</parameters>
+<return> the initialized #ClutterActorBox
+
+</return>
+</function>
+
+<function name="clutter_actor_box_init_rect">
+<description>
+Initializes @box with the given origin and size.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate of the origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate of the origin
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the box
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the box
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_list_model_newv">
+<function name="clutter_actor_box_interpolate">
<description>
-Non-vararg version of clutter_list_model_new(). This function is
-useful for language bindings.
+Interpolates between @initial and @final #ClutterActorBox<!-- -->es
+using @progress
-Since: 0.6
+Since: 1.2
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the model
+<parameter name="initial">
+<parameter_description> the initial #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> an array of #GType types for the columns, from first to last
+<parameter name="final">
+<parameter_description> the final #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="names">
-<parameter_description> an array of names for the columns, from first to last
+<parameter name="progress">
+<parameter_description> the interpolation progress
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the interpolation
</parameter_description>
</parameter>
</parameters>
-<return> a new default #ClutterModel
+<return></return>
+</function>
+
+<function name="clutter_actor_box_new">
+<description>
+Allocates a new #ClutterActorBox using the passed coordinates
+for the top left and bottom right points.
+
+This function is the logical equivalent of:
+
+|[
+clutter_actor_box_init (clutter_actor_box_alloc (),
+x_1, y_1,
+x_2, y_2);
+]|
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="x_1">
+<parameter_description> X coordinate of the top left point
+</parameter_description>
+</parameter>
+<parameter name="y_1">
+<parameter_description> Y coordinate of the top left point
+</parameter_description>
+</parameter>
+<parameter name="x_2">
+<parameter_description> X coordinate of the bottom right point
+</parameter_description>
+</parameter>
+<parameter name="y_2">
+<parameter_description> Y coordinate of the bottom right point
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly allocated #ClutterActorBox.
+Use clutter_actor_box_free() to free the resources
</return>
</function>
-<function name="clutter_score_pause">
+<function name="clutter_actor_box_set_origin">
<description>
-Pauses a playing score @score.
+Changes the origin of @box, maintaining the size of the #ClutterActorBox.
-Since: 0.6
+Since: 1.6
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the X coordinate of the new origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the Y coordinate of the new origin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_max_length">
+<function name="clutter_actor_box_set_size">
<description>
-Gets the maximum length of text that can be set into a text actor.
+Sets the size of @box, maintaining the origin of the #ClutterActorBox.
-See clutter_text_set_max_length().
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the new width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the new height
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_box_union">
+<description>
+Unions the two boxes @a and @b and stores the result in @result.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> the first #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> the second #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> the #ClutterActorBox representing a union
+of @a and @b
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_clear_actions">
+<description>
+Clears the list of actions applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_clear_constraints">
+<description>
+Clears the list of constraints applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_clear_effects">
+<description>
+Clears the list of effects applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_contains">
+<description>
+Determines if @descendant is contained inside @self (either as an
+immediate child, or as a deeper descendant). If @self and
+ descendant point to the same actor then it will also return %TRUE.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="descendant">
+<parameter_description> A #ClutterActor, possibly contained in @self
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether @descendent is contained within @self
+
+</return>
+</function>
+
+<function name="clutter_actor_continue_paint">
+<description>
+Run the next stage of the paint sequence. This function should only
+be called within the implementation of the ‘run’ virtual of a
+#ClutterEffect. It will cause the run method of the next effect to
+be applied, or it will paint the actual actor if the current effect
+is the last effect in the chain.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_create_pango_context">
+<description>
+Creates a #PangoContext for the given actor. The #PangoContext
+is already configured using the appropriate font map, resolution
+and font options.
+
+See also clutter_actor_get_pango_context().
Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the maximum number of characters.
+<return> the newly created #PangoContext.
+Use g_object_unref() on the returned value to deallocate its
+resources
</return>
</function>
-<function name="clutter_actor_set_shader_param">
+<function name="clutter_actor_create_pango_layout">
<description>
-Sets the value for a named parameter of the shader applied
-to @actor.
+Creates a new #PangoLayout from the same #PangoContext used
+by the #ClutterActor. The #PangoLayout is already configured
+with the font map, resolution and font options, and the
+given @text.
+
+If you want to keep around a #PangoLayout created by this
+function you will have to connect to the #ClutterBackend::font-changed
+and #ClutterBackend::resolution-changed signals, and call
+pango_layout_context_changed() in response to them.
Since: 1.0
@@ -2413,63 +6682,243 @@ Since: 1.0
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="param">
-<parameter_description> the name of the parameter
+<parameter name="text">
+<parameter_description> the text to set on the #PangoLayout, or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the parameter
+</parameters>
+<return> the newly created #PangoLayout.
+Use g_object_unref() when done
+
+</return>
+</function>
+
+<function name="clutter_actor_destroy">
+<description>
+Destroys an actor. When an actor is destroyed, it will break any
+references it holds to other objects. If the actor is inside a
+container, the actor will be removed.
+
+When you destroy a container, its children will be destroyed as well.
+
+Note: you cannot destroy the #ClutterStage returned by
+clutter_stage_get_default().
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_bin_layout_set_alignment">
+<function name="clutter_actor_destroy_all_children">
<description>
-Sets the horizontal and vertical alignment policies to be applied
-to a @child of @self
+Destroys all children of @self.
-If @child is %NULL then the @x_align and @y_align values will
-be set as the default alignment policies
+This function releases the reference added by inserting a child
+actor in the list of children of @self, and ensures that the
+#ClutterActor::destroy signal is emitted on each child of the
+actor.
-Since: 1.2
+By default, #ClutterActor will emit the #ClutterActor::destroy signal
+when its reference count drops to 0; the default handler of the
+#ClutterActor::destroy signal will destroy all the children of an
+actor. This function ensures that all children are destroyed, instead
+of just removed from @self, unlike clutter_actor_remove_all_children()
+which will merely release the reference and remove each child.
+
+Unless you acquired an additional reference on each child of @self
+prior to calling clutter_actor_remove_all_children() and want to reuse
+the actors, you should use clutter_actor_destroy_all_children() in
+order to make sure that children are destroyed and signal handlers
+are disconnected even in cases where circular references prevent this
+from automatically happening through reference counting alone.
+
+Since: 1.10
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBinLayout
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child of @container
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_detach_animation">
+<description>
+Detaches the #ClutterAnimation used by @actor, if clutter_actor_animate()
+has been called on @actor.
+
+Once the animation has been detached, it loses a reference. If it was
+the only reference then the #ClutterAnimation becomes invalid.
+
+The #ClutterAnimation::completed signal will not be emitted.
+
+Since: 1.4
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead, and clutter_actor_remove_transition() to
+remove the transition.
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> the horizontal alignment policy to be used for the @child
-inside @container
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_event">
+<description>
+This function is used to emit an event on the main stage.
+You should rarely need to use this function, except for
+synthetising events.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> the vertical aligment policy to be used on the @child
-inside @container
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="capture">
+<parameter_description> %TRUE if event in in capture phase, %FALSE otherwise.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the return value from the signal emission: %TRUE
+if the actor handled the event, or %FALSE if the event was
+not handled
+
+</return>
+</function>
+
+<function name="clutter_actor_get_abs_allocation_vertices">
+<description>
+Calculates the transformed screen coordinates of the four corners of
+the actor; the returned vertices relate to the #ClutterActorBox
+coordinates as follows:
+<itemizedlist>
+<listitem><para>v[0] contains (x1, y1)</para></listitem>
+<listitem><para>v[1] contains (x2, y1)</para></listitem>
+<listitem><para>v[2] contains (x1, y2)</para></listitem>
+<listitem><para>v[3] contains (x2, y2)</para></listitem>
+</itemizedlist>
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="verts">
+<parameter_description> Pointer to a location of an array
+of 4 #ClutterVertex where to store the result.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_preferred_height">
+<function name="clutter_actor_get_accessible">
<description>
-Computes the requested minimum and natural heights for an actor,
-or if they are already computed, returns the cached values.
+Returns the accessible object that describes the actor to an
+assistive technology.
-An actor may not get its request - depending on the layout
-manager that's in effect.
+If no class-specific #AtkObject implementation is available for the
+actor instance in question, it will inherit an #AtkObject
+implementation from the first ancestor class for which such an
+implementation is defined.
-A request should not incorporate the actor's scale or anchor point;
+The documentation of the <ulink
+url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
+library contains more information about accessible objects and
+their uses.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #AtkObject associated with @actor
+</return>
+</function>
+
+<function name="clutter_actor_get_action">
+<description>
+Retrieves the #ClutterAction with the given name in the list
+of actions applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the action to retrieve
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterAction for the given
+name, or %NULL. The returned #ClutterAction is owned by the
+actor and it should not be unreferenced directly
+
+</return>
+</function>
+
+<function name="clutter_actor_get_actions">
+<description>
+Retrieves the list of actions applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy
+of the list of #ClutterAction<!-- -->s. The contents of the list are
+owned by the #ClutterActor. Use g_list_free() to free the resources
+allocated by the returned #GList
+
+</return>
+</function>
+
+<function name="clutter_actor_get_allocation_box">
+<description>
+Gets the layout box an actor has been assigned. The allocation can
+only be assumed valid inside a paint() method; anywhere else, it
+may be out-of-date.
+
+An allocation does not incorporate the actor's scale or anchor point;
those transformations do not affect layout, only rendering.
+<note>Do not call any of the clutter_actor_get_allocation_*() family
+of functions inside the implementation of the get_preferred_width()
+or get_preferred_height() virtual functions.</note>
+
Since: 0.8
</description>
@@ -2478,1058 +6927,2060 @@ Since: 0.8
<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="for_width">
-<parameter_description> available width to assume in computing desired height,
-or a negative value to indicate that no width is defined
+<parameter name="box">
+<parameter_description> the function fills this in with the actor's allocation
</parameter_description>
</parameter>
-<parameter name="min_height_p">
-<parameter_description> return location for minimum height,
-or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_allocation_geometry">
+<description>
+Gets the layout box an actor has been assigned. The allocation can
+only be assumed valid inside a paint() method; anywhere else, it
+may be out-of-date.
+
+An allocation does not incorporate the actor's scale or anchor point;
+those transformations do not affect layout, only rendering.
+
+The returned rectangle is in pixels.
+
+Since: 0.8
+
+Deprecated: 1.12: Use clutter_actor_get_allocation_box() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="natural_height_p">
-<parameter_description> return location for natural
-height, or %NULL
+<parameter name="geom">
+<parameter_description> allocation geometry in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_parser_load_from_file">
+<function name="clutter_actor_get_allocation_vertices">
<description>
-Loads a JSON stream from the content of @filename and parses it. See
-json_parser_load_from_data().
+Calculates the transformed coordinates of the four corners of the
+actor in the plane of @ancestor. The returned vertices relate to
+the #ClutterActorBox coordinates as follows:
+<itemizedlist>
+<listitem><para>@verts[0] contains (x1, y1)</para></listitem>
+<listitem><para>@verts[1] contains (x2, y1)</para></listitem>
+<listitem><para>@verts[2] contains (x1, y2)</para></listitem>
+<listitem><para>@verts[3] contains (x2, y2)</para></listitem>
+</itemizedlist>
+If @ancestor is %NULL the ancestor will be the #ClutterStage. In
+this case, the coordinates returned will be the coordinates on
+the stage before the projection is applied. This is different from
+the behaviour of clutter_actor_get_abs_allocation_vertices().
+
+Since: 0.6
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #JsonParser
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the path for the file to parse
+<parameter name="ancestor">
+<parameter_description> A #ClutterActor to calculate the vertices
+against, or %NULL to use the #ClutterStage
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="verts">
+<parameter_description> return
+location for an array of 4 #ClutterVertex in which to store the result
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_anchor_point">
+<description>
+Gets the current anchor point of the @actor in pixels.
+
+Since: 0.6
+
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="anchor_x">
+<parameter_description> return location for the X coordinate of the anchor point
+</parameter_description>
+</parameter>
+<parameter name="anchor_y">
+<parameter_description> return location for the Y coordinate of the anchor point
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_anchor_point_gravity">
+<description>
+Retrieves the anchor position expressed as a #ClutterGravity. If
+the anchor point was specified using pixels or units this will
+return %CLUTTER_GRAVITY_NONE.
+
+Since: 1.0
+
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file was successfully loaded and parsed.
-In case of error, @error is set accordingly and %FALSE is returned
+<return> the #ClutterGravity used by the anchor point
+
</return>
</function>
-<function name="clutter_stage_manager_list_stages">
+<function name="clutter_actor_get_animation">
<description>
-Lists all currently used stages.
+Retrieves the #ClutterAnimation used by @actor, if clutter_actor_animate()
+has been called on @actor.
-Since: 0.8
+Since: 1.0
+Deprecated: 1.12: Use the implicit transition for animatable properties
+in #ClutterActor instead, and clutter_actor_get_transition() to retrieve
+the transition.
</description>
<parameters>
-<parameter name="stage_manager">
-<parameter_description> a #ClutterStageManager
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a newly
-allocated list of #ClutterStage objects. Use g_slist_free() to
-deallocate it when done.
+<return> a #ClutterAnimation, or %NULL
</return>
</function>
-<function name="clutter_container_add_valist">
+<function name="clutter_actor_get_background_color">
<description>
-Alternative va_list version of clutter_container_add().
+Retrieves the color set using clutter_actor_set_background_color().
-Since: 0.4
+Since: 1.10
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="first_actor">
-<parameter_description> the first #ClutterActor to add
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> list of actors to add, followed by %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_child_at_index">
+<description>
+Retrieves the actor at the given @index_ inside the list of
+children of @self.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the position in the list of children
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_actor_get_child_transform">
+<description>
+Retrieves the child transformation matrix set using
+clutter_actor_set_child_transform(); if none is currently set,
+the @transform matrix will be initialized to the identity matrix.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="transform">
+<parameter_description> a #ClutterMatrix
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_keysym_to_unicode">
+<function name="clutter_actor_get_children">
<description>
-Convert from a Clutter key symbol to the corresponding ISO10646 (Unicode)
-character.
+Retrieves the list of children of @self.
+Since: 1.10
</description>
<parameters>
-<parameter name="keyval">
-<parameter_description> a key symbol
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a Unicode character, or 0 if there is no corresponding
-character.
+<return> A newly
+allocated #GList of #ClutterActor<!-- -->s. Use g_list_free() when
+done.
+
</return>
</function>
-<function name="clutter_model_insertv">
+<function name="clutter_actor_get_clip">
<description>
-Inserts data at @row into the #ClutterModel, setting the row
-values for the given @columns upon creation.
+Gets the clip area for @self, if any is set.
Since: 0.6
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> row index
+<parameter name="xoff">
+<parameter_description> return location for the X offset of
+the clip rectangle, or %NULL
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> the number of columns and values to set
+<parameter name="yoff">
+<parameter_description> return location for the Y offset of
+the clip rectangle, or %NULL
</parameter_description>
</parameter>
-<parameter name="columns">
-<parameter_description> a vector containing the columns to set
+<parameter name="width">
+<parameter_description> return location for the width of
+the clip rectangle, or %NULL
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector containing the values for the cells
+<parameter name="height">
+<parameter_description> return location for the height of
+the clip rectangle, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_vertex_new">
+<function name="clutter_actor_get_clip_to_allocation">
<description>
-Creates a new #ClutterVertex for the point in 3D space
-identified by the 3 coordinates @x, @y, @z
+Retrieves the value set using clutter_actor_set_clip_to_allocation()
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="x">
-<parameter_description> X coordinate
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate
+</parameters>
+<return> %TRUE if the #ClutterActor is clipped to its allocation
+
+</return>
+</function>
+
+<function name="clutter_actor_get_constraint">
+<description>
+Retrieves the #ClutterConstraint with the given name in the list
+of constraints applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="z">
-<parameter_description> Z coordinate
+<parameter name="name">
+<parameter_description> the name of the constraint to retrieve
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocate #ClutterVertex. Use
-clutter_vertex_free() to free the resources
+<return> a #ClutterConstraint for the given
+name, or %NULL. The returned #ClutterConstraint is owned by the
+actor and it should not be unreferenced directly
</return>
</function>
-<function name="clutter_texture_set_load_async">
+<function name="clutter_actor_get_constraints">
<description>
-Sets whether @texture should use a worker thread to load the data
-from disk asynchronously. Setting @load_async to %TRUE will make
-clutter_texture_set_from_file() return immediately.
+Retrieves the list of constraints applied to @self
-See the #ClutterTexture:load-async property documentation, and
-clutter_texture_set_load_data_async().
+Since: 1.4
-Since: 1.0
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy
+of the list of #ClutterConstraint<!-- -->s. The contents of the list are
+owned by the #ClutterActor. Use g_list_free() to free the resources
+allocated by the returned #GList
+
+</return>
+</function>
+
+<function name="clutter_actor_get_content">
+<description>
+Retrieves the contents of @self.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="load_async">
-<parameter_description> %TRUE if the texture should asynchronously load data
-from a filename
+</parameters>
+<return> a pointer to the #ClutterContent instance,
+or %NULL if none was set
+
+</return>
+</function>
+
+<function name="clutter_actor_get_content_box">
+<description>
+Retrieves the bounding box for the #ClutterContent of @self.
+
+The bounding box is relative to the actor's allocation.
+
+If no #ClutterContent is set for @self, or if @self has not been
+allocated yet, then the result is undefined.
+
+The content box is guaranteed to be, at most, as big as the allocation
+of the #ClutterActor.
+
+If the #ClutterContent used by the actor has a preferred size, then
+it is possible to modify the content box by using the
+#ClutterActor:content-gravity property.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="box">
+<parameter_description> the return location for the bounding
+box for the #ClutterContent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_get_default_backend">
+<function name="clutter_actor_get_content_gravity">
<description>
-Retrieves the default #ClutterBackend used by Clutter. The
-#ClutterBackend holds backend-specific configuration options.
+Retrieves the content gravity as set using
+clutter_actor_set_content_gravity().
-Since: 0.4
+Since: 1.10
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
</parameters>
-<return> the default backend. You should
-not ref or unref the returned object. Applications should rarely
-need to use this.
+<return> the content gravity
</return>
</function>
-<function name="clutter_score_get_timeline">
+<function name="clutter_actor_get_content_repeat">
<description>
-Retrieves the #ClutterTimeline for @id inside @score.
+Retrieves the repeat policy for a #ClutterActor set by
+clutter_actor_set_content_repeat().
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="id">
-<parameter_description> the id of the timeline
+</parameters>
+<return> the content repeat policy
+
+</return>
+</function>
+
+<function name="clutter_actor_get_content_scaling_filters">
+<description>
+Retrieves the values set using clutter_actor_set_content_scaling_filters().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="min_filter">
+<parameter_description> return location for the minification
+filter, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mag_filter">
+<parameter_description> return location for the magnification
+filter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the requested timeline, or %NULL. This
-function does not increase the reference count on the returned
-#ClutterTimeline
+<return></return>
+</function>
+
+<function name="clutter_actor_get_default_paint_volume">
+<description>
+Retrieves the default paint volume for @self.
+
+This function provides the same #ClutterPaintVolume that would be
+computed by the default implementation inside #ClutterActor of the
+#ClutterActorClass.get_paint_volume() virtual function.
+
+This function should only be used by #ClutterActor subclasses that
+cannot chain up to the parent implementation when computing their
+paint volume.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the default
+#ClutterPaintVolume, relative to the #ClutterActor, or %NULL if
+the actor could not compute a valid paint volume. The returned value
+is not guaranteed to be stable across multiple frames, so if you
+want to retain it, you will need to copy it using
+clutter_paint_volume_copy().
</return>
</function>
-<function name="json_node_get_node_type">
+<function name="clutter_actor_get_depth">
<description>
-Retrieves the #JsonNodeType of @node
+Retrieves the depth of @self.
-Since: 0.8
+Deprecated: 1.12: Use clutter_actor_get_z_position() instead.
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the type of the node
+<return> the depth of the actor
</return>
</function>
-<function name="clutter_x11_has_composite_extension">
+<function name="clutter_actor_get_easing_delay">
<description>
-Retrieves whether Clutter is running on an X11 server with the
-XComposite extension
+Retrieves the delay that should be applied when tweening animatable
+properties.
+Since: 1.10
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the XComposite extension is available
+<return> a delay, in milliseconds
+
</return>
</function>
-<function name="json_array_get_boolean_element">
+<function name="clutter_actor_get_easing_duration">
<description>
-Conveniently retrieves the boolean value of the element at @index_
-inside @array
+Retrieves the duration of the tweening for animatable
+properties of @self for the current easing state.
-See also: json_array_get_element(), json_node_get_boolean()
+Since: 1.10
-Since: 0.8
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the duration of the tweening, in milliseconds
+
+</return>
+</function>
+
+<function name="clutter_actor_get_easing_mode">
+<description>
+Retrieves the easing mode for the tweening of animatable properties
+of @self for the current easing state.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+</parameters>
+<return> an easing mode
+
+</return>
+</function>
+
+<function name="clutter_actor_get_effect">
+<description>
+Retrieves the #ClutterEffect with the given name in the list
+of effects applied to @self
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the effect to retrieve
</parameter_description>
</parameter>
</parameters>
-<return> the integer value
+<return> a #ClutterEffect for the given
+name, or %NULL. The returned #ClutterEffect is owned by the
+actor and it should not be unreferenced directly
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_angle_end">
+<function name="clutter_actor_get_effects">
<description>
-Gets the at which movements ends.
+Retrieves the #ClutterEffect<!-- -->s applied on @self, if any
-Since: 0.4
+Since: 1.4
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> angle in degrees
+<return> a list
+of #ClutterEffect<!-- -->s, or %NULL. The elements of the returned
+list are owned by Clutter and they should not be freed. You should
+free the returned list using g_list_free() when done
</return>
</function>
-<function name="clutter_interval_peek_final_value">
+<function name="clutter_actor_get_first_child">
<description>
-Gets the pointer to the final value of @interval
+Retrieves the first child of @self.
-Since: 1.0
+The returned pointer is only valid until the scene graph changes; it
+is not safe to modify the list of children of @self while iterating
+it.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the final value of the interval.
-The value is owned by the #ClutterInterval and it should not be
-modified or freed
+<return> a pointer to a #ClutterActor, or %NULL
</return>
</function>
-<function name="clutter_group_get_n_children">
+<function name="clutter_actor_get_fixed_position_set">
<description>
-Gets the number of actors held in the group.
+Checks whether an actor has a fixed position set (and will thus be
+unaffected by any layout manager).
-Since: 0.2
+Since: 0.8
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterGroup
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> The number of child actors held in the group.
+<return> %TRUE if the fixed position is set on the actor
</return>
</function>
-<function name="clutter_text_set_line_wrap">
+<function name="clutter_actor_get_flags">
<description>
-Sets whether the contents of a #ClutterText actor should wrap,
-if they don't fit the size assigned to the actor.
+Retrieves the flags set on @self
Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="line_wrap">
-<parameter_description> whether the contents should wrap
+</parameters>
+<return> a bitwise or of #ClutterActorFlags or 0
+
+</return>
+</function>
+
+<function name="clutter_actor_get_geometry">
+<description>
+Gets the size and position of an actor relative to its parent
+actor. This is the same as calling clutter_actor_get_position() and
+clutter_actor_get_size(). It tries to "do what you mean" and get the
+requested size and position if the actor's allocation is invalid.
+
+Deprecated: 1.10: Use clutter_actor_get_position() and
+clutter_actor_get_size(), or clutter_actor_get_allocation_geometry()
+instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="geometry">
+<parameter_description> A location to store actors #ClutterGeometry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_set_sync_size">
+<function name="clutter_actor_get_gid">
<description>
-Sets whether @texture should have the same preferred size as the
-underlying image data.
+Retrieves the unique id for @self.
-Since: 1.0
+Since: 0.6
+
+Deprecated: 1.8: The id is not used any longer.
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="sync_size">
-<parameter_description> %TRUE if the texture should have the same size of the
-underlying image data
+</parameters>
+<return> Globally unique value for this object instance.
+
+</return>
+</function>
+
+<function name="clutter_actor_get_height">
+<description>
+Retrieves the height of a #ClutterActor.
+
+If the actor has a valid allocation, this function will return the
+height of the allocated area given to the actor.
+
+If the actor does not have a valid allocation, this function will
+return the actor's natural height, that is the preferred height of
+the actor.
+
+If you care whether you get the preferred height or the height that
+has been assigned to the actor, you should probably call a different
+function like clutter_actor_get_allocation_box() to retrieve the
+allocated size or clutter_actor_get_preferred_height() to retrieve the
+preferred height.
+
+If an actor has a fixed height, for instance a height that has been
+assigned using clutter_actor_set_height(), the height returned will
+be the same value.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the height of the actor, in pixels
+</return>
</function>
-<function name="clutter_win32_disable_event_retrieval">
+<function name="clutter_actor_get_last_child">
<description>
-Disables retrieval of Windows messages in the main loop. Use to
-create event-less canvas.
+Retrieves the last child of @self.
-This function can only be called before calling clutter_init().
+The returned pointer is only valid until the scene graph changes; it
+is not safe to modify the list of children of @self while iterating
+it.
-Since: 0.8
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_actor_get_layout_manager">
+<description>
+Retrieves the #ClutterLayoutManager used by @self.
+
+Since: 1.10
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the #ClutterLayoutManager,
+or %NULL
+
+</return>
+</function>
+
+<function name="clutter_actor_get_margin">
+<description>
+Retrieves all the components of the margin of a #ClutterActor.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> return location for a #ClutterMargin
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_duration">
+<function name="clutter_actor_get_margin_bottom">
<description>
-Retrieves the duration of the media stream that @media represents.
+Retrieves the bottom margin of a #ClutterActor.
-Since: 0.2
+Since: 1.10
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the duration of the media stream, in seconds
+<return> the bottom margin
</return>
</function>
-<function name="clutter_actor_get_gid">
+<function name="clutter_actor_get_margin_left">
<description>
-Retrieves the unique id for @self.
+Retrieves the left margin of a #ClutterActor.
-Since: 0.6
+Since: 1.10
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> Globally unique value for this object instance.
+<return> the left margin
</return>
</function>
-<function name="clutter_animation_get_timeline">
+<function name="clutter_actor_get_margin_right">
<description>
-Retrieves the #ClutterTimeline used by @animation
+Retrieves the right margin of a #ClutterActor.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the timeline used by the animation
+<return> the right margin
</return>
</function>
-<function name="clutter_shader_is_compiled">
+<function name="clutter_actor_get_margin_top">
<description>
-Checks whether @shader is is currently compiled, linked and bound
-to the GL context.
+Retrieves the top margin of a #ClutterActor.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the shader is compiled, linked and ready for use.
+<return> the top margin
</return>
</function>
-<function name="clutter_container_class_find_child_property">
+<function name="clutter_actor_get_n_children">
<description>
-Looks up the #GParamSpec for a child property of @klass.
+Retrieves the number of children of @self.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GObjectClass implementing the #ClutterContainer interface.
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> a property name.
+</parameters>
+<return> the number of children of an actor
+
+</return>
+</function>
+
+<function name="clutter_actor_get_name">
+<description>
+Retrieves the name of @self.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> The #GParamSpec for the property or %NULL
-if no such property exist.
+<return> the name of the actor, or %NULL. The returned string is
+owned by the actor and should not be modified or freed.
+</return>
+</function>
+
+<function name="clutter_actor_get_next_sibling">
+<description>
+Retrieves the sibling of @self that comes after it in the list
+of children of @self's parent.
+
+The returned pointer is only valid until the scene graph changes; it
+is not safe to modify the list of children of @self while iterating
+it.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a #ClutterActor, or %NULL
</return>
</function>
-<function name="clutter_actor_should_pick_paint">
+<function name="clutter_actor_get_offscreen_redirect">
<description>
-Should be called inside the implementation of the
-#ClutterActor::pick virtual function in order to check whether
-the actor should paint itself in pick mode or not.
+Retrieves whether to redirect the actor to an offscreen buffer, as
+set by clutter_actor_set_offscreen_redirect().
-This function should never be called directly by applications.
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the value of the offscreen-redirect property of the actor
+
+</return>
+</function>
+
+<function name="clutter_actor_get_opacity">
+<description>
+Retrieves the opacity value of an actor, as set by
+clutter_actor_set_opacity().
+
+For retrieving the absolute opacity of the actor inside a paint
+virtual function, see clutter_actor_get_paint_opacity().
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor should paint its silhouette,
-%FALSE otherwise
+<return> the opacity of the actor
</return>
</function>
-<function name="clutter_x11_texture_pixmap_set_automatic">
+<function name="clutter_actor_get_paint_box">
<description>
-Enables or disables the automatic updates ot @texture in case the backing
-pixmap or window is damaged
+Retrieves the paint volume of the passed #ClutterActor, and
+transforms it into a 2D bounding box in stage coordinates.
-Since: 0.8
+This function is useful to determine the on screen area occupied by
+the actor. The box is only an approximation and may often be
+considerably larger due to the optimizations used to calculate the
+box. The box is never smaller though, so it can reliably be used
+for culling.
+
+There are times when a 2D paint box can't be determined, e.g.
+because the actor isn't yet parented under a stage or because
+the actor is unable to determine a paint volume.
+
+Since: 1.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterX11TexturePixmap
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to enable automatic updates
+<parameter name="box">
+<parameter_description> return location for a #ClutterActorBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if a 2D paint box could be determined, else
+%FALSE.
+
+</return>
</function>
-<function name="clutter_path_add_move_to">
+<function name="clutter_actor_get_paint_opacity">
<description>
-Adds a %CLUTTER_PATH_MOVE_TO type node to the path. This is usually
-used as the first node in a path. It can also be used in the middle
-of the path to cause the actor to jump to the new coordinate.
+Retrieves the absolute opacity of the actor, as it appears on the stage.
-Since: 1.0
+This function traverses the hierarchy chain and composites the opacity of
+the actor with that of its parents.
+
+This function is intended for subclasses to use in the paint virtual
+function, to paint themselves with the correct opacity.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate
+</parameters>
+<return> The actor opacity value.
+
+</return>
+</function>
+
+<function name="clutter_actor_get_paint_visibility">
+<description>
+Retrieves the 'paint' visibility of an actor recursively checking for non
+visible parents.
+
+This is by definition the same as %CLUTTER_ACTOR_IS_MAPPED.
+
+Since: 0.8.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate
+</parameters>
+<return> %TRUE if the actor is visibile and will be painted.
+
+</return>
+</function>
+
+<function name="clutter_actor_get_paint_volume">
+<description>
+Retrieves the paint volume of the passed #ClutterActor, or %NULL
+when a paint volume can't be determined.
+
+The paint volume is defined as the 3D space occupied by an actor
+when being painted.
+
+This function will call the <function>get_paint_volume()</function>
+virtual function of the #ClutterActor class. Sub-classes of #ClutterActor
+should not usually care about overriding the default implementation,
+unless they are, for instance: painting outside their allocation, or
+actors with a depth factor (not in terms of #ClutterActor:depth but real
+3D depth).
+
+<note>2D actors overriding <function>get_paint_volume()</function>
+ensure their volume has a depth of 0. (This will be true so long as
+you don't call clutter_paint_volume_set_depth().)</note>
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to a #ClutterPaintVolume,
+or %NULL if no volume could be determined. The returned pointer
+is not guaranteed to be valid across multiple frames; if you want
+to keep it, you will need to copy it using clutter_paint_volume_copy().
+
+</return>
</function>
-<function name="clutter_event_get_key_symbol">
+<function name="clutter_actor_get_pango_context">
<description>
-Retrieves the key symbol of @event
+Retrieves the #PangoContext for @self. The actor's #PangoContext
+is already configured using the appropriate font map, resolution
+and font options.
+
+Unlike clutter_actor_create_pango_context(), this context is owend
+by the #ClutterActor and it will be updated each time the options
+stored by the #ClutterBackend change.
+
+You can use the returned #PangoContext to create a #PangoLayout
+and render text using cogl_pango_render_layout() to reuse the
+glyphs cache also used by Clutter.
Since: 1.0
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS or
-of type %CLUTTER_KEY_RELEASE
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the key symbol representing the key
+<return> the #PangoContext for a #ClutterActor.
+The returned #PangoContext is owned by the actor and should not be
+unreferenced by the application code
</return>
</function>
-<function name="clutter_animatable_animate_property">
+<function name="clutter_actor_get_parent">
<description>
-Calls the animate_property() virtual function for @animatable.
+Retrieves the parent of @self.
-The @initial_value and @final_value #GValue<!-- -->s must contain
-the same type; @value must have been initialized to the same
-type of @initial_value and @final_value.
-All implementation of the #ClutterAnimatable interface must
-implement this function.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> The #ClutterActor parent, or %NULL
+if no parent is set
+</return>
+</function>
-Since: 1.0
+<function name="clutter_actor_get_pivot_point">
+<description>
+Retrieves the coordinates of the #ClutterActor:pivot-point.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="animatable">
-<parameter_description> a #ClutterAnimatable
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="pivot_x">
+<parameter_description> return location for the normalized X
+coordinate of the pivot point, or %NULL
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the animated property
+<parameter name="pivot_y">
+<parameter_description> return location for the normalized Y
+coordinate of the pivot point, or %NULL
</parameter_description>
</parameter>
-<parameter name="initial_value">
-<parameter_description> the initial value of the animation interval
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_pivot_point_z">
+<description>
+Retrieves the Z component of the #ClutterActor:pivot-point.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="final_value">
-<parameter_description> the final value of the animation interval
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_position">
+<description>
+This function tries to "do what you mean" and tell you where the
+actor is, prior to any transformations. Retrieves the fixed
+position of an actor in pixels, if one has been set; otherwise, if
+the allocation is valid, returns the actor's allocated position;
+otherwise, returns 0,0.
+
+The returned position is in pixels.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> the progress factor
+<parameter name="x">
+<parameter_description> return location for the X coordinate, or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> return location for the animation value
+<parameter name="y">
+<parameter_description> return location for the Y coordinate, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the value has been validated and can
-be applied to the #ClutterAnimatable, and %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_shader_set_vertex_source">
+<function name="clutter_actor_get_preferred_height">
<description>
-Sets the GLSL source code to be used by a #ClutterShader for the vertex
-program.
+Computes the requested minimum and natural heights for an actor,
+or if they are already computed, returns the cached values.
-Since: 0.6
+An actor may not get its request - depending on the layout
+manager that's in effect.
+
+A request should not incorporate the actor's scale or anchor point;
+those transformations do not affect layout, only rendering.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> GLSL source code.
+<parameter name="for_width">
+<parameter_description> available width to assume in computing desired height,
+or a negative value to indicate that no width is defined
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of source buffer (currently ignored)
+<parameter name="min_height_p">
+<parameter_description> return location for minimum height,
+or %NULL
+</parameter_description>
+</parameter>
+<parameter name="natural_height_p">
+<parameter_description> return location for natural
+height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_units_from_cm">
+<function name="clutter_actor_get_preferred_size">
<description>
-Stores a value in centimeters inside @units
+Computes the preferred minimum and natural size of an actor, taking into
+account the actor's geometry management (either height-for-width
+or width-for-height).
-Since: 1.2
+The width and height used to compute the preferred height and preferred
+width are the actor's natural ones.
+
+If you need to control the height for the preferred width, or the width for
+the preferred height, you should use clutter_actor_get_preferred_width()
+and clutter_actor_get_preferred_height(), and check the actor's preferred
+geometry management using the #ClutterActor:request-mode property.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="cm">
-<parameter_description> centimeters
+<parameter name="min_width_p">
+<parameter_description> return location for the minimum
+width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="min_height_p">
+<parameter_description> return location for the minimum
+height, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="natural_width_p">
+<parameter_description> return location for the natural
+width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="natural_height_p">
+<parameter_description> return location for the natural
+height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_new">
+<function name="clutter_actor_get_preferred_width">
<description>
-Creates a new #JsonNode of @type.
+Computes the requested minimum and natural widths for an actor,
+optionally depending on the specified height, or if they are
+already computed, returns the cached values.
+
+An actor may not get its request - depending on the layout
+manager that's in effect.
+A request should not incorporate the actor's scale or anchor point;
+those transformations do not affect layout, only rendering.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="type">
-<parameter_description> a #JsonNodeType
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="for_height">
+<parameter_description> available height when computing the preferred width,
+or a negative value to indicate that no height is defined
+</parameter_description>
+</parameter>
+<parameter name="min_width_p">
+<parameter_description> return location for minimum width,
+or %NULL
+</parameter_description>
+</parameter>
+<parameter name="natural_width_p">
+<parameter_description> return location for the natural
+width, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #JsonNode
-</return>
+<return></return>
</function>
-<function name="clutter_path_get_position">
+<function name="clutter_actor_get_previous_sibling">
<description>
-The value in @progress represents a position along the path where
-0.0 is the beginning and 1.0 is the end of the path. An
-interpolated position is then stored in @position.
+Retrieves the sibling of @self that comes before it in the list
+of children of @self's parent.
-Since: 1.0
+The returned pointer is only valid until the scene graph changes; it
+is not safe to modify the list of children of @self while iterating
+it.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> a position along the path as a fraction of its length
+</parameters>
+<return> a pointer to a #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_actor_get_reactive">
+<description>
+Checks whether @actor is marked as reactive.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> location to store the position
+</parameters>
+<return> %TRUE if the actor is reactive
+
+</return>
+</function>
+
+<function name="clutter_actor_get_request_mode">
+<description>
+Retrieves the geometry request mode of @self
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> index of the node used to calculate the position.
+<return> the request mode for the actor
</return>
</function>
-<function name="clutter_value_get_units">
+<function name="clutter_actor_get_rotation">
<description>
-Gets the #ClutterUnit<!-- -->s contained in @value.
+Retrieves the angle and center of rotation on the given axis,
+set using clutter_actor_set_rotation().
Since: 0.8
+Deprecated: 1.12: Use clutter_actor_get_rotation_angle() and
+clutter_actor_get_pivot_point() instead.
+
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue initialized to #CLUTTER_TYPE_UNIT
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="axis">
+<parameter_description> the axis of rotation
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return value for the X coordinate of the center of rotation
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return value for the Y coordinate of the center of rotation
+</parameter_description>
+</parameter>
+<parameter name="z">
+<parameter_description> return value for the Z coordinate of the center of rotation
</parameter_description>
</parameter>
</parameters>
-<return> the units inside the passed #GValue
+<return> the angle of rotation
</return>
</function>
-<function name="clutter_actor_animate_with_timelinev">
+<function name="clutter_actor_get_rotation_angle">
<description>
-Animates the given list of properties of @actor between the current
-value for each property and a new final value. The animation has a
-definite duration given by @timeline and a speed given by the @mode.
+Retrieves the angle of rotation set by clutter_actor_set_rotation_angle().
-See clutter_actor_animate() for further details.
+Since: 1.12
-This function is useful if you want to use an existing timeline
-to animate @actor.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="axis">
+<parameter_description> the axis of the rotation
+</parameter_description>
+</parameter>
+</parameters>
+<return> the angle of rotation, in degrees
-This is the vector-based variant of clutter_actor_animate_with_timeline(),
-useful for language bindings.
+</return>
+</function>
-<warning>Unlike clutter_actor_animate_with_timeline(), this function
-will not allow you to specify "signal::" names and callbacks.</warning>
+<function name="clutter_actor_get_scale">
+<description>
+Retrieves an actors scale factors.
-Since: 1.0
+Since: 0.2
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an animation mode logical id
+<parameter name="scale_x">
+<parameter_description> Location to store horizonal
+scale factor, or %NULL.
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="scale_y">
+<parameter_description> Location to store vertical
+scale factor, or %NULL.
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> number of property names and values
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_scale_center">
+<description>
+Retrieves the scale center coordinate in pixels relative to the top
+left corner of the actor. If the scale center was specified using a
+#ClutterGravity this will calculate the pixel offset using the
+current size of the actor.
+
+Since: 1.0
+
+Deprecated: 1.12: Use clutter_actor_get_pivot_point() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="properties">
-<parameter_description> a vector
-containing the property names to set
+<parameter name="center_x">
+<parameter_description> Location to store the X position
+of the scale center, or %NULL.
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector containing the
-property values to set
+<parameter name="center_y">
+<parameter_description> Location to store the Y position
+of the scale center, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAnimation object. The object is
-owned by the #ClutterActor and should not be unreferenced with
-g_object_unref()
+<return></return>
+</function>
+
+<function name="clutter_actor_get_scale_gravity">
+<description>
+Retrieves the scale center as a compass direction. If the scale
+center was specified in pixels or units this will return
+%CLUTTER_GRAVITY_NONE.
+
+Since: 1.0
+
+Deprecated: 1.12: Use clutter_actor_get_pivot_point() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the scale gravity
</return>
</function>
-<function name="clutter_timeline_get_direction">
+<function name="clutter_actor_get_scale_z">
<description>
-Retrieves the direction of the timeline set with
-clutter_timeline_set_direction().
+Retrieves the scaling factor along the Z axis, as set using
+clutter_actor_set_scale_z().
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the direction of the timeline
+<return> the scaling factor along the Z axis
</return>
</function>
-<function name="clutter_text_get_password_char">
+<function name="clutter_actor_get_shader">
<description>
-Retrieves the character to use in place of the actual text
-as set by clutter_text_set_password_char().
+Queries the currently set #ClutterShader on @self.
-Since: 1.0
+Since: 0.6
+
+Deprecated: 1.8: Use clutter_actor_get_effect() instead.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a Unicode character or 0 if the password
-character is not set
+<return> The currently set #ClutterShader
+or %NULL if no shader is set.
</return>
</function>
-<function name="clutter_get_option_group_without_init">
+<function name="clutter_actor_get_size">
<description>
-Returns a #GOptionGroup for the command line arguments recognized
-by Clutter. You should add this group to your #GOptionContext with
-g_option_context_add_group(), if you are using g_option_context_parse()
-to parse your commandline arguments. Unlike clutter_get_option_group(),
-calling g_option_context_parse() with the #GOptionGroup returned by this
-function requires a subsequent explicit call to clutter_init(); use this
-function when needing to set foreign display connection with
-clutter_x11_set_display(), or with gtk_clutter_init().
+This function tries to "do what you mean" and return
+the size an actor will have. If the actor has a valid
+allocation, the allocation will be returned; otherwise,
+the actors natural size request will be returned.
-Since: 0.8.2
+If you care whether you get the request vs. the allocation, you
+should probably call a different function like
+clutter_actor_get_allocation_box() or
+clutter_actor_get_preferred_width().
+
+Since: 0.2
</description>
<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> return location for the width, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the height, or %NULL.
+</parameter_description>
+</parameter>
</parameters>
-<return> a #GOptionGroup for the commandline arguments
-recognized by Clutter
+<return></return>
+</function>
+
+<function name="clutter_actor_get_stage">
+<description>
+Retrieves the #ClutterStage where @actor is contained.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the stage
+containing the actor, or %NULL
</return>
</function>
-<function name="clutter_text_get_font_name">
+<function name="clutter_actor_get_text_direction">
<description>
-Retrieves the font name as set by clutter_text_set_font_name().
+Retrieves the value set using clutter_actor_set_text_direction()
-Since: 1.0
+If no text direction has been previously set, the default text
+direction, as returned by clutter_get_default_text_direction(), will
+be returned instead
+
+Since: 1.2
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the font name. The returned
-string is owned by the #ClutterText actor and should not be
-modified or freed
+<return> the #ClutterTextDirection for the actor
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_direction">
+<function name="clutter_actor_get_transform">
<description>
-Retrieves the #ClutterRotateDirection used by the ellipse behaviour.
+Retrieves the current transformation matrix of a #ClutterActor.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="transform">
+<parameter_description> a #ClutterMatrix
</parameter_description>
</parameter>
</parameters>
-<return> the rotation direction
+<return></return>
+</function>
+
+<function name="clutter_actor_get_transformation_matrix">
+<description>
+Retrieves the transformations applied to @self relative to its
+parent.
+
+Since: 1.0
+
+Deprecated: 1.12: Use clutter_actor_get_transform() instead
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="matrix">
+<parameter_description> the return location for a #ClutterMatrix
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_transformed_paint_volume">
+<description>
+Retrieves the 3D paint volume of an actor like
+clutter_actor_get_paint_volume() does (Please refer to the
+documentation of clutter_actor_get_paint_volume() for more
+details.) and it additionally transforms the paint volume into the
+coordinate space of @relative_to_ancestor. (Or the stage if %NULL
+is passed for @relative_to_ancestor)
+
+This can be used by containers that base their paint volume on
+the volume of their children. Such containers can query the
+transformed paint volume of all of its children and union them
+together using clutter_paint_volume_union().
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="relative_to_ancestor">
+<parameter_description> A #ClutterActor that is an ancestor of @self
+(or %NULL for the stage)
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a #ClutterPaintVolume,
+or %NULL if no volume could be determined. The returned pointer is
+not guaranteed to be valid across multiple frames; if you wish to
+keep it, you will have to copy it using clutter_paint_volume_copy().
</return>
</function>
-<function name="clutter_x11_texture_pixmap_set_pixmap">
+<function name="clutter_actor_get_transformed_position">
<description>
-Sets the X Pixmap to which the texture should be bound.
+Gets the absolute position of an actor, in pixels relative to the stage.
Since: 0.8
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> the texture to bind
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> the X Pixmap to which the texture should be bound
+<parameter name="x">
+<parameter_description> return location for the X coordinate, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for the Y coordinate, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_init_with_args">
+<function name="clutter_actor_get_transformed_size">
<description>
-This function does the same work as clutter_init(). Additionally,
-it allows you to add your own command line options, and it
-automatically generates nicely formatted <option>--help</option>
-output. Note that your program will be terminated after writing
-out the help output. Also note that, in case of error, the
-error message will be placed inside @error instead of being
-printed on the display.
+Gets the absolute size of an actor in pixels, taking into account the
+scaling factors.
-Since: 0.2
+If the actor has a valid allocation, the allocated size will be used.
+If the actor has not a valid allocation then the preferred size will
+be transformed and returned.
+
+If you want the transformed allocation, see
+clutter_actor_get_abs_allocation_vertices() instead.
+
+<note>When the actor (or one of its ancestors) is rotated around the
+X or Y axis, it no longer appears as on the stage as a rectangle, but
+as a generic quadrangle; in that case this function returns the size
+of the smallest rectangle that encapsulates the entire quad. Please
+note that in this case no assumptions can be made about the relative
+position of this envelope to the absolute position of the actor, as
+returned by clutter_actor_get_transformed_position(); if you need this
+information, you need to use clutter_actor_get_abs_allocation_vertices()
+to get the coords of the actual quadrangle.</note>
+
+Since: 0.8
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> a pointer to the number of command line arguments
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> a pointer to the array
-of command line arguments
+<parameter name="width">
+<parameter_description> return location for the width, or %NULL
</parameter_description>
</parameter>
-<parameter name="parameter_string">
-<parameter_description> a string which is displayed in the
-first line of <option>--help</option> output, after
-<literal><replaceable>programname</replaceable> [OPTION...]</literal>
+<parameter name="height">
+<parameter_description> return location for the height, or %NULL
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> a %NULL terminated array of #GOptionEntry<!-- -->s
-describing the options of your program
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_get_transition">
+<description>
+Retrieves the #ClutterTransition of a #ClutterActor by using the
+transition @name.
+
+Transitions created for animatable properties use the name of the
+property itself, for instance the code below:
+
+|[
+clutter_actor_set_easing_duration (actor, 1000);
+clutter_actor_set_rotation (actor, CLUTTER_Y_AXIS, 360.0, x, y, z);
+
+transition = clutter_actor_get_transition (actor, "rotation-angle-y");
+g_signal_connect (transition, "stopped",
+G_CALLBACK (on_transition_stopped),
+actor);
+]|
+
+will call the <function>on_transition_stopped</function> callback when
+the transition is finished.
+
+If you just want to get notifications of the completion of a transition,
+you should use the #ClutterActor::transition-stopped signal, using the
+transition name as the signal detail.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="translation_domain">
-<parameter_description> a translation domain to use for
-translating the <option>--help</option> output for the options in
- entries with gettext(), or %NULL
+<parameter name="name">
+<parameter_description> the name of the transition
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a return location for a #GError
+</parameters>
+<return> a #ClutterTransition, or %NULL is none
+was found to match the passed name; the returned instance is owned
+by Clutter and it should not be freed
+
+</return>
+</function>
+
+<function name="clutter_actor_get_translation">
+<description>
+Retrieves the translation set using clutter_actor_set_translation().
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="translate_x">
+<parameter_description> return location for the X component
+of the translation, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="translate_y">
+<parameter_description> return location for the Y component
+of the translation, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="translate_z">
+<parameter_description> return location for the Z component
+of the translation, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %CLUTTER_INIT_SUCCESS if Clutter has been successfully
-initialised, or other values or #ClutterInitError in case of
-error.
+<return></return>
+</function>
+
+<function name="clutter_actor_get_width">
+<description>
+Retrieves the width of a #ClutterActor.
+
+If the actor has a valid allocation, this function will return the
+width of the allocated area given to the actor.
+
+If the actor does not have a valid allocation, this function will
+return the actor's natural width, that is the preferred width of
+the actor.
+
+If you care whether you get the preferred width or the width that
+has been assigned to the actor, you should probably call a different
+function like clutter_actor_get_allocation_box() to retrieve the
+allocated size or clutter_actor_get_preferred_width() to retrieve the
+preferred width.
+
+If an actor has a fixed width, for instance a width that has been
+assigned using clutter_actor_set_width(), the width returned will
+be the same value.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the width of the actor, in pixels
</return>
</function>
-<function name="clutter_text_set_single_line_mode">
+<function name="clutter_actor_get_x">
<description>
-Sets whether a #ClutterText actor should be in single line mode
-or not.
+Retrieves the X coordinate of a #ClutterActor.
-A text actor in single line mode will not wrap text and will clip
-the the visible area to the predefined size. The contents of the
-text actor will scroll to display the end of the text if its length
-is bigger than the allocated width.
+This function tries to "do what you mean", by returning the
+correct value depending on the actor's state.
-When setting the single line mode the #ClutterText:activatable
-property is also set as a side effect. Instead of entering a new
-line character, the text actor will emit the #ClutterText::activate
-signal.
+If the actor has a valid allocation, this function will return
+the X coordinate of the origin of the allocation box.
+
+If the actor has any fixed coordinate set using clutter_actor_set_x(),
+clutter_actor_set_position() or clutter_actor_set_geometry(), this
+function will return that coordinate.
+
+If both the allocation and a fixed position are missing, this function
+will return 0.
-Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="single_line">
-<parameter_description> whether to enable single line mode
+</parameters>
+<return> the X coordinate, in pixels, ignoring any
+transformation (i.e. scaling, rotation)
+</return>
+</function>
+
+<function name="clutter_actor_get_x_align">
+<description>
+Retrieves the horizontal alignment policy set using
+clutter_actor_set_x_align().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal alignment policy.
+
+</return>
</function>
-<function name="clutter_behaviour_remove">
+<function name="clutter_actor_get_x_expand">
<description>
-Removes @actor from the list of #ClutterActor<!-- -->s to which
- behave applies. This function removes a reference on the actor.
+Retrieves the value set with clutter_actor_set_x_expand().
-Since: 0.2
+See also: clutter_actor_needs_expand()
+
+Since: 1.12
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
+</parameters>
+<return> %TRUE if the actor has been set to expand
+
+</return>
+</function>
+
+<function name="clutter_actor_get_y">
+<description>
+Retrieves the Y coordinate of a #ClutterActor.
+
+This function tries to "do what you mean", by returning the
+correct value depending on the actor's state.
+
+If the actor has a valid allocation, this function will return
+the Y coordinate of the origin of the allocation box.
+
+If the actor has any fixed coordinate set using clutter_actor_set_y(),
+clutter_actor_set_position() or clutter_actor_set_geometry(), this
+function will return that coordinate.
+
+If both the allocation and a fixed position are missing, this function
+will return 0.
+
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the Y coordinate, in pixels, ignoring any
+transformation (i.e. scaling, rotation)
+</return>
+</function>
+
+<function name="clutter_actor_get_y_align">
+<description>
+Retrieves the vertical alignment policy set using
+clutter_actor_set_y_align().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the vertical alignment policy.
+
+</return>
</function>
-<function name="clutter_actor_unrealize">
+<function name="clutter_actor_get_y_expand">
<description>
-Frees up any underlying graphics resources needed by the actor to
-be displayed.
+Retrieves the value set with clutter_actor_set_y_expand().
-Unrealization means the actor is now independent of any specific
-rendering context (is not attached to a specific toplevel stage).
+See also: clutter_actor_needs_expand()
-Because mapped actors must be realized, actors may not be
-unrealized if they are mapped. This function hides the actor to be
-sure it isn't mapped, an application-visible side effect that you
-may not be expecting.
+Since: 1.12
-This function should not really be in the public API, because
-there isn't a good reason to call it. ClutterActor will already
-unrealize things for you when it's important to do so.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor has been set to expand
-If you were using clutter_actor_unrealize() in a dispose
-implementation, then don't, just chain up to ClutterActor's
-dispose.
+</return>
+</function>
-If you were using clutter_actor_unrealize() to implement
-unrealizing children of your container, then don't, ClutterActor
-will already take care of that.
+<function name="clutter_actor_get_z_position">
+<description>
+Retrieves the actor's position on the Z axis.
-If you were using clutter_actor_unrealize() to re-realize to
-create your resources in a different way, then use
-_clutter_actor_rerealize() (inside Clutter) or just call your
-code that recreates your resources directly (outside Clutter).
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the position on the Z axis.
+
+</return>
+</function>
+
+<function name="clutter_actor_get_z_rotation_gravity">
+<description>
+Retrieves the center for the rotation around the Z axis as a
+compass direction. If the center was specified in pixels or units
+this will return %CLUTTER_GRAVITY_NONE.
+
+Since: 1.0
+
+Deprecated: 1.12: Use the #ClutterActor:pivot-point instead of
+a #ClutterGravity
</description>
<parameters>
@@ -3538,56 +8989,79 @@ code that recreates your resources directly (outside Clutter).
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the Z rotation center
+
+</return>
</function>
-<function name="clutter_actor_push_internal">
+<function name="clutter_actor_grab_key_focus">
<description>
-Should be used by actors implementing the #ClutterContainer and with
-internal children added through clutter_actor_set_parent(), for instance:
+Sets the key focus of the #ClutterStage including @self
+to this #ClutterActor.
-|[
-static void
-my_actor_init (MyActor *self)
-{
-self->priv = SELF_ACTOR_GET_PRIVATE (self);
+Since: 1.0
-clutter_actor_push_internal (CLUTTER_ACTOR (self));
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-/ * calling clutter_actor_set_parent() now will result in
-* the internal flag being set on a child of MyActor
-* /
+<function name="clutter_actor_has_actions">
+<description>
+Returns whether the actor has any actions applied.
-/ * internal child: a background texture * /
-self->priv->background_tex = clutter_texture_new ();
-clutter_actor_set_parent (self->priv->background_tex,
-CLUTTER_ACTOR (self));
+Since: 1.10
-/ * internal child: a label * /
-self->priv->label = clutter_text_new ();
-clutter_actor_set_parent (self->priv->label,
-CLUTTER_ACTOR (self));
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor has any actions,
+%FALSE otherwise
-clutter_actor_pop_internal (CLUTTER_ACTOR (self));
+</return>
+</function>
-/ * calling clutter_actor_set_parent() now will not result in
-* the internal flag being set on a child of MyActor
-* /
-}
-]|
+<function name="clutter_actor_has_allocation">
+<description>
+Checks if the actor has an up-to-date allocation assigned to
+it. This means that the actor should have an allocation: it's
+visible and has a parent. It also means that there is no
+outstanding relayout request in progress for the actor or its
+children (There might be other outstanding layout requests in
+progress that will cause the actor to get a new allocation
+when the stage is laid out, however).
-This function will be used by Clutter to toggle an "internal child"
-flag whenever clutter_actor_set_parent() is called; internal children
-are handled differently by Clutter, specifically when destroying their
-parent.
+If this function returns %FALSE, then the actor will normally
+be allocated before it is next drawn on the screen.
-Call clutter_actor_pop_internal() when you finished adding internal
-children.
+Since: 1.4
-Nested calls to clutter_actor_push_internal() are allowed, but each
-one must by followed by a clutter_actor_pop_internal() call.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor has an up-to-date allocation
-Since: 1.2
+</return>
+</function>
+
+<function name="clutter_actor_has_clip">
+<description>
+Determines whether the actor has a clip area set or not.
+
+Since: 0.1.1
</description>
<parameters>
@@ -3596,303 +9070,532 @@ Since: 1.2
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the actor has a clip area set.
+
+</return>
</function>
-<function name="clutter_units_to_pixels">
+<function name="clutter_actor_has_constraints">
<description>
-Converts a value in #ClutterUnits to pixels
+Returns whether the actor has any constraints applied.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="units">
-<parameter_description> units to convert
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the value in pixels
+<return> %TRUE if the actor has any constraints,
+%FALSE otherwise
</return>
</function>
-<function name="json_array_add_array_element">
+<function name="clutter_actor_has_effects">
<description>
-Conveniently adds an array into @array. The @array takes ownership
-of the newly added #JsonArray
+Returns whether the actor has any effects applied.
-See also: json_array_add_element(), json_node_take_array()
+Since: 1.10
-Since: 0.8
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor has any effects,
+%FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_actor_has_key_focus">
+<description>
+Checks whether @self is the #ClutterActor that has key focus
+
+Since: 1.4
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #JsonArray
+</parameters>
+<return> %TRUE if the actor has key focus, and %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_actor_has_mapped_clones">
+<description>
+Returns whether the actor has any mapped clones.
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_util_next_p2">
+<function name="clutter_actor_has_overlaps">
<description>
-Calculates the nearest power of two, greater than or equal to @a.
+Asks the actor's implementation whether it may contain overlapping
+primitives.
-Deprecated: 1.2
+For example; Clutter may use this to determine whether the painting
+should be redirected to an offscreen buffer to correctly implement
+the opacity property.
+
+Custom actors can override the default response by implementing the
+#ClutterActor <function>has_overlaps</function> virtual function. See
+clutter_actor_set_offscreen_redirect() for more information.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="a">
-<parameter_description> Value to get the next power
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> The nearest power of two, greater or equal to @a.
+<return> %TRUE if the actor may have overlapping primitives, and
+%FALSE otherwise
</return>
</function>
-<function name="clutter_box_layout_pack">
+<function name="clutter_actor_has_pointer">
<description>
-Packs @actor inside the #ClutterContainer associated to @layout
-and sets the layout properties
+Checks whether an actor contains the pointer of a
+#ClutterInputDevice
Since: 1.2
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
-</parameter_description>
-</parameter>
-<parameter name="actor">
+<parameter name="self">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> whether the @actor should expand
+</parameters>
+<return> %TRUE if the actor contains the pointer, and
+%FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_actor_hide">
+<description>
+Flags an actor to be hidden. A hidden actor will not be
+rendered on the stage.
+
+Actors are visible by default.
+
+If this function is called on an actor without a parent, the
+#ClutterActor:show-on-set-parent property will be set to %FALSE
+as a side-effect.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x_fill">
-<parameter_description> whether the @actor should fill horizontally
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_hide_all">
+<description>
+Calls clutter_actor_hide() on all child actors (if any).
+
+Since: 0.2
+
+Deprecated: 1.10: Using clutter_actor_hide() on the actor will
+prevent its children from being painted as well.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y_fill">
-<parameter_description> whether the @actor should fill vertically
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_insert_child_above">
+<description>
+Inserts @child into the list of children of @self, above another
+child of @self or, if @sibling is %NULL, above all the children
+of @self.
+
+This function will acquire a reference on @child that will only
+be released when calling clutter_actor_remove_child().
+
+This function will not take into consideration the #ClutterActor:depth
+of @child.
+
+This function will emit the #ClutterContainer::actor-added signal
+on @self.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> the horizontal alignment policy for @actor
+<parameter name="child">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> the vertical alignment policy for @actor
+<parameter name="sibling">
+<parameter_description> a child of @self, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_add_object_element">
+<function name="clutter_actor_insert_child_at_index">
<description>
-Conveniently adds an object into @array. The @array takes ownership
-of the newly added #JsonObject
+Inserts @child into the list of children of @self, using the
+given @index_. If @index_ is greater than the number of children
+in @self, or is less than 0, then the new child is added at the end.
-See also: json_array_add_element(), json_node_take_object()
+This function will acquire a reference on @child that will only
+be released when calling clutter_actor_remove_child().
-Since: 0.8
+This function will not take into consideration the #ClutterActor:depth
+of @child.
+
+This function will emit the #ClutterContainer::actor-added signal
+on @self.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #JsonObject
+<parameter name="child">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_get_array_member">
+<function name="clutter_actor_insert_child_below">
<description>
-Convenience function that retrieves the array
-stored in @member_name of @object
+Inserts @child into the list of children of @self, below another
+child of @self or, if @sibling is %NULL, below all the children
+of @self.
-See also: json_object_get_member()
+This function will acquire a reference on @child that will only
+be released when calling clutter_actor_remove_child().
-Since: 0.8
+This function will not take into consideration the #ClutterActor:depth
+of @child.
+
+This function will emit the #ClutterContainer::actor-added signal
+on @self.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="child">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a child of @self, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_is_in_clone_paint">
+<description>
+Checks whether @self is being currently painted by a #ClutterClone
+
+This function is useful only inside the ::paint virtual function
+implementations or within handlers for the #ClutterActor::paint
+signal
+
+This function should not be used by applications
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the array inside the object's member
+<return> %TRUE if the #ClutterActor is currently being painted
+by a #ClutterClone, and %FALSE otherwise
</return>
</function>
-<function name="clutter_behaviour_apply">
+<function name="clutter_actor_is_rotated">
<description>
-Applies @behave to @actor. This function adds a reference on
-the actor.
+Checks whether any rotation is applied to the actor.
-Since: 0.2
+Since: 0.6
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
+</parameters>
+<return> %TRUE if the actor is rotated.
+
+</return>
+</function>
+
+<function name="clutter_actor_is_scaled">
+<description>
+Checks whether the actor is scaled in either dimension.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="self">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the actor is scaled.
+
+</return>
</function>
-<function name="clutter_x11_disable_event_retrieval">
+<function name="clutter_actor_iter_destroy">
<description>
-Disables retrieval of X events in the main loop. Use to create event-less
-canvas or in conjunction with clutter_x11_handle_event.
+Safely destroys the #ClutterActor currently pointer to by the iterator
+from its parent.
-This function can only be called before calling clutter_init().
+This function can only be called after clutter_actor_iter_next() or
+clutter_actor_iter_prev() returned %TRUE, and cannot be called more
+than once for the same actor.
-Since: 0.8
+This function will call clutter_actor_destroy() internally.
+
+Since: 1.10
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_opacity">
+<function name="clutter_actor_iter_init">
<description>
-Sets the actor's opacity, with zero being completely transparent and
-255 (0xff) being fully opaque.
+Initializes a #ClutterActorIter, which can then be used to iterate
+efficiently over a section of the scene graph, and associates it
+with @root.
+
+Modifying the scene graph section that contains @root will invalidate
+the iterator.
+
+|[
+ClutterActorIter iter;
+ClutterActor *child;
+
+clutter_actor_iter_init (&iter, container);
+while (clutter_actor_iter_next (&iter, &child))
+{
+/ * do something with child * /
+}
+]|
+
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
</parameter_description>
</parameter>
-<parameter name="opacity">
-<parameter_description> New opacity value for the actor.
+<parameter name="root">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_paint_opacity">
+<function name="clutter_actor_iter_is_valid">
<description>
-Retrieves the absolute opacity of the actor, as it appears on the stage.
-
-This function traverses the hierarchy chain and composites the opacity of
-the actor with that of its parents.
+Checks whether a #ClutterActorIter is still valid.
-This function is intended for subclasses to use in the paint virtual
-function, to paint themselves with the correct opacity.
+An iterator is considered valid if it has been initialized, and
+if the #ClutterActor that it refers to hasn't been modified after
+the initialization.
-Since: 0.8
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
</parameter_description>
</parameter>
</parameters>
-<return> The actor opacity value.
+<return> %TRUE if the iterator is valid, and %FALSE otherwise
</return>
</function>
-<function name="clutter_text_new_with_text">
+<function name="clutter_actor_iter_next">
<description>
-Creates a new #ClutterText actor, using @font_name as the font
-description; @text will be used to set the contents of the actor.
+Advances the @iter and retrieves the next child of the root #ClutterActor
+that was used to initialize the #ClutterActorIterator.
-This function is equivalent to calling clutter_text_new(),
-clutter_text_set_font_name(), and clutter_text_set_text().
+If the iterator can advance, this function returns %TRUE and sets the
+ child argument.
-Since: 1.0
+If the iterator cannot advance, this function returns %FALSE, and
+the contents of @child are undefined.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="font_name">
-<parameter_description> a string with a font description
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the contents of the actor
+<parameter name="child">
+<parameter_description> return location for a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterText actor
+<return> %TRUE if the iterator could advance, and %FALSE otherwise.
</return>
</function>
-<function name="clutter_input_device_get_pointer_actor">
+<function name="clutter_actor_iter_prev">
<description>
-Retrieves the #ClutterActor underneath the pointer of @device
+Advances the @iter and retrieves the previous child of the root
+#ClutterActor that was used to initialize the #ClutterActorIterator.
-Since: 1.2
+If the iterator can advance, this function returns %TRUE and sets the
+ child argument.
+
+If the iterator cannot advance, this function returns %FALSE, and
+the contents of @child are undefined.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> return location for a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the #ClutterActor or %NULL
+<return> %TRUE if the iterator could advance, and %FALSE otherwise.
</return>
</function>
-<function name="json_node_get_value_type">
+<function name="clutter_actor_iter_remove">
<description>
-Returns the #GType of the payload of the node.
+Safely removes the #ClutterActor currently pointer to by the iterator
+from its parent.
-Since: 0.4
+This function can only be called after clutter_actor_iter_next() or
+clutter_actor_iter_prev() returned %TRUE, and cannot be called more
+than once for the same actor.
+
+This function will call clutter_actor_remove_child() internally.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="iter">
+<parameter_description> a #ClutterActorIter
</parameter_description>
</parameter>
</parameters>
-<return> a #GType for the payload.
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_lower">
+<description>
+Puts @self below @above.
+
+Both actors must have the same parent, and the parent must implement
+the #ClutterContainer interface.
+
+This function calls clutter_container_lower_child() internally.
+
+Deprecated: 1.10: Use clutter_actor_set_child_below_sibling() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="above">
+<parameter_description> A #ClutterActor to lower below
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_raise_top">
+<function name="clutter_actor_lower_bottom">
<description>
-Raises @self to the top.
+Lowers @self to the bottom.
-This function calls clutter_actor_raise() internally.
+This function calls clutter_actor_lower() internally.
+
+Deprecated: 1.10: Use clutter_actor_set_child_below_sibling() with
+a %NULL sibling, instead.
</description>
<parameters>
@@ -3904,97 +9607,139 @@ This function calls clutter_actor_raise() internally.
<return></return>
</function>
-<function name="clutter_vertex_free">
+<function name="clutter_actor_map">
<description>
-Frees a #ClutterVertex allocated using clutter_vertex_copy()
+Sets the %CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps
+and realizes its children if they are visible. Does nothing if the
+actor is not visible.
+
+Calling this function is strongly disencouraged: the default
+implementation of #ClutterActorClass.map() will map all the children
+of an actor when mapping its parent.
+
+When overriding map, it is mandatory to chain up to the parent
+implementation.
Since: 1.0
</description>
<parameters>
-<parameter name="vertex">
-<parameter_description> a #ClutterVertex
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_set_loop">
+<function name="clutter_actor_meta_get_actor">
<description>
-Sets whether @score should loop. A looping #ClutterScore will start
-from its initial state after the ::complete signal has been fired.
+Retrieves a pointer to the #ClutterActor that owns @meta
-Since: 0.6
+Since: 1.4
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="meta">
+<parameter_description> a #ClutterActorMeta
</parameter_description>
</parameter>
-<parameter name="loop">
-<parameter_description> %TRUE for enable looping
+</parameters>
+<return> a pointer to a #ClutterActor or %NULL
+
+</return>
+</function>
+
+<function name="clutter_actor_meta_get_enabled">
+<description>
+Retrieves whether @meta is enabled
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="meta">
+<parameter_description> a #ClutterActorMeta
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the #ClutterActorMeta instance is enabled
+
+</return>
</function>
-<function name="clutter_interval_get_initial_value">
+<function name="clutter_actor_meta_get_name">
<description>
-Retrieves the initial value of @interval and copies
-it into @value.
+Retrieves the name set using clutter_actor_meta_set_name()
-The passed #GValue must be initialized to the value held by
-the #ClutterInterval.
+Since: 1.4
-Since: 1.0
+</description>
+<parameters>
+<parameter name="meta">
+<parameter_description> a #ClutterActorMeta
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the #ClutterActorMeta
+instance, or %NULL if none was set. The returned string is owned
+by the #ClutterActorMeta instance and it should not be modified
+or freed
+
+</return>
+</function>
+
+<function name="clutter_actor_meta_set_enabled">
+<description>
+Sets whether @meta should be enabled or not
+
+Since: 1.4
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="meta">
+<parameter_description> a #ClutterActorMeta
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="is_enabled">
+<parameter_description> whether @meta is enabled
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_set_orientation">
+<function name="clutter_actor_meta_set_name">
<description>
-Sets the orientation of the flow layout
+Sets the name of @meta
-The orientation controls the direction used to allocate
-the children: either horizontally or vertically. The
-orientation also controls the direction of the overflowing
+The name can be used to identify the #ClutterActorMeta instance
-Since: 1.2
+Since: 1.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="meta">
+<parameter_description> a #ClutterActorMeta
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> the orientation of the layout
+<parameter name="name">
+<parameter_description> the name of @meta
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_anchor_point">
+<function name="clutter_actor_move_anchor_point">
<description>
-Gets the current anchor point of the @actor in pixels.
+Sets an anchor point for the actor, and adjusts the actor postion so that
+the relative position of the actor toward its parent remains the same.
Since: 0.6
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead.
+
</description>
<parameters>
<parameter name="self">
@@ -4002,459 +9747,1009 @@ Since: 0.6
</parameter_description>
</parameter>
<parameter name="anchor_x">
-<parameter_description> return location for the X coordinate of the anchor point
+<parameter_description> X coordinate of the anchor point
</parameter_description>
</parameter>
<parameter name="anchor_y">
-<parameter_description> return location for the Y coordinate of the anchor point
+<parameter_description> Y coordinate of the anchor point
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_set_alignment">
+<function name="clutter_actor_move_anchor_point_from_gravity">
<description>
-Sets the horizontal and vertical alignment policies for @actor
-inside @layout
+Sets an anchor point on the actor based on the given gravity, adjusting the
+actor postion so that its relative position within its parent remains
+unchanged.
-Since: 1.2
+Since version 1.0 the anchor point will be stored as a gravity so
+that if the actor changes size then the anchor point will move. For
+example, if you set the anchor point to %CLUTTER_GRAVITY_SOUTH_EAST
+and later double the size of the actor, the anchor point will move
+to the bottom right.
+
+Since: 0.6
+
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @layout
+<parameter name="gravity">
+<parameter_description> #ClutterGravity.
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> Horizontal alignment policy for @actor
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_move_by">
+<description>
+Moves an actor by the specified distance relative to its current
+position in pixels.
+
+This function modifies the fixed position of an actor and thus removes
+it from any layout management. Another way to move an actor is with an
+anchor point, see clutter_actor_set_anchor_point(), or with an additional
+translation, using clutter_actor_set_translation().
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> Vertical alignment policy for @actor
+<parameter name="dx">
+<parameter_description> Distance to move Actor on X axis.
+</parameter_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> Distance to move Actor on Y axis.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_grab_keyboard">
+<function name="clutter_actor_needs_expand">
<description>
-Grabs keyboard events, after the grab is done keyboard
-events (#ClutterActor::key-press-event and #ClutterActor::key-release-event)
-are delivered to this actor directly. The source set in the event will be
-the actor that would have received the event if the keyboard grab was not
-in effect.
+Checks whether an actor, or any of its children, is set to expand
+horizontally or vertically.
-Like pointer grabs, keyboard grabs should only be used as a last
-resource.
+This function should only be called by layout managers that can
+assign extra space to their children.
-See also clutter_stage_set_key_focus() and clutter_actor_grab_key_focus()
-to perform a "soft" key grab and assign key focus to a specific actor.
+If you want to know whether the actor was explicitly set to expand,
+use clutter_actor_get_x_expand() or clutter_actor_get_y_expand().
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="actor">
+<parameter name="self">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
+<parameter name="orientation">
+<parameter_description> the direction of expansion
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor should expand
+
+</return>
+</function>
+
+<function name="clutter_actor_new">
+<description>
+Creates a new #ClutterActor.
+
+A newly created actor has a floating reference, which will be sunk
+when it is added to another actor.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterActor
+
+</return>
+</function>
+
+<function name="clutter_actor_paint">
+<description>
+Renders the actor to display.
+
+This function should not be called directly by applications.
+Call clutter_actor_queue_redraw() to queue paints, instead.
+
+This function is context-aware, and will either cause a
+regular paint or a pick paint.
+
+This function will emit the #ClutterActor::paint signal or
+the #ClutterActor::pick signal, depending on the context.
+
+This function does not paint the actor if the actor is set to 0,
+unless it is performing a pick paint.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_get_filter_set">
+<function name="clutter_actor_pop_internal">
<description>
-Returns whether the @model has a filter in place, set
-using clutter_model_set_filter()
+Disables the effects of clutter_actor_push_internal().
-Since: 1.0
+Since: 1.2
+
+Deprecated: 1.10: All children of an actor are accessible through
+the #ClutterActor API. This function is only useful for legacy
+containers overriding the default implementation of the
+#ClutterContainer interface.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a filter is set
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_push_internal">
+<description>
+Should be used by actors implementing the #ClutterContainer and with
+internal children added through clutter_actor_set_parent(), for instance:
+
+|[
+static void
+my_actor_init (MyActor *self)
+{
+self->priv = my_actor_get_instance_private (self);
+
+clutter_actor_push_internal (CLUTTER_ACTOR (self));
+
+/ * calling clutter_actor_set_parent() now will result in
+* the internal flag being set on a child of MyActor
+* /
+
+/ * internal child - a background texture * /
+self->priv->background_tex = clutter_texture_new ();
+clutter_actor_set_parent (self->priv->background_tex,
+CLUTTER_ACTOR (self));
+
+/ * internal child - a label * /
+self->priv->label = clutter_text_new ();
+clutter_actor_set_parent (self->priv->label,
+CLUTTER_ACTOR (self));
+
+clutter_actor_pop_internal (CLUTTER_ACTOR (self));
+
+/ * calling clutter_actor_set_parent() now will not result in
+* the internal flag being set on a child of MyActor
+* /
+}
+]|
+
+This function will be used by Clutter to toggle an "internal child"
+flag whenever clutter_actor_set_parent() is called; internal children
+are handled differently by Clutter, specifically when destroying their
+parent.
+
+Call clutter_actor_pop_internal() when you finished adding internal
+children.
+
+Nested calls to clutter_actor_push_internal() are allowed, but each
+one must by followed by a clutter_actor_pop_internal() call.
+
+Since: 1.2
+
+Deprecated: 1.10: All children of an actor are accessible through
+the #ClutterActor API, and #ClutterActor implements the
+#ClutterContainer interface, so this function is only useful
+for legacy containers overriding the default implementation.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_timeline_start">
+<function name="clutter_actor_queue_redraw">
<description>
-Starts the #ClutterTimeline playing.
+Queues up a redraw of an actor and any children. The redraw occurs
+once the main loop becomes idle (after the current batch of events
+has been processed, roughly).
+
+Applications rarely need to call this, as redraws are handled
+automatically by modification functions.
+
+This function will not do anything if @self is not visible, or
+if the actor is inside an invisible part of the scenegraph.
+
+Also be aware that painting is a NOP for actors with an opacity of
+0
+
+When you are implementing a custom actor you must queue a redraw
+whenever some private state changes that will affect painting or
+picking of your actor.
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_get_double_member">
+<function name="clutter_actor_queue_redraw_with_clip">
<description>
-Convenience function that retrieves the floating point value
-stored in @member_name of @object
+Queues a redraw on @self limited to a specific, actor-relative
+rectangular area.
-See also: json_object_get_member()
+If @clip is %NULL this function is equivalent to
+clutter_actor_queue_redraw().
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="clip">
+<parameter_description> a rectangular clip region, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the floating point value of the object's member
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_queue_relayout">
+<description>
+Indicates that the actor's size request or other layout-affecting
+properties may have changed. This function is used inside #ClutterActor
+subclass implementations, not by applications directly.
+
+Queueing a new layout automatically queues a redraw as well.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_media_set_subtitle_uri">
+<function name="clutter_actor_raise">
<description>
-Sets the location of a subtitle file to display while playing @media.
+Puts @self above @below.
-Since: 1.2
+Both actors must have the same parent, and the parent must implement
+the #ClutterContainer interface
+
+This function calls clutter_container_raise_child() internally.
+
+Deprecated: 1.10: Use clutter_actor_set_child_above_sibling() instead.
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> the URI of a subtitle file
+<parameter name="below">
+<parameter_description> A #ClutterActor to raise above.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_get_actor_at_pos">
+<function name="clutter_actor_raise_top">
<description>
-Checks the scene at the coordinates @x and @y and returns a pointer
-to the #ClutterActor at those coordinates.
+Raises @self to the top.
-By using @pick_mode it is possible to control which actors will be
-painted and thus available.
+This function calls clutter_actor_raise() internally.
+Deprecated: 1.10: Use clutter_actor_set_child_above_sibling() with
+a %NULL sibling, instead.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="pick_mode">
-<parameter_description> how the scene graph should be painted
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_realize">
+<description>
+Realization informs the actor that it is attached to a stage. It
+can use this to allocate resources if it wanted to delay allocation
+until it would be rendered. However it is perfectly acceptable for
+an actor to create resources before being realized because Clutter
+only ever has a single rendering context so that actor is free to
+be moved from one stage to another.
+
+This function does nothing if the actor is already realized.
+
+Because a realized actor must have realized parent actors, calling
+clutter_actor_realize() will also realize all parents of the actor.
+
+This function does not realize child actors, except in the special
+case that realizing the stage, when the stage is visible, will
+suddenly map (and thus realize) the children of the stage.
+
+Deprecated: 1.16: Actors are automatically realized, and nothing
+requires explicit realization.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate to check
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_remove_action">
+<description>
+Removes @action from the list of actions applied to @self
+
+The reference held by @self on the #ClutterAction will be released
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate to check
+<parameter name="action">
+<parameter_description> a #ClutterAction
</parameter_description>
</parameter>
</parameters>
-<return> the actor at the specified coordinates,
-if any
-</return>
+<return></return>
</function>
-<function name="clutter_animation_get_object">
+<function name="clutter_actor_remove_action_by_name">
<description>
-Retrieves the #GObject attached to @animation.
+Removes the #ClutterAction with the given name from the list
+of actions applied to @self
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the action to remove
</parameter_description>
</parameter>
</parameters>
-<return> a #GObject
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_remove_all_children">
+<description>
+Removes all children of @self.
+
+This function releases the reference added by inserting a child actor
+in the list of children of @self.
+
+If the reference count of a child drops to zero, the child will be
+destroyed. If you want to ensure the destruction of all the children
+of @self, use clutter_actor_destroy_all_children().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_timeline_set_direction">
+<function name="clutter_actor_remove_all_transitions">
<description>
-Sets the direction of @timeline, either %CLUTTER_TIMELINE_FORWARD or
-%CLUTTER_TIMELINE_BACKWARD.
+Removes all transitions associated to @self.
-Since: 0.6
+Since: 1.10
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> the direction of the timeline
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_remove_child">
+<description>
+Removes @child from the children of @self.
+
+This function will release the reference added by
+clutter_actor_add_child(), so if you want to keep using @child
+you will have to acquire a referenced on it before calling this
+function.
+
+This function will emit the #ClutterContainer::actor-removed
+signal on @self.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_from_vertices">
+<function name="clutter_actor_remove_clip">
<description>
-Calculates the bounding box represented by the four vertices; for details
-of the vertex array see clutter_actor_get_abs_allocation_vertices().
+Removes clip area from @self.
-Since: 1.0
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_remove_constraint">
+<description>
+Removes @constraint from the list of constraints applied to @self
+
+The reference held by @self on the #ClutterConstraint will be released
+
+Since: 1.4
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="verts">
-<parameter_description> array of four #ClutterVertex
+<parameter name="constraint">
+<parameter_description> a #ClutterConstraint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_set_ellipsize">
+<function name="clutter_actor_remove_constraint_by_name">
<description>
-Sets the mode used to ellipsize (add an ellipsis: "...") to the
-text if there is not enough space to render the entire contents
-of a #ClutterText actor
+Removes the #ClutterConstraint with the given name from the list
+of constraints applied to @self
-Since: 1.0
+Since: 1.4
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> a #PangoEllipsizeMode
+<parameter name="name">
+<parameter_description> the name of the constraint to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_set_interval">
+<function name="clutter_actor_remove_effect">
<description>
-Variable arguments wrapper for clutter_interval_set_initial_value()
-and clutter_interval_set_final_value() that avoids using the
-#GValue arguments:
+Removes @effect from the list of effects applied to @self
-|[
-clutter_interval_set_interval (interval, 0, 50);
-clutter_interval_set_interval (interval, 1.0, 0.0);
-clutter_interval_set_interval (interval, FALSE, TRUE);
-]|
+The reference held by @self on the #ClutterEffect will be released
-This function is meant for the convenience of the C API; bindings
-should reimplement this function using the #GValue-based API.
+Since: 1.4
-Since: 1.0
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="effect">
+<parameter_description> a #ClutterEffect
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_remove_effect_by_name">
+<description>
+Removes the #ClutterEffect with the given name from the list
+of effects applied to @self
+
+Since: 1.4
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> the initial and final values of the interval
+<parameter name="name">
+<parameter_description> the name of the effect to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_set_key_focus">
+<function name="clutter_actor_remove_transition">
<description>
-Sets the key focus on @actor. An actor with key focus will receive
-all the key events. If @actor is %NULL, the stage will receive
-focus.
+Removes the transition stored inside a #ClutterActor using @name
+identifier.
-Since: 0.6
+If the transition is currently in progress, it will be stopped.
+
+This function releases the reference acquired when the transition
+was added to the #ClutterActor.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> the actor to set key focus to, or %NULL
+<parameter name="name">
+<parameter_description> the name of the transition to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_set_filter">
+<function name="clutter_actor_reparent">
<description>
-Filters the @model using the given filtering function.
+Resets the parent actor of @self.
-Since: 0.6
+This function is logically equivalent to calling clutter_actor_unparent()
+and clutter_actor_set_parent(), but more efficiently implemented, as it
+ensures the child is not finalized when unparented, and emits the
+#ClutterActor::parent-set signal only once.
+
+In reality, calling this function is less useful than it sounds, as some
+application code may rely on changes in the intermediate state between
+removal and addition of the actor from its old parent to the @new_parent.
+Thus, it is strongly encouraged to avoid using this function in application
+code.
+
+Since: 0.2
+
+Deprecated: 1.10: Use clutter_actor_remove_child() and
+clutter_actor_add_child() instead; remember to take a reference on
+the actor being removed before calling clutter_actor_remove_child()
+to avoid the reference count dropping to zero and the actor being
+destroyed.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #ClutterModelFilterFunc, or #NULL
+<parameter name="new_parent">
+<parameter_description> the new #ClutterActor parent
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func, or #NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_replace_child">
+<description>
+Replaces @old_child with @new_child in the list of children of @self.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> destroy notifier of @user_data, or #NULL
+<parameter name="old_child">
+<parameter_description> the child of @self to replace
+</parameter_description>
+</parameter>
+<parameter name="new_child">
+<parameter_description> the #ClutterActor to replace @old_child
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_ellipse_new">
+<function name="clutter_actor_restore_easing_state">
<description>
-Creates a behaviour that drives actors along an elliptical path with
-given center, width and height; the movement starts at @start
-degrees (with 0 corresponding to 12 o'clock) and ends at @end
-degrees. Angles greated than 360 degrees get clamped to the canonical
-interval <0, 360); if @start is equal to @end, the behaviour will
-rotate by exacly 360 degrees.
+Restores the easing state as it was prior to a call to
+clutter_actor_save_easing_state().
-Since: 0.4
+Since: 1.10
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha, or %NULL
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinace of the center
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_save_easing_state">
+<description>
+Saves the current easing state for animatable properties, and creates
+a new state with the default values for easing mode and duration.
+
+New transitions created after calling this function will inherit the
+duration, easing mode, and delay of the new easing state; this also
+applies to transitions modified in flight.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordiance of the center
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_allocation">
+<description>
+Stores the allocation of @self as defined by @box.
+
+This function can only be called from within the implementation of
+the #ClutterActorClass.allocate() virtual function.
+
+The allocation should have been adjusted to take into account constraints,
+alignment, and margin properties. If you are implementing a #ClutterActor
+subclass that provides its own layout management policy for its children
+instead of using a #ClutterLayoutManager delegate, you should not call
+this function on the children of @self; instead, you should call
+clutter_actor_allocate(), which will adjust the allocation box for
+you.
+
+This function should only be used by subclasses of #ClutterActor
+that wish to store their allocation but cannot chain up to the
+parent's implementation; the default implementation of the
+#ClutterActorClass.allocate() virtual function will call this
+function.
+
+It is important to note that, while chaining up was the recommended
+behaviour for #ClutterActor subclasses prior to the introduction of
+this function, it is recommended to call clutter_actor_set_allocation()
+instead.
+
+If the #ClutterActor is using a #ClutterLayoutManager delegate object
+to handle the allocation of its children, this function will call
+the clutter_layout_manager_allocate() function only if the
+%CLUTTER_DELEGATE_LAYOUT flag is set on @flags, otherwise it is
+expected that the subclass will call clutter_layout_manager_allocate()
+by itself. For instance, the following code:
+
+|[
+static void
+my_actor_allocate (ClutterActor *actor,
+const ClutterActorBox *allocation,
+ClutterAllocationFlags flags)
+{
+ClutterActorBox new_alloc;
+ClutterAllocationFlags new_flags;
+
+adjust_allocation (allocation, &new_alloc);
+
+new_flags = flags | CLUTTER_DELEGATE_LAYOUT;
+
+/ * this will use the layout manager set on the actor * /
+clutter_actor_set_allocation (actor, &new_alloc, new_flags);
+}
+]|
+
+is equivalent to this:
+
+|[
+static void
+my_actor_allocate (ClutterActor *actor,
+const ClutterActorBox *allocation,
+ClutterAllocationFlags flags)
+{
+ClutterLayoutManager *layout;
+ClutterActorBox new_alloc;
+
+adjust_allocation (allocation, &new_alloc);
+
+clutter_actor_set_allocation (actor, &new_alloc, flags);
+
+layout = clutter_actor_get_layout_manager (actor);
+clutter_layout_manager_allocate (layout,
+CLUTTER_CONTAINER (actor),
+&new_alloc,
+flags);
+}
+]|
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of the ellipse
+<parameter name="box">
+<parameter_description> a #ClutterActorBox
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of the ellipse
+<parameter name="flags">
+<parameter_description> allocation flags
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> #ClutterRotateDirection of rotation
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_anchor_point">
+<description>
+Sets an anchor point for @self. The anchor point is a point in the
+coordinate space of an actor to which the actor position within its
+parent is relative; the default is (0, 0), i.e. the top-left corner
+of the actor.
+
+Since: 0.6
+
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> angle in degrees at which movement starts, between 0 and 360
+<parameter name="anchor_x">
+<parameter_description> X coordinate of the anchor point
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> angle in degrees at which movement ends, between 0 and 360
+<parameter name="anchor_y">
+<parameter_description> Y coordinate of the anchor point
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterBehaviourEllipse
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_set_anchor_point_from_gravity">
+<description>
+Sets an anchor point on the actor, based on the given gravity (this is a
+convenience function wrapping clutter_actor_set_anchor_point()).
+
+Since version 1.0 the anchor point will be stored as a gravity so
+that if the actor changes size then the anchor point will move. For
+example, if you set the anchor point to %CLUTTER_GRAVITY_SOUTH_EAST
+and later double the size of the actor, the anchor point will move
+to the bottom right.
+
+Since: 0.6
+
+Deprecated: 1.12: Use #ClutterActor:pivot-point instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="gravity">
+<parameter_description> #ClutterGravity.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_stage_ensure_redraw">
+<function name="clutter_actor_set_background_color">
<description>
-Ensures that @stage is redrawn
+Sets the background color of a #ClutterActor.
-This function should not be called by applications: it is
-used when embedding a #ClutterStage into a toolkit with
-another windowing system, like GTK+.
+The background color will be used to cover the whole allocation of the
+actor. The default background color of an actor is transparent.
-Since: 1.0
+To check whether an actor has a background color, you can use the
+#ClutterActor:background-color-set actor property.
+
+The #ClutterActor:background-color property is animatable.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #ClutterColor, or %NULL to unset a previously
+set color
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_get_elements">
+<function name="clutter_actor_set_child_above_sibling">
<description>
-Gets the elements of a #JsonArray as a list of #JsonNode<!-- -->s.
+Sets @child to be above @sibling in the list of children of @self.
+
+If @sibling is %NULL, @child will be the new last child of @self.
+This function is logically equivalent to removing @child and using
+clutter_actor_insert_child_above(), but it will not emit signals
+or change state on @child.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor child of @self
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a #ClutterActor child of @self, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GList containing the elements of the array. The
-contents of the list are owned by the array and should never be
-modified or freed. Use g_list_free() on the returned list when
-done using it
-</return>
+<return></return>
</function>
-<function name="json_array_get_double_element">
+<function name="clutter_actor_set_child_at_index">
<description>
-Conveniently retrieves the floating point value of the element at
- index_ inside @array
+Changes the index of @child in the list of children of @self.
-See also: json_array_get_element(), json_node_get_double()
+This function is logically equivalent to removing @child and
+calling clutter_actor_insert_child_at_index(), but it will not
+emit signals or change state on @child.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor child of @self
</parameter_description>
</parameter>
<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter_description> the new index for @child
</parameter_description>
</parameter>
</parameters>
-<return> the floating point value
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_set_child_below_sibling">
+<description>
+Sets @child to be below @sibling in the list of children of @self.
+
+If @sibling is %NULL, @child will be the new first child of @self.
+
+This function is logically equivalent to removing @self and using
+clutter_actor_insert_child_below(), but it will not emit signals
+or change state on @child.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor child of @self
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a #ClutterActor child of @self, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_child_transform">
+<description>
+Sets the transformation matrix to be applied to all the children
+of @self prior to their own transformations. The default child
+transformation is the identity matrix.
+
+If @transform is %NULL, the child transform will be unset.
+
+The #ClutterActor:child-transform property is animatable.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="transform">
+<parameter_description> a #ClutterMatrix, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
<function name="clutter_actor_set_clip">
@@ -4491,166 +10786,215 @@ Since: 0.6
<return></return>
</function>
-<function name="clutter_actor_hide">
+<function name="clutter_actor_set_clip_to_allocation">
<description>
-Flags an actor to be hidden. A hidden actor will not be
-rendered on the stage.
+Sets whether @self should be clipped to the same size as its
+allocation
-Actors are visible by default.
-
-If this function is called on an actor without a parent, the
-#ClutterActor:show-on-set-parent property will be set to %FALSE
-as a side-effect.
+Since: 1.4
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="clip_set">
+<parameter_description> %TRUE to apply a clip tracking the allocation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_remove_repaint_func">
+<function name="clutter_actor_set_content">
<description>
-Removes the repaint function with @handle_id as its id
+Sets the contents of a #ClutterActor.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="handle_id">
-<parameter_description> an unsigned integer greater than zero
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="content">
+<parameter_description> a #ClutterContent, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_find_action">
+<function name="clutter_actor_set_content_gravity">
<description>
-Retrieves the name of the action matching the given key symbol
-and modifiers bitmask.
+Sets the gravity of the #ClutterContent used by @self.
-Since: 1.0
+See the description of the #ClutterActor:content-gravity property for
+more information.
+
+The #ClutterActor:content-gravity property is animatable.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> a key symbol
+<parameter name="gravity">
+<parameter_description> the #ClutterContentGravity
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> a bitmask for the modifiers
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_content_repeat">
+<description>
+Sets the policy for repeating the #ClutterActor:content of a
+#ClutterActor. The behaviour is deferred to the #ClutterContent
+implementation.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="repeat">
+<parameter_description> the repeat policy
</parameter_description>
</parameter>
</parameters>
-<return> the name of the action, if found, or %NULL. The
-returned string is owned by the binding pool and should never
-be modified or freed
-
-</return>
+<return></return>
</function>
-<function name="clutter_alpha_get_mode">
+<function name="clutter_actor_set_content_scaling_filters">
<description>
-Retrieves the #ClutterAnimationMode used by @alpha.
+Sets the minification and magnification filter to be applied when
+scaling the #ClutterActor:content of a #ClutterActor.
-Since: 1.0
+The #ClutterActor:minification-filter will be used when reducing
+the size of the content; the #ClutterActor:magnification-filter
+will be used when increasing the size of the content.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="min_filter">
+<parameter_description> the minification filter for the content
+</parameter_description>
+</parameter>
+<parameter name="mag_filter">
+<parameter_description> the magnification filter for the content
</parameter_description>
</parameter>
</parameters>
-<return> the animation mode
-
-</return>
+<return></return>
</function>
-<function name="clutter_path_new_with_description">
+<function name="clutter_actor_set_depth">
<description>
-Creates a new #ClutterPath instance with the nodes described in
- desc See clutter_path_add_string() for details of the format of
-the string.
+Sets the Z coordinate of @self to @depth.
-The object has a floating reference so if you add it to a
-#ClutterBehaviourPath then you do not need to unref it.
+The unit used by @depth is dependant on the perspective setup. See
+also clutter_stage_set_perspective().
-Since: 1.0
+Deprecated: 1.12: Use clutter_actor_set_z_position() instead.
</description>
<parameters>
-<parameter name="desc">
-<parameter_description> a string describing the path
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="depth">
+<parameter_description> Z co-ord
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterPath
-
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_tilt">
+<function name="clutter_actor_set_easing_delay">
<description>
-Sets the angles at which the ellipse should be tilted around it's center.
+Sets the delay that should be applied before tweening animatable
+properties.
-Since: 0.4
+Since: 1.10
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="angle_tilt_x">
-<parameter_description> tilt of the elipse around the center in X axis in degrees.
+<parameter name="msecs">
+<parameter_description> the delay before the start of the tweening, in milliseconds
</parameter_description>
</parameter>
-<parameter name="angle_tilt_y">
-<parameter_description> tilt of the elipse around the center in Y axis in degrees.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_easing_duration">
+<description>
+Sets the duration of the tweening for animatable properties
+of @self for the current easing state.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="angle_tilt_z">
-<parameter_description> tilt of the elipse around the center in Z axis in degrees.
+<parameter name="msecs">
+<parameter_description> the duration of the easing, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_get_use_animations">
+<function name="clutter_actor_set_easing_mode">
<description>
-Retrieves whether @layout should animate changes in the layout properties
-
-Since clutter_box_layout_set_use_animations()
+Sets the easing mode for the tweening of animatable properties
+of @self.
-Since: 1.2
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> an easing mode, excluding %CLUTTER_CUSTOM_MODE
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the animations should be used, %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_lower_bottom">
+<function name="clutter_actor_set_fixed_position_set">
<description>
-Lowers @self to the bottom.
+Sets whether an actor has a fixed position set (and will thus be
+unaffected by any layout manager).
-This function calls clutter_actor_lower() internally.
+Since: 0.8
</description>
<parameters>
@@ -4658,172 +11002,223 @@ This function calls clutter_actor_lower() internally.
<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
+<parameter name="is_set">
+<parameter_description> whether to use fixed position
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_delete_selection">
+<function name="clutter_actor_set_flags">
<description>
-Deletes the currently selected text
+Sets @flags on @self
-This function is only useful in subclasses of #ClutterText
+This function will emit notifications for the changed properties
Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the flags to set
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if text was deleted or if the text actor
-is empty, and %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_stage_get_throttle_motion_events">
+<function name="clutter_actor_set_geometry">
<description>
-Retrieves the value set with clutter_stage_set_throttle_motion_events()
+Sets the actor's fixed position and forces its minimum and natural
+size, in pixels. This means the untransformed actor will have the
+given geometry. This is the same as calling clutter_actor_set_position()
+and clutter_actor_set_size().
-Since: 1.0
+Deprecated: 1.10: Use clutter_actor_set_position() and
+clutter_actor_set_size() instead.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="geometry">
+<parameter_description> A #ClutterGeometry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the motion events are being throttled,
-and %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_text_set_activatable">
+<function name="clutter_actor_set_height">
<description>
-Sets whether a #ClutterText actor should be activatable.
+Forces a height on an actor, causing the actor's preferred width
+and height (if any) to be ignored.
-An activatable #ClutterText actor will emit the #ClutterText::activate
-signal whenever the 'Enter' (or 'Return') key is pressed; if it is not
-activatable, a new line will be appended to the current content.
+If @height is -1 the actor will use its preferred height instead of
+overriding it, i.e. you can "unset" the height with -1.
-An activatable #ClutterText must also be set as editable using
-clutter_text_set_editable().
+This function sets both the minimum and natural size of the actor.
-Since: 1.0
+since: 0.2
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="activatable">
-<parameter_description> whether the #ClutterText actor should be activatable
+<parameter name="height">
+<parameter_description> Requested new height for the actor, in pixels, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_add_node">
+<function name="clutter_actor_set_layout_manager">
<description>
-Adds @node to the end of the path.
+Sets the #ClutterLayoutManager delegate object that will be used to
+lay out the children of @self.
-Since: 1.0
+The #ClutterActor will take a reference on the passed @manager which
+will be released either when the layout manager is removed, or when
+the actor is destroyed.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> a #ClutterPathNode
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager, or %NULL to unset it
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_set_double">
+<function name="clutter_actor_set_margin">
<description>
-Sets @value as the double content of the @node, replacing any existing
-content.
+Sets all the components of the margin of a #ClutterActor.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a double value
+<parameter name="margin">
+<parameter_description> a #ClutterMargin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_container_add_actor">
+<function name="clutter_actor_set_margin_bottom">
<description>
-Adds a #ClutterActor to @container. This function will emit the
-"actor-added" signal. The actor should be parented to
- container You cannot add a #ClutterActor to more than one
-#ClutterContainer.
+Sets the margin from the bottom of a #ClutterActor.
-Since: 0.4
+The #ClutterActor:margin-bottom property is animatable.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> the first #ClutterActor to add
+<parameter name="margin">
+<parameter_description> the bottom margin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_value_get_shader_float">
+<function name="clutter_actor_set_margin_left">
<description>
-Retrieves the list of floating point values stored inside
-the passed #GValue. @value must have been initialized with
-%CLUTTER_TYPE_SHADER_FLOAT.
+Sets the margin from the left of a #ClutterActor.
-Since: 0.8
+The #ClutterActor:margin-left property is animatable.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of returned floating
-point values, or %NULL
+<parameter name="margin">
+<parameter_description> the left margin
</parameter_description>
</parameter>
</parameters>
-<return> the pointer to a list of floating point values.
-The returned value is owned by the #GValue and should never
-be modified or freed.
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_set_margin_right">
+<description>
+Sets the margin from the right of a #ClutterActor.
+
+The #ClutterActor:margin-right property is animatable.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> the right margin
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_set_fixed_position_set">
+<function name="clutter_actor_set_margin_top">
<description>
-Sets whether an actor has a fixed position set (and will thus be
-unaffected by any layout manager).
+Sets the margin from the top of a #ClutterActor.
-Since: 0.8
+The #ClutterActor:margin-top property is animatable.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> the top margin
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_name">
+<description>
+Sets the given name to @self. The name can be used to identify
+a #ClutterActor.
</description>
<parameters>
@@ -4831,133 +11226,245 @@ Since: 0.8
<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="is_set">
-<parameter_description> whether to use fixed position
+<parameter name="name">
+<parameter_description> Textual tag to apply to actor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_set_names">
+<function name="clutter_actor_set_offscreen_redirect">
<description>
-Assigns a name to the columns of a #ClutterModel.
+Defines the circumstances where the actor should be redirected into
+an offscreen image. The offscreen image is used to flatten the
+actor into a single image while painting for two main reasons.
+Firstly, when the actor is painted a second time without any of its
+contents changing it can simply repaint the cached image without
+descending further down the actor hierarchy. Secondly, it will make
+the opacity look correct even if there are overlapping primitives
+in the actor.
-This function is meant primarily for #GObjects that inherit from
-#ClutterModel, and should only be used when contructing a #ClutterModel.
-It will not work after the initial creation of the #ClutterModel.
+Caching the actor could in some cases be a performance win and in
+some cases be a performance lose so it is important to determine
+which value is right for an actor before modifying this value. For
+example, there is never any reason to flatten an actor that is just
+a single texture (such as a #ClutterTexture) because it is
+effectively already cached in an image so the offscreen would be
+redundant. Also if the actor contains primitives that are far apart
+with a large transparent area in the middle (such as a large
+CluterGroup with a small actor in the top left and a small actor in
+the bottom right) then the cached image will contain the entire
+image of the large area and the paint will waste time blending all
+of the transparent pixels in the middle.
-Since: 0.6
+The default method of implementing opacity on a container simply
+forwards on the opacity to all of the children. If the children are
+overlapping then it will appear as if they are two separate glassy
+objects and there will be a break in the color where they
+overlap. By redirecting to an offscreen buffer it will be as if the
+two opaque objects are combined into one and then made transparent
+which is usually what is expected.
+
+The image below demonstrates the difference between redirecting and
+not. The image shows two Clutter groups, each containing a red and
+a green rectangle which overlap. The opacity on the group is set to
+128 (which is 50%). When the offscreen redirect is not used, the
+red rectangle can be seen through the blue rectangle as if the two
+rectangles were separately transparent. When the redirect is used
+the group as a whole is transparent instead so the red rectangle is
+not visible where they overlap.
+
+<figure id="offscreen-redirect">
+<title>Sample of using an offscreen redirect for transparency</title>
+<graphic fileref="offscreen-redirect.png" format="PNG"/>
+</figure>
+
+The default value for this property is 0, so we effectively will
+never redirect an actor offscreen by default. This means that there
+are times that transparent actors may look glassy as described
+above. The reason this is the default is because there is a
+performance trade off between quality and performance here. In many
+cases the default form of glassy opacity looks good enough, but if
+it's not you will need to set the
+%CLUTTER_OFFSCREEN_REDIRECT_AUTOMATIC_FOR_OPACITY flag to enable
+redirection for opacity.
+
+Custom actors that don't contain any overlapping primitives are
+recommended to override the has_overlaps() virtual to return %FALSE
+for maximum efficiency.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> the number of column names
+<parameter name="redirect">
+<parameter_description> New offscreen redirect flags for the actor.
</parameter_description>
</parameter>
-<parameter name="names">
-<parameter_description> an array of strings
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_opacity">
+<description>
+Sets the actor's opacity, with zero being completely transparent and
+255 (0xff) being fully opaque.
+
+The #ClutterActor:opacity property is animatable.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="opacity">
+<parameter_description> New opacity value for the actor.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_events_pending">
+<function name="clutter_actor_set_parent">
<description>
-Checks if events are pending in the event queue.
+Sets the parent of @self to @parent.
-Since: 0.4
+This function will result in @parent acquiring a reference on @self,
+eventually by sinking its floating reference first. The reference
+will be released by clutter_actor_unparent().
+
+This function should only be called by legacy #ClutterActor<!-- -->s
+implementing the #ClutterContainer interface.
+
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
</description>
<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> A new #ClutterActor parent
+</parameter_description>
+</parameter>
</parameters>
-<return> TRUE if there are pending events, FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="clutter_layout_manager_get_child_meta">
+<function name="clutter_actor_set_pivot_point">
<description>
-Retrieves the #ClutterLayoutMeta that the layout @manager associated
-to the @actor child of @container, eventually by creating one if the
-#ClutterLayoutManager supports layout properties
+Sets the position of the #ClutterActor:pivot-point around which the
+scaling and rotation transformations occur.
-Since: 1.0
+The pivot point's coordinates are in normalized space, with the (0, 0)
+point being the top left corner of the actor, and the (1, 1) point being
+the bottom right corner.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> a #ClutterContainer using @manager
+<parameter name="pivot_x">
+<parameter_description> the normalized X coordinate of the pivot point
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @container
+<parameter name="pivot_y">
+<parameter_description> the normalized Y coordinate of the pivot point
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterLayoutMeta, or %NULL if the #ClutterLayoutManager
-does not have layout properties
+<return></return>
+</function>
-</return>
+<function name="clutter_actor_set_pivot_point_z">
+<description>
+Sets the component on the Z axis of the #ClutterActor:pivot-point around
+which the scaling and rotation transformations occur.
+
+The @pivot_z value is expressed as a distance along the Z axis.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="pivot_z">
+<parameter_description> the Z coordinate of the actor's pivot point
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_behaviour_opacity_set_bounds">
+<function name="clutter_actor_set_position">
<description>
-Sets the initial and final levels of the opacity applied by @behaviour
-on each actor it controls.
+Sets the actor's fixed position in pixels relative to any parent
+actor.
-Since: 0.6
+If a layout manager is in use, this position will override the
+layout manager and force a fixed position.
</description>
<parameters>
-<parameter name="behaviour">
-<parameter_description> a #ClutterBehaviourOpacity
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="opacity_start">
-<parameter_description> minimum level of opacity
+<parameter name="x">
+<parameter_description> New left position of actor in pixels.
</parameter_description>
</parameter>
-<parameter name="opacity_end">
-<parameter_description> maximum level of opacity
+<parameter name="y">
+<parameter_description> New top position of actor in pixels.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_get_loop">
+<function name="clutter_actor_set_reactive">
<description>
-Gets whether @timeline is looping
+Sets @actor as reactive. Reactive actors will receive events.
+Since: 0.6
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="reactive">
+<parameter_description> whether the actor should be reactive to events
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the timeline is looping
-</return>
+<return></return>
</function>
-<function name="clutter_actor_set_flags">
+<function name="clutter_actor_set_request_mode">
<description>
-Sets @flags on @self
+Sets the geometry request mode of @self.
-This function will emit notifications for the changed properties
+The @mode determines the order for invoking
+clutter_actor_get_preferred_width() and
+clutter_actor_get_preferred_height()
-Since: 1.0
+Since: 1.2
</description>
<parameters>
@@ -4965,265 +11472,385 @@ Since: 1.0
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the flags to set
+<parameter name="mode">
+<parameter_description> the request mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_scale_get_bounds">
+<function name="clutter_actor_set_rotation">
<description>
-Retrieves the bounds used by scale behaviour.
+Sets the rotation angle of @self around the given axis.
-Since: 0.4
+The rotation center coordinates used depend on the value of @axis:
+<itemizedlist>
+<listitem><para>%CLUTTER_X_AXIS requires @y and @z</para></listitem>
+<listitem><para>%CLUTTER_Y_AXIS requires @x and @z</para></listitem>
+<listitem><para>%CLUTTER_Z_AXIS requires @x and @y</para></listitem>
+</itemizedlist>
+
+The rotation coordinates are relative to the anchor point of the
+actor, set using clutter_actor_set_anchor_point(). If no anchor
+point is set, the upper left corner is assumed as the origin.
+
+Since: 0.8
+
+Deprecated: 1.12: Use clutter_actor_set_rotation_angle() and
+clutter_actor_set_pivot_point() instead.
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #ClutterBehaviourScale
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x_scale_start">
-<parameter_description> return location for the initial scale factor on the X
-axis, or %NULL
+<parameter name="axis">
+<parameter_description> the axis of rotation
</parameter_description>
</parameter>
-<parameter name="y_scale_start">
-<parameter_description> return location for the initial scale factor on the Y
-axis, or %NULL
+<parameter name="angle">
+<parameter_description> the angle of rotation
</parameter_description>
</parameter>
-<parameter name="x_scale_end">
-<parameter_description> return location for the final scale factor on the X axis,
-or %NULL
+<parameter name="x">
+<parameter_description> X coordinate of the rotation center
</parameter_description>
</parameter>
-<parameter name="y_scale_end">
-<parameter_description> return location for the final scale factor on the Y axis,
-or %NULL
+<parameter name="y">
+<parameter_description> Y coordinate of the rotation center
+</parameter_description>
+</parameter>
+<parameter name="z">
+<parameter_description> Z coordinate of the rotation center
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_input_device_get_device_id">
+<function name="clutter_actor_set_rotation_angle">
<description>
-Retrieves the unique identifier of @device
+Sets the @angle of rotation of a #ClutterActor on the given @axis.
-Since: 1.0
+This function is a convenience for setting the rotation properties
+#ClutterActor:rotation-angle-x, #ClutterActor:rotation-angle-y,
+and #ClutterActor:rotation-angle-z.
+
+The center of rotation is established by the #ClutterActor:pivot-point
+property.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="axis">
+<parameter_description> the axis to set the angle one
+</parameter_description>
+</parameter>
+<parameter name="angle">
+<parameter_description> the angle of rotation, in degrees
</parameter_description>
</parameter>
</parameters>
-<return> the identifier of the device
-
-</return>
+<return></return>
</function>
-<function name="clutter_redraw">
+<function name="clutter_actor_set_scale">
<description>
-Forces a redraw of the entire stage. Applications should never use this
-function, but queue a redraw using clutter_actor_queue_redraw().
+Scales an actor with the given factors.
-This function should only be used by libraries integrating Clutter from
-within another toolkit.
+The scale transformation is relative the the #ClutterActor:pivot-point.
+
+The #ClutterActor:scale-x and #ClutterActor:scale-y properties are
+animatable.
+
+Since: 0.2
</description>
<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="scale_x">
+<parameter_description> double factor to scale actor by horizontally.
+</parameter_description>
+</parameter>
+<parameter name="scale_y">
+<parameter_description> double factor to scale actor by vertically.
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="cogl_pango_render_layout_line">
+<function name="clutter_actor_set_scale_full">
<description>
-Renders @line at the given coordinates using the given color.
+Scales an actor with the given factors around the given center
+point. The center point is specified in pixels relative to the
+anchor point (usually the top left corner of the actor).
+
+The #ClutterActor:scale-x and #ClutterActor:scale-y properties
+are animatable.
Since: 1.0
+Deprecated: 1.12: Use clutter_actor_set_pivot_point() to control
+the scale center
+
</description>
<parameters>
-<parameter name="line">
-<parameter_description> a #PangoLayoutLine
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate to render the line at
+<parameter name="scale_x">
+<parameter_description> double factor to scale actor by horizontally.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate to render the line at
+<parameter name="scale_y">
+<parameter_description> double factor to scale actor by vertically.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> color to use when rendering the line
+<parameter name="center_x">
+<parameter_description> X coordinate of the center of the scaling
+</parameter_description>
+</parameter>
+<parameter name="center_y">
+<parameter_description> Y coordinate of the center of the scaling
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_set_cogl_texture">
+<function name="clutter_actor_set_scale_with_gravity">
<description>
-Replaces the underlying COGL texture drawn by this actor with
- cogl_tex A reference to the texture is taken so if the handle is
-no longer needed it should be deref'd with cogl_handle_unref.
+Scales an actor with the given factors around the given
+center point. The center point is specified as one of the compass
+directions in #ClutterGravity. For example, setting it to north
+will cause the top of the actor to remain unchanged and the rest of
+the actor to expand left, right and downwards.
-This should not be called on an unrealizable texture (one that
-isn't inside a stage). (Currently the ClutterTexture
-implementation relies on being able to have a GL texture while
-unrealized, which means you can get away with it, but it's
-not correct and may change in the future.)
+The #ClutterActor:scale-x and #ClutterActor:scale-y properties are
+animatable.
-Since: 0.8
+Since: 1.0
+
+Deprecated: 1.12: Use clutter_actor_set_pivot_point() to set the
+scale center using normalized coordinates instead.
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="cogl_tex">
-<parameter_description> A CoglHandle for a texture
+<parameter name="scale_x">
+<parameter_description> double factor to scale actor by horizontally.
+</parameter_description>
+</parameter>
+<parameter name="scale_y">
+<parameter_description> double factor to scale actor by vertically.
+</parameter_description>
+</parameter>
+<parameter name="gravity">
+<parameter_description> the location of the scale center expressed as a compass
+direction.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_get_layout_manager">
+<function name="clutter_actor_set_scale_z">
<description>
-Retrieves the #ClutterLayoutManager instance used by @box
+Scales an actor on the Z axis by the given @scale_z factor.
-Since: 1.2
+The scale transformation is relative the the #ClutterActor:pivot-point.
+
+The #ClutterActor:scale-z property is animatable.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="scale_z">
+<parameter_description> the scaling factor along the Z axis
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterLayoutManager
-
-</return>
+<return></return>
</function>
-<function name="clutter_win32_get_stage_from_window">
+<function name="clutter_actor_set_shader">
<description>
-Gets the stage for a particular window.
+Sets the #ClutterShader to be used when rendering @self.
-Since: 0.8
+If @shader is %NULL this function will unset any currently set shader
+for the actor.
+
+<note>Any #ClutterEffect applied to @self will take the precedence
+over the #ClutterShader set using this function.</note>
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect and
+clutter_actor_add_effect() instead.
</description>
<parameters>
-<parameter name="hwnd">
-<parameter_description> a window handle
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="shader">
+<parameter_description> a #ClutterShader or %NULL to unset the shader.
</parameter_description>
</parameter>
</parameters>
-<return> The stage or NULL if a stage does not exist for the
-window.
+<return> %TRUE if the shader was successfully applied
+or removed
</return>
</function>
-<function name="clutter_path_remove_node">
+<function name="clutter_actor_set_shader_param">
<description>
-Removes the node at the given offset from the path.
+Sets the value for a named parameter of the shader applied
+to @actor.
Since: 1.0
+Deprecated: 1.8: Use clutter_shader_effect_set_uniform_value() instead
+
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> index of the node to remove
+<parameter name="param">
+<parameter_description> the name of the parameter
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value of the parameter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_new_with_func">
+<function name="clutter_actor_set_shader_param_float">
<description>
-Creates a new #ClutterAlpha instances and sets the timeline
-and the alpha function.
-
-This function will not register @func as a global alpha function.
+Sets the value for a named float parameter of the shader applied
+to @actor.
-See also clutter_alpha_set_timeline() and clutter_alpha_set_func().
+Since: 0.8
-Since: 1.0
+Deprecated: 1.8: Use clutter_shader_effect_set_uniform() instead
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #ClutterAlphaFunc
+<parameter name="param">
+<parameter_description> the name of the parameter
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function, or %NULL
+<parameter name="value">
+<parameter_description> the value of the parameter
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> function to call when removing the alpha function, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_shader_param_int">
+<description>
+Sets the value for a named int parameter of the shader applied to
+ actor
+
+Since: 0.8
+
+Deprecated: 1.8: Use clutter_shader_effect_set_uniform() instead
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="param">
+<parameter_description> the name of the parameter
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value of the parameter
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterAlpha
-
-</return>
+<return></return>
</function>
-<function name="clutter_units_from_pixels">
+<function name="clutter_actor_set_size">
<description>
-Stores a value in pixels inside @units
+Sets the actor's size request in pixels. This overrides any
+"normal" size request the actor would have. For example
+a text actor might normally request the size of the text;
+this function would force a specific size instead.
-Since: 1.0
+If @width and/or @height are -1 the actor will use its
+"normal" size request instead of overriding it, i.e.
+you can "unset" the size with -1.
+
+This function sets or unsets both the minimum and natural size.
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="px">
-<parameter_description> pixels
+<parameter name="width">
+<parameter_description> New width of actor in pixels, or -1
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> New height of actor in pixels, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_preferred_size">
+<function name="clutter_actor_set_text_direction">
<description>
-Computes the preferred minimum and natural size of an actor, taking into
-account the actor's geometry management (either height-for-width
-or width-for-height).
+Sets the #ClutterTextDirection for an actor
-The width and height used to compute the preferred height and preferred
-width are the actor's natural ones.
+The passed text direction must not be %CLUTTER_TEXT_DIRECTION_DEFAULT
-If you need to control the height for the preferred width, or the width for
-the preferred height, you should use clutter_actor_get_preferred_width()
-and clutter_actor_get_preferred_height(), and check the actor's preferred
-geometry management using the #ClutterActor:request-mode property.
+If @self implements #ClutterContainer then this function will recurse
+inside all the children of @self (including the internal ones).
-Since: 0.8
+Composite actors not implementing #ClutterContainer, or actors requiring
+special handling when the text direction changes, should connect to
+the #GObject::notify signal for the #ClutterActor:text-direction property
+
+Since: 1.2
</description>
<parameters>
@@ -5231,219 +11858,302 @@ Since: 0.8
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="min_width_p">
-<parameter_description> return location for the minimum
-width, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="min_height_p">
-<parameter_description> return location for the minimum
-height, or %NULL
+<parameter name="text_dir">
+<parameter_description> the text direction for @self
</parameter_description>
</parameter>
-<parameter name="natural_width_p">
-<parameter_description> return location for the natural
-width, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_transform">
+<description>
+Overrides the transformations of a #ClutterActor with a custom
+matrix, which will be applied relative to the origin of the
+actor's allocation and to the actor's pivot point.
+
+The #ClutterActor:transform property is animatable.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="natural_height_p">
-<parameter_description> return location for the natural
-height, or %NULL
+<parameter name="transform">
+<parameter_description> a #ClutterMatrix, or %NULL to
+unset a custom transformation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_get_column_width">
+<function name="clutter_actor_set_translation">
<description>
-Retrieves the minimum and maximum column widths
+Sets an additional translation transformation on a #ClutterActor,
+relative to the #ClutterActor:pivot-point.
-Since: 1.2
+Since: 1.12
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="min_width">
-<parameter_description> return location for the minimum column width, or %NULL
+<parameter name="translate_x">
+<parameter_description> the translation along the X axis
</parameter_description>
</parameter>
-<parameter name="max_width">
-<parameter_description> return location for the maximum column width, or %NULL
+<parameter name="translate_y">
+<parameter_description> the translation along the Y axis
+</parameter_description>
+</parameter>
+<parameter name="translate_z">
+<parameter_description> the translation along the Z axis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_get_root_window">
+<function name="clutter_actor_set_width">
<description>
-Retrieves the root window.
+Forces a width on an actor, causing the actor's preferred width
+and height (if any) to be ignored.
-Since: 0.6
+If @width is -1 the actor will use its preferred width request
+instead of overriding it, i.e. you can "unset" the width with -1.
+
+This function sets both the minimum and natural size of the actor.
+
+since: 0.2
</description>
<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> Requested new width for the actor, in pixels, or -1
+</parameter_description>
+</parameter>
</parameters>
-<return> the id of the root window
-
-</return>
+<return></return>
</function>
-<function name="clutter_path_add_line_to">
+<function name="clutter_actor_set_x">
<description>
-Adds a %CLUTTER_PATH_LINE_TO type node to the path. This causes the
-actor to move to the new coordinates in a straight line.
+Sets the actor's X coordinate, relative to its parent, in pixels.
-Since: 1.0
+Overrides any layout manager and forces a fixed position for
+the actor.
+
+The #ClutterActor:x property is animatable.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the x coordinate
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate
+<parameter_description> the actor's position on the X axis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_selection_color">
+<function name="clutter_actor_set_x_align">
<description>
-Retrieves the color of the selection of a #ClutterText actor.
+Sets the horizontal alignment policy of a #ClutterActor, in case the
+actor received extra horizontal space.
-Since: 1.0
+See also the #ClutterActor:x-align property.
+
+Since: 1.10
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="x_align">
+<parameter_description> the horizontal alignment policy
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_rotate_get_bounds">
+<function name="clutter_actor_set_x_expand">
<description>
-Retrieves the rotation boundaries of the rotate behaviour.
+Sets whether a #ClutterActor should expand horizontally; this means
+that layout manager should allocate extra space for the actor, if
+possible.
-Since: 0.4
+Setting an actor to expand will also make all its parent expand, so
+that it's possible to build an actor tree and only set this flag on
+its leaves and not on every single actor.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="angle_start">
-<parameter_description> return value for the initial angle
+<parameter name="expand">
+<parameter_description> whether the actor should expand horizontally
</parameter_description>
</parameter>
-<parameter name="angle_end">
-<parameter_description> return value for the final angle
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_set_y">
+<description>
+Sets the actor's Y coordinate, relative to its parent, in pixels.#
+
+Overrides any layout manager and forces a fixed position for
+the actor.
+
+The #ClutterActor:y property is animatable.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the actor's position on the Y axis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_get_object_element">
+<function name="clutter_actor_set_y_align">
<description>
-Conveniently retrieves the object from the element at @index_
-inside @array
+Sets the vertical alignment policy of a #ClutterActor, in case the
+actor received extra vertical space.
-See also: json_array_get_element(), json_node_get_object()
+See also the #ClutterActor:y-align property.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="y_align">
+<parameter_description> the vertical alignment policy
</parameter_description>
</parameter>
</parameters>
-<return> the object
-
-</return>
+<return></return>
</function>
-<function name="clutter_stage_is_default">
+<function name="clutter_actor_set_y_expand">
<description>
-Checks if @stage is the default stage, or an instance created using
-clutter_stage_new() but internally using the same implementation.
+Sets whether a #ClutterActor should expand horizontally; this means
+that layout manager should allocate extra space for the actor, if
+possible.
-Since: 0.8
+Setting an actor to expand will also make all its parent expand, so
+that it's possible to build an actor tree and only set this flag on
+its leaves and not on every single actor.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> whether the actor should expand vertically
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the passed stage is the default one
-
-</return>
+<return></return>
</function>
-<function name="clutter_timeline_is_playing">
+<function name="clutter_actor_set_z_position">
<description>
-Queries state of a #ClutterTimeline.
+Sets the actor's position on the Z axis.
+
+See #ClutterActor:z-position.
+Since: 1.12
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="z_position">
+<parameter_description> the position on the Z axis
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if timeline is currently playing
-</return>
+<return></return>
</function>
-<function name="clutter_color_darken">
+<function name="clutter_actor_set_z_rotation_from_gravity">
<description>
-Darkens @color by a fixed amount, and saves the changed color
-in @result.
+Sets the rotation angle of @self around the Z axis using the center
+point specified as a compass point. For example to rotate such that
+the center of the actor remains static you can use
+%CLUTTER_GRAVITY_CENTER. If the actor changes size the center point
+will move accordingly.
+
+Since: 1.0
+
+Deprecated: 1.12: Use clutter_actor_set_rotation_angle() and
+clutter_actor_set_pivot_point() instead.
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the darker color
+<parameter name="angle">
+<parameter_description> the angle of rotation
+</parameter_description>
+</parameter>
+<parameter name="gravity">
+<parameter_description> the center point of the rotation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_parent">
+<function name="clutter_actor_should_pick_paint">
<description>
-Retrieves the parent of @self.
+Should be called inside the implementation of the
+#ClutterActor::pick virtual function in order to check whether
+the actor should paint itself in pick mode or not.
+
+This function should never be called directly by applications.
</description>
@@ -5453,74 +12163,202 @@ Retrieves the parent of @self.
</parameter_description>
</parameter>
</parameters>
-<return> The #ClutterActor parent, or %NULL
-if no parent is set
+<return> %TRUE if the actor should paint its silhouette,
+%FALSE otherwise
</return>
</function>
-<function name="clutter_stage_set_use_alpha">
+<function name="clutter_actor_show">
<description>
-Sets whether the @stage should honour the #ClutterActor:opacity and
-the alpha channel of the #ClutterStage:color
+Flags an actor to be displayed. An actor that isn't shown will not
+be rendered on the stage.
-Since: 1.2
+Actors are visible by default.
+
+If this function is called on an actor without a parent, the
+#ClutterActor:show-on-set-parent will be set to %TRUE as a side
+effect.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
-<parameter name="use_alpha">
-<parameter_description> whether the stage should honour the opacity or the
-alpha channel of the stage color
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_show_all">
+<description>
+Calls clutter_actor_show() on all children of an actor (if any).
+
+Since: 0.2
+
+Deprecated: 1.10: Actors are visible by default
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_free">
+<function name="clutter_actor_transform_stage_point">
<description>
-Frees a #ClutterActorBox allocated using clutter_actor_box_new()
-or clutter_actor_box_copy()
+This function translates screen coordinates (@x, @y) to
+coordinates relative to the actor. For example, it can be used to translate
+screen events from global screen coordinates into actor-local coordinates.
+
+The conversion can fail, notably if the transform stack results in the
+actor being projected on the screen as a mere line.
+
+The conversion should not be expected to be pixel-perfect due to the
+nature of the operation. In general the error grows when the skewing
+of the actor rectangle on screen increases.
+
+<note><para>This function can be computationally intensive.</para></note>
+
+<note><para>This function only works when the allocation is up-to-date,
+i.e. inside of paint().</para></note>
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x screen coordinate of the point to unproject
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y screen coordinate of the point to unproject
+</parameter_description>
+</parameter>
+<parameter name="x_out">
+<parameter_description> return location for the unprojected x coordinance
+</parameter_description>
+</parameter>
+<parameter name="y_out">
+<parameter_description> return location for the unprojected y coordinance
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if conversion was successful.
+
+</return>
+</function>
+
+<function name="clutter_actor_unmap">
+<description>
+Unsets the %CLUTTER_ACTOR_MAPPED flag on the actor and possibly
+unmaps its children if they were mapped.
+
+Calling this function is not encouraged: the default #ClutterActor
+implementation of #ClutterActorClass.unmap() will also unmap any
+eventual children by default when their parent is unmapped.
+
+When overriding #ClutterActorClass.unmap(), it is mandatory to
+chain up to the parent implementation.
+
+<note>It is important to note that the implementation of the
+#ClutterActorClass.unmap() virtual function may be called after
+the #ClutterActorClass.destroy() or the #GObjectClass.dispose()
+implementation, but it is guaranteed to be called before the
+#GObjectClass.finalize() implementation.</note>
Since: 1.0
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_get_color">
+<function name="clutter_actor_unparent">
<description>
-Retrieves the stage color.
+Removes the parent of @self.
+
+This will cause the parent of @self to release the reference
+acquired when calling clutter_actor_set_parent(), so if you
+want to keep @self you will have to acquire a reference of
+your own, through g_object_ref().
+
+This function should only be called by legacy #ClutterActor<!-- -->s
+implementing the #ClutterContainer interface.
+
+Since: 0.1.1
+
+Deprecated: 1.10: Use clutter_actor_remove_child() instead.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_actor_unrealize">
+<description>
+Unrealization informs the actor that it may be being destroyed or
+moved to another stage. The actor may want to destroy any
+underlying graphics resources at this point. However it is
+perfectly acceptable for it to retain the resources until the actor
+is destroyed because Clutter only ever uses a single rendering
+context and all of the graphics resources are valid on any stage.
+
+Because mapped actors must be realized, actors may not be
+unrealized if they are mapped. This function hides the actor to be
+sure it isn't mapped, an application-visible side effect that you
+may not be expecting.
+
+This function should not be called by application code.
+
+This function should not really be in the public API, because
+there isn't a good reason to call it. ClutterActor will already
+unrealize things for you when it's important to do so.
+
+If you were using clutter_actor_unrealize() in a dispose
+implementation, then don't, just chain up to ClutterActor's
+dispose.
+
+If you were using clutter_actor_unrealize() to implement
+unrealizing children of your container, then don't, ClutterActor
+will already take care of that.
+
+Deprecated: 1.16: Actors are automatically unrealized, and nothing
+requires explicit realization.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_move_anchor_point">
+<function name="clutter_actor_unset_flags">
<description>
-Sets an anchor point for the actor, and adjusts the actor postion so that
-the relative position of the actor toward its parent remains the same.
+Unsets @flags on @self
-Since: 0.6
+This function will emit notifications for the changed properties
+
+Since: 1.0
</description>
<parameters>
@@ -5528,1831 +12366,2782 @@ Since: 0.6
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="anchor_x">
-<parameter_description> X coordinate of the anchor point
+<parameter name="flags">
+<parameter_description> the flags to unset
</parameter_description>
</parameter>
-<parameter name="anchor_y">
-<parameter_description> Y coordinate of the anchor point
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_align_constraint_get_align_axis">
+<description>
+Retrieves the value set using clutter_align_constraint_set_align_axis()
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the alignment axis
+
+</return>
</function>
-<function name="clutter_model_iter_next">
+<function name="clutter_align_constraint_get_factor">
<description>
-Updates the @iter to point at the next position in the model.
-The model implementation should take into account the presence of
-a filter function.
+Retrieves the factor set using clutter_align_constraint_set_factor()
-Since: 0.6
+Since: 1.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
</parameter_description>
</parameter>
</parameters>
-<return> The passed iterator, updated to point at the next
-row in the model.
+<return> the alignment factor
</return>
</function>
-<function name="clutter_model_filter_row">
+<function name="clutter_align_constraint_get_source">
<description>
-Checks whether @row should be filtered or not using the
-filtering function set on @model.
+Retrieves the source of the alignment
-This function should be used only by subclasses of #ClutterModel.
+Since: 1.4
-Since: 0.6
+</description>
+<parameters>
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #ClutterActor used as the source
+of the alignment
+
+</return>
+</function>
+
+<function name="clutter_align_constraint_new">
+<description>
+Creates a new constraint, aligning a #ClutterActor's position with
+regards of the size of the actor to @source, with the given
+alignment @factor
+
+Since: 1.4
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="source">
+<parameter_description> the #ClutterActor to use as the source of the
+alignment, or %NULL
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> the row to filter
+<parameter name="axis">
+<parameter_description> the axis to be used to compute the alignment
+</parameter_description>
+</parameter>
+<parameter name="factor">
+<parameter_description> the alignment factor, between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row should be displayed,
-%FALSE otherwise
+<return> the newly created #ClutterAlignConstraint
</return>
</function>
-<function name="clutter_path_get_node">
+<function name="clutter_align_constraint_set_align_axis">
<description>
-Retrieves the node of the path indexed by @index.
+Sets the axis to which the alignment refers to
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the node number to retrieve
+<parameter name="axis">
+<parameter_description> the axis to which the alignment refers to
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> a location to store a copy of the node
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_align_constraint_set_factor">
+<description>
+Sets the alignment factor of the constraint
+
+The factor depends on the #ClutterAlignConstraint:align-axis property
+and it is a value between 0.0 (meaning left, when
+#ClutterAlignConstraint:align-axis is set to %CLUTTER_ALIGN_X_AXIS; or
+meaning top, when #ClutterAlignConstraint:align-axis is set to
+%CLUTTER_ALIGN_Y_AXIS) and 1.0 (meaning right, when
+#ClutterAlignConstraint:align-axis is set to %CLUTTER_ALIGN_X_AXIS; or
+meaning bottom, when #ClutterAlignConstraint:align-axis is set to
+%CLUTTER_ALIGN_Y_AXIS). A value of 0.5 aligns in the middle in either
+cases
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
+</parameter_description>
+</parameter>
+<parameter name="factor">
+<parameter_description> the alignment factor, between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_texture_pixmap_new">
+<function name="clutter_align_constraint_set_source">
<description>
-Creates a new #ClutterX11TexturePixmap which can be used to display the
-contents of an X11 Pixmap inside a Clutter scene graph
+Sets the source of the alignment constraint
-Since: 0.8
+Since: 1.4
</description>
<parameters>
+<parameter name="align">
+<parameter_description> a #ClutterAlignConstraint
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> a #ClutterActor, or %NULL to unset the source
+</parameter_description>
+</parameter>
</parameters>
-<return> A new #ClutterX11TexturePixmap
+<return></return>
+</function>
+
+<function name="clutter_alpha_get_alpha">
+<description>
+Query the current alpha value.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="alpha">
+<parameter_description> A #ClutterAlpha
+</parameter_description>
+</parameter>
+</parameters>
+<return> The current alpha value for the alpha
</return>
</function>
-<function name="clutter_actor_unset_flags">
+<function name="clutter_alpha_get_mode">
<description>
-Unsets @flags on @self
-
-This function will emit notifications for the changed properties
+Retrieves the #ClutterAnimationMode used by @alpha.
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the flags to unset
+</parameters>
+<return> the animation mode
+
+</return>
+</function>
+
+<function name="clutter_alpha_get_timeline">
+<description>
+Gets the #ClutterTimeline bound to @alpha.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="alpha">
+<parameter_description> A #ClutterAlpha
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterTimeline instance
+
+</return>
</function>
-<function name="clutter_text_new">
+<function name="clutter_alpha_new">
<description>
-Creates a new #ClutterText actor. This actor can be used to
-display and edit text.
+Creates a new #ClutterAlpha instance. You must set a function
+to compute the alpha value using clutter_alpha_set_func() and
+bind a #ClutterTimeline object to the #ClutterAlpha instance
+using clutter_alpha_set_timeline().
+
+You should use the newly created #ClutterAlpha instance inside
+a #ClutterBehaviour object.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created empty #ClutterAlpha instance.
+
+</return>
+</function>
+
+<function name="clutter_alpha_new_full">
+<description>
+Creates a new #ClutterAlpha instance and sets the timeline
+and animation mode.
+
+See also clutter_alpha_set_timeline() and clutter_alpha_set_mode().
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
+<parameter name="timeline">
+<parameter_description> #ClutterTimeline timeline
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> animation mode
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterText actor
+<return> the newly created #ClutterAlpha
</return>
</function>
-<function name="json_object_set_string_member">
+<function name="clutter_alpha_new_with_func">
<description>
-Convenience function for setting a string @value of
- member_name inside @object.
+Creates a new #ClutterAlpha instances and sets the timeline
+and the alpha function.
+
+This function will not register @func as a global alpha function.
-See also: json_object_set_member()
+See also clutter_alpha_set_timeline() and clutter_alpha_set_func().
-Since: 0.8
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="func">
+<parameter_description> a #ClutterAlphaFunc
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+<parameter name="data">
+<parameter_description> data to pass to the function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> function to call when removing the alpha function, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #ClutterAlpha
+
+</return>
</function>
-<function name="clutter_get_script_id">
+<function name="clutter_alpha_register_closure">
<description>
-Retrieves the Clutter script id, if any.
+#GClosure variant of clutter_alpha_register_func().
-Since: 0.6
+Registers a global alpha function and returns its logical id
+to be used by clutter_alpha_set_mode() or by #ClutterAnimation.
+
+The logical id is always greater than %CLUTTER_ANIMATION_LAST.
+
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="gobject">
-<parameter_description> a #GObject
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
</parameters>
-<return> the script id, or %NULL if @object was not defined inside
-a UI definition file. The returned string is owned by the object and
-should never be modified or freed.
+<return> the logical id of the alpha function
</return>
</function>
-<function name="clutter_frame_source_add">
+<function name="clutter_alpha_register_func">
<description>
-Simple wrapper around clutter_frame_source_add_full().
+Registers a global alpha function and returns its logical id
+to be used by clutter_alpha_set_mode() or by #ClutterAnimation.
-Since: 0.8
+The logical id is always greater than %CLUTTER_ANIMATION_LAST.
+
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="fps">
-<parameter_description> the number of times per second to call the function
-</parameter_description>
-</parameter>
<parameter name="func">
-<parameter_description> function to call
+<parameter_description> a #ClutterAlphaFunc
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter_description> user data to pass to @func, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> the logical id of the alpha function
</return>
</function>
-<function name="json_object_add_member">
+<function name="clutter_alpha_set_closure">
<description>
-Adds a member named @member_name and containing @node into a #JsonObject.
-The object will take ownership of the #JsonNode.
+Sets the #GClosure used to compute the alpha value at each
+frame of the #ClutterTimeline bound to @alpha.
-This function will return if the @object already contains a member
- member_name
+Since: 0.8
-Deprecated: 0.8: Use json_object_set_member() instead
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="alpha">
+<parameter_description> A #ClutterAlpha
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="closure">
+<parameter_description> A #GClosure
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the value of the member
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_alpha_set_func">
+<description>
+Sets the #ClutterAlphaFunc function used to compute
+the alpha value at each frame of the #ClutterTimeline
+bound to @alpha.
+
+This function will not register @func as a global alpha function.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="alpha">
+<parameter_description> A #ClutterAlpha
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> A #ClutterAlphaFunc
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to be passed to the alpha function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> notify function used when disposing the alpha function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_justify">
+<function name="clutter_alpha_set_mode">
<description>
-Retrieves whether the #ClutterText actor should justify its contents
-on both margins.
+Sets the progress function of @alpha using the symbolic value
+of @mode, as taken by the #ClutterAnimationMode enumeration or
+using the value returned by clutter_alpha_register_func().
-Since: 0.6
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a #ClutterAnimationMode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the text should be justified
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_queue_relayout">
+<function name="clutter_alpha_set_timeline">
<description>
-Indicates that the actor's size request or other layout-affecting
-properties may have changed. This function is used inside #ClutterActor
-subclass implementations, not by applications directly.
+Binds @alpha to @timeline.
-Queueing a new layout automatically queues a redraw as well.
+Since: 0.2
-Since: 0.8
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="alpha">
+<parameter_description> A #ClutterAlpha
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_is_in_clone_paint">
+<function name="clutter_animatable_animate_property">
<description>
-Checks whether @self is being currently painted by a #ClutterClone
+Calls the animate_property() virtual function for @animatable.
-This function is useful only inside the ::paint virtual function
-implementations or within handlers for the #ClutterActor::paint
-signal
+The @initial_value and @final_value #GValue<!-- -->s must contain
+the same type; @value must have been initialized to the same
+type of @initial_value and @final_value.
-This function should not be used by applications
+All implementation of the #ClutterAnimatable interface must
+implement this function.
Since: 1.0
+Deprecated: 1.8: Use clutter_animatable_interpolate_value()
+instead
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable
+</parameter_description>
+</parameter>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the animated property
+</parameter_description>
+</parameter>
+<parameter name="initial_value">
+<parameter_description> the initial value of the animation interval
+</parameter_description>
+</parameter>
+<parameter name="final_value">
+<parameter_description> the final value of the animation interval
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> the progress factor
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> return location for the animation value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterActor is currently being painted
-by a #ClutterClone, and %FALSE otherwise
+<return> %TRUE if the value has been validated and can
+be applied to the #ClutterAnimatable, and %FALSE otherwise
</return>
</function>
-<function name="clutter_box_layout_get_vertical">
+<function name="clutter_animatable_find_property">
<description>
-Retrieves the orientation of the @layout as set using the
-clutter_box_layout_set_vertical() function
+Finds the #GParamSpec for @property_name
-Since: 1.2
+Since: 1.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the animatable property to find
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterBoxLayout is arranging its children
-vertically, and %FALSE otherwise
+<return> The #GParamSpec for the given property
+or %NULL
</return>
</function>
-<function name="clutter_behaviour_scale_set_bounds">
+<function name="clutter_animatable_get_initial_state">
<description>
-Sets the bounds used by scale behaviour.
+Retrieves the current state of @property_name and sets @value with it
-Since: 0.6
+Since: 1.4
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #ClutterBehaviourScale
-</parameter_description>
-</parameter>
-<parameter name="x_scale_start">
-<parameter_description> initial scale factor on the X axis
-</parameter_description>
-</parameter>
-<parameter name="y_scale_start">
-<parameter_description> initial scale factor on the Y axis
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable
</parameter_description>
</parameter>
-<parameter name="x_scale_end">
-<parameter_description> final scale factor on the X axis
+<parameter name="property_name">
+<parameter_description> the name of the animatable property to retrieve
</parameter_description>
</parameter>
-<parameter name="y_scale_end">
-<parameter_description> final scale factor on the Y axis
+<parameter name="value">
+<parameter_description> a #GValue initialized to the type of the property to retrieve
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_get_boolean_member">
+<function name="clutter_animatable_interpolate_value">
<description>
-Convenience function that retrieves the boolean value
-stored in @member_name of @object
+Asks a #ClutterAnimatable implementation to interpolate a
+a named property between the initial and final values of
+a #ClutterInterval, using @progress as the interpolation
+value, and store the result inside @value.
-See also: json_object_get_member()
+This function should be used for every property animation
+involving #ClutterAnimatable<!-- -->s.
-Since: 0.8
+This function replaces clutter_animatable_animate_property().
+
+Since: 1.8
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="property_name">
+<parameter_description> the name of the property to interpolate
+</parameter_description>
+</parameter>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval with the animation range
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> the progress to use to interpolate between the
+initial and final values of the @interval
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> return location for an initialized #GValue
+using the same type of the @interval
</parameter_description>
</parameter>
</parameters>
-<return> the boolean value of the object's member
+<return> %TRUE if the interpolation was successful,
+and %FALSE otherwise
</return>
</function>
-<function name="clutter_actor_box_get_origin">
+<function name="clutter_animatable_set_final_state">
<description>
-Retrieves the origin of @box
+Sets the current state of @property_name to @value
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate, or %NULL
+<parameter name="property_name">
+<parameter_description> the name of the animatable property to set
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate, or %NULL
+<parameter name="value">
+<parameter_description> the value of the animatable property to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_clone_get_source">
+<function name="clutter_animation_bind">
<description>
-Retrieves the source #ClutterActor being cloned by @clone
+Adds a single property with name @property_name to the
+animation @animation. For more information about animations,
+see clutter_actor_animate().
+
+This method returns the animation primarily to make chained
+calls convenient in language bindings.
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="clone">
-<parameter_description> a #ClutterClone
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the property to control
+</parameter_description>
+</parameter>
+<parameter name="final">
+<parameter_description> The final value of the property
</parameter_description>
</parameter>
</parameters>
-<return> the actor source for the clone
+<return> The animation itself.
</return>
</function>
-<function name="clutter_threads_add_frame_source">
+<function name="clutter_animation_bind_interval">
<description>
-Simple wrapper around clutter_threads_add_frame_source_full().
+Binds @interval to the @property_name of the #GObject
+attached to @animation. The #ClutterAnimation will take
+ownership of the passed #ClutterInterval. For more information
+about animations, see clutter_actor_animate().
-Since: 0.8
+If you need to update the interval instance use
+clutter_animation_update_interval() instead.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="fps">
-<parameter_description> the number of times per second to call the function
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+<parameter name="property_name">
+<parameter_description> the property to control
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
+<return> The animation itself.
</return>
</function>
-<function name="clutter_path_get_nodes">
+<function name="clutter_animation_completed">
<description>
-Returns a #GSList of #ClutterPathNode<!-- -->s. The list should be
-freed with g_slist_free(). The nodes are owned by the path and
-should not be freed. Altering the path may cause the nodes in the
-list to become invalid so you should copy them if you want to keep
-the list.
+Emits the ::completed signal on @animation
+
+When using this function with a #ClutterAnimation created
+by the clutter_actor_animate() family of functions, @animation
+will be unreferenced and it will not be valid anymore,
+unless g_object_ref() was called before calling this function
+or unless a reference was taken inside a handler for the
+#ClutterAnimation::completed signal
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
</parameters>
-<return> a list of nodes in the path.
-
-</return>
+<return></return>
</function>
-<function name="json_array_get_int_element">
+<function name="clutter_animation_get_alpha">
<description>
-Conveniently retrieves the integer value of the element at @index_
-inside @array
+Retrieves the #ClutterAlpha used by @animation.
-See also: json_array_get_element(), json_node_get_int()
+Since: 1.0
-Since: 0.8
+Deprecated: 1.10: Use clutter_animation_get_timeline() and
+clutter_timeline_get_progress_mode() instead.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
</parameters>
-<return> the integer value
+<return> the alpha object used by the animation
</return>
</function>
-<function name="clutter_actor_get_paint_visibility">
+<function name="clutter_animation_get_duration">
<description>
-Retrieves the 'paint' visibility of an actor recursively checking for non
-visible parents.
-
-This is by definition the same as CLUTTER_ACTOR_IS_MAPPED().
+Retrieves the duration of @animation, in milliseconds.
-Since: 0.8.4
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the actor is visibile and will be painted.
+<return> the duration of the animation
</return>
</function>
-<function name="clutter_cairo_set_source_color">
+<function name="clutter_animation_get_interval">
<description>
-Utility function for setting the source color of @cr using
-a #ClutterColor.
+Retrieves the #ClutterInterval associated to @property_name
+inside @animation.
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a Cairo context
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="property_name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterInterval or %NULL if no
+property with the same name was found. The returned interval is
+owned by the #ClutterAnimation and should not be unreferenced
+
+</return>
</function>
-<function name="clutter_actor_get_x">
+<function name="clutter_animation_get_loop">
<description>
-Retrieves the X coordinate of a #ClutterActor.
+Retrieves whether @animation is looping.
-This function tries to "do what you mean", by returning the
-correct value depending on the actor's state.
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
-If the actor has a valid allocation, this function will return
-the X coordinate of the origin of the allocation box.
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the animation is looping
-If the actor has any fixed coordinate set using clutter_actor_set_x(),
-clutter_actor_set_position() or clutter_actor_set_geometry(), this
-function will return that coordinate.
+</return>
+</function>
-If both the allocation and a fixed position are missing, this function
-will return 0.
+<function name="clutter_animation_get_mode">
+<description>
+Retrieves the animation mode of @animation, as set by
+clutter_animation_set_mode().
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
</parameters>
-<return> the X coordinate, in pixels, ignoring any
-transformation (i.e. scaling, rotation)
+<return> the mode for the animation
+
</return>
</function>
-<function name="clutter_actor_get_y">
+<function name="clutter_animation_get_object">
<description>
-Retrieves the Y coordinate of a #ClutterActor.
+Retrieves the #GObject attached to @animation.
-This function tries to "do what you mean", by returning the
-correct value depending on the actor's state.
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
-If the actor has a valid allocation, this function will return
-the Y coordinate of the origin of the allocation box.
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GObject
-If the actor has any fixed coordinate set using clutter_actor_set_y(),
-clutter_actor_set_position() or clutter_actor_set_geometry(), this
-function will return that coordinate.
+</return>
+</function>
-If both the allocation and a fixed position are missing, this function
-will return 0.
+<function name="clutter_animation_get_timeline">
+<description>
+Retrieves the #ClutterTimeline used by @animation
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
</parameters>
-<return> the Y coordinate, in pixels, ignoring any
-transformation (i.e. scaling, rotation)
+<return> the timeline used by the animation
+
</return>
</function>
-<function name="json_node_get_boolean">
+<function name="clutter_animation_has_property">
<description>
-Gets the boolean value stored inside a #JsonNode
+Checks whether @animation is controlling @property_name.
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
</parameters>
-<return> a boolean value.
+<return> %TRUE if the property is animated by the
+#ClutterAnimation, %FALSE otherwise
+
</return>
</function>
-<function name="clutter_interval_register_progress_func">
+<function name="clutter_animation_new">
<description>
-Sets the progress function for a given @value_type, like:
+Creates a new #ClutterAnimation instance. You should set the
+#GObject to be animated using clutter_animation_set_object(),
+set the duration with clutter_animation_set_duration() and the
+easing mode using clutter_animation_set_mode().
-|[
-clutter_interval_register_progress_func (MY_TYPE_FOO,
-my_foo_progress);
-]|
+Use clutter_animation_bind() or clutter_animation_bind_interval()
+to define the properties to be animated. The interval and the
+animated properties can be updated at runtime.
-Whenever a #ClutterInterval instance using the default
-#ClutterInterval::compute_value implementation is set as an
-interval between two #GValue of type @value_type, it will call
- func to establish the value depending on the given progress,
-for instance:
+The clutter_actor_animate() and relative family of functions provide
+an easy way to animate a #ClutterActor and automatically manage the
+lifetime of a #ClutterAnimation instance, so you should consider using
+those functions instead of manually creating an animation.
-|[
-static gboolean
-my_int_progress (const GValue *a,
-const GValue *b,
-gdouble progress,
-GValue *retval)
-{
-gint ia = g_value_get_int (a);
-gint ib = g_value_get_int (b);
-gint res = factor * (ib - ia) + ia;
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
-g_value_set_int (retval, res);
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterAnimation. Use g_object_unref()
+to release the associated resources
-return TRUE;
-}
+</return>
+</function>
-clutter_interval_register_progress_func (G_TYPE_INT, my_int_progress);
-]|
+<function name="clutter_animation_set_alpha">
+<description>
+Sets @alpha as the #ClutterAlpha used by @animation.
-To unset a previously set progress function of a #GType, pass %NULL
-for @func.
+If @alpha is not %NULL, the #ClutterAnimation will take ownership
+of the #ClutterAlpha instance.
Since: 1.0
+Deprecated: 1.10: Use clutter_animation_get_timeline() and
+clutter_timeline_set_progress_mode() instead.
+
</description>
<parameters>
-<parameter name="value_type">
-<parameter_description> a #GType
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #ClutterProgressFunc, or %NULL to unset a previously
-set progress function
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha, or %NULL to unset the current #ClutterAlpha
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_delete_chars">
+<function name="clutter_animation_set_duration">
<description>
-Deletes @n_chars inside a #ClutterText actor, starting from the
-current cursor position.
+Sets the duration of @animation in milliseconds.
+
+This function will set #ClutterAnimation:alpha and
+#ClutterAnimation:timeline if needed.
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> the number of characters to delete
+<parameter name="msecs">
+<parameter_description> the duration in milliseconds
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_device_manager_peek_devices">
+<function name="clutter_animation_set_loop">
<description>
-Lists all currently registered input devices
+Sets whether @animation should loop over itself once finished.
-Since: 1.2
+A looping #ClutterAnimation will not emit the #ClutterAnimation::completed
+signal when finished.
+
+This function will set #ClutterAnimation:alpha and
+#ClutterAnimation:timeline if needed.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="device_manager">
-<parameter_description> a #ClutterDeviceManager
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="loop">
+<parameter_description> %TRUE if the animation should loop
</parameter_description>
</parameter>
</parameters>
-<return>
-a pointer to the internal list of #ClutterInputDevice objects. The
-returned list is owned by the #ClutterDeviceManager and should never
-be modified or freed
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_has_pointer">
+<function name="clutter_animation_set_mode">
<description>
-Checks whether an actor contains the the pointer of a
-#ClutterInputDevice
+Sets the animation @mode of @animation. The animation @mode is
+a logical id, either coming from the #ClutterAnimationMode enumeration
+or the return value of clutter_alpha_register_func().
-Since: 1.2
+This function will also set #ClutterAnimation:alpha if needed.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> an animation mode logical id
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor contains the pointer, and
-%FALSE otherwise
+<return></return>
+</function>
-</return>
+<function name="clutter_animation_set_object">
+<description>
+Attaches @animation to @object. The #ClutterAnimation will take a
+reference on @object.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
+
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_path_add_rel_curve_to">
+<function name="clutter_animation_set_timeline">
<description>
-Same as clutter_path_add_curve_to() except the coordinates are
-relative to the previous node.
+Sets the #ClutterTimeline used by @animation.
+
+This function will take a reference on the passed @timeline.
Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="x_1">
-<parameter_description> the x coordinate of the first control point
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline, or %NULL to unset the
+current #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="y_1">
-<parameter_description> the y coordinate of the first control point
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_animation_unbind_property">
+<description>
+Removes @property_name from the list of animated properties.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
+
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="x_2">
-<parameter_description> the x coordinate of the second control point
+<parameter name="property_name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="y_2">
-<parameter_description> the y coordinate of the second control point
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_animation_update">
+<description>
+Updates the @final value of the interval for @property_name
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
+
+</description>
+<parameters>
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="x_3">
-<parameter_description> the x coordinate of the third control point
+<parameter name="property_name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="y_3">
-<parameter_description> the y coordinate of the third control point
+<parameter name="final">
+<parameter_description> The final value of the property
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The animation itself.
+
+</return>
</function>
-<function name="clutter_actor_apply_transform_to_point">
+<function name="clutter_animation_update_interval">
<description>
-Transforms @point in coordinates relative to the actor
-into screen-relative coordinates with the current actor
-transformation (i.e. scale, rotation, etc)
+Changes the @interval for @property_name. The #ClutterAnimation
+will take ownership of the passed #ClutterInterval.
-Since: 0.4
+Since: 1.0
+Deprecated: 1.12: Use #ClutterPropertyTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="animation">
+<parameter_description> a #ClutterAnimation
</parameter_description>
</parameter>
-<parameter name="point">
-<parameter_description> A point as #ClutterVertex
+<parameter name="property_name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="vertex">
-<parameter_description> The translated #ClutterVertex
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_get_alpha">
+<function name="clutter_animator_compute_value">
<description>
-Query the current alpha value.
+Compute the value for a managed property at a given progress.
-Since: 0.2
+If the property is an ease-in property, the current value of the property
+on the object will be used as the starting point for computation.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> A #ClutterAlpha
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the property on object to check
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> a value between 0.0 and 1.0
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an initialized value to store the computed result
</parameter_description>
</parameter>
</parameters>
-<return> The current alpha value for the alpha
+<return> %TRUE if the computation yields has a value, otherwise (when
+an error occurs or the progress is before any of the keys) %FALSE is
+returned and the #GValue is left untouched
</return>
</function>
-<function name="clutter_actor_box_get_area">
+<function name="clutter_animator_get_duration">
<description>
-Retrieves the area of @box
+Retrieves the current duration of an animator
-Since: 1.0
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
</parameter_description>
</parameter>
</parameters>
-<return> the area of a #ClutterActorBox, in pixels
+<return> the duration of the animation, in milliseconds
</return>
</function>
-<function name="clutter_model_iter_set">
+<function name="clutter_animator_get_keys">
<description>
-Sets the value of one or more cells in the row referenced by @iter. The
-variable argument list should contain integer column numbers, each column
-column number followed by the value to be set. The list is terminated by a
--1.
-
-For example, to set column 0 with type %G_TYPE_STRING, use:
-<informalexample><programlisting>
-clutter_model_iter_set (iter, 0, "foo", -1);
-</programlisting></informalexample>
+Returns a list of pointers to opaque structures with accessor functions
+that describe the keys added to an animator.
-Since: 0.6
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator instance
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of column/return location pairs, terminated by -1
+<parameter name="object">
+<parameter_description> a #GObject to search for, or %NULL for all objects
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> a specific property name to query for,
+or %NULL for all properties
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> a specific progress to search for, or a negative value for all
+progresses
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a
+list of #ClutterAnimatorKey<!-- -->s; the contents of the list are owned
+by the #ClutterAnimator, but you should free the returned list when done,
+using g_list_free()
+
+</return>
</function>
-<function name="clutter_color_from_hls">
+<function name="clutter_animator_get_timeline">
<description>
-Converts a color expressed in HLS (hue, luminance and saturation)
-values into a #ClutterColor.
+Get the timeline hooked up for driving the #ClutterAnimator
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
</parameter_description>
</parameter>
-<parameter name="hue">
-<parameter_description> hue value, in the 0 .. 360 range
+</parameters>
+<return> the #ClutterTimeline that drives the animator
+
+</return>
+</function>
+
+<function name="clutter_animator_key_get_mode">
+<description>
+Retrieves the mode of a #ClutterAnimator key, for the first key of a
+property for an object this represents the whether the animation is
+open ended and or curved for the remainding keys for the property it
+represents the easing mode.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="luminance">
-<parameter_description> luminance value, in the 0 .. 1 range
+</parameters>
+<return> the mode of a #ClutterAnimatorKey
+
+</return>
+</function>
+
+<function name="clutter_animator_key_get_object">
+<description>
+Retrieves the object a key applies to.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="saturation">
-<parameter_description> saturation value, in the 0 .. 1 range
+</parameters>
+<return> the object an animator_key exist for.
+
+</return>
+</function>
+
+<function name="clutter_animator_key_get_progress">
+<description>
+Retrieves the progress of an clutter_animator_key
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the progress defined for a #ClutterAnimator key.
+
+</return>
</function>
-<function name="clutter_text_get_color">
+<function name="clutter_animator_key_get_property_name">
<description>
-Retrieves the text color as set by clutter_text_set_color().
+Retrieves the name of the property a key applies to.
-Since: 1.0
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+</parameters>
+<return> the name of the property an animator_key exist for.
+
+</return>
+</function>
+
+<function name="clutter_animator_key_get_property_type">
+<description>
+Retrieves the #GType of the property a key applies to
+
+You can use this type to initialize the #GValue to pass to
+clutter_animator_key_get_value()
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GType of the property
+
+</return>
</function>
-<function name="clutter_main_level">
+<function name="clutter_animator_key_get_value">
<description>
-Retrieves the depth of the Clutter mainloop.
+Retrieves a copy of the value for a #ClutterAnimatorKey.
+The passed in #GValue needs to be already initialized for the value
+type of the key or to a type that allow transformation from the value
+type of the key.
+
+Use g_value_unset() when done.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterAnimatorKey
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue initialized with the correct type for the animator key
+</parameter_description>
+</parameter>
</parameters>
-<return> The level of the mainloop.
+<return> %TRUE if the passed #GValue was successfully set, and
+%FALSE otherwise
+
</return>
</function>
-<function name="clutter_script_get_objects">
+<function name="clutter_animator_new">
<description>
-Retrieves a list of objects for the given names. After @script, object
-names/return location pairs should be listed, with a %NULL pointer
-ending the list, like:
+Creates a new #ClutterAnimator instance
-<informalexample><programlisting>
-GObject *my_label, *a_button, *main_timeline;
+Since: 1.2
-clutter_script_get_objects (script,
-"my-label", &my_label,
-"a-button", &a_button,
-"main-timeline", &main_timeline,
-NULL);
-</programlisting></informalexample>
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
-Note: This function does not increment the reference count of the
-returned objects.
+</description>
+<parameters>
+</parameters>
+<return> a new #ClutterAnimator.
-Since: 0.6
+</return>
+</function>
+
+<function name="clutter_animator_property_get_ease_in">
+<description>
+Checks if a property value is to be eased into the animation.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="animator">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="first_name">
-<parameter_description> the name of the first object to retrieve
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> return location for a #GObject, then additional names, ending
-with %NULL
+<parameter name="property_name">
+<parameter_description> the name of a property on object
</parameter_description>
</parameter>
</parameters>
-<return> the number of objects returned.
+<return> %TRUE if the property is eased in
</return>
</function>
-<function name="clutter_animation_update">
+<function name="clutter_animator_property_get_interpolation">
<description>
-Updates the @final value of the interval for @property_name
+Get the interpolation used by animator for a property on a particular
+object.
-Since: 1.0
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="animator">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> name of the property
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="final">
-<parameter_description> The final value of the property
+<parameter name="property_name">
+<parameter_description> the name of a property on object
</parameter_description>
</parameter>
</parameters>
-<return> The animation itself.
-
+<return> a ClutterInterpolation value.
</return>
</function>
-<function name="clutter_box_get_color">
+<function name="clutter_animator_property_set_ease_in">
<description>
-Retrieves the background color of @box
-
-If the #ClutterBox:color-set property is set to %FALSE the
-returned #ClutterColor is undefined
+Sets whether a property value is to be eased into the animation.
Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="animator">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of a property on object
+</parameter_description>
+</parameter>
+<parameter name="ease_in">
+<parameter_description> we are going to be easing in this property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_event">
+<function name="clutter_animator_property_set_interpolation">
<description>
-This function is used to emit an event on the main stage.
-
-You should rarely need to use this function, except for
-synthetised events.
+Set the interpolation method to use, %CLUTTER_INTERPOLATION_LINEAR causes
+the values to linearly change between the values, and
+%CLUTTER_INTERPOLATION_CUBIC causes the values to smoothly change between
+the values.
-Since: 0.4
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="animator">
+<parameter_description> a #ClutterAnimatorKey
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of a property on object
+</parameter_description>
+</parameter>
+<parameter name="interpolation">
+<parameter_description> the #ClutterInterpolation to use
</parameter_description>
</parameter>
</parameters>
-<return> the return value from the signal emission
+<return></return>
+</function>
-</return>
+<function name="clutter_animator_remove_key">
+<description>
+Removes all keys matching the conditions specificed in the arguments.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> a #GObject to search for, or %NULL for all
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> a specific property name to query for,
+or %NULL for all
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> a specific progress to search for or a negative value
+for all
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_model_set_sort">
+<function name="clutter_animator_set">
<description>
-Sorts @model using the given sorting function.
+Adds multiple keys to a #ClutterAnimator, specifying the value a given
+property should have at a given progress of the animation. The mode
+specified is the mode used when going to this key from the previous key of
+the @property_name
-Since: 0.6
+If a given (object, property, progress) tuple already exist the mode and
+value will be replaced with the new values.
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> the column to sort on
+<parameter name="first_object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #ClutterModelSortFunc, or #NULL
+<parameter name="first_property_name">
+<parameter_description> the property to specify a key for
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func, or #NULL
+<parameter name="first_mode">
+<parameter_description> the id of the alpha function to use
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> destroy notifier of @user_data, or #NULL
+<parameter name="first_progress">
+<parameter_description> at which stage of the animation this value applies; the
+range is a normalized floating point value between 0 and 1
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the value first_property_name should have for first_object
+at first_progress, followed by more (object, property_name, mode,
+progress, value) tuples, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_get_row_spacing">
+<function name="clutter_animator_set_duration">
<description>
-Retrieves the spacing between rows
+Runs the timeline of the #ClutterAnimator with a duration in msecs
+as specified.
Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
+</parameter_description>
+</parameter>
+<parameter name="duration">
+<parameter_description> milliseconds a run of the animator should last.
</parameter_description>
</parameter>
</parameters>
-<return> the spacing between rows of the #ClutterFlowLayout,
-in pixels
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_set_rotation">
+<function name="clutter_animator_set_key">
<description>
-Sets the rotation angle of @self around the given axis.
-
-The rotation center coordinates used depend on the value of @axis:
-<itemizedlist>
-<listitem><para>%CLUTTER_X_AXIS requires @y and @z</para></listitem>
-<listitem><para>%CLUTTER_Y_AXIS requires @x and @z</para></listitem>
-<listitem><para>%CLUTTER_Z_AXIS requires @x and @y</para></listitem>
-</itemizedlist>
+Sets a single key in the #ClutterAnimator for the @property_name of
+ object at @progress.
-The rotation coordinates are relative to the anchor point of the
-actor, set using clutter_actor_set_anchor_point(). If no anchor
-point is set, the upper left corner is assumed as the origin.
+See also: clutter_animator_set()
-Since: 0.8
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
</parameter_description>
</parameter>
-<parameter name="axis">
-<parameter_description> the axis of rotation
+<parameter name="object">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="angle">
-<parameter_description> the angle of rotation
+<parameter name="property_name">
+<parameter_description> the property to specify a key for
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate of the rotation center
+<parameter name="mode">
+<parameter_description> the id of the alpha function to use
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate of the rotation center
+<parameter name="progress">
+<parameter_description> the normalized range at which stage of the animation this
+value applies
</parameter_description>
</parameter>
-<parameter name="z">
-<parameter_description> Z coordinate of the rotation center
+<parameter name="value">
+<parameter_description> the value property_name should have at progress.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The animator instance
+
+</return>
+</function>
+
+<function name="clutter_animator_set_timeline">
+<description>
+Sets an external timeline that will be used for driving the animation
+
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
+
+</description>
+<parameters>
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_get_sync_size">
+<function name="clutter_animator_start">
<description>
-Retrieves the value set with clutter_texture_get_sync_size()
+Start the ClutterAnimator, this is a thin wrapper that rewinds
+and starts the animators current timeline.
-Since: 1.0
+Since: 1.2
+Deprecated: 1.12: Use #ClutterKeyframeTransition instead
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterTexture should have the same
-preferred size of the underlying image data
+<return> the #ClutterTimeline that drives
+the animator. The returned timeline is owned by the #ClutterAnimator
+and it should not be unreferenced
</return>
</function>
-<function name="clutter_value_get_shader_matrix">
+<function name="clutter_backend_get_cogl_context">
<description>
-Retrieves a matrix of floating point values stored inside
-the passed #GValue. @value must have been initialized with
-%CLUTTER_TYPE_SHADER_MATRIX.
+Retrieves the #CoglContext associated with the given clutter
+ backend A #CoglContext is required when using some of the
+experimental 2.0 Cogl API.
-Since: 0.8
+<note>Since CoglContext is itself experimental API this API should
+be considered experimental too.</note>
+
+<note>This API is not yet supported on OSX because OSX still
+uses the stub Cogl winsys and the Clutter backend doesn't
+explicitly create a CoglContext.</note>
+
+Since: 1.8
+Stability: unstable
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of returned floating
-point values, or %NULL
+</parameters>
+<return> The #CoglContext associated with @backend.
+
+</return>
+</function>
+
+<function name="clutter_backend_get_double_click_distance">
+<description>
+Retrieves the distance used to verify a double click event
+
+Since: 0.4
+
+Deprecated: 1.4: Use #ClutterSettings:double-click-distance instead
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
</parameters>
-<return> the pointer to a matrix
-of floating point values. The returned value is owned by the #GValue and
-should never be modified or freed.
+<return> a distance, in pixels.
</return>
</function>
-<function name="clutter_text_set_font_description">
+<function name="clutter_backend_get_double_click_time">
<description>
-Sets @font_desc as the font description for a #ClutterText
+Gets the maximum time between two button press events, as set
+by clutter_backend_set_double_click_time().
-The #PangoFontDescription is copied by the #ClutterText actor
-so you can safely call pango_font_description_free() on it after
-calling this function.
+Since: 0.4
-Since: 1.2
+Deprecated: 1.4: Use #ClutterSettings:double-click-time instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
-<parameter name="font_desc">
-<parameter_description> a #PangoFontDescription
+</parameters>
+<return> a time in milliseconds
+
+</return>
+</function>
+
+<function name="clutter_backend_get_font_name">
+<description>
+Retrieves the default font name as set by
+clutter_backend_set_font_name().
+
+Since: 1.0
+
+Deprecated: 1.4: Use #ClutterSettings:font-name instead
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the font name for the backend. The returned string is
+owned by the #ClutterBackend and should never be modified or freed
+
+</return>
</function>
-<function name="clutter_get_pointer_grab">
+<function name="clutter_backend_get_font_options">
<description>
-Queries the current pointer grab of clutter.
+Retrieves the font options for @backend.
-Since: 0.6
+Since: 0.8
</description>
<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
+</parameter_description>
+</parameter>
</parameters>
-<return> the actor currently holding the pointer grab, or NULL if there is no grab.
+<return> the font options of the #ClutterBackend.
+The returned #cairo_font_options_t is owned by the backend and should
+not be modified or freed
</return>
</function>
-<function name="clutter_layout_manager_list_child_properties">
+<function name="clutter_backend_get_resolution">
<description>
-Retrieves all the #GParamSpec<!-- -->s for the layout properties
-stored inside the #ClutterLayoutMeta sub-class used by @manager
+Gets the resolution for font handling on the screen.
-Since: 1.2
+The resolution is a scale factor between points specified in a
+#PangoFontDescription and cairo units. The default value is 96.0,
+meaning that a 10 point font will be 13 units
+high (10 * 96. / 72. = 13.3).
+
+Clutter will set the resolution using the current backend when
+initializing; the resolution is also stored in the
+#ClutterSettings:font-dpi property.
+
+Since: 0.4
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
-<parameter name="n_pspecs">
-<parameter_description> return location for the number of returned
-#GParamSpec<!-- -->s
+</parameters>
+<return> the current resolution, or -1 if no resolution
+has been set.
+
+</return>
+</function>
+
+<function name="clutter_backend_set_double_click_distance">
+<description>
+Sets the maximum distance used to verify a double click event.
+
+Since: 0.4
+
+Deprecated: 1.4: Use #ClutterSettings:double-click-distance instead
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
+</parameter_description>
+</parameter>
+<parameter name="distance">
+<parameter_description> a distance, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> the newly-allocated, %NULL-terminated
-array of #GParamSpec<!-- -->s. Use g_free() to free the resources
-allocated for the array
+<return></return>
+</function>
-</return>
+<function name="clutter_backend_set_double_click_time">
+<description>
+Sets the maximum time between two button press events, used to
+verify whether it's a double click event or not.
+
+Since: 0.4
+
+Deprecated: 1.4: Use #ClutterSettings:double-click-time instead
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
+</parameter_description>
+</parameter>
+<parameter name="msec">
+<parameter_description> milliseconds between two button press events
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_units_copy">
+<function name="clutter_backend_set_font_name">
<description>
-Copies @units
+Sets the default font to be used by Clutter. The @font_name string
+must either be %NULL, which means that the font name from the
+default #ClutterBackend will be used; or be something that can
+be parsed by the pango_font_description_from_string() function.
Since: 1.0
+Deprecated: 1.4: Use #ClutterSettings:font-name instead
+
</description>
<parameters>
-<parameter name="units">
-<parameter_description> the #ClutterUnits to copy
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
+</parameter_description>
+</parameter>
+<parameter name="font_name">
+<parameter_description> the name of the font
</parameter_description>
</parameter>
</parameters>
-<return> the newly created copy of a #ClutterUnits structure.
-Use clutter_units_free() to free the allocated resources
-
-</return>
+<return></return>
</function>
-<function name="clutter_x11_texture_pixmap_set_window">
+<function name="clutter_backend_set_font_options">
<description>
-Sets up a suitable pixmap for the window, using the composite and damage
-extensions if possible, and then calls
-clutter_x11_texture_pixmap_set_pixmap().
+Sets the new font options for @backend. The #ClutterBackend will
+copy the #cairo_font_options_t.
-If you want to display a window in a #ClutterTexture, you probably want
-this function, or its older sister, clutter_glx_texture_pixmap_set_window()
+If @options is %NULL, the first following call to
+clutter_backend_get_font_options() will return the default font
+options for @backend.
+
+This function is intended for actors creating a Pango layout
+using the PangoCairo API.
Since: 0.8
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> the texture to bind
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> the X window to which the texture should be bound
+<parameter name="options">
+<parameter_description> Cairo font options for the backend, or %NULL
</parameter_description>
</parameter>
-<parameter name="automatic">
-<parameter_description> %TRUE for automatic window updates, %FALSE for manual.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_backend_set_resolution">
+<description>
+Sets the resolution for font handling on the screen. This is a
+scale factor between points specified in a #PangoFontDescription
+and cairo units. The default value is 96, meaning that a 10 point
+font will be 13 units high. (10 * 96. / 72. = 13.3).
+
+Applications should never need to call this function.
+
+Since: 0.4
+
+Deprecated: 1.4: Use #ClutterSettings:font-dpi instead
+
+</description>
+<parameters>
+<parameter name="backend">
+<parameter_description> a #ClutterBackend
+</parameter_description>
+</parameter>
+<parameter name="dpi">
+<parameter_description> the resolution in "dots per inch" (Physical inches aren't
+actually involved; the terminology is conventional).
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_get_int">
+<function name="clutter_behaviour_actors_foreach">
<description>
-Gets the integer value stored inside a #JsonNode
+Calls @func for every actor driven by @behave.
+
+Since: 0.2
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a function called for each actor
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> optional data to be passed to the function, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> an integer value.
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_center">
+<function name="clutter_behaviour_apply">
<description>
-Sets the center of the elliptical path to the point represented by knot.
+Applies @behave to @actor. This function adds a reference on
+the actor.
-Since: 0.4
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinace of centre
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinace of centre
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_depth_get_bounds">
+<description>
+Gets the boundaries of the @behaviour
+
+Since: 0.6
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="behaviour">
+<parameter_description> a #ClutterBehaviourDepth
+</parameter_description>
+</parameter>
+<parameter name="depth_start">
+<parameter_description> return location for the initial depth value, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="depth_end">
+<parameter_description> return location for the final depth value, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_set_container">
+<function name="clutter_behaviour_depth_new">
<description>
-If the #ClutterLayoutManager sub-class allows it, allow
-adding a weak reference of the @container using @manager
-from within the layout manager
+Creates a new #ClutterBehaviourDepth which can be used to control
+the ClutterActor:depth property of a set of #ClutterActor<!-- -->s.
-The layout manager should not increase the reference
-count of the @container
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
-Since: 1.2
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha instance, or %NULL
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> a #ClutterContainer using @manager
+<parameter name="depth_start">
+<parameter_description> initial value of the depth
+</parameter_description>
+</parameter>
+<parameter name="depth_end">
+<parameter_description> final value of the depth
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created behaviour
+
+</return>
+</function>
+
+<function name="clutter_behaviour_depth_set_bounds">
+<description>
+Sets the boundaries of the @behaviour.
+
+Since: 0.6
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="behaviour">
+<parameter_description> a #ClutterBehaviourDepth
+</parameter_description>
+</parameter>
+<parameter name="depth_start">
+<parameter_description> initial value of the depth
+</parameter_description>
+</parameter>
+<parameter name="depth_end">
+<parameter_description> final value of the depth
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_new">
+<function name="clutter_behaviour_ellipse_get_angle_end">
<description>
-Creates a new #ClutterBoxLayout layout manager
+Gets the at which movements ends.
-Since: 1.2
+Since: 0.4
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterBoxLayout
+<return> angle in degrees
</return>
</function>
-<function name="clutter_text_get_font_description">
+<function name="clutter_behaviour_ellipse_get_angle_start">
<description>
-Retrieves the #PangoFontDescription used by @self
+Gets the angle at which movements starts.
-Since: 1.2
+Since: 0.6
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoFontDescription. The returned value is owned
-by the #ClutterText actor and it should not be modified or freed
+<return> angle in degrees
</return>
</function>
-<function name="clutter_x11_get_stage_window">
+<function name="clutter_behaviour_ellipse_get_angle_tilt">
<description>
-Gets the stages X Window.
+Gets the tilt of the ellipse around the center in the given axis.
Since: 0.4
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="axis">
+<parameter_description> a #ClutterRotateAxis
</parameter_description>
</parameter>
</parameters>
-<return> An XID for the stage window.
+<return> angle in degrees.
</return>
</function>
-<function name="clutter_cairo_texture_get_surface_size">
+<function name="clutter_behaviour_ellipse_get_center">
<description>
-Retrieves the surface width and height for @self.
+Gets the center of the elliptical path path.
-Since: 1.0
+Since: 0.4
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterCairoTexture
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for the surface width, or %NULL
+<parameter name="x">
+<parameter_description> return location for the X coordinate of the center, or %NULL
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the surface height, or %NULL
+<parameter name="y">
+<parameter_description> return location for the Y coordinate of the center, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_get_font_flags">
+<function name="clutter_behaviour_ellipse_get_direction">
<description>
-Gets the current font flags for rendering text. See
-clutter_set_font_flags().
+Retrieves the #ClutterRotateDirection used by the ellipse behaviour.
-Since: 1.0
+Since: 0.4
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
</parameters>
-<return> The font flags
+<return> the rotation direction
</return>
</function>
-<function name="clutter_box_set_color">
+<function name="clutter_behaviour_ellipse_get_height">
<description>
-Sets (or unsets) the background color for @box
+Gets the height of the elliptical path.
-Since: 1.2
+Since: 0.4
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the background color, or %NULL to unset
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the height of the path
+
+</return>
</function>
-<function name="clutter_ungrab_pointer_for_device">
+<function name="clutter_behaviour_ellipse_get_tilt">
<description>
-Removes an existing grab of the pointer events for device @id.
+Gets the tilt of the ellipse around the center in Y axis.
-Since: 0.8
+Since: 0.4
</description>
<parameters>
-<parameter name="id">
-<parameter_description> a device id
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="angle_tilt_x">
+<parameter_description> return location for tilt angle on the X axis, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="angle_tilt_y">
+<parameter_description> return location for tilt angle on the Y axis, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="angle_tilt_z">
+<parameter_description> return location for tilt angle on the Z axis, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_queue_redraw">
+<function name="clutter_behaviour_ellipse_get_width">
<description>
-Queues a redraw for the passed stage.
-
-<note>Applications should call clutter_actor_queue_redraw() and not
-this function.</note>
-
-<note>This function is just a wrapper for clutter_actor_queue_redraw()
-and should probably go away.</note>
+Gets the width of the elliptical path.
-Since: 0.8
+Since: 0.4
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of the path
+
+</return>
</function>
-<function name="json_object_get_member">
+<function name="clutter_behaviour_ellipse_new">
<description>
-Retrieves the #JsonNode containing the value of @member_name inside
-a #JsonObject.
+Creates a behaviour that drives actors along an elliptical path with
+given center, width and height; the movement starts at @start
+degrees (with 0 corresponding to 12 o'clock) and ends at @end
+degrees. Angles greated than 360 degrees get clamped to the canonical
+interval <0, 360); if @start is equal to @end, the behaviour will
+rotate by exacly 360 degrees.
+
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+Since: 0.4
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha instance, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x coordinace of the center
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y coordiance of the center
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the JSON object member to access
+<parameter name="width">
+<parameter_description> width of the ellipse
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the ellipse
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> #ClutterRotateDirection of rotation
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> angle in degrees at which movement starts, between 0 and 360
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> angle in degrees at which movement ends, between 0 and 360
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the node for the requested object
-member, or %NULL
+<return> the newly created #ClutterBehaviourEllipse
+
</return>
</function>
-<function name="json_array_add_null_element">
+<function name="clutter_behaviour_ellipse_set_angle_end">
<description>
-Conveniently adds a null element into @array
-
-See also: json_array_add_element(), %JSON_NODE_NULL
+Sets the angle at which movement ends; angles >= 360 degress get clamped
+to the canonical interval <0, 360).
-Since: 0.8
+Since: 0.4
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="angle_end">
+<parameter_description> angle at which movement ends in degrees, between 0 and 360.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_put">
+<function name="clutter_behaviour_ellipse_set_angle_start">
<description>
-Puts a copy of the event on the back of the event queue. The event will
-have the %CLUTTER_EVENT_FLAG_SYNTHETIC flag set. If the source is set
-event signals will be emitted for this source and capture/bubbling for
-its ancestors. If the source is not set it will be generated by picking
-or use the actor that currently has keyboard focus
+Sets the angle at which movement starts; angles >= 360 degress get clamped
+to the canonical interval <0, 360).
Since: 0.6
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="angle_start">
+<parameter_description> angle at which movement starts in degrees, between 0 and 360.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_param_spec_fixed">
+<function name="clutter_behaviour_ellipse_set_angle_tilt">
<description>
-Creates a #GParamSpec for properties using #CoglFixed values
+Sets the angle at which the ellipse should be tilted around it's center.
-Since: 0.8
+Since: 0.4
</description>
<parameters>
-<parameter name="name">
-<parameter_description> name of the property
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
-<parameter name="nick">
-<parameter_description> short name
+<parameter name="axis">
+<parameter_description> a #ClutterRotateAxis
</parameter_description>
</parameter>
-<parameter name="blurb">
-<parameter_description> description (can be translatable)
+<parameter name="angle_tilt">
+<parameter_description> tilt of the elipse around the center in the given axis in
+degrees.
</parameter_description>
</parameter>
-<parameter name="minimum">
-<parameter_description> lower boundary
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_ellipse_set_center">
+<description>
+Sets the center of the elliptical path to the point represented by knot.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
-<parameter name="maximum">
-<parameter_description> higher boundary
+<parameter name="x">
+<parameter_description> x coordinace of centre
</parameter_description>
</parameter>
-<parameter name="default_value">
-<parameter_description> default value
+<parameter name="y">
+<parameter_description> y coordinace of centre
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags for the param spec
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_ellipse_set_direction">
+<description>
+Sets the rotation direction used by the ellipse behaviour.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> the rotation direction
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GParamSpec
-
-</return>
+<return></return>
</function>
-<function name="clutter_color_equal">
+<function name="clutter_behaviour_ellipse_set_height">
<description>
-Compares two #ClutterColor<!-- -->s and checks if they are the same.
-
-This function can be passed to g_hash_table_new() as the @key_equal_func
-parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
+Sets the height of the elliptical path.
-Since: 0.2
+Since: 0.4
</description>
<parameters>
-<parameter name="v1">
-<parameter_description> a #ClutterColor
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
-<parameter name="v2">
-<parameter_description> a #ClutterColor
+<parameter name="height">
+<parameter_description> height of the ellipse
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the two colors are the same.
-
-</return>
+<return></return>
</function>
-<function name="clutter_shader_set_uniform">
+<function name="clutter_behaviour_ellipse_set_tilt">
<description>
-Sets a user configurable variable in the GLSL shader programs attached to
-a #ClutterShader.
+Sets the angles at which the ellipse should be tilted around it's center.
-Since: 1.0
+Since: 0.4
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader.
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of uniform in GLSL shader program to set.
+<parameter name="angle_tilt_x">
+<parameter_description> tilt of the elipse around the center in X axis in degrees.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #ClutterShaderFloat, #ClutterShaderInt or #ClutterShaderMatrix
-#GValue.
+<parameter name="angle_tilt_y">
+<parameter_description> tilt of the elipse around the center in Y axis in degrees.
+</parameter_description>
+</parameter>
+<parameter name="angle_tilt_z">
+<parameter_description> tilt of the elipse around the center in Z axis in degrees.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_rotate_get_axis">
+<function name="clutter_behaviour_ellipse_set_width">
<description>
-Retrieves the #ClutterRotateAxis used by the rotate behaviour.
+Sets the width of the elliptical path.
Since: 0.4
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="self">
+<parameter_description> a #ClutterBehaviourEllipse
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the ellipse
</parameter_description>
</parameter>
</parameters>
-<return> the rotation axis
+<return></return>
+</function>
+
+<function name="clutter_behaviour_get_actors">
+<description>
+Retrieves all the actors to which @behave applies. It is not recommended
+for derived classes to use this in there alpha notify method but use
+#clutter_behaviour_actors_foreach as it avoids alot of needless allocations.
+
+Since: 0.2
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
+</parameter_description>
+</parameter>
+</parameters>
+<return> a list of
+actors. You should free the returned list with g_slist_free() when
+finished using it.
</return>
</function>
-<function name="clutter_actor_get_request_mode">
+<function name="clutter_behaviour_get_alpha">
<description>
-Retrieves the geometry request mode of @self
+Retrieves the #ClutterAlpha object bound to @behave.
-Since: 1.2
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
</parameter_description>
</parameter>
</parameters>
-<return> the request mode for the actor
+<return> a #ClutterAlpha object, or %NULL if no alpha
+object has been bound to this behaviour.
</return>
</function>
-<function name="clutter_glx_texture_pixmap_new">
+<function name="clutter_behaviour_get_n_actors">
<description>
-Creates a new, empty #ClutterGLXTexturePixmap
+Gets the number of actors this behaviour is applied too.
-Since: 0.8
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
+</parameter_description>
+</parameter>
</parameters>
-<return> A new #ClutterGLXTexturePixmap
+<return> The number of applied actors
</return>
</function>
-<function name="clutter_rectangle_new_with_color">
+<function name="clutter_behaviour_get_nth_actor">
<description>
-Creates a new #ClutterActor with a rectangular shape
-and of the given @color.
+Gets an actor the behaviour was applied to referenced by index num.
+
+Since: 0.2
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of an actor this behaviour is applied too.
</parameter_description>
</parameter>
</parameters>
-<return> a new #ClutterActor
+<return> A Clutter actor or NULL if @index_ is invalid.
+
</return>
</function>
-<function name="clutter_win32_set_stage_foreign">
+<function name="clutter_behaviour_is_applied">
<description>
-Target the #ClutterStage to use an existing external window handle.
+Check if @behave applied to @actor.
-Since: 0.8
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
</parameter_description>
</parameter>
-<parameter name="hwnd">
-<parameter_description> an existing window handle
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if foreign window is valid
+<return> TRUE if actor has behaviour. FALSE otherwise.
</return>
</function>
-<function name="clutter_container_remove">
+<function name="clutter_behaviour_opacity_get_bounds">
<description>
-Removes a %NULL terminated list of #ClutterActor<!-- -->s from
- container Each actor should be unparented, so if you want to keep it
-around you must hold a reference to it yourself, using g_object_ref().
-Each time an actor is removed, the "actor-removed" signal is
-emitted by @container.
+Gets the initial and final levels of the opacity applied by @behaviour
+on each actor it controls.
-Since: 0.4
+Since: 0.6
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="behaviour">
+<parameter_description> a #ClutterBehaviourOpacity
</parameter_description>
</parameter>
-<parameter name="first_actor">
-<parameter_description> first #ClutterActor to remove
+<parameter name="opacity_start">
+<parameter_description> return location for the minimum level of opacity, or %NULL
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of actors to remove
+<parameter name="opacity_end">
+<parameter_description> return location for the maximum level of opacity, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_set_func">
+<function name="clutter_behaviour_opacity_new">
<description>
-Sets the #ClutterAlphaFunc function used to compute
-the alpha value at each frame of the #ClutterTimeline
-bound to @alpha.
+Creates a new #ClutterBehaviourOpacity object, driven by @alpha
+which controls the opacity property of every actor, making it
+change in the interval between @opacity_start and @opacity_end.
-This function will not register @func as a global alpha function.
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
Since: 0.2
+Deprecated: 1.6
+
</description>
<parameters>
<parameter name="alpha">
-<parameter_description> A #ClutterAlpha
+<parameter_description> a #ClutterAlpha instance, or %NULL
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> A #ClutterAlphaFunc
+<parameter name="opacity_start">
+<parameter_description> minimum level of opacity
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to be passed to the alpha function, or %NULL
+<parameter name="opacity_end">
+<parameter_description> maximum level of opacity
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> notify function used when disposing the alpha function
+</parameters>
+<return> the newly created #ClutterBehaviourOpacity
+
+</return>
+</function>
+
+<function name="clutter_behaviour_opacity_set_bounds">
+<description>
+Sets the initial and final levels of the opacity applied by @behaviour
+on each actor it controls.
+
+Since: 0.6
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="behaviour">
+<parameter_description> a #ClutterBehaviourOpacity
+</parameter_description>
+</parameter>
+<parameter name="opacity_start">
+<parameter_description> minimum level of opacity
+</parameter_description>
+</parameter>
+<parameter name="opacity_end">
+<parameter_description> maximum level of opacity
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_get_size">
+<function name="clutter_behaviour_path_get_path">
<description>
-Retrieves the size of @box
+Get the current path of the behaviour
Since: 1.0
+Deprecated: 1.6
+
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="pathb">
+<parameter_description> a #ClutterBehaviourPath instance
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for the width, or %NULL
+</parameters>
+<return> the path
+
+</return>
+</function>
+
+<function name="clutter_behaviour_path_new">
+<description>
+Creates a new path behaviour. You can use this behaviour to drive
+actors along the nodes of a path, described by @path.
+
+This will claim the floating reference on the #ClutterPath so you
+do not need to unref if it.
+
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+
+Since: 0.2
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha instance, or %NULL
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the height, or %NULL
+<parameter name="path">
+<parameter_description> a #ClutterPath or %NULL for an empty path
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterBehaviour
+
+</return>
+</function>
+
+<function name="clutter_behaviour_path_new_with_description">
+<description>
+Creates a new path behaviour using the path described by @desc. See
+clutter_path_add_string() for a description of the format.
+
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+
+Since: 1.0
+
+Deprecated: 1.6
+
+</description>
+<parameters>
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha instance, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="desc">
+<parameter_description> a string description of the path
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterBehaviour
+
+</return>
</function>
<function name="clutter_behaviour_path_new_with_knots">
@@ -7364,12 +15153,18 @@ A path will be created where the first knot is used in a
%CLUTTER_PATH_MOVE_TO and the subsequent knots are used in
%CLUTTER_PATH_LINE_TO<!-- -->s.
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+
Since: 1.0
+Deprecated: 1.6
+
</description>
<parameters>
<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter_description> a #ClutterAlpha instance, or %NULL
</parameter_description>
</parameter>
<parameter name="knots">
@@ -7386,77 +15181,160 @@ Since: 1.0
</return>
</function>
-<function name="clutter_script_ensure_objects">
+<function name="clutter_behaviour_path_set_path">
<description>
-Ensure that every object defined inside @script is correctly
-constructed. You should rarely need to use this function.
+Change the path that the actors will follow. This will take the
+floating reference on the #ClutterPath so you do not need to unref
+it.
-Since: 0.6
+Since: 1.0
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="pathb">
+<parameter_description> the path behaviour
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> the new path to follow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_set_object">
+<function name="clutter_behaviour_remove">
<description>
-Sets @objects inside @node. The reference count of @object is increased.
+Removes @actor from the list of #ClutterActor<!-- -->s to which
+ behave applies. This function removes a reference on the actor.
+
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_clip">
+<function name="clutter_behaviour_remove_all">
<description>
-Gets the clip area for @self, if any is set
+Removes every actor from the list that @behave holds.
-Since: 0.6
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
</parameter_description>
</parameter>
-<parameter name="xoff">
-<parameter_description> return location for the X offset of
-the clip rectangle, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_rotate_get_axis">
+<description>
+Retrieves the #ClutterRotateAxis used by the rotate behaviour.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
</parameter_description>
</parameter>
-<parameter name="yoff">
-<parameter_description> return location for the Y offset of
-the clip rectangle, or %NULL
+</parameters>
+<return> the rotation axis
+
+</return>
+</function>
+
+<function name="clutter_behaviour_rotate_get_bounds">
+<description>
+Retrieves the rotation boundaries of the rotate behaviour.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for the width of
-the clip rectangle, or %NULL
+<parameter name="angle_start">
+<parameter_description> return value for the initial angle
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the height of
-the clip rectangle, or %NULL
+<parameter name="angle_end">
+<parameter_description> return value for the final angle
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_rotate_get_center">
+<description>
+Retrieves the center of rotation set using
+clutter_behaviour_rotate_set_center().
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return location for the X center of rotation
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for the Y center of rotation
+</parameter_description>
+</parameter>
+<parameter name="z">
+<parameter_description> return location for the Z center of rotation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="clutter_behaviour_rotate_get_direction">
+<description>
+Retrieves the #ClutterRotateDirection used by the rotate behaviour.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
+</parameter_description>
+</parameter>
+</parameters>
+<return> the rotation direction
+
+</return>
+</function>
+
<function name="clutter_behaviour_rotate_new">
<description>
Creates a new #ClutterBehaviourRotate. This behaviour will rotate actors
@@ -7465,12 +15343,16 @@ bound to it on @axis, following @direction, between @angle_start and
<0, 360), if angle_start == angle_end, the behaviour will carry out a
single rotation of 360 degrees.
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+
Since: 0.4
</description>
<parameters>
<parameter name="alpha">
-<parameter_description> a #ClutterAlpha, or %NULL
+<parameter_description> a #ClutterAlpha instance, or %NULL
</parameter_description>
</parameter>
<parameter name="axis">
@@ -7495,1484 +15377,2824 @@ Since: 0.4
</return>
</function>
-<function name="clutter_actor_set_parent">
+<function name="clutter_behaviour_rotate_set_axis">
<description>
-Sets the parent of @self to @parent. The opposite function is
-clutter_actor_unparent().
+Sets the axis used by the rotate behaviour.
-This function should not be used by applications, but by custom
-container actor subclasses.
+Since: 0.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> A new #ClutterActor parent
+<parameter name="axis">
+<parameter_description> a #ClutterRotateAxis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_set_cursor_color">
+<function name="clutter_behaviour_rotate_set_bounds">
<description>
-Sets the color of the cursor of a #ClutterText actor.
-
-If @color is %NULL, the cursor color will be the same as the
-text color.
+Sets the initial and final angles of a rotation behaviour; angles >= 360
+degrees get clamped to the canonical interval <0, 360).
-Since: 1.0
+Since: 0.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color of the cursor, or %NULL to unset it
+<parameter name="angle_start">
+<parameter_description> initial angle in degrees, between 0 and 360.
+</parameter_description>
+</parameter>
+<parameter name="angle_end">
+<parameter_description> final angle in degrees, between 0 and 360.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_set_load_data_async">
+<function name="clutter_behaviour_rotate_set_center">
<description>
-Sets whether @texture should use a worker thread to load the data
-from disk asynchronously. Setting @load_async to %TRUE will make
-clutter_texture_set_from_file() block until the #ClutterTexture has
-determined the width and height of the image data.
+Sets the center of rotation. The coordinates are relative to the plane
+normal to the rotation axis set with clutter_behaviour_rotate_set_axis().
-See the #ClutterTexture:load-async property documentation, and
-clutter_texture_set_load_async().
+Since: 0.4
-Since: 1.0
+</description>
+<parameters>
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X axis center of rotation
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y axis center of rotation
+</parameter_description>
+</parameter>
+<parameter name="z">
+<parameter_description> Z axis center of rotation
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_behaviour_rotate_set_direction">
+<description>
+Sets the rotation direction used by the rotate behaviour.
+
+Since: 0.4
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="rotate">
+<parameter_description> a #ClutterBehaviourRotate
</parameter_description>
</parameter>
-<parameter name="load_async">
-<parameter_description> %TRUE if the texture should asynchronously load data
-from a filename
+<parameter name="direction">
+<parameter_description> the rotation direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_child_set_property">
+<function name="clutter_behaviour_scale_get_bounds">
<description>
-Sets a property on the #ClutterLayoutMeta created by @manager and
-attached to a child of @container
+Retrieves the bounds used by scale behaviour.
-Since: 1.2
+Since: 0.4
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="scale">
+<parameter_description> a #ClutterBehaviourScale
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> a #ClutterContainer using @manager
+<parameter name="x_scale_start">
+<parameter_description> return location for the initial scale factor on the X
+axis, or %NULL
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @container
+<parameter name="y_scale_start">
+<parameter_description> return location for the initial scale factor on the Y
+axis, or %NULL
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property to set
+<parameter name="x_scale_end">
+<parameter_description> return location for the final scale factor on the X axis,
+or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue with the value of the property to set
+<parameter name="y_scale_end">
+<parameter_description> return location for the final scale factor on the Y axis,
+or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_win32_get_stage_window">
+<function name="clutter_behaviour_scale_new">
<description>
-Gets the stage's window handle
+Creates a new #ClutterBehaviourScale instance.
-Since: 0.8
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance. In the case when @alpha is %NULL,
+it can be set later with clutter_behaviour_set_alpha().
+
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha instance, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="x_scale_start">
+<parameter_description> initial scale factor on the X axis
+</parameter_description>
+</parameter>
+<parameter name="y_scale_start">
+<parameter_description> initial scale factor on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="x_scale_end">
+<parameter_description> final scale factor on the X axis
+</parameter_description>
+</parameter>
+<parameter name="y_scale_end">
+<parameter_description> final scale factor on the Y axis
</parameter_description>
</parameter>
</parameters>
-<return> An HWND for the stage window.
+<return> the newly created #ClutterBehaviourScale
</return>
</function>
-<function name="clutter_actor_lower">
+<function name="clutter_behaviour_scale_set_bounds">
<description>
-Puts @self below @above.
+Sets the bounds used by scale behaviour.
-Both actors must have the same parent, and the parent must implement
-the #ClutterContainer interface.
+Since: 0.6
-This function is the equivalent of clutter_container_lower_child().
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="scale">
+<parameter_description> a #ClutterBehaviourScale
</parameter_description>
</parameter>
-<parameter name="above">
-<parameter_description> A #ClutterActor to lower below
+<parameter name="x_scale_start">
+<parameter_description> initial scale factor on the X axis
+</parameter_description>
+</parameter>
+<parameter name="y_scale_start">
+<parameter_description> initial scale factor on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="x_scale_end">
+<parameter_description> final scale factor on the X axis
+</parameter_description>
+</parameter>
+<parameter name="y_scale_end">
+<parameter_description> final scale factor on the Y axis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_layout">
+<function name="clutter_behaviour_set_alpha">
<description>
-Retrieves the current #PangoLayout used by a #ClutterText actor.
+Binds @alpha to a #ClutterBehaviour. The #ClutterAlpha object
+is what makes a behaviour work: for each tick of the timeline
+used by #ClutterAlpha a new value of the alpha parameter is
+computed by the alpha function; the value should be used by
+the #ClutterBehaviour to update one or more properties of the
+actors to which the behaviour applies.
-Since: 1.0
+If @alpha is not %NULL, the #ClutterBehaviour will take ownership
+of the #ClutterAlpha instance.
+
+Since: 0.2
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="behave">
+<parameter_description> a #ClutterBehaviour
+</parameter_description>
+</parameter>
+<parameter name="alpha">
+<parameter_description> a #ClutterAlpha or %NULL to unset a previously set alpha
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoLayout. The returned object is owned by
-the #ClutterText actor and should not be modified or freed
-
-</return>
+<return></return>
</function>
-<function name="clutter_x11_remove_filter">
+<function name="clutter_bin_layout_add">
<description>
-Removes the given filter function.
+Adds a #ClutterActor to the container using @self and
+sets the alignment policies for it
-Since: 0.6
+This function is equivalent to clutter_container_add_actor()
+and clutter_layout_manager_child_set_property() but it does not
+require a pointer to the #ClutterContainer associated to the
+#ClutterBinLayout
+
+Since: 1.2
+
+Deprecated: 1.12: Use clutter_actor_add_child() instead.
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a filter function
+<parameter name="self">
+<parameter_description> a #ClutterBinLayout
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to be passed to the filter function, or %NULL
+<parameter name="child">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> horizontal alignment policy for @child
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> vertical alignment policy for @child
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_allocate">
+<function name="clutter_bin_layout_get_alignment">
<description>
-Called by the parent of an actor to assign the actor its size.
-Should never be called by applications (except when implementing
-a container or layout manager).
+Retrieves the horizontal and vertical alignment policies for
+a child of @self
-Actors can know from their allocation box whether they have moved
-with respect to their parent actor. The @flags parameter describes
-additional information about the allocation, for instance whether
-the parent has moved with respect to the stage, for example because
-a grandparent's origin has moved.
+If @child is %NULL the default alignment policies will be returned
+instead
-Since: 0.8
+Since: 1.2
+
+Deprecated: 1.12: Use the #ClutterActor:x-align and the
+#ClutterActor:y-align properties of #ClutterActor instead.
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterBinLayout
</parameter_description>
</parameter>
-<parameter name="box">
-<parameter_description> new allocation of the actor, in parent-relative coordinates
+<parameter name="child">
+<parameter_description> a child of @container
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags that control the allocation
+<parameter name="x_align">
+<parameter_description> return location for the horizontal
+alignment policy
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> return location for the vertical
+alignment policy
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_get_length">
+<function name="clutter_bin_layout_new">
<description>
-Retrieves the length of a #JsonArray
+Creates a new #ClutterBinLayout layout manager
+Since: 1.2
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="x_align">
+<parameter_description> the default alignment policy to be used on the
+horizontal axis
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> the default alignment policy to be used on the
+vertical axis
</parameter_description>
</parameter>
</parameters>
-<return> the length of the array
+<return> the newly created layout manager
+
</return>
</function>
-<function name="clutter_score_stop">
+<function name="clutter_bin_layout_set_alignment">
<description>
-Stops and rewinds a playing #ClutterScore instance.
+Sets the horizontal and vertical alignment policies to be applied
+to a @child of @self
-Since: 0.6
+If @child is %NULL then the @x_align and @y_align values will
+be set as the default alignment policies
+
+Since: 1.2
+
+Deprecated: 1.12: Use the #ClutterActor:x-align and
+#ClutterActor:y-align properties of #ClutterActor instead.
</description>
<parameters>
-<parameter name="score">
-<parameter_description> A #ClutterScore
+<parameter name="self">
+<parameter_description> a #ClutterBinLayout
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a child of @container
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> the horizontal alignment policy to be used for the @child
+inside @container
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> the vertical aligment policy to be used on the @child
+inside @container
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_selection_bound">
+<function name="clutter_bind_constraint_get_coordinate">
<description>
-Retrieves the other end of the selection of a #ClutterText actor,
-in characters from the current cursor position.
+Retrieves the bound coordinate of the constraint
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
</parameter_description>
</parameter>
</parameters>
-<return> the position of the other end of the selection
+<return> the bound coordinate
</return>
</function>
-<function name="clutter_x11_get_stage_from_window">
+<function name="clutter_bind_constraint_get_offset">
<description>
-Gets the stage for a particular X window.
+Retrieves the offset set using clutter_bind_constraint_set_offset()
-Since: 0.8
+Since: 1.4
</description>
<parameters>
-<parameter name="win">
-<parameter_description> an X Window ID
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
</parameter_description>
</parameter>
</parameters>
-<return> The stage or NULL if a stage does not exist for the window.
+<return> the offset, in pixels
</return>
</function>
-<function name="clutter_timeline_get_elapsed_time">
+<function name="clutter_bind_constraint_get_source">
<description>
-Request the current time position of the timeline.
+Retrieves the #ClutterActor set using clutter_bind_constraint_set_source()
+Since: 1.4
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
</parameter_description>
</parameter>
</parameters>
-<return> current elapsed time in milliseconds.
+<return> a pointer to the source actor
+
</return>
</function>
-<function name="clutter_backend_get_font_name">
+<function name="clutter_bind_constraint_new">
<description>
-Retrieves the default font name as set by
-clutter_backend_set_font_name().
+Creates a new constraint, binding a #ClutterActor's position to
+the given @coordinate of the position of @source
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="source">
+<parameter_description> the #ClutterActor to use as the source of
+the binding, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="coordinate">
+<parameter_description> the coordinate to bind
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> the offset to apply to the binding, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> the font name for the backend. The returned string is
-owned by the #ClutterBackend and should never be modified or freed
+<return> the newly created #ClutterBindConstraint
</return>
</function>
-<function name="clutter_x11_trap_x_errors">
+<function name="clutter_bind_constraint_set_coordinate">
<description>
-Traps every X error until clutter_x11_untrap_x_errors() is called.
+Sets the coordinate to bind in the constraint
-Since: 0.6
+Since: 1.4
</description>
<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
+</parameter_description>
+</parameter>
+<parameter name="coordinate">
+<parameter_description> the coordinate to bind
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="json_generator_set_root">
+<function name="clutter_bind_constraint_set_offset">
<description>
-Sets @node as the root of the JSON data stream to be serialized by
-the #JsonGenerator.
+Sets the offset to be applied to the constraint
+
+Since: 1.4
</description>
<parameters>
-<parameter name="generator">
-<parameter_description> a #JsonGenerator
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="offset">
+<parameter_description> the offset to apply, in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_position_to_coords">
+<function name="clutter_bind_constraint_set_source">
<description>
-Retrieves the coordinates of the given @position.
+Sets the source #ClutterActor for the constraint
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterBindConstraint
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> a #ClutterActor, or %NULL to unset the source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_binding_pool_activate">
+<description>
+Activates the callback associated to the action that is
+bound to the @key_val and @modifiers pair.
+
+The callback has the following signature:
+
+|[
+void (* callback) (GObject *gobject,
+const gchar *action_name,
+guint key_val,
+ClutterModifierType modifiers,
+gpointer user_data);
+]|
+
+Where the #GObject instance is @gobject and the user data
+is the one passed when installing the action with
+clutter_binding_pool_install_action().
+
+If the action bound to the @key_val, @modifiers pair has been
+blocked using clutter_binding_pool_block_action(), the callback
+will not be invoked, and this function will return %FALSE.
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> position in characters
+<parameter name="key_val">
+<parameter_description> the key symbol
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate, or %NULL
+<parameter name="modifiers">
+<parameter_description> bitmask for the modifiers
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate, or %NULL
+<parameter name="gobject">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
-<parameter name="line_height">
-<parameter_description> return location for the line height, or %NULL
+</parameters>
+<return> %TRUE if an action was found and was activated
+
+</return>
+</function>
+
+<function name="clutter_binding_pool_block_action">
+<description>
+Blocks all the actions with name @action_name inside @pool.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
+</parameter_description>
+</parameter>
+<parameter name="action_name">
+<parameter_description> an action name
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the conversion was successful
+<return></return>
+</function>
+
+<function name="clutter_binding_pool_find">
+<description>
+Finds the #ClutterBindingPool with @name.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the name of the binding pool to find
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the #ClutterBindingPool, or %NULL
</return>
</function>
-<function name="clutter_text_get_line_alignment">
+<function name="clutter_binding_pool_find_action">
<description>
-Retrieves the alignment of a #ClutterText, as set by
-clutter_text_set_line_alignment().
+Retrieves the name of the action matching the given key symbol
+and modifiers bitmask.
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
+</parameter_description>
+</parameter>
+<parameter name="key_val">
+<parameter_description> a key symbol
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> a bitmask for the modifiers
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoAlignment
+<return> the name of the action, if found, or %NULL. The
+returned string is owned by the binding pool and should never
+be modified or freed
</return>
</function>
-<function name="clutter_actor_animatev">
+<function name="clutter_binding_pool_get_for_class">
<description>
-Animates the given list of properties of @actor between the current
-value for each property and a new final value. The animation has a
-definite duration and a speed given by the @mode.
+Retrieves the #ClutterBindingPool for the given #GObject class
+and, eventually, creates it. This function is a wrapper around
+clutter_binding_pool_new() and uses the class type name as the
+unique name for the binding pool.
-This is the vector-based variant of clutter_actor_animate(), useful
-for language bindings.
+Calling this function multiple times will return the same
+#ClutterBindingPool.
-<warning>Unlike clutter_actor_animate(), this function will not
-allow you to specify "signal::" names and callbacks.</warning>
+A binding pool for a class can also be retrieved using
+clutter_binding_pool_find() with the class type name:
+
+|[
+pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));
+]|
Since: 1.0
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="klass">
+<parameter_description> a #GObjectClass pointer
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an animation mode logical id
+</parameters>
+<return> the binding pool for the given class.
+The returned #ClutterBindingPool is owned by Clutter and should not
+be freed directly
+
+</return>
+</function>
+
+<function name="clutter_binding_pool_install_action">
+<description>
+Installs a new action inside a #ClutterBindingPool. The action
+is bound to @key_val and @modifiers.
+
+The same action name can be used for multiple @key_val, @modifiers
+pairs.
+
+When an action has been activated using clutter_binding_pool_activate()
+the passed @callback will be invoked (with @data).
+
+Actions can be blocked with clutter_binding_pool_block_action()
+and then unblocked using clutter_binding_pool_unblock_action().
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
</parameter_description>
</parameter>
-<parameter name="duration">
-<parameter_description> duration of the animation, in milliseconds
+<parameter name="action_name">
+<parameter_description> the name of the action
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> number of property names and values
+<parameter name="key_val">
+<parameter_description> key symbol
</parameter_description>
</parameter>
-<parameter name="properties">
-<parameter_description> a vector
-containing the property names to set
+<parameter name="modifiers">
+<parameter_description> bitmask of modifiers
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector containing the
-property values to set
+<parameter name="callback">
+<parameter_description> function to be called
+when the action is activated
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to be passed to @callback
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when the action is removed
+from the pool
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAnimation object. The object is
-owned by the #ClutterActor and should not be unreferenced with
-g_object_unref()
-
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_rotate_set_direction">
+<function name="clutter_binding_pool_install_closure">
<description>
-Sets the rotation direction used by the rotate behaviour.
+A #GClosure variant of clutter_binding_pool_install_action().
-Since: 0.4
+Installs a new action inside a #ClutterBindingPool. The action
+is bound to @key_val and @modifiers.
+
+The same action name can be used for multiple @key_val, @modifiers
+pairs.
+
+When an action has been activated using clutter_binding_pool_activate()
+the passed @closure will be invoked.
+
+Actions can be blocked with clutter_binding_pool_block_action()
+and then unblocked using clutter_binding_pool_unblock_action().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> the rotation direction
+<parameter name="action_name">
+<parameter_description> the name of the action
+</parameter_description>
+</parameter>
+<parameter name="key_val">
+<parameter_description> key symbol
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> bitmask of modifiers
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_get_title">
+<function name="clutter_binding_pool_new">
<description>
-Gets the stage title.
+Creates a new #ClutterBindingPool that can be used to store
+key bindings for an actor. The @name must be a unique identifier
+for the binding pool, so that clutter_binding_pool_find() will
+be able to return the correct binding pool.
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="name">
+<parameter_description> the name of the binding pool
</parameter_description>
</parameter>
</parameters>
-<return> pointer to the title string for the stage. The
-returned string is owned by the actor and should not
-be modified or freed.
+<return> the newly created binding pool with the given
+name. Use g_object_unref() when done.
</return>
</function>
-<function name="json_object_has_member">
+<function name="clutter_binding_pool_override_action">
<description>
-Checks whether @object has a member named @member_name.
+Allows overriding the action for @key_val and @modifiers inside a
+#ClutterBindingPool. See clutter_binding_pool_install_action().
+When an action has been activated using clutter_binding_pool_activate()
+the passed @callback will be invoked (with @data).
+
+Actions can be blocked with clutter_binding_pool_block_action()
+and then unblocked using clutter_binding_pool_unblock_action().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
+</parameter_description>
+</parameter>
+<parameter name="key_val">
+<parameter_description> key symbol
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of a JSON object member
+<parameter name="modifiers">
+<parameter_description> bitmask of modifiers
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> function to be called when the action is activated
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to be passed to @callback
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when the action is removed
+from the pool
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the JSON object has the requested member
-</return>
+<return></return>
</function>
-<function name="clutter_timeline_has_marker">
+<function name="clutter_binding_pool_override_closure">
<description>
-Checks whether @timeline has a marker set with the given name.
+A #GClosure variant of clutter_binding_pool_override_action().
-Since: 0.8
+Allows overriding the action for @key_val and @modifiers inside a
+#ClutterBindingPool. See clutter_binding_pool_install_closure().
+
+When an action has been activated using clutter_binding_pool_activate()
+the passed @callback will be invoked (with @data).
+
+Actions can be blocked with clutter_binding_pool_block_action()
+and then unblocked using clutter_binding_pool_unblock_action().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
</parameter_description>
</parameter>
-<parameter name="marker_name">
-<parameter_description> the name of the marker
+<parameter name="key_val">
+<parameter_description> key symbol
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> bitmask of modifiers
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the marker was found
+<return></return>
+</function>
-</return>
+<function name="clutter_binding_pool_remove_action">
+<description>
+Removes the action matching the given @key_val, @modifiers pair,
+if any exists.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
+</parameter_description>
+</parameter>
+<parameter name="key_val">
+<parameter_description> a key symbol
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> a bitmask for the modifiers
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_texture_get_load_async">
+<function name="clutter_binding_pool_unblock_action">
<description>
-Retrieves the value set using clutter_texture_get_load_async()
+Unblockes all the actions with name @action_name inside @pool.
+
+Unblocking an action does not cause the callback bound to it to
+be invoked in case clutter_binding_pool_activate() was called on
+an action previously blocked with clutter_binding_pool_block_action().
Since: 1.0
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="pool">
+<parameter_description> a #ClutterBindingPool
+</parameter_description>
+</parameter>
+<parameter name="action_name">
+<parameter_description> an action name
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterTexture should load the data from
-disk asynchronously
+<return></return>
+</function>
+
+<function name="clutter_blur_effect_new">
+<description>
+Creates a new #ClutterBlurEffect to be used with
+clutter_actor_add_effect()
+
+Since: 1.4
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterBlurEffect or %NULL
</return>
</function>
-<function name="json_array_add_int_element">
+<function name="clutter_box_get_color">
<description>
-Conveniently adds an integer @value into @array
+Retrieves the background color of @box
+
+If the #ClutterBox:color-set property is set to %FALSE the
+returned #ClutterColor is undefined
-See also: json_array_add_element(), json_node_set_int()
+Since: 1.2
-Since: 0.8
+Deprecated: 1.10: Use clutter_actor_get_background_color() instead.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="box">
+<parameter_description> a #ClutterBox
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an integer value
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animator_get_keys">
+<function name="clutter_box_get_layout_manager">
<description>
-Returns a list of pointers to opaque structures with accessor functions
-that describe the keys added to an animator.
+Retrieves the #ClutterLayoutManager instance used by @box
Since: 1.2
+Deprecated: 1.10: Use clutter_actor_get_layout_manager() instead.
+
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator instance
+<parameter name="box">
+<parameter_description> a #ClutterBox
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject to search for, or %NULL for all objects
+</parameters>
+<return> a #ClutterLayoutManager. The returned
+#ClutterLayoutManager is owned by the #ClutterBox and it should not
+be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_alignment">
+<description>
+Retrieves the horizontal and vertical alignment policies for @actor
+as set using clutter_box_layout_pack() or clutter_box_layout_set_alignment()
+
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-align and #ClutterActor:y-align properies
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> a specific property name to query for,
-or %NULL for all properties
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> a specific progress to search for, or a negative value for all
-progresses
+<parameter name="x_align">
+<parameter_description> return location for the horizontal alignment policy
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> return location for the vertical alignment policy
</parameter_description>
</parameter>
</parameters>
-<return> a
-list of #ClutterAnimatorKey<!-- -->s; the contents of the list are owned
-by the #ClutterAnimator, but you should free the returned list when done,
-using g_list_free()
+<return></return>
+</function>
+
+<function name="clutter_box_layout_get_easing_duration">
+<description>
+Retrieves the duration set using clutter_box_layout_set_easing_duration()
+
+Since: 1.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the duration of the animations, in milliseconds
</return>
</function>
-<function name="clutter_color_to_hls">
+<function name="clutter_box_layout_get_easing_mode">
<description>
-Converts @color to the HLS format.
+Retrieves the easing mode set using clutter_box_layout_set_easing_mode()
-The @hue value is in the 0 .. 360 range. The @luminance and
- saturation values are in the 0 .. 1 range.
+Since: 1.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="hue">
-<parameter_description> return location for the hue value or %NULL
+</parameters>
+<return> an easing mode
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_expand">
+<description>
+Retrieves whether @actor should expand inside @layout
+
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-expand and #ClutterActor:y-expand properies
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="luminance">
-<parameter_description> return location for the luminance value or %NULL
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
</parameter_description>
</parameter>
-<parameter name="saturation">
-<parameter_description> return location for the saturation value or %NULL
+</parameters>
+<return> %TRUE if the #ClutterActor should expand, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_fill">
+<description>
+Retrieves the horizontal and vertical fill policies for @actor
+as set using clutter_box_layout_pack() or clutter_box_layout_set_fill()
+
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-align and #ClutterActor:y-align properies
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_fill">
+<parameter_description> return location for the horizontal fill policy
+</parameter_description>
+</parameter>
+<parameter name="y_fill">
+<parameter_description> return location for the vertical fill policy
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_insert_text">
+<function name="clutter_box_layout_get_homogeneous">
<description>
-Inserts @text into a #ClutterActor at the given position.
+Retrieves if the children sizes are allocated homogeneously.
-If @position is a negative number, the text will be appended
-at the end of the current contents of the #ClutterText.
+Since: 1.4
-The position is expressed in characters, not in bytes.
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the #ClutterBoxLayout is arranging its children
+homogeneously, and %FALSE otherwise
-Since: 1.0
+</return>
+</function>
+
+<function name="clutter_box_layout_get_orientation">
+<description>
+Retrieves the orientation of the @layout.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to be inserted
+</parameters>
+<return> the orientation of the layout
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_pack_start">
+<description>
+Retrieves the value set using clutter_box_layout_set_pack_start()
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the position of the insertion, or -1
+</parameters>
+<return> %TRUE if the #ClutterBoxLayout should pack children
+at the beginning of the layout, and %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_spacing">
+<description>
+Retrieves the spacing set using clutter_box_layout_set_spacing()
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the spacing between children of the #ClutterBoxLayout
+
+</return>
</function>
-<function name="clutter_interval_set_initial_value">
+<function name="clutter_box_layout_get_use_animations">
<description>
-Sets the initial value of @interval to @value. The value is copied
-inside the #ClutterInterval.
+Retrieves whether @layout should animate changes in the layout properties.
-Since: 1.0
+Since: 1.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue
+</parameters>
+<return> %TRUE if the animations should be used, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_box_layout_get_vertical">
+<description>
+Retrieves the orientation of the @layout as set using the
+clutter_box_layout_set_vertical() function
+
+Since: 1.2
+
+Deprecated: 1.12: Use clutter_box_layout_get_orientation() instead
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the #ClutterBoxLayout is arranging its children
+vertically, and %FALSE otherwise
+
+</return>
</function>
-<function name="clutter_stage_set_minimum_size">
+<function name="clutter_box_layout_new">
<description>
-Sets the minimum size for a stage window, if the default backend
-uses #ClutterStage inside a window
+Creates a new #ClutterBoxLayout layout manager
-This is a convenience function, and it is equivalent to setting the
-#ClutterActor:min-width and #ClutterActor:min-height on @stage
+Since: 1.2
-If the current size of @stage is smaller than the minimum size, the
- stage will be resized to the new @width and @height
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterBoxLayout
-This function has no effect if @stage is fullscreen
+</return>
+</function>
+
+<function name="clutter_box_layout_pack">
+<description>
+Packs @actor inside the #ClutterContainer associated to @layout
+and sets the layout properties
Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout honours #ClutterActor's
+align and expand properties. The preferred way is adding
+the @actor with clutter_actor_add_child() and setting
+#ClutterActor:x-align, #ClutterActor:y-align,
+#ClutterActor:x-expand and #ClutterActor:y-expand
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width, in pixels
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height, in pixels
+<parameter name="expand">
+<parameter_description> whether the @actor should expand
+</parameter_description>
+</parameter>
+<parameter name="x_fill">
+<parameter_description> whether the @actor should fill horizontally
+</parameter_description>
+</parameter>
+<parameter name="y_fill">
+<parameter_description> whether the @actor should fill vertically
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> the horizontal alignment policy for @actor
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> the vertical alignment policy for @actor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_layout_changed">
+<function name="clutter_box_layout_set_alignment">
<description>
-Emits the #ClutterLayoutManager::layout-changed signal on @manager
+Sets the horizontal and vertical alignment policies for @actor
+inside @layout
-This function should only be called by implementations of the
-#ClutterLayoutManager class
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-align and #ClutterActor:y-align properies
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> Horizontal alignment policy for @actor
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> Vertical alignment policy for @actor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_box_layout_set_easing_duration">
+<description>
+Sets the duration of the animations used by @layout when animating changes
+in the layout properties.
Since: 1.2
+Deprecated: 1.12: The layout manager will honour the easing state
+of the children when allocating them.
+
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> the duration of the animations, in milliseconds
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_has_property">
+<function name="clutter_box_layout_set_easing_mode">
<description>
-Checks whether @animation is controlling @property_name.
+Sets the easing mode to be used by @layout when animating changes in layout
+properties.
-Since: 1.0
+Since: 1.2
+
+Deprecated: 1.12: The layout manager will honour the easing state
+of the children when allocating them.
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> name of the property
+<parameter name="mode">
+<parameter_description> an easing mode, either from #ClutterAnimationMode or a logical id
+from clutter_alpha_register_func()
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the property is animated by the
-#ClutterAnimation, %FALSE otherwise
+<return></return>
+</function>
-</return>
+<function name="clutter_box_layout_set_expand">
+<description>
+Sets whether @actor should expand inside @layout
+
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-expand and #ClutterActor:y-expand properies
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> whether @actor should expand
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_model_remove">
+<function name="clutter_box_layout_set_fill">
<description>
-Removes the row at the given position from the model.
+Sets the horizontal and vertical fill policies for @actor
+inside @layout
-Since: 0.6
+Since: 1.2
+Deprecated: 1.12: #ClutterBoxLayout will honour #ClutterActor's
+#ClutterActor:x-align and #ClutterActor:y-align properies
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> position of row to remove
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_fill">
+<parameter_description> whether @actor should fill horizontally the allocated space
+</parameter_description>
+</parameter>
+<parameter name="y_fill">
+<parameter_description> whether @actor should fill vertically the allocated space
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_progress">
+<function name="clutter_box_layout_set_homogeneous">
<description>
-Retrieves the playback progress of @media.
+Sets whether the size of @layout children should be
+homogeneous
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="homogeneous">
+<parameter_description> %TRUE if the layout should be homogeneous
</parameter_description>
</parameter>
</parameters>
-<return> the playback progress, between 0.0 and 1.0
+<return></return>
+</function>
-</return>
+<function name="clutter_box_layout_set_orientation">
+<description>
+Sets the orientation of the #ClutterBoxLayout layout manager.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation of the #ClutterBoxLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_value_get_color">
+<function name="clutter_box_layout_set_pack_start">
<description>
-Gets the #ClutterColor contained in @value.
+Sets whether children of @layout should be layed out by appending
+them or by prepending them
-Since: 0.8.4
+Since: 1.2
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue initialized to #CLUTTER_TYPE_COLOR
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="pack_start">
+<parameter_description> %TRUE if the @layout should pack children at the
+beginning of the layout
</parameter_description>
</parameter>
</parameters>
-<return> the colors inside the passed #GValue
+<return></return>
+</function>
-</return>
+<function name="clutter_box_layout_set_spacing">
+<description>
+Sets the spacing between children of @layout
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the spacing between children of the layout, in pixels
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_set_scale_with_gravity">
+<function name="clutter_box_layout_set_use_animations">
<description>
-Scales an actor with the given factors around the given
-center point. The center point is specified as one of the compass
-directions in #ClutterGravity. For example, setting it to north
-will cause the top of the actor to remain unchanged and the rest of
-the actor to expand left, right and downwards.
+Sets whether @layout should animate changes in the layout properties
-Since: 1.0
+The duration of the animations is controlled by
+clutter_box_layout_set_easing_duration(); the easing mode to be used
+by the animations is controlled by clutter_box_layout_set_easing_mode().
+
+Enabling animations will override the easing state of each child
+of the actor using @layout, and will use the #ClutterBoxLayout:easing-mode
+and #ClutterBoxLayout:easing-duration properties instead.
+
+Since: 1.2
+
+Deprecated: 1.12: The layout manager will honour the easing state
+of the children when allocating them.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="scale_x">
-<parameter_description> double factor to scale actor by horizontally.
+<parameter name="animate">
+<parameter_description> %TRUE if the @layout should use animations
</parameter_description>
</parameter>
-<parameter name="scale_y">
-<parameter_description> double factor to scale actor by vertically.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_box_layout_set_vertical">
+<description>
+Sets whether @layout should arrange its children vertically alongside
+the Y axis, instead of horizontally alongside the X axis
+
+Since: 1.2
+
+Deprecated: 1.12: Use clutter_box_layout_set_orientation() instead.
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterBoxLayout
</parameter_description>
</parameter>
-<parameter name="gravity">
-<parameter_description> the location of the scale center expressed as a compass
-direction.
+<parameter name="vertical">
+<parameter_description> %TRUE if the layout should be vertical
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="cogl_pango_font_map_get_use_mipmapping">
+<function name="clutter_box_new">
<description>
-Retrieves whether the #CoglPangoRenderer used by @fm will
-use mipmapping when rendering the glyphs.
+Creates a new #ClutterBox. The children of the box will be layed
+out by the passed @manager
-Since: 1.0
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_new() instead.
</description>
<parameters>
-<parameter name="fm">
-<parameter_description> a #CoglPangoFontMap
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if mipmapping is used, %FALSE otherwise.
+<return> the newly created #ClutterBox actor
</return>
</function>
-<function name="clutter_flow_layout_set_row_height">
+<function name="clutter_box_pack">
<description>
-Sets the minimum and maximum heights that a row can have
+Adds @actor to @box and sets layout properties at the same time,
+if the #ClutterLayoutManager used by @box has them
+
+This function is a wrapper around clutter_container_add_actor()
+and clutter_layout_manager_child_set()
+
+Language bindings should use the vector-based clutter_box_packv()
+variant instead
Since: 1.2
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
+
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="box">
+<parameter_description> a #ClutterBox
</parameter_description>
</parameter>
-<parameter name="min_height">
-<parameter_description> the minimum height of a row
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="max_height">
-<parameter_description> the maximum height of a row
+<parameter name="first_property">
+<parameter_description> the name of the first property to set, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of property name and value pairs, terminated by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_reparent">
+<function name="clutter_box_pack_after">
<description>
-This function resets the parent actor of @self. It is
-logically equivalent to calling clutter_actor_unparent()
-and clutter_actor_set_parent(), but more efficiently
-implemented, ensures the child is not finalized
-when unparented, and emits the parent-set signal only
-one time.
+Adds @actor to @box, placing it after @sibling, and sets layout
+properties at the same time, if the #ClutterLayoutManager used by
+ box supports them
-Since: 0.2
+If @sibling is %NULL then @actor is placed at the end of the
+list of children, to be allocated and painted after every other child
+
+This function is a wrapper around clutter_container_add_actor(),
+clutter_container_raise_child() and clutter_layout_manager_child_set()
+
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_insert_child_above() instead.
</description>
<parameters>
-<parameter name="self">
+<parameter name="box">
+<parameter_description> a #ClutterBox
+</parameter_description>
+</parameter>
+<parameter name="actor">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="new_parent">
-<parameter_description> the new #ClutterActor parent
+<parameter name="sibling">
+<parameter_description> a #ClutterActor or %NULL
+</parameter_description>
+</parameter>
+<parameter name="first_property">
+<parameter_description> the name of the first property to set, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of property name and value pairs, terminated by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_new">
+<function name="clutter_box_pack_at">
<description>
-Creates a new #ClutterInterval holding values of type @gtype.
+Adds @actor to @box, placing it at @position, and sets layout
+properties at the same time, if the #ClutterLayoutManager used by
+ box supports them
-This function avoids using a #GValue for the initial and final values
-of the interval:
+If @position is a negative number, or is larger than the number of
+children of @box, the new child is added at the end of the list of
+children
-|[
-interval = clutter_interval_new (G_TYPE_FLOAT, 0.0, 1.0);
-interval = clutter_interval_new (G_TYPE_BOOLEAN, FALSE, TRUE);
-interval = clutter_interval_new (G_TYPE_INT, 0, 360);
-]|
+Since: 1.2
-Since: 1.0
+Deprecated: 1.10: Use clutter_actor_insert_child_at_index() instead.
</description>
<parameters>
-<parameter name="gtype">
-<parameter_description> the type of the values in the interval
+<parameter name="box">
+<parameter_description> a #ClutterBox
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position to insert the @actor at
+</parameter_description>
+</parameter>
+<parameter name="first_property">
+<parameter_description> the name of the first property to set, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> the initial value and the final value of the interval
+<parameter_description> a list of property name and value pairs, terminated by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterInterval
-
-</return>
+<return></return>
</function>
-<function name="clutter_media_set_filename">
+<function name="clutter_box_pack_before">
<description>
-Sets the source of @media using a file path.
+Adds @actor to @box, placing it before @sibling, and sets layout
+properties at the same time, if the #ClutterLayoutManager used by
+ box supports them
-Since: 0.2
+If @sibling is %NULL then @actor is placed at the beginning of the
+list of children, to be allocated and painted below every other child
+
+This function is a wrapper around clutter_container_add_actor(),
+clutter_container_lower_child() and clutter_layout_manager_child_set()
+
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_insert_child_below() instead.
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="box">
+<parameter_description> a #ClutterBox
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> A filename
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> a #ClutterActor or %NULL
+</parameter_description>
+</parameter>
+<parameter name="first_property">
+<parameter_description> the name of the first property to set, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of property name and value pairs, terminated by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_get_actor_by_gid">
+<function name="clutter_box_packv">
<description>
-Retrieves the #ClutterActor with @id.
+Vector-based variant of clutter_box_pack(), intended for language
+bindings to use
-Since: 0.6
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
</description>
<parameters>
-<parameter name="id">
-<parameter_description> a #ClutterActor ID.
+<parameter name="box">
+<parameter_description> a #ClutterBox
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="n_properties">
+<parameter_description> the number of properties to set
+</parameter_description>
+</parameter>
+<parameter name="properties">
+<parameter_description> a vector
+containing the property names to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the property
+values to set
</parameter_description>
</parameter>
</parameters>
-<return> the actor with the passed id or %NULL.
-The returned actor does not have its reference count increased.
+<return></return>
+</function>
-</return>
+<function name="clutter_box_set_color">
+<description>
+Sets (or unsets) the background color for @box
+
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_set_background_color() instead.
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #ClutterBox
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the background color, or %NULL to unset
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_shader_get_fragment_source">
+<function name="clutter_box_set_layout_manager">
<description>
-Query the current GLSL fragment source set on @shader.
+Sets the #ClutterLayoutManager for @box
-Since: 0.6
+A #ClutterLayoutManager is a delegate object that controls the
+layout of the children of @box
+
+Since: 1.2
+
+Deprecated: 1.10: Use clutter_actor_set_layout_manager() instead.
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="box">
+<parameter_description> a #ClutterBox
+</parameter_description>
+</parameter>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
</parameter_description>
</parameter>
</parameters>
-<return> the source of the fragment shader for this
-ClutterShader object or %NULL. The returned string is owned by the
-shader object and should never be modified or freed
+<return></return>
+</function>
-</return>
+<function name="clutter_brightness_contrast_effect_get_brightness">
+<description>
+Retrieves the change in brightness used by @effect.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
+</parameter_description>
+</parameter>
+<parameter name="red">
+<parameter_description> return location for red component of the
+change in brightness
+</parameter_description>
+</parameter>
+<parameter name="green">
+<parameter_description> return location for green component of the
+change in brightness
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> return location for blue component of the
+change in brightness
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_animation_get_loop">
+<function name="clutter_brightness_contrast_effect_get_contrast">
<description>
-Retrieves whether @animation is looping.
+Retrieves the contrast value used by @effect.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
+</parameter_description>
+</parameter>
+<parameter name="red">
+<parameter_description> return location for red component of the
+change in contrast
+</parameter_description>
+</parameter>
+<parameter name="green">
+<parameter_description> return location for green component of the
+change in contrast
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> return location for blue component of the
+change in contrast
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the animation is looping
+<return></return>
+</function>
+
+<function name="clutter_brightness_contrast_effect_new">
+<description>
+Creates a new #ClutterBrightnessContrastEffect to be used with
+clutter_actor_add_effect()
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created
+#ClutterBrightnessContrastEffect or %NULL. Use g_object_unref() when
+done.
</return>
</function>
-<function name="clutter_media_set_progress">
+<function name="clutter_brightness_contrast_effect_set_brightness">
<description>
-Sets the playback progress of @media. The @progress is
-a normalized value between 0.0 (begin) and 1.0 (end).
+The range of @brightness is [-1.0, 1.0], where 0.0 designates no change;
+a value below 0.0 indicates a decrease in brightness; and a value
+above 0.0 indicates an increase of brightness.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> the progress of the playback, between 0.0 and 1.0
+<parameter name="brightness">
+<parameter_description> the brightness change for all three components (r, g, b)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_new">
+<function name="clutter_brightness_contrast_effect_set_brightness_full">
<description>
-Creates a new #ClutterScore. A #ClutterScore is an object that can
-hold multiple #ClutterTimeline<!-- -->s in a sequential order.
+The range for each component is [-1.0, 1.0] where 0.0 designates no change,
+values below 0.0 mean a decrease in brightness, and values above indicate
+an increase.
-Since: 0.6
+Since: 1.10
</description>
<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
+</parameter_description>
+</parameter>
+<parameter name="red">
+<parameter_description> red component of the change in brightness
+</parameter_description>
+</parameter>
+<parameter name="green">
+<parameter_description> green component of the change in brightness
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> blue component of the change in brightness
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterScore. Use g_object_unref()
-when done.
+<return></return>
+</function>
-</return>
+<function name="clutter_brightness_contrast_effect_set_contrast">
+<description>
+The range for @contrast is [-1.0, 1.0], where 0.0 designates no change;
+a value below 0.0 indicates a decrease in contrast; and a value above
+0.0 indicates an increase.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
+</parameter_description>
+</parameter>
+<parameter name="contrast">
+<parameter_description> contrast change for all three channels
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="json_object_ref">
+<function name="clutter_brightness_contrast_effect_set_contrast_full">
<description>
-Increase by one the reference count of a #JsonObject.
+The range for each component is [-1.0, 1.0] where 0.0 designates no change,
+values below 0.0 mean a decrease in contrast, and values above indicate
+an increase.
+Since: 1.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="effect">
+<parameter_description> a #ClutterBrightnessContrastEffect
+</parameter_description>
+</parameter>
+<parameter name="red">
+<parameter_description> red component of the change in contrast
+</parameter_description>
+</parameter>
+<parameter name="green">
+<parameter_description> green component of the change in contrast
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> blue component of the change in contrast
</parameter_description>
</parameter>
</parameters>
-<return> the passed #JsonObject, with the reference count
-increased by one.
-</return>
+<return></return>
</function>
-<function name="clutter_child_meta_get_actor">
+<function name="clutter_cairo_clear">
<description>
-Retrieves the actor wrapped by @data
+Utility function to clear a Cairo context.
-Since: 0.8
+Since: 1.12
</description>
<parameters>
-<parameter name="data">
-<parameter_description> a #ClutterChildMeta
+<parameter name="cr">
+<parameter_description> a Cairo context
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterActor
+<return></return>
+</function>
-</return>
+<function name="clutter_cairo_set_source_color">
+<description>
+Utility function for setting the source color of @cr using
+a #ClutterColor. This function is the equivalent of:
+
+|[
+cairo_set_source_rgba (cr,
+color->red / 255.0,
+color->green / 255.0,
+color->blue / 255.0,
+color->alpha / 255.0);
+]|
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="cr">
+<parameter_description> a Cairo context
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_threads_leave">
+<function name="clutter_cairo_texture_clear">
<description>
-Unlocks the Clutter thread lock.
+Clears @self's internal drawing surface, so that the next upload
+will replace the previous contents of the #ClutterCairoTexture
+rather than adding to it.
-Since: 0.4
+Calling this function from within a #ClutterCairoTexture::draw
+signal handler will clear the invalidated area.
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterCanvas instead
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_validate">
+<function name="clutter_cairo_texture_create">
<description>
-Validates the initial and final values of @interval against
-a #GParamSpec.
+Creates a new Cairo context for the @cairo texture. It is
+similar to using clutter_cairo_texture_create_region() with @x_offset
+and @y_offset of 0, @width equal to the @cairo texture surface width
+and @height equal to the @cairo texture surface height.
+
+<warning><para>Do not call this function within the paint virtual
+function or from a callback to the #ClutterActor::paint
+signal.</para></warning>
Since: 1.0
+Deprecated: 1.8: Use the #ClutterCairoTexture::draw signal and
+the clutter_cairo_texture_invalidate() function to obtain a
+Cairo context for 2D drawing.
+
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
</parameter_description>
</parameter>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
+</parameters>
+<return> a newly created Cairo context. Use cairo_destroy()
+to upload the contents of the context when done drawing
+
+</return>
+</function>
+
+<function name="clutter_cairo_texture_create_region">
+<description>
+Creates a new Cairo context that will updat the region defined
+by @x_offset, @y_offset, @width and @height.
+
+<warning><para>Do not call this function within the paint virtual
+function or from a callback to the #ClutterActor::paint
+signal.</para></warning>
+
+Since: 1.0
+
+Deprecated: 1.8: Use the #ClutterCairoTexture::draw signal and
+clutter_cairo_texture_invalidate_rectangle() to obtain a
+clipped Cairo context for 2D drawing.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
+<parameter name="x_offset">
+<parameter_description> offset of the region on the X axis
+</parameter_description>
+</parameter>
+<parameter name="y_offset">
+<parameter_description> offset of the region on the Y axis
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the region, or -1 for the full surface width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the region, or -1 for the full surface height
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterInterval is valid, %FALSE otherwise
+<return> a newly created Cairo context. Use cairo_destroy()
+to upload the contents of the context when done drawing
</return>
</function>
-<function name="json_parser_new">
+<function name="clutter_cairo_texture_get_auto_resize">
<description>
-Creates a new #JsonParser instance. You can use the #JsonParser to
-load a JSON stream from either a file or a buffer and then walk the
-hierarchy using the data types API.
+Retrieves the value set using clutter_cairo_texture_set_auto_resize().
+Since: 1.8
+Deprecated: 1.12: Use #ClutterCanvas instead
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #JsonParser. Use g_object_unref()
-to release all the memory it allocates.
+<return> %TRUE if the #ClutterCairoTexture should track the
+allocation, and %FALSE otherwise
+
</return>
</function>
-<function name="clutter_interval_peek_initial_value">
+<function name="clutter_cairo_texture_get_surface_size">
<description>
-Gets the pointer to the initial value of @interval
+Retrieves the surface width and height for @self.
Since: 1.0
+Deprecated: 1.12: Use #ClutterCanvas instead
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> return location for the surface width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the surface height, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the initial value of the interval.
-The value is owned by the #ClutterInterval and it should not be
-modified or freed
+<return></return>
+</function>
-</return>
+<function name="clutter_cairo_texture_invalidate">
+<description>
+Invalidates the whole surface of a #ClutterCairoTexture.
+
+This function will cause the #ClutterCairoTexture::draw signal
+to be emitted.
+
+See also: clutter_cairo_texture_invalidate_rectangle()
+
+Since: 1.8
+Deprecated: 1.12: Use #ClutterCanvas instead
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_container_child_get">
+<function name="clutter_cairo_texture_invalidate_rectangle">
<description>
-Gets @container specific properties of an actor.
+Invalidates a rectangular region of a #ClutterCairoTexture.
-In general, a copy is made of the property contents and the caller is
-responsible for freeing the memory in the appropriate manner for the type, for
-instance by calling g_free() or g_object_unref().
+The invalidation will cause the #ClutterCairoTexture::draw signal
+to be emitted.
-Since: 0.8
+See also: clutter_cairo_texture_invalidate()
+
+Since: 1.8
+Deprecated: 1.12: Use #ClutterCanvas instead
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor that is a child of @container.
+<parameter name="rect">
+<parameter_description> a rectangle with the area to invalida,
+or %NULL to perform an unbounded invalidation
</parameter_description>
</parameter>
-<parameter name="first_prop">
-<parameter_description> name of the first property to be set.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_cairo_texture_new">
+<description>
+Creates a new #ClutterCairoTexture actor, with a surface of @width by
+ height pixels.
+
+Since: 1.0
+
+Deprecated: 1.12: Use #ClutterCanvas instead
+
+</description>
+<parameters>
+<parameter name="width">
+<parameter_description> the width of the surface
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> value for the first property, followed optionally by more name/value
-pairs terminated with NULL.
+<parameter name="height">
+<parameter_description> the height of the surface
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #ClutterCairoTexture actor
+
+</return>
+</function>
+
+<function name="clutter_cairo_texture_set_auto_resize">
+<description>
+Sets whether the #ClutterCairoTexture should ensure that the
+backing Cairo surface used matches the allocation assigned to
+the actor. If the allocation changes, the contents of the
+#ClutterCairoTexture will also be invalidated automatically.
+
+Since: 1.8
+Deprecated: 1.12: Use #ClutterCanvas instead
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> %TRUE if the #ClutterCairoTexture should bind the surface
+size to the allocation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_opacity_get_bounds">
+<function name="clutter_cairo_texture_set_surface_size">
<description>
-Gets the initial and final levels of the opacity applied by @behaviour
-on each actor it controls.
+Resizes the Cairo surface used by @self to @width and @height.
-Since: 0.6
+This function will not invalidate the contents of the Cairo
+texture: you will have to explicitly call either
+clutter_cairo_texture_invalidate_rectangle() or
+clutter_cairo_texture_invalidate().
+
+Since: 1.0
+Deprecated: 1.12: Use #ClutterCanvas instead
</description>
<parameters>
-<parameter name="behaviour">
-<parameter_description> a #ClutterBehaviourOpacity
+<parameter name="self">
+<parameter_description> a #ClutterCairoTexture
</parameter_description>
</parameter>
-<parameter name="opacity_start">
-<parameter_description> return location for the minimum level of opacity, or %NULL
+<parameter name="width">
+<parameter_description> the new width of the surface
</parameter_description>
</parameter>
-<parameter name="opacity_end">
-<parameter_description> return location for the maximum level of opacity, or %NULL
+<parameter name="height">
+<parameter_description> the new height of the surface
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_rotate_set_axis">
+<function name="clutter_canvas_get_scale_factor">
<description>
-Sets the axis used by the rotate behaviour.
+Retrieves the scaling factor of @canvas, as set using
+clutter_canvas_set_scale_factor().
-Since: 0.4
+Since: 1.18
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="canvas">
+<parameter_description> a #ClutterCanvas
</parameter_description>
</parameter>
-<parameter name="axis">
-<parameter_description> a #ClutterRotateAxis
+</parameters>
+<return> the scaling factor, or -1 if the @canvas
+uses the default from #ClutterSettings
+
+</return>
+</function>
+
+<function name="clutter_canvas_new">
+<description>
+Creates a new instance of #ClutterCanvas.
+
+You should call clutter_canvas_set_size() to set the size of the canvas.
+
+You should call clutter_content_invalidate() every time you wish to
+draw the contents of the canvas.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> The newly allocated instance of
+#ClutterCanvas. Use g_object_unref() when done.
+
+</return>
+</function>
+
+<function name="clutter_canvas_set_scale_factor">
+<description>
+Sets the scaling factor for the Cairo surface used by @canvas.
+
+This function should rarely be used.
+
+The default scaling factor of a #ClutterCanvas content uses the
+#ClutterSettings:window-scaling-factor property, which is set by
+the windowing system. By using this function it is possible to
+override that setting.
+
+Changing the scale factor will invalidate the @canvas.
+
+Since: 1.18
+
+</description>
+<parameters>
+<parameter name="canvas">
+<parameter_description> a #ClutterCanvas
+</parameter_description>
+</parameter>
+<parameter name="scale">
+<parameter_description> the scale factor, or -1 for the default
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animator_set_key">
+<function name="clutter_canvas_set_size">
<description>
-Sets a single key in the #ClutterAnimator for the @property_name of
- object at @progress.
+Sets the size of the @canvas, and invalidates the content.
-See also: clutter_animator_set()
+This function will cause the @canvas to be invalidated only
+if the size of the canvas surface has changed.
-Since: 1.2
+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
+call clutter_content_invalidate():
+
+|[
+if (!clutter_canvas_set_size (canvas, width, height))
+clutter_content_invalidate (CLUTTER_CONTENT (canvas));
+]|
+
+Since: 1.10
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="canvas">
+<parameter_description> a #ClutterCanvas
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+<parameter name="width">
+<parameter_description> the width of the canvas, in pixels
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the property to specify a key for
+<parameter name="height">
+<parameter_description> the height of the canvas, in pixels
</parameter_description>
</parameter>
+</parameters>
+<return> this function returns %TRUE if the size change
+caused a content invalidation, and %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_cex100_get_egl_display">
+<description>
+Retrieves the EGL display used by Clutter, if it supports the
+EGL windowing system and if it is running using an EGL backend.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> the EGL display used by Clutter, or 0
+
+</return>
+</function>
+
+<function name="clutter_cex100_set_buffering_mode">
+<description>
+Configure the buffering mode of the underlying GDL plane. The GDL
+surface used by Clutter to draw can be backed up by either one or two
+back buffers thus being double or triple buffered, respectively.
+
+Clutter defaults to %CLUTTER_CEX100_TRIPLE_BUFFERING.
+
+<note>This function has to be called before clutter_init()</note>
+
+Since: 1.6
+
+</description>
+<parameters>
<parameter name="mode">
-<parameter_description> the id of the alpha function to use
+<parameter_description> a #ClutterCex100BufferingMode
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> the normalized range at which stage of the animation this
-value applies
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_cex100_set_plane">
+<description>
+Intel CE3100 and CE4100 have several planes (frame buffers) and a
+hardware blender to blend the planes togeteher and produce the final
+image.
+
+clutter_cex100_set_plane() let's you configure the GDL plane where
+the stage will be drawn. By default Clutter will pick UPP_C
+(GDL_PLANE_ID_UPP_C).
+
+<note>This function has to be called before clutter_init()</note>
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="plane">
+<parameter_description> a GDL plane
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value property_name should have at progress.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_check_version">
+<description>
+Run-time version check, to check the version the Clutter library
+that an application is currently linked against
+
+This is the run-time equivalent of the compile-time %CLUTTER_CHECK_VERSION
+pre-processor macro
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="major">
+<parameter_description> major version, like 1 in 1.2.3
+</parameter_description>
+</parameter>
+<parameter name="minor">
+<parameter_description> minor version, like 2 in 1.2.3
+</parameter_description>
+</parameter>
+<parameter name="micro">
+<parameter_description> micro version, like 3 in 1.2.3
</parameter_description>
</parameter>
</parameters>
-<return> The animator instance
+<return> %TRUE if the version of the Clutter library is
+greater than (@major, @minor, @micro), and %FALSE otherwise
</return>
</function>
-<function name="json_object_foreach_member">
+<function name="clutter_check_windowing_backend">
<description>
-Iterates over all members of @object and calls @func on
-each one of them.
+Checks the run-time name of the Clutter windowing system backend, using
+the symbolic macros like %CLUTTER_WINDOWING_WIN32 or
+%CLUTTER_WINDOWING_X11.
-It is safe to change the value of a #JsonNode of the @object
-from within the iterator @func, but it is not safe to add or
-remove members from the @object.
+This function should be used in conjuction with the compile-time macros
+inside applications and libraries that are using the platform-specific
+windowing system API, to ensure that they are running on the correct
+windowing system; for instance:
-Since: 0.8
+|[
+#ifdef CLUTTER_WINDOWING_X11
+if (clutter_check_windowing_backend (CLUTTER_WINDOWING_X11))
+{
+/ * it is safe to use the clutter_x11_* API * /
+}
+else
+#endif
+#ifdef CLUTTER_WINDOWING_WIN32
+if (clutter_check_windowing_backend (CLUTTER_WINDOWING_WIN32))
+{
+/ * it is safe to use the clutter_win32_* API * /
+}
+else
+#endif
+g_error ("Unknown Clutter backend.");
+]|
+
+Since: 1.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="backend_type">
+<parameter_description> the name of the backend to check
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to be called on each member
+</parameters>
+<return> %TRUE if the current Clutter windowing system backend is
+the one checked, and %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_child_meta_get_actor">
+<description>
+Retrieves the actor wrapped by @data
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="data">
+<parameter_description> a #ClutterChildMeta
</parameter_description>
</parameter>
+</parameters>
+<return> a #ClutterActor
+
+</return>
+</function>
+
+<function name="clutter_child_meta_get_container">
+<description>
+Retrieves the container using @data
+
+Since: 0.8
+
+</description>
+<parameters>
<parameter name="data">
-<parameter_description> data to be passed to the function
+<parameter_description> a #ClutterChildMeta
</parameter_description>
</parameter>
</parameters>
+<return> a #ClutterContainer
+
+</return>
+</function>
+
+<function name="clutter_clear_glyph_cache">
+<description>
+Clears the internal cache of glyphs used by the Pango
+renderer. This will free up some memory and GL texture
+resources. The cache will be automatically refilled as more text is
+drawn.
+
+Since: 0.8
+
+Deprecated: 1.10: Use clutter_get_font_map() and
+cogl_pango_font_map_clear_glyph_cache() instead.
+
+</description>
+<parameters>
+</parameters>
<return></return>
</function>
-<function name="clutter_event_get_key_code">
+<function name="clutter_click_action_get_button">
<description>
-Retrieves the keycode of the key that caused @event
+Retrieves the button that was pressed.
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS or
-of type %CLUTTER_KEY_RELEASE
+<parameter name="action">
+<parameter_description> a #ClutterClickAction
</parameter_description>
</parameter>
</parameters>
-<return> The keycode representing the key
+<return> the button value
</return>
</function>
-<function name="clutter_actor_unparent">
+<function name="clutter_click_action_get_coords">
<description>
-Removes the parent of @self.
-
-This function should not be used in applications. It should be called by
-implementations of container actors, to dissociate a child from the
-container.
+Retrieves the screen coordinates of the button press.
-Since: 0.1.1
+Since: 1.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="action">
+<parameter_description> a #ClutterClickAction
+</parameter_description>
+</parameter>
+<parameter name="press_x">
+<parameter_description> return location for the X coordinate, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="press_y">
+<parameter_description> return location for the Y coordinate, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_rectangle_get_border_width">
+<function name="clutter_click_action_get_state">
<description>
-Gets the width (in pixels) of the border used by @rectangle
+Retrieves the modifier state of the click action.
-Since: 0.2
+Since: 1.6
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
+<parameter name="action">
+<parameter_description> a #ClutterClickAction
</parameter_description>
</parameter>
</parameters>
-<return> the border's width
+<return> the modifier state parameter, or 0
</return>
</function>
-<function name="clutter_text_activate">
+<function name="clutter_click_action_new">
<description>
-Emits the #ClutterText::activate signal, if @self has been set
-as activatable using clutter_text_set_activatable().
+Creates a new #ClutterClickAction instance
-This function can be used to emit the ::activate signal inside
-a #ClutterActor::captured-event or #ClutterActor::key-press-event
-signal handlers before the default signal handler for the
-#ClutterText is invoked.
+Since: 1.4
-Since: 1.0
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterClickAction
+
+</return>
+</function>
+
+<function name="clutter_click_action_release">
+<description>
+Emulates a release of the pointer button, which ungrabs the pointer
+and unsets the #ClutterClickAction:pressed state.
+
+This function will also cancel the long press gesture if one was
+initiated.
+
+This function is useful to break a grab, for instance after a certain
+amount of time has passed.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="action">
+<parameter_description> a #ClutterClickAction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the ::activate signal has been emitted,
-and %FALSE otherwise
+<return></return>
+</function>
+
+<function name="clutter_clip_node_new">
+<description>
+Creates a new #ClutterPaintNode that will clip its child
+nodes to the 2D regions added to it.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterPaintNode.
+Use clutter_paint_node_unref() when done.
</return>
</function>
-<function name="clutter_rectangle_get_border_color">
+<function name="clutter_clone_get_source">
<description>
-Gets the color of the border used by @rectangle and places
-it into @color.
+Retrieves the source #ClutterActor being cloned by @self.
-Since: 0.2
+Since: 1.0
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="self">
+<parameter_description> a #ClutterClone
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the actor source for the clone
+
+</return>
</function>
-<function name="json_node_get_string">
+<function name="clutter_clone_new">
<description>
-Gets the string value stored inside a #JsonNode
+Creates a new #ClutterActor which clones @source/
+Since: 1.0
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="source">
+<parameter_description> a #ClutterActor, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a string value.
+<return> the newly created #ClutterClone
+
</return>
</function>
-<function name="clutter_actor_set_scale_full">
+<function name="clutter_clone_set_source">
<description>
-Scales an actor with the given factors around the given center
-point. The center point is specified in pixels relative to the
-anchor point (usually the top left corner of the actor).
+Sets @source as the source actor to be cloned by @self.
Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterClone
</parameter_description>
</parameter>
-<parameter name="scale_x">
-<parameter_description> double factor to scale actor by horizontally.
+<parameter name="source">
+<parameter_description> a #ClutterActor, or %NULL
</parameter_description>
</parameter>
-<parameter name="scale_y">
-<parameter_description> double factor to scale actor by vertically.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_color_add">
+<description>
+Adds @a to @b and saves the resulting color inside @result.
+
+The alpha channel of @result is set as as the maximum value
+between the alpha channels of @a and @b.
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="center_x">
-<parameter_description> X coordinate of the center of the scale.
+<parameter name="b">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="center_y">
-<parameter_description> Y coordinate of the center of the scale
+<parameter name="result">
+<parameter_description> return location for the result
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
+<function name="clutter_color_alloc">
+<description>
+Allocates a new, transparent black #ClutterColor.
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly allocated #ClutterColor; use
+clutter_color_free() to free its resources
+
+</return>
+</function>
+
<function name="clutter_color_copy">
<description>
Makes a copy of the color structure. The result must be
@@ -8992,527 +18214,853 @@ Since: 0.2
</return>
</function>
-<function name="clutter_box_new">
+<function name="clutter_color_darken">
<description>
-Creates a new #ClutterBox. The children of the box will be layed
-out by the passed @manager
+Darkens @color by a fixed amount, and saves the changed color
+in @result.
-Since: 1.0
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the darker color
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_color_equal">
+<description>
+Compares two #ClutterColor<!-- -->s and checks if they are the same.
+
+This function can be passed to g_hash_table_new() as the @key_equal_func
+parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
+
+Since: 0.2
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="v1">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="v2">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterBox actor
+<return> %TRUE if the two colors are the same.
</return>
</function>
-<function name="clutter_x11_texture_pixmap_update_area">
+<function name="clutter_color_free">
<description>
-Performs the actual binding of texture to the current content of
-the pixmap. Can be called to update the texture if the pixmap
-content has changed.
+Frees a color structure created with clutter_color_copy().
-Since: 0.8
+Since: 0.2
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> The texture whose content shall be updated.
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the X coordinate of the area to update
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_color_from_hls">
+<description>
+Converts a color expressed in HLS (hue, luminance and saturation)
+values into a #ClutterColor.
+
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the Y coordinate of the area to update
+<parameter name="hue">
+<parameter_description> hue value, in the 0 .. 360 range
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the area to update
+<parameter name="luminance">
+<parameter_description> luminance value, in the 0 .. 1 range
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the area to update
+<parameter name="saturation">
+<parameter_description> saturation value, in the 0 .. 1 range
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_add_idle_full">
+<function name="clutter_color_from_pixel">
<description>
-Adds a function to be called whenever there are no higher priority
-events pending. If the function returns %FALSE it is automatically
-removed from the list of event sources and will not be called again.
+Converts @pixel from the packed representation of a four 8 bit channel
+color to a #ClutterColor.
-This function can be considered a thread-safe variant of g_idle_add_full():
-it will call @function while holding the Clutter lock. It is logically
-equivalent to the following implementation:
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="pixel">
+<parameter_description> a 32 bit packed integer containing a color
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-|[
-static gboolean
-idle_safe_callback (gpointer data)
-{
-SafeClosure *closure = data;
-gboolean res = FALSE;
+<function name="clutter_color_from_string">
+<description>
+Parses a string definition of a color, filling the
+<structfield>red</structfield>, <structfield>green</structfield>,
+<structfield>blue</structfield> and <structfield>alpha</structfield>
+channels of @color.
-/ * mark the critical section * /
+The @color is not allocated.
-clutter_threads_enter();
+The format of @str can be either one of:
-/ * the callback does not need to acquire the Clutter
-* lock itself, as it is held by the this proxy handler
-* /
-res = closure->callback (closure->data);
+<itemizedlist>
+<listitem>
+<para>a standard name (as taken from the X11 rgb.txt file)</para>
+</listitem>
+<listitem>
+<para>an hexadecimal value in the form: <literal>#rgb</literal>,
+<literal>#rrggbb</literal>, <literal>#rgba</literal> or
+<literal>#rrggbbaa</literal></para>
+</listitem>
+<listitem>
+<para>a RGB color in the form: <literal>rgb(r, g, b)</literal></para>
+</listitem>
+<listitem>
+<para>a RGB color in the form: <literal>rgba(r, g, b, a)</literal></para>
+</listitem>
+<listitem>
+<para>a HSL color in the form: <literal>hsl(h, s, l)</literal></para>
+</listitem>
+<listitem>
+<para>a HSL color in the form: <literal>hsla(h, s, l, a)</literal></para>
+</listitem>
+</itemizedlist>
-clutter_threads_leave();
+where 'r', 'g', 'b' and 'a' are (respectively) the red, green, blue color
+intensities and the opacity. The 'h', 's' and 'l' are (respectively) the
+hue, saturation and luminance values.
-return res;
-}
-static gulong
-add_safe_idle (GSourceFunc callback,
-gpointer data)
-{
-SafeClosure *closure = g_new0 (SafeClosure, 1);
+In the rgb() and rgba() formats, the 'r', 'g', and 'b' values are either
+integers between 0 and 255, or percentage values in the range between 0%
+and 100%; the percentages require the '%' character. The 'a' value, if
+specified, can only be a floating point value between 0.0 and 1.0.
-closure->callback = callback;
-closure->data = data;
+In the hls() and hlsa() formats, the 'h' value (hue) is an angle between
+0 and 360.0 degrees; the 'l' and 's' values (luminance and saturation) are
+percentage values in the range between 0% and 100%. The 'a' value, if specified,
+can only be a floating point value between 0.0 and 1.0.
-return g_add_idle_full (G_PRIORITY_DEFAULT_IDLE,
-idle_safe_callback,
-closure,
-g_free)
-}
-]|
+Whitespace inside the definitions is ignored; no leading whitespace
+is allowed.
-This function should be used by threaded applications to make sure
-that @func is emitted under the Clutter threads lock and invoked
-from the same thread that started the Clutter main loop. For instance,
-it can be used to update the UI using the results from a worker
-thread:
+If the alpha component is not specified then it is assumed to be set to
+be fully opaque.
-|[
-static gboolean
-update_ui (gpointer data)
-{
-SomeClosure *closure = data;
+Since: 1.0
-/ * it is safe to call Clutter API from this function because
-* it is invoked from the same thread that started the main
-* loop and under the Clutter thread lock
-* /
-clutter_label_set_text (CLUTTER_LABEL (closure->label),
-closure->text);
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> a string specifiying a color
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if parsing succeeded, and %FALSE otherwise
-g_object_unref (closure->label);
-g_free (closure);
+</return>
+</function>
-return FALSE;
-}
+<function name="clutter_color_get_static">
+<description>
+Retrieves a static color for the given @color name
-/ * within another thread * /
-closure = g_new0 (SomeClosure, 1);
-/ * always take a reference on GObject instances * /
-closure->label = g_object_ref (my_application->label);
-closure->text = g_strdup (processed_text_to_update_the_label);
+Static colors are created by Clutter and are guaranteed to always be
+available and valid
-clutter_threads_add_idle_full (G_PRIORITY_HIGH_IDLE,
-update_ui,
-closure,
-NULL);
-]|
+Since: 1.6
-Since: 0.4
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> the named global color
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to a static color; the returned pointer
+is owned by Clutter and it should never be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_color_hash">
+<description>
+Converts a #ClutterColor to a hash value.
+
+This function can be passed to g_hash_table_new() as the @hash_func
+parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the timeout source. Typically this will be in the
-range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
+<parameter name="v">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+</parameters>
+<return> a hash value corresponding to the color
+
+</return>
+</function>
+
+<function name="clutter_color_init">
+<description>
+Initializes @color with the given values.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="red">
+<parameter_description> red component of the color, between 0 and 255
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> functio to call when the idle source is removed
+<parameter name="green">
+<parameter_description> green component of the color, between 0 and 255
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> blue component of the color, between 0 and 255
+</parameter_description>
+</parameter>
+<parameter name="alpha">
+<parameter_description> alpha component of the color, between 0 and 255
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> the initialized #ClutterColor
</return>
</function>
-<function name="cogl_pango_font_map_new">
+<function name="clutter_color_interpolate">
<description>
-Creates a new font map.
+Interpolates between @initial and @final #ClutterColor<!-- -->s
+using @progress
-Since: 1.0
+Since: 1.6
</description>
<parameters>
+<parameter name="initial">
+<parameter_description> the initial #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="final">
+<parameter_description> the final #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> the interpolation progress
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the interpolation
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #PangoFontMap
+<return></return>
+</function>
-</return>
+<function name="clutter_color_lighten">
+<description>
+Lightens @color by a fixed amount, and saves the changed color
+in @result.
+
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the lighter color
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_animation_get_duration">
+<function name="clutter_color_new">
<description>
-Retrieves the duration of @animation, in milliseconds.
+Creates a new #ClutterColor with the given values.
-Since: 1.0
+This function is the equivalent of:
+
+|[
+clutter_color_init (clutter_color_alloc (), red, green, blue, alpha);
+]|
+
+Since: 0.8.4
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="red">
+<parameter_description> red component of the color, between 0 and 255
+</parameter_description>
+</parameter>
+<parameter name="green">
+<parameter_description> green component of the color, between 0 and 255
+</parameter_description>
+</parameter>
+<parameter name="blue">
+<parameter_description> blue component of the color, between 0 and 255
+</parameter_description>
+</parameter>
+<parameter name="alpha">
+<parameter_description> alpha component of the color, between 0 and 255
</parameter_description>
</parameter>
</parameters>
-<return> the duration of the animation
+<return> the newly allocated color.
+Use clutter_color_free() when done
</return>
</function>
-<function name="json_array_new">
+<function name="clutter_color_node_new">
<description>
-Creates a new #JsonArray.
+Creates a new #ClutterPaintNode that will paint a solid color
+fill using @color.
+Since: 1.10
</description>
<parameters>
+<parameter name="color">
+<parameter_description> the color to paint, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #JsonArray
+<return> the newly created #ClutterPaintNode. Use
+clutter_paint_node_unref() when done
+
</return>
</function>
-<function name="clutter_egl_display">
+<function name="clutter_color_shade">
<description>
-Retrieves the <structname>EGLDisplay</structname> used by Clutter
-
+Shades @color by @factor and saves the modified color into @result.
</description>
<parameters>
+<parameter name="color">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="factor">
+<parameter_description> the shade factor to apply
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the shaded color
+</parameter_description>
+</parameter>
</parameters>
-<return> the EGL display
-</return>
+<return></return>
</function>
-<function name="clutter_actor_transform_stage_point">
+<function name="clutter_color_subtract">
<description>
-This function translates screen coordinates (@x, @y) to
-coordinates relative to the actor. For example, it can be used to translate
-screen events from global screen coordinates into actor-local coordinates.
+Subtracts @b from @a and saves the resulting color inside @result.
-The conversion can fail, notably if the transform stack results in the
-actor being projected on the screen as a mere line.
+This function assumes that the components of @a are greater than the
+components of @b; the result is, otherwise, undefined.
-The conversion should not be expected to be pixel-perfect due to the
-nature of the operation. In general the error grows when the skewing
-of the actor rectangle on screen increases.
+The alpha channel of @result is set as the minimum value
+between the alpha channels of @a and @b.
-Note: This function is fairly computationally intensive.
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> return location for the result
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Note: This function only works when the allocation is up-to-date,
-i.e. inside of paint()
+<function name="clutter_color_to_hls">
+<description>
+Converts @color to the HLS format.
-Since: 0.6
+The @hue value is in the 0 .. 360 range. The @luminance and
+ saturation values are in the 0 .. 1 range.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x screen coordinate of the point to unproject
+<parameter name="hue">
+<parameter_description> return location for the hue value or %NULL
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y screen coordinate of the point to unproject
+<parameter name="luminance">
+<parameter_description> return location for the luminance value or %NULL
</parameter_description>
</parameter>
-<parameter name="x_out">
-<parameter_description> return location for the unprojected x coordinance
+<parameter name="saturation">
+<parameter_description> return location for the saturation value or %NULL
</parameter_description>
</parameter>
-<parameter name="y_out">
-<parameter_description> return location for the unprojected y coordinance
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_color_to_pixel">
+<description>
+Converts @color into a packed 32 bit integer, containing
+all the four 8 bit channels used by #ClutterColor.
+
+
+</description>
+<parameters>
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if conversion was successful.
-
+<return> a packed color
</return>
</function>
-<function name="clutter_actor_get_fixed_position_set">
+<function name="clutter_color_to_string">
<description>
-Checks whether an actor has a fixed position set (and will thus be
-unaffected by any layout manager).
+Returns a textual specification of @color in the hexadecimal form
+<literal>#rrggbbaa</literal>, where <literal>r</literal>,
+<literal>g</literal>, <literal>b</literal> and <literal>a</literal> are
+hexadecimal digits representing the red, green, blue and alpha components
+respectively.
-Since: 0.8
+Since: 0.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the fixed position is set on the actor
+<return> a newly-allocated text string
</return>
</function>
-<function name="clutter_animation_bind_interval">
+<function name="clutter_colorize_effect_get_tint">
<description>
-Binds @interval to the @property_name of the #GObject
-attached to @animation. The #ClutterAnimation will take
-ownership of the passed #ClutterInterval. For more information
-about animations, see clutter_actor_animate().
+Retrieves the tint used by @effect
-If you need to update the interval instance use
-clutter_animation_update_property() instead.
-
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="effect">
+<parameter_description> a #ClutterColorizeEffect
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the property to control
+<parameter name="tint">
+<parameter_description> return location for the color used
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_colorize_effect_new">
+<description>
+Creates a new #ClutterColorizeEffect to be used with
+clutter_actor_add_effect()
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="tint">
+<parameter_description> the color to be used
</parameter_description>
</parameter>
</parameters>
-<return> The animation itself.
+<return> the newly created #ClutterColorizeEffect or %NULL
+
</return>
</function>
-<function name="clutter_units_get_unit_type">
+<function name="clutter_colorize_effect_set_tint">
<description>
-Retrieves the unit type of the value stored inside @units
+Sets the tint to be used when colorizing
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="effect">
+<parameter_description> a #ClutterColorizeEffect
+</parameter_description>
+</parameter>
+<parameter name="tint">
+<parameter_description> the color to be used
</parameter_description>
</parameter>
</parameters>
-<return> a unit type
-
-</return>
+<return></return>
</function>
-<function name="clutter_box_layout_set_use_animations">
+<function name="clutter_container_add">
<description>
-Sets whether @layout should animate changes in the layout properties
+Adds a list of #ClutterActor<!-- -->s to @container. Each time and
+actor is added, the "actor-added" signal is emitted. Each actor should
+be parented to @container, which takes a reference on the actor. You
+cannot add a #ClutterActor to more than one #ClutterContainer.
-The duration of the animations is controlled by
-clutter_box_layout_set_easing_duration(); the easing mode to be used
-by the animations is controlled by clutter_box_layout_set_easing_mode()
+This function will call #ClutterContainerIface.add(), which is a
+deprecated virtual function. The default implementation will
+call clutter_actor_add_child().
-Since: 1.2
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="animate">
-<parameter_description> %TRUE if the @layout should use animations
+<parameter name="first_actor">
+<parameter_description> the first #ClutterActor to add
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> %NULL terminated list of actors to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_angle_end">
+<function name="clutter_container_add_actor">
<description>
-Sets the angle at which movement ends; angles >= 360 degress get clamped
-to the canonical interval <0, 360).
+Adds a #ClutterActor to @container. This function will emit the
+"actor-added" signal. The actor should be parented to
+ container You cannot add a #ClutterActor to more than one
+#ClutterContainer.
+
+This function will call #ClutterContainerIface.add(), which is a
+deprecated virtual function. The default implementation will
+call clutter_actor_add_child().
+
+Virtual: add
Since: 0.4
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="angle_end">
-<parameter_description> angle at which movement ends in degrees, between 0 and 360.
+<parameter name="actor">
+<parameter_description> the first #ClutterActor to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_set_user_resizable">
+<function name="clutter_container_add_valist">
<description>
-Sets if the stage is resizable by user interaction (e.g. via
-window manager controls)
+Alternative va_list version of clutter_container_add().
+
+This function will call #ClutterContainerIface.add(), which is a
+deprecated virtual function. The default implementation will
+call clutter_actor_add_child().
Since: 0.4
+Deprecated: 1.10: Use clutter_actor_add_child() instead.
+
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="resizable">
-<parameter_description> whether the stage should be user resizable.
+<parameter name="first_actor">
+<parameter_description> the first #ClutterActor to add
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> list of actors to add, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_get_first_iter">
+<function name="clutter_container_child_get">
<description>
-Retrieves a #ClutterModelIter representing the first non-filtered
-row in @model.
+Gets @container specific properties of an actor.
-Since: 0.6
+In general, a copy is made of the property contents and the caller is
+responsible for freeing the memory in the appropriate manner for the type, for
+instance by calling g_free() or g_object_unref().
+
+Since: 0.8
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor that is a child of @container.
+</parameter_description>
+</parameter>
+<parameter name="first_prop">
+<parameter_description> name of the first property to be set.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value for the first property, followed optionally by more name/value
+pairs terminated with NULL.
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterModelIter.
-Call g_object_unref() when done using it
-
-</return>
+<return></return>
</function>
-<function name="clutter_group_get_nth_child">
+<function name="clutter_container_child_get_property">
<description>
-Gets a groups child held at @index_ in stack.
+Gets a container specific property of a child of @container, In general,
+a copy is made of the property contents and the caller is responsible for
+freeing the memory by calling g_value_unset().
-Since: 0.2
+Note that clutter_container_child_set_property() is really intended for
+language bindings, clutter_container_child_set() is much more convenient
+for C programming.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterGroup
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the position of the requested actor.
+<parameter name="child">
+<parameter_description> a #ClutterActor that is a child of @container.
+</parameter_description>
+</parameter>
+<parameter name="property">
+<parameter_description> the name of the property to set.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value.
</parameter_description>
</parameter>
</parameters>
-<return> A Clutter actor, or %NULL if
- index_ is invalid.
+<return></return>
+</function>
-</return>
+<function name="clutter_container_child_notify">
+<description>
+Calls the #ClutterContainerIface.child_notify() virtual function
+of #ClutterContainer. The default implementation will emit the
+#ClutterContainer::child-notify signal.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_text_insert_unichar">
+<function name="clutter_container_child_set">
<description>
-Inserts @wc at the current cursor position of a
-#ClutterText actor.
+Sets container specific properties on the child of a container.
-Since: 1.0
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="wc">
-<parameter_description> a Unicode character
+<parameter name="actor">
+<parameter_description> a #ClutterActor that is a child of @container.
+</parameter_description>
+</parameter>
+<parameter name="first_prop">
+<parameter_description> name of the first property to be set.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value for the first property, followed optionally by more name/value
+pairs terminated with NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_remove_clip">
+<function name="clutter_container_child_set_property">
<description>
-Removes clip area from @self.
+Sets a container-specific property on a child of @container.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #ClutterActor that is a child of @container.
+</parameter_description>
+</parameter>
+<parameter name="property">
+<parameter_description> the name of the property to set.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_get_animation_progress">
+<function name="clutter_container_class_find_child_property">
<description>
-Retrieves the progress of the animation, if one has been started by
-clutter_layout_manager_begin_animation()
+Looks up the #GParamSpec for a child property of @klass.
-The returned value has the same semantics of the #ClutterAlpha:alpha
-value
+Since: 0.8
-Since: 1.2
+</description>
+<parameters>
+<parameter name="klass">
+<parameter_description> a #GObjectClass implementing the #ClutterContainer interface.
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> a property name.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The #GParamSpec for the property or %NULL
+if no such property exist.
+
+</return>
+</function>
+
+<function name="clutter_container_class_list_child_properties">
+<description>
+Returns an array of #GParamSpec for all child properties.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="klass">
+<parameter_description> a #GObjectClass implementing the #ClutterContainer interface.
+</parameter_description>
+</parameter>
+<parameter name="n_properties">
+<parameter_description> return location for length of returned array.
</parameter_description>
</parameter>
</parameters>
-<return> the progress of the animation
+<return> an array
+of #GParamSpec<!-- -->s which should be freed after use.
</return>
</function>
-<function name="clutter_grab_pointer">
+<function name="clutter_container_create_child_meta">
<description>
-Grabs pointer events, after the grab is done all pointer related events
-(press, motion, release, enter, leave and scroll) are delivered to this
-actor directly without passing through both capture and bubble phases of
-the event delivery chain. The source set in the event will be the actor
-that would have received the event if the pointer grab was not in effect.
+Creates the #ClutterChildMeta wrapping @actor inside the
+ container, if the #ClutterContainerIface::child_meta_type
+class member is not set to %G_TYPE_INVALID.
-<note><para>Grabs completely override the entire event delivery chain
-done by Clutter. Pointer grabs should only be used as a last resource;
-using the #ClutterActor::captured-event signal should always be the
-preferred way to intercept event delivery to reactive actors.</para></note>
+This function is only useful when adding a #ClutterActor to
+a #ClutterContainer implementation outside of the
+#ClutterContainer::add() virtual function implementation.
-If you wish to grab all the pointer events for a specific input device,
-you should use clutter_grab_pointer_for_device().
+Applications should not call this function.
-Since: 0.6
+Since: 1.2
</description>
<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
<parameter name="actor">
<parameter_description> a #ClutterActor
</parameter_description>
@@ -9521,1621 +19069,2697 @@ Since: 0.6
<return></return>
</function>
-<function name="clutter_model_resort">
+<function name="clutter_container_destroy_child_meta">
<description>
-Force a resort on the @model. This function should only be
-used by subclasses of #ClutterModel.
+Destroys the #ClutterChildMeta wrapping @actor inside the
+ container, if any.
-Since: 0.6
+This function is only useful when removing a #ClutterActor to
+a #ClutterContainer implementation outside of the
+#ClutterContainer::add() virtual function implementation.
+
+Applications should not call this function.
+
+Since: 1.2
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_set_fog">
+<function name="clutter_container_find_child_by_name">
<description>
-Sets the fog (also known as "depth cueing") settings for the @stage.
-
-A #ClutterStage will only use a linear fog progression, which
-depends solely on the distance from the viewer. The cogl_set_fog()
-function in COGL exposes more of the underlying implementation,
-and allows changing the for progression function. It can be directly
-used by disabling the #ClutterStage:use-fog property and connecting
-a signal handler to the #ClutterActor::paint signal on the @stage,
-like:
-
-|[
-clutter_stage_set_use_fog (stage, FALSE);
-g_signal_connect (stage, "paint", G_CALLBACK (on_stage_paint), NULL);
-]|
+Finds a child actor of a container by its name. Search recurses
+into any child container.
-The paint signal handler will call cogl_set_fog() with the
-desired settings:
+Since: 0.6
-|[
-static void
-on_stage_paint (ClutterActor *actor)
-{
-ClutterColor stage_color = { 0, };
-CoglColor fog_color = { 0, };
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="child_name">
+<parameter_description> the name of the requested child.
+</parameter_description>
+</parameter>
+</parameters>
+<return> The child actor with the requested name,
+or %NULL if no actor with that name was found.
-/ * set the fog color to the stage background color * /
-clutter_stage_get_color (CLUTTER_STAGE (actor), &stage_color);
-cogl_color_set_from_4ub (&fog_color,
-stage_color.red,
-stage_color.green,
-stage_color.blue,
-stage_color.alpha);
+</return>
+</function>
-/ * enable fog * /
-cogl_set_fog (&fog_color,
-COGL_FOG_MODE_EXPONENTIAL, / * mode * /
-0.5, / * density * /
-5.0, 30.0); / * z_near and z_far * /
-}
-]|
+<function name="clutter_container_foreach">
+<description>
+Calls @callback for each child of @container that was added
+by the application (with clutter_container_add_actor()). Does
+not iterate over "internal" children that are part of the
+container's own implementation, if any.
-Note: The fogging functions only work correctly when the visible actors use
-unmultiplied alpha colors. By default Cogl will premultiply textures
-and cogl_set_source_color will premultiply colors, so unless you
-explicitly load your textures requesting an unmultiplied
-internal_format and use cogl_material_set_color you can only use
-fogging with fully opaque actors.
+This function calls the #ClutterContainerIface.foreach()
+virtual function, which has been deprecated.
-We can look to improve this in the future when we can depend on
-fragment shaders.
+Since: 0.4
-Since: 0.6
+Deprecated: 1.10: Use clutter_actor_get_first_child() or
+clutter_actor_get_last_child() to retrieve the beginning of
+the list of children, and clutter_actor_get_next_sibling()
+and clutter_actor_get_previous_sibling() to iterate over it;
+alternatively, use the #ClutterActorIter API.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="fog">
-<parameter_description> a #ClutterFog structure
+<parameter name="callback">
+<parameter_description> a function to be called for each child
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to be passed to the function, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_color_free">
+<function name="clutter_container_foreach_with_internals">
<description>
-Frees a color structure created with clutter_color_copy().
+Calls @callback for each child of @container, including "internal"
+children built in to the container itself that were never added
+by the application.
-Since: 0.2
+This function calls the #ClutterContainerIface.foreach_with_internals()
+virtual function, which has been deprecated.
+
+Since: 1.0
+
+Deprecated: 1.10: See clutter_container_foreach().
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> a function to be called for each child
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to be passed to the function, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_value_get_fixed">
+<function name="clutter_container_get_child_meta">
<description>
-Gets the fixed point value stored inside @value.
+Retrieves the #ClutterChildMeta which contains the data about the
+ container specific state for @actor.
Since: 0.8
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue initialized to %COGL_TYPE_FIXED
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor that is a child of @container.
</parameter_description>
</parameter>
</parameters>
-<return> the value inside the passed #GValue
+<return> the #ClutterChildMeta for the @actor child
+of @container or %NULL if the specifiec actor does not exist or the
+container is not configured to provide #ClutterChildMeta<!-- -->s
</return>
</function>
-<function name="clutter_flow_layout_set_column_width">
+<function name="clutter_container_get_children">
<description>
-Sets the minimum and maximum widths that a column can have
+Retrieves all the children of @container.
-Since: 1.2
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_actor_get_children() instead.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="min_width">
-<parameter_description> minimum width of a column
+</parameters>
+<return> a list
+of #ClutterActor<!-- -->s. Use g_list_free() on the returned
+list when done.
+
+</return>
+</function>
+
+<function name="clutter_container_lower_child">
+<description>
+Lowers @actor to @sibling level, in the depth ordering.
+
+This function calls the #ClutterContainerIface.lower() virtual function,
+which has been deprecated. The default implementation will call
+clutter_actor_set_child_below_sibling().
+
+Virtual: lower
+
+Since: 0.6
+
+Deprecated: 1.10: Use clutter_actor_set_child_below_sibling() instead.
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="max_width">
-<parameter_description> maximum width of a column
+<parameter name="actor">
+<parameter_description> the actor to raise
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> the sibling to lower to, or %NULL to lower
+to the bottom
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_get_stage">
+<function name="clutter_container_raise_child">
<description>
-Retrieves the source #ClutterStage the event originated for, or
-%NULL if the event has no stage.
+Raises @actor to @sibling level, in the depth ordering.
-Since: 0.8
+This function calls the #ClutterContainerIface.raise() virtual function,
+which has been deprecated. The default implementation will call
+clutter_actor_set_child_above_sibling().
+
+Virtual: raise
+
+Since: 0.6
+
+Deprecated: 1.10: Use clutter_actor_set_child_above_sibling() instead.
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the actor to raise
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> the sibling to raise to, or %NULL to raise
+to the top
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterStage
-
-</return>
+<return></return>
</function>
-<function name="json_generator_new">
+<function name="clutter_container_remove">
<description>
-Creates a new #JsonGenerator. You can use this object to generate a
-JSON data stream starting from a data object model composed by
-#JsonNode<!-- -->s.
+Removes a %NULL terminated list of #ClutterActor<!-- -->s from
+ container Each actor should be unparented, so if you want to keep it
+around you must hold a reference to it yourself, using g_object_ref().
+Each time an actor is removed, the "actor-removed" signal is
+emitted by @container.
+This function will call #ClutterContainerIface.remove(), which is a
+deprecated virtual function. The default implementation will call
+clutter_actor_remove_child().
+
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_actor_remove_child() instead.
</description>
<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+<parameter name="first_actor">
+<parameter_description> first #ClutterActor to remove
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a %NULL-terminated list of actors to remove
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #JsonGenerator instance
-</return>
+<return></return>
</function>
-<function name="clutter_backend_set_font_options">
+<function name="clutter_container_remove_actor">
<description>
-Sets the new font options for @backend. The #ClutterBackend will
-copy the #cairo_font_options_t.
+Removes @actor from @container. The actor should be unparented, so
+if you want to keep it around you must hold a reference to it
+yourself, using g_object_ref(). When the actor has been removed,
+the "actor-removed" signal is emitted by @container.
-If @options is %NULL, the first following call to
-clutter_backend_get_font_options() will return the default font
-options for @backend.
+This function will call #ClutterContainerIface.remove(), which is a
+deprecated virtual function. The default implementation will call
+clutter_actor_remove_child().
-This function is intended for actors creating a Pango layout
-using the PangoCairo API.
+Virtual: remove
-Since: 0.8
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_actor_remove_child() instead.
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="options">
-<parameter_description> Cairo font options for the backend, or %NULL
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_begin_animation">
+<function name="clutter_container_remove_valist">
<description>
-Begins an animation of @duration milliseconds, using the provided
-easing @mode
+Alternative va_list version of clutter_container_remove().
-The easing mode can be specified either as a #ClutterAnimationMode
-or as a logical id returned by clutter_alpha_register_func()
+This function will call #ClutterContainerIface.remove(), which is a
+deprecated virtual function. The default implementation will call
+clutter_actor_remove_child().
-The result of this function depends on the @manager implementation
+Since: 0.4
-Since: 1.2
+Deprecated: 1.10: Use clutter_actor_remove_child() instead.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="container">
+<parameter_description> a #ClutterContainer
</parameter_description>
</parameter>
-<parameter name="duration">
-<parameter_description> the duration of the animation, in milliseconds
+<parameter name="first_actor">
+<parameter_description> the first #ClutterActor to add
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> the easing mode of the animation
+<parameter name="var_args">
+<parameter_description> list of actors to remove, followed by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The #ClutterAlpha created by the
-layout manager; the returned instance is owned by the layout
-manager and should not be unreferenced
+<return></return>
+</function>
-</return>
+<function name="clutter_container_sort_depth_order">
+<description>
+Sorts a container's children using their depth. This function should not
+be normally used by applications.
+
+Since: 0.6
+
+Deprecated: 1.10: The #ClutterContainerIface.sort_depth_order() virtual
+function should not be used any more; the default implementation in
+#ClutterContainer does not do anything.
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #ClutterContainer
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_shader_set_is_enabled">
+<function name="clutter_content_get_preferred_size">
<description>
-Enables a shader. This function will attempt to compile and link
-the shader, if it isn't already.
+Retrieves the natural size of the @content, if any.
-When @enabled is %FALSE the default state of the GL pipeline will be
-used instead.
+The natural size of a #ClutterContent is defined as the size the content
+would have regardless of the allocation of the actor that is painting it,
+for instance the size of an image data.
-Since: 0.6
+Since: 1.10
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="content">
+<parameter_description> a #ClutterContent
</parameter_description>
</parameter>
-<parameter name="enabled">
-<parameter_description> The new state of the shader.
+<parameter name="width">
+<parameter_description> return location for the natural width of the content
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the natural height of the content
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the content has a preferred size, and %FALSE
+otherwise
+
+</return>
+</function>
+
+<function name="clutter_content_invalidate">
+<description>
+Invalidates a #ClutterContent.
+
+This function should be called by #ClutterContent implementations when
+they change the way a the content should be painted regardless of the
+actor state.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="content">
+<parameter_description> a #ClutterContent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_glx_texture_pixmap_using_extension">
+<function name="clutter_deform_effect_get_back_material">
<description>
-Checks whether @texture is using the GLX_EXT_texture_from_pixmap
-extension; this extension can be optionally (though it is strongly
-encouraged) implemented as a zero-copy between a GLX pixmap and
-a GL texture.
+Retrieves the handle to the back face material used by @effect
-Since: 0.8
+Since: 1.4
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterGLXTexturePixmap
+<parameter name="effect">
+<parameter_description> a #ClutterDeformEffect
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the texture is using the
-GLX_EXT_texture_from_pixmap OpenGL extension or falling back to the
-slower software mechanism.
+<return> a handle for the material, or %NULL.
+The returned material is owned by the #ClutterDeformEffect and it
+should not be freed directly
</return>
</function>
-<function name="clutter_texture_get_keep_aspect_ratio">
+<function name="clutter_deform_effect_get_n_tiles">
<description>
-Retrieves the value set using clutter_texture_get_keep_aspect_ratio()
+Retrieves the number of horizontal and vertical tiles used to sub-divide
+the actor's geometry during the effect
-Since: 1.0
+Since: 1.4
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="effect">
+<parameter_description> a #ClutterDeformEffect
+</parameter_description>
+</parameter>
+<parameter name="x_tiles">
+<parameter_description> return location for the number of horizontal tiles,
+or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y_tiles">
+<parameter_description> return location for the number of vertical tiles,
+or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterTexture should maintain the
-aspect ratio of the underlying image
+<return></return>
+</function>
-</return>
+<function name="clutter_deform_effect_invalidate">
+<description>
+Invalidates the @effect<!-- -->'s vertices and, if it is associated
+to an actor, it will queue a redraw
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterDeformEffect
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_destroy">
+<function name="clutter_deform_effect_set_back_material">
<description>
-Destroys an actor. When an actor is destroyed, it will break any
-references it holds to other objects. If the actor is inside a
-container, the actor will be removed.
+Sets the material that should be used when drawing the back face
+of the actor during a deformation
-When you destroy a container, its children will be destroyed as well.
+The #ClutterDeformEffect will take a reference on the material's
+handle
-Note: you cannot destroy the #ClutterStage returned by
-clutter_stage_get_default().
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="effect">
+<parameter_description> a #ClutterDeformEffect
+</parameter_description>
+</parameter>
+<parameter name="material">
+<parameter_description> a handle to a Cogl material
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_width">
+<function name="clutter_deform_effect_set_n_tiles">
<description>
-Retrieves the width of a #ClutterActor.
+Sets the number of horizontal and vertical tiles to be used
+when applying the effect
-If the actor has a valid allocation, this function will return the
-width of the allocated area given to the actor.
+More tiles allow a finer grained deformation at the expenses
+of computation
-If the actor does not have a valid allocation, this function will
-return the actor's natural width, that is the preferred width of
-the actor.
+Since: 1.4
-If you care whether you get the preferred width or the width that
-has been assigned to the actor, you should probably call a different
-function like clutter_actor_get_allocation_box() to retrieve the
-allocated size or clutter_actor_get_preferred_width() to retrieve the
-preferred width.
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterDeformEffect
+</parameter_description>
+</parameter>
+<parameter name="x_tiles">
+<parameter_description> number of horizontal tiles
+</parameter_description>
+</parameter>
+<parameter name="y_tiles">
+<parameter_description> number of vertical tiles
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-If an actor has a fixed width, for instance a width that has been
-assigned using clutter_actor_set_width(), the width returned will
-be the same value.
+<function name="clutter_desaturate_effect_get_factor">
+<description>
+Retrieves the desaturation factor of @effect
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="effect">
+<parameter_description> a #ClutterDesaturateEffect
</parameter_description>
</parameter>
</parameters>
-<return> the width of the actor, in pixels
+<return> the desaturation factor
+
</return>
</function>
-<function name="clutter_behaviour_depth_set_bounds">
+<function name="clutter_desaturate_effect_new">
<description>
-Sets the boundaries of the @behaviour.
+Creates a new #ClutterDesaturateEffect to be used with
+clutter_actor_add_effect()
-Since: 0.6
+Since: 1.4
</description>
<parameters>
-<parameter name="behaviour">
-<parameter_description> a #ClutterBehaviourDepth
+<parameter name="factor">
+<parameter_description> the desaturation factor, between 0.0 and 1.0
</parameter_description>
</parameter>
-<parameter name="depth_start">
-<parameter_description> initial value of the depth
+</parameters>
+<return> the newly created #ClutterDesaturateEffect or %NULL
+
+</return>
+</function>
+
+<function name="clutter_desaturate_effect_set_factor">
+<description>
+Sets the desaturation factor for @effect, with 0.0 being "do not desaturate"
+and 1.0 being "fully desaturate"
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterDesaturateEffect
</parameter_description>
</parameter>
-<parameter name="depth_end">
-<parameter_description> final value of the depth
+<parameter name="factor">
+<parameter_description> the desaturation factor, between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_units_free">
+<function name="clutter_device_manager_get_core_device">
<description>
-Frees the resources allocated by @units
+Retrieves the core #ClutterInputDevice of type @device_type
-You should only call this function on a #ClutterUnits
-created using clutter_units_copy()
+Core devices are devices created automatically by the default
+Clutter backend
-Since: 1.0
+Since: 1.2
</description>
<parameters>
-<parameter name="units">
-<parameter_description> the #ClutterUnits to free
+<parameter name="device_manager">
+<parameter_description> a #ClutterDeviceManager
+</parameter_description>
+</parameter>
+<parameter name="device_type">
+<parameter_description> the type of the core device
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterInputDevice or %NULL. The
+returned device is owned by the #ClutterDeviceManager and should
+not be modified or freed
+
+</return>
</function>
-<function name="json_node_type_name">
+<function name="clutter_device_manager_get_default">
<description>
-Retrieves the user readable name of the data type contained by @node.
+Retrieves the device manager singleton
+Since: 1.2
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+</parameters>
+<return> the #ClutterDeviceManager singleton.
+The returned instance is owned by Clutter and it should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="clutter_device_manager_get_device">
+<description>
+Retrieves the #ClutterInputDevice with the given @device_id
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="device_manager">
+<parameter_description> a #ClutterDeviceManager
+</parameter_description>
+</parameter>
+<parameter name="device_id">
+<parameter_description> the integer id of a device
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the name of the type. The returned string
-is owned by the node and should never be modified or freed
+<return> a #ClutterInputDevice or %NULL. The
+returned device is owned by the #ClutterDeviceManager and should
+never be modified or freed
+
</return>
</function>
-<function name="clutter_path_foreach">
+<function name="clutter_device_manager_list_devices">
<description>
-Calls a function for each node of the path.
+Lists all currently registered input devices
-Since: 1.0
+Since: 1.2
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="device_manager">
+<parameter_description> a #ClutterDeviceManager
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> the function to call with each node
+</parameters>
+<return>
+a newly allocated list of #ClutterInputDevice objects. Use
+g_slist_free() to deallocate it when done
+
+</return>
+</function>
+
+<function name="clutter_device_manager_peek_devices">
+<description>
+Lists all currently registered input devices
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="device_manager">
+<parameter_description> a #ClutterDeviceManager
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to the function
+</parameters>
+<return>
+a pointer to the internal list of #ClutterInputDevice objects. The
+returned list is owned by the #ClutterDeviceManager and should never
+be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_disable_accessibility">
+<description>
+Disable loading the accessibility support. It has the same effect
+as setting the environment variable
+CLUTTER_DISABLE_ACCESSIBILITY. For the same reason, this method
+should be called before clutter_init().
+
+Since: 1.14
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_do_event">
+<description>
+Processes an event.
+
+The @event must be a valid #ClutterEvent and have a #ClutterStage
+associated to it.
+
+This function is only useful when embedding Clutter inside another
+toolkit, and it should never be called by applications.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_rotate_get_center">
+<function name="clutter_drag_action_get_drag_area">
<description>
-Retrieves the center of rotation set using
-clutter_behaviour_rotate_set_center().
+Retrieves the "drag area" associated with @action, that
+is a #ClutterRect that constrains the actor movements,
+in parents coordinates.
-Since: 0.4
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X center of rotation
+<parameter name="drag_area">
+<parameter_description> a #ClutterRect to be filled
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y center of rotation
+</parameters>
+<return> %TRUE if the actor is actually constrained (and thus
+ drag_area is valid), %FALSE otherwise
+</return>
+</function>
+
+<function name="clutter_drag_action_get_drag_axis">
+<description>
+Retrieves the axis constraint set by clutter_drag_action_set_drag_axis()
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="z">
-<parameter_description> return location for the Z center of rotation
+</parameters>
+<return> the axis constraint
+
+</return>
+</function>
+
+<function name="clutter_drag_action_get_drag_handle">
+<description>
+Retrieves the drag handle set by clutter_drag_action_set_drag_handle()
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #ClutterActor, used as the drag
+handle, or %NULL if none was set
+
+</return>
</function>
-<function name="clutter_script_load_from_file">
+<function name="clutter_drag_action_get_drag_threshold">
<description>
-Loads the definitions from @filename into @script and merges with
-the currently loaded ones, if any.
+Retrieves the values set by clutter_drag_action_set_drag_threshold().
-Since: 0.6
+If the #ClutterDragAction:x-drag-threshold property or the
+#ClutterDragAction:y-drag-threshold property have been set to -1 then
+this function will return the default drag threshold value as stored
+by the #ClutterSettings:dnd-drag-threshold property of #ClutterSettings.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the full path to the definition file
+<parameter name="x_threshold">
+<parameter_description> return location for the horizontal drag
+threshold value, in pixels
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="y_threshold">
+<parameter_description> return location for the vertical drag
+threshold value, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> on error, zero is returned and @error is set
-accordingly. On success, the merge id for the UI definitions is
-returned. You can use the merge id with clutter_script_unmerge().
-
-</return>
+<return></return>
</function>
-<function name="clutter_model_prepend">
+<function name="clutter_drag_action_get_motion_coords">
<description>
-Creates and prepends a new row to the #ClutterModel, setting the row
-values upon creation. For example, to prepend a new row where column 0
-is type %G_TYPE_INT and column 1 is of type %G_TYPE_STRING:
+Retrieves the coordinates, in stage space, of the latest motion
+event during the dragging
-<informalexample><programlisting>
-ClutterModel *model;
-model = clutter_model_default_new (2,
-G_TYPE_INT, "Score",
-G_TYPE_STRING, "Team");
-clutter_model_prepend (model, 0, 42, 1, "Team #1", -1);
-</programlisting></informalexample>
+Since: 1.4
-Since: 0.6
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
+</parameter_description>
+</parameter>
+<parameter name="motion_x">
+<parameter_description> return location for the latest motion
+event's X coordinate
+</parameter_description>
+</parameter>
+<parameter name="motion_y">
+<parameter_description> return location for the latest motion
+event's Y coordinate
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_drag_action_get_press_coords">
+<description>
+Retrieves the coordinates, in stage space, of the press event
+that started the dragging
+
+Since: 1.4
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+<parameter name="press_x">
+<parameter_description> return location for the press event's X coordinate
+</parameter_description>
+</parameter>
+<parameter name="press_y">
+<parameter_description> return location for the press event's Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_untrap_x_errors">
+<function name="clutter_drag_action_new">
<description>
-Removes the X error trap and returns the current status.
+Creates a new #ClutterDragAction instance
-Since: 0.4
+Since: 1.4
</description>
<parameters>
</parameters>
-<return> the trapped error code, or 0 for success
+<return> the newly created #ClutterDragAction
</return>
</function>
-<function name="clutter_animator_set">
+<function name="clutter_drag_action_set_drag_area">
<description>
-Adds multiple keys to a #ClutterAnimator, specifying the value a given
-property should have at a given progress of the animation. The mode
-specified is the mode used when going to this key from the previous key of
-the @property_name
+Sets @drag_area to constrain the dragging of the actor associated
+with @action, so that it position is always within @drag_area, expressed
+in parent's coordinates.
+If @drag_area is %NULL, the actor is not constrained.
-If a given (object, property, progress) tuple already exist the mode and
-value will be replaced with the new values.
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
+</parameter_description>
+</parameter>
+<parameter name="drag_area">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.2
+<function name="clutter_drag_action_set_drag_axis">
+<description>
+Restricts the dragging action to a specific axis
+
+Since: 1.4
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="first_object">
-<parameter_description> a #GObject
+<parameter name="axis">
+<parameter_description> the axis to constraint the dragging to
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the property to specify a key for
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_drag_action_set_drag_handle">
+<description>
+Sets the actor to be used as the drag handle.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="first_mode">
-<parameter_description> the id of the alpha function to use
+<parameter name="handle">
+<parameter_description> a #ClutterActor, or %NULL to unset
</parameter_description>
</parameter>
-<parameter name="first_progress">
-<parameter_description> at which stage of the animation this value applies; the
-range is a normalized floating point value between 0 and 1
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_drag_action_set_drag_threshold">
+<description>
+Sets the horizontal and vertical drag thresholds that must be
+cleared by the pointer before @action can begin the dragging.
+
+If @x_threshold or @y_threshold are set to -1 then the default
+drag threshold stored in the #ClutterSettings:dnd-drag-threshold
+property of #ClutterSettings will be used.
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterDragAction
</parameter_description>
</parameter>
-<parameter name="VarArgs">
-<parameter_description> the value first_property_name should have for first_object
-at first_progress, followed by more (object, property_name, mode,
-progress, value) tuples, followed by %NULL
+<parameter name="x_threshold">
+<parameter_description> a distance on the horizontal axis, in pixels, or
+-1 to use the default drag threshold from #ClutterSettings
+</parameter_description>
+</parameter>
+<parameter name="y_threshold">
+<parameter_description> a distance on the vertical axis, in pixels, or
+-1 to use the default drag threshold from #ClutterSettings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_subtitle_font_name">
+<function name="clutter_drop_action_new">
<description>
-Retrieves the font name currently used.
+Creates a new #ClutterDropAction.
-Since: 1.2
+Use clutter_actor_add_action() to add the action to a #ClutterActor.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+</parameters>
+<return> the newly created #ClutterDropAction
+
+</return>
+</function>
+
+<function name="clutter_effect_queue_repaint">
+<description>
+Queues a repaint of the effect. The effect can detect when the ‘paint’
+method is called as a result of this function because it will not
+have the %CLUTTER_EFFECT_PAINT_ACTOR_DIRTY flag set. In that case the
+effect is free to assume that the actor has not changed its
+appearance since the last time it was painted so it doesn't need to
+call clutter_actor_continue_paint() if it can draw a cached
+image. This is mostly intended for effects that are using a
+%CoglOffscreen to redirect the actor (such as
+%ClutterOffscreenEffect). In that case the effect can save a bit of
+rendering time by painting the cached texture without causing the
+entire actor to be painted.
+
+This function can be used by effects that have their own animatable
+parameters. For example, an effect which adds a varying degree of a
+red tint to an actor by redirecting it through a CoglOffscreen
+might have a property to specify the level of tint. When this value
+changes, the underlying actor doesn't need to be redrawn so the
+effect can call clutter_effect_queue_repaint() to make sure the
+effect is repainted.
+
+Note however that modifying the position of the parent of an actor
+may change the appearance of the actor because its transformation
+matrix would change. In this case a redraw wouldn't be queued on
+the actor itself so the %CLUTTER_EFFECT_PAINT_ACTOR_DIRTY would still
+not be set. The effect can detect this case by keeping track of the
+last modelview matrix that was used to render the actor and
+veryifying that it remains the same in the next paint.
+
+Any other effects that are layered on top of the passed in effect
+will still be passed the %CLUTTER_EFFECT_PAINT_ACTOR_DIRTY flag. If
+anything queues a redraw on the actor without specifying an effect
+or with an effect that is lower in the chain of effects than this
+one then that will override this call. In that case this effect
+will instead be called with the %CLUTTER_EFFECT_PAINT_ACTOR_DIRTY
+flag set.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> A #ClutterEffect which needs redrawing
</parameter_description>
</parameter>
</parameters>
-<return> a string containing the font name. Use g_free()
-to free the returned string
+<return></return>
+</function>
+
+<function name="clutter_egl_display">
+<description>
+Retrieves the EGL display used by Clutter.
+
+Since: 0.6
+
+Deprecated: 1.6: Use clutter_egl_get_egl_display() instead.
+
+</description>
+<parameters>
+</parameters>
+<return> the EGL display used by Clutter, or 0
</return>
</function>
-<function name="clutter_animator_remove_key">
+<function name="clutter_egl_get_egl_display">
<description>
-Removes all keys matching the conditions specificed in the arguments.
+Retrieves the EGL display used by Clutter, if it supports the
+EGL windowing system and if it is running using an EGL backend.
-Since: 1.2
+Since: 1.6
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+</parameters>
+<return> the EGL display used by Clutter, or 0
+
+</return>
+</function>
+
+<function name="clutter_eglx_display">
+<description>
+Retrieves the EGL display used by Clutter.
+
+Since: 0.6
+
+Deprecated: 1.6: Use clutter_egl_get_egl_display() instead.
+
+</description>
+<parameters>
+</parameters>
+<return> the EGL display, or 0
+
+</return>
+</function>
+
+<function name="clutter_evdev_get_keyboard_map">
+<description>
+Retrieves the #xkb_keymap in use by the evdev backend.
+
+Since: 1.18
+Stability: unstable
+
+</description>
+<parameters>
+<parameter name="evdev">
+<parameter_description> the #ClutterDeviceManager created by the evdev backend
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject to search for, or %NULL for all
+</parameters>
+<return> the #xkb_keymap.
+
+</return>
+</function>
+
+<function name="clutter_evdev_reclaim_devices">
+<description>
+This causes Clutter to re-probe for evdev devices. This is must only be
+called after a corresponding call to clutter_evdev_release_devices()
+was previously used to release all evdev devices. This API is typically
+used when a clutter application using evdev has regained focus due to
+switching ttys.
+
+This function should only be called after clutter has been initialized.
+
+Since: 1.10
+Stability: unstable
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_evdev_release_devices">
+<description>
+Releases all the evdev devices that Clutter is currently managing. This api
+is typically used when switching away from the Clutter application when
+switching tty. The devices can be reclaimed later with a call to
+clutter_evdev_reclaim_devices().
+
+This function should only be called after clutter has been initialized.
+
+Since: 1.10
+Stability: unstable
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_evdev_set_device_callbacks">
+<description>
+Through this function, the application can set a custom callback
+to invoked when Clutter is about to open an evdev device. It can do
+so if special handling is needed, for example to circumvent permission
+problems.
+
+Setting @callback to %NULL will reset the default behavior.
+
+For reliable effects, this function must be called before clutter_init().
+
+Since: 1.16
+Stability: unstable
+
+</description>
+<parameters>
+<parameter name="open_callback">
+<parameter_description> the user replacement for open()
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> a specific property name to query for,
-or %NULL for all
+<parameter name="close_callback">
+<parameter_description> the user replacement for close()
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> a specific progress to search for or a negative value
-for all
+<parameter name="user_data">
+<parameter_description> user data for @callback
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_units_from_em">
+<function name="clutter_evdev_set_keyboard_map">
<description>
-Stores a value in em inside @units, using the default font
-name as returned by clutter_backend_get_font_name()
+Instructs @evdev to use the speficied keyboard map. This will cause
+the backend to drop the state and create a new one with the new
+map. To avoid state being lost, callers should ensure that no key
+is pressed when calling this function.
-Since: 1.0
+Since: 1.16
+Stability: unstable
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="evdev">
+<parameter_description> the #ClutterDeviceManager created by the evdev backend
</parameter_description>
</parameter>
-<parameter name="em">
-<parameter_description> em
+<parameter name="keymap">
+<parameter_description> the new keymap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_set_use_argb_visual">
+<function name="clutter_evdev_set_keyboard_repeat">
<description>
-Sets whether the Clutter X11 backend should request ARGB visuals by default
-or not.
-
-By default, Clutter requests RGB visuals.
+Enables or disables sythetic key press events, allowing for initial
+delay and interval period to be specified.
-<note>If no ARGB visuals are found, the X11 backend will fall back to
-requesting a RGB visual instead.</note>
+Since: 1.18
+Stability: unstable
-ARGB visuals are required for the #ClutterStage:use-alpha property to work.
+</description>
+<parameters>
+<parameter name="evdev">
+<parameter_description> the #ClutterDeviceManager created by the evdev backend
+</parameter_description>
+</parameter>
+<parameter name="repeat">
+<parameter_description> whether to enable or disable keyboard repeat events
+</parameter_description>
+</parameter>
+<parameter name="delay">
+<parameter_description> the delay in ms between the hardware key press event and
+the first synthetic event
+</parameter_description>
+</parameter>
+<parameter name="interval">
+<parameter_description> the period in ms between consecutive synthetic key
+press events
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-<note>This function can only be called once, and before clutter_init() is
-called.</note>
+<function name="clutter_evdev_set_pointer_constrain_callback">
+<description>
+Sets a callback to be invoked for every pointer motion. The callback
+can then modify the new pointer coordinates to constrain movement within
+a specific region.
-Since: 1.2
+Since: 1.16
+Stability: unstable
</description>
<parameters>
-<parameter name="use_argb">
-<parameter_description> %TRUE if ARGB visuals should be requested by default
+<parameter name="evdev">
+<parameter_description> the #ClutterDeviceManager created by the evdev backend
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the callback
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="user_data_notify">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_type">
+<function name="clutter_event_add_filter">
<description>
-Retrieves the type of the event.
+Adds a function which will be called for all events that Clutter
+processes. The function will be called before any signals are
+emitted for the event and it will take precedence over any grabs.
+Since: 1.18
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="stage">
+<parameter_description> The #ClutterStage to capture events for
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> The callback function which will be passed all events.
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> A #GDestroyNotify
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> A data pointer to pass to the function.
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterEventType
+<return> an identifier for the event filter, to be used
+with clutter_event_remove_filter().
+
</return>
</function>
-<function name="json_array_ref">
+<function name="clutter_event_copy">
<description>
-Increase by one the reference count of a #JsonArray.
+Copies @event.
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="event">
+<parameter_description> A #ClutterEvent.
</parameter_description>
</parameter>
</parameters>
-<return> the passed #JsonArray, with the reference count
-increased by one.
+<return> A newly allocated #ClutterEvent
</return>
</function>
-<function name="clutter_shader_get_vertex_source">
+<function name="clutter_event_free">
<description>
-Query the current GLSL vertex source set on @shader.
-
-Since: 0.6
+Frees all resources used by @event.
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="event">
+<parameter_description> A #ClutterEvent.
</parameter_description>
</parameter>
</parameters>
-<return> the source of the vertex shader for this
-ClutterShader object or %NULL. The returned string is owned by the
-shader object and should never be modified or freed
+<return></return>
+</function>
+
+<function name="clutter_event_get">
+<description>
+Pops an event off the event queue. Applications should not need to call
+this.
+
+Since: 0.4
+
+</description>
+<parameters>
+</parameters>
+<return> A #ClutterEvent or NULL if queue empty
</return>
</function>
-<function name="clutter_text_get_editable">
+<function name="clutter_event_get_angle">
<description>
-Retrieves whether a #ClutterText is editable or not.
+Retrieves the angle relative from @source to @target.
-Since: 1.0
+The direction of the angle is from the position X axis towards
+the positive Y axis.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="source">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is editable
+<return> the angle between two #ClutterEvent
</return>
</function>
-<function name="json_array_sized_new">
+<function name="clutter_event_get_axes">
<description>
-Creates a new #JsonArray with @n_elements slots already allocated.
+Retrieves the array of axes values attached to the event.
+Since: 1.6
</description>
<parameters>
-<parameter name="n_elements">
-<parameter_description> number of slots to pre-allocate
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="n_axes">
+<parameter_description> return location for the number of axes returned
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #JsonArray
+<return> an array of axis values
+
</return>
</function>
-<function name="clutter_timeline_rewind">
+<function name="clutter_event_get_button">
<description>
-Rewinds #ClutterTimeline to the first frame if its direction is
-%CLUTTER_TIMELINE_FORWARD and the last frame if it is
-%CLUTTER_TIMELINE_BACKWARD.
+Retrieves the button number of @event
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_BUTTON_PRESS or
+of type %CLUTTER_BUTTON_RELEASE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the button number
+
+</return>
</function>
-<function name="clutter_script_new">
+<function name="clutter_event_get_click_count">
<description>
-Creates a new #ClutterScript instance. #ClutterScript can be used
-to load objects definitions for scenegraph elements, like actors,
-or behavioural elements, like behaviours and timelines. The
-definitions must be encoded using the JavaScript Object Notation (JSON)
-language.
+Retrieves the number of clicks of @event
-Since: 0.6
+Since: 1.0
</description>
<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_BUTTON_PRESS or
+of type %CLUTTER_BUTTON_RELEASE
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterScript instance. Use
-g_object_unref() when done.
+<return> the click count
</return>
</function>
-<function name="clutter_behaviour_depth_get_bounds">
+<function name="clutter_event_get_coords">
<description>
-Gets the boundaries of the @behaviour
+Retrieves the coordinates of @event and puts them into @x and @y.
-Since: 0.6
+Since: 0.4
</description>
<parameters>
-<parameter name="behaviour">
-<parameter_description> a #ClutterBehaviourDepth
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="depth_start">
-<parameter_description> return location for the initial depth value, or %NULL
+<parameter name="x">
+<parameter_description> return location for the X coordinate, or %NULL
</parameter_description>
</parameter>
-<parameter name="depth_end">
-<parameter_description> return location for the final depth value, or %NULL
+<parameter name="y">
+<parameter_description> return location for the Y coordinate, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_set_throttle_motion_events">
+<function name="clutter_event_get_device">
<description>
-Sets whether motion events received between redraws should
-be throttled or not. If motion events are throttled, those
-events received by the windowing system between redraws will
-be compressed so that only the last event will be propagated
-to the @stage and its actors.
+Retrieves the #ClutterInputDevice for the event.
+If you want the physical device the event originated from, use
+clutter_event_get_source_device().
-This function should only be used if you want to have all
-the motion events delivered to your application code.
+The #ClutterInputDevice structure is completely opaque and should
+be cast to the platform-specific implementation.
Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="throttle">
-<parameter_description> %TRUE to throttle motion events
+</parameters>
+<return> the #ClutterInputDevice or %NULL. The
+returned device is owned by the #ClutterEvent and it should not
+be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_event_get_device_id">
+<description>
+Retrieves the events device id if set.
+
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a clutter event
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A unique identifier for the device or -1 if the event has
+no specific device set.
+</return>
</function>
-<function name="clutter_binding_pool_get_for_class">
+<function name="clutter_event_get_device_type">
<description>
-Retrieves the #ClutterBindingPool for the given #GObject class
-and, eventually, creates it. This function is a wrapper around
-clutter_binding_pool_new() and uses the class type name as the
-unique name for the binding pool.
+Retrieves the type of the device for @event
-Calling this function multiple times will return the same
-#ClutterBindingPool.
+Since: 1.0
-A binding pool for a class can also be retrieved using
-clutter_binding_pool_find() with the class type name:
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #ClutterInputDeviceType for the device, if
+any is set
-|[
-pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (instance));
-]|
+</return>
+</function>
+
+<function name="clutter_event_get_distance">
+<description>
+Retrieves the distance between two events, a @source and a @target.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="source">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+</parameters>
+<return> the distance between two #ClutterEvent
+
+</return>
+</function>
+
+<function name="clutter_event_get_event_sequence">
+<description>
+Retrieves the #ClutterEventSequence of @event.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_TOUCH_BEGIN,
+%CLUTTER_TOUCH_UPDATE, %CLUTTER_TOUCH_END, or
+%CLUTTER_TOUCH_CANCEL
+</parameter_description>
+</parameter>
+</parameters>
+<return> the event sequence, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_event_get_flags">
+<description>
+Retrieves the #ClutterEventFlags of @event
Since: 1.0
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GObjectClass pointer
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> the binding pool for the given class.
-The returned #ClutterBindingPool is owned by Clutter and should not
-be freed directly
+<return> the event flags
</return>
</function>
-<function name="clutter_container_class_list_child_properties">
+<function name="clutter_event_get_key_code">
<description>
-Returns an array of #GParamSpec for all child properties.
+Retrieves the keycode of the key that caused @event
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GObjectClass implementing the #ClutterContainer interface.
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS or
+of type %CLUTTER_KEY_RELEASE
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> return location for length of returned array.
+</parameters>
+<return> The keycode representing the key
+
+</return>
+</function>
+
+<function name="clutter_event_get_key_symbol">
+<description>
+Retrieves the key symbol of @event
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS or
+of type %CLUTTER_KEY_RELEASE
</parameter_description>
</parameter>
</parameters>
-<return> an array
-of #GParamSpec<!-- -->s which should be freed after use.
+<return> the key symbol representing the key
</return>
</function>
-<function name="clutter_layout_manager_get_preferred_height">
+<function name="clutter_event_get_key_unicode">
<description>
-Computes the minimum and natural heights of the @container according
-to @manager.
+Retrieves the unicode value for the key that caused @keyev.
-See also clutter_actor_get_preferred_height()
-Since: 1.2
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS
+or %CLUTTER_KEY_RELEASE
+</parameter_description>
+</parameter>
+</parameters>
+<return> The unicode value representing the key
+</return>
+</function>
+
+<function name="clutter_event_get_position">
+<description>
+Retrieves the event coordinates as a #ClutterPoint.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> the #ClutterContainer using @manager
+<parameter name="position">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
-<parameter name="for_width">
-<parameter_description> the width for which the height should be computed, or -1
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_event_get_related">
+<description>
+Retrieves the related actor of a crossing event.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_ENTER or of
+type %CLUTTER_LEAVE
</parameter_description>
</parameter>
-<parameter name="min_height_p">
-<parameter_description> return location for the minimum height
-of the layout, or %NULL
+</parameters>
+<return> the related #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_event_get_scroll_delta">
+<description>
+Retrieves the precise scrolling information of @event.
+
+The @event has to have a #ClutterScrollEvent.direction value
+of %CLUTTER_SCROLL_SMOOTH.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_SCROLL
</parameter_description>
</parameter>
-<parameter name="nat_height_p">
-<parameter_description> return location for the natural height
-of the layout, or %NULL
+<parameter name="dx">
+<parameter_description> return location for the delta on the horizontal axis
+</parameter_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> return location for the delta on the vertical axis
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_get_width">
+<function name="clutter_event_get_scroll_direction">
<description>
-Retrieves the width of the @box
+Retrieves the direction of the scrolling of @event
Since: 1.0
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_SCROLL
</parameter_description>
</parameter>
</parameters>
-<return> the width of the box
+<return> the scrolling direction
</return>
</function>
-<function name="clutter_binding_pool_install_action">
+<function name="clutter_event_get_source">
<description>
-Installs a new action inside a #ClutterBindingPool. The action
-is bound to @key_val and @modifiers.
+Retrieves the source #ClutterActor the event originated from, or
+NULL if the event has no source.
-The same action name can be used for multiple @key_val, @modifiers
-pairs.
+Since: 0.6
-When an action has been activated using clutter_binding_pool_activate()
-the passed @callback will be invoked (with @data).
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterActor
-Actions can be blocked with clutter_binding_pool_block_action()
-and then unblocked using clutter_binding_pool_unblock_action().
+</return>
+</function>
-Since: 1.0
+<function name="clutter_event_get_source_device">
+<description>
+Retrieves the hardware device that originated the event.
+
+If you need the virtual device, use clutter_event_get_device().
+
+If no hardware device originated this event, this function will
+return the same device as clutter_event_get_device().
+
+Since: 1.6
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="action_name">
-<parameter_description> the name of the action
+</parameters>
+<return> a pointer to a #ClutterInputDevice
+or %NULL
+
+</return>
+</function>
+
+<function name="clutter_event_get_stage">
+<description>
+Retrieves the source #ClutterStage the event originated for, or
+%NULL if the event has no stage.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> key symbol
+</parameters>
+<return> a #ClutterStage
+
+</return>
+</function>
+
+<function name="clutter_event_get_state">
+<description>
+Retrieves the modifier state of the event. In case the window system
+supports reporting latched and locked modifiers, this function returns
+the effective state.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> bitmask of modifiers
+</parameters>
+<return> the modifier state parameter, or 0
+
+</return>
+</function>
+
+<function name="clutter_event_get_state_full">
+<description>
+Retrieves the decomposition of the keyboard state into button, base,
+latched, locked and effective. This can be used to transmit to other
+applications, for example when implementing a wayland compositor.
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> function to be called when the action is activated
+<parameter name="button_state">
+<parameter_description> the pressed buttons as a mask
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to be passed to @callback
+<parameter name="base_state">
+<parameter_description> the regular pressed modifier keys
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to be called when the action is removed
-from the pool
+<parameter name="latched_state">
+<parameter_description> the latched modifier keys (currently released but still valid for one key
press/release)
+</parameter_description>
+</parameter>
+<parameter name="locked_state">
+<parameter_description> the locked modifier keys (valid until the lock key is pressed and released again)
+</parameter_description>
+</parameter>
+<parameter name="effective_state">
+<parameter_description> the logical OR of all the state bits above
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_list_timelines">
+<function name="clutter_event_get_time">
<description>
-Retrieves a list of all the #ClutterTimelines managed by @score.
+Retrieves the time of the event.
-Since: 0.6
+Since: 0.4
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList
-containing all the timelines in the score. This function does not increase
-the reference count of the returned timelines. Use g_slist_free() on the
-returned list to deallocate its resources.
+<return> the time of the event, or %CLUTTER_CURRENT_TIME
</return>
</function>
-<function name="clutter_event_get_click_count">
+<function name="clutter_event_has_control_modifier">
<description>
-Retrieves the number of clicks of @event
+Checks whether @event has the Control modifier mask set.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_BUTTON_PRESS or
-of type %CLUTTER_BUTTON_RELEASE
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> the click count
+<return> %TRUE if the event has the Control modifier mask set
</return>
</function>
-<function name="clutter_layout_meta_get_manager">
+<function name="clutter_event_has_shift_modifier">
<description>
-Retrieves the actor wrapped by @data
+Checks whether @event has the Shift modifier mask set.
-Since: 1.2
+Since: 1.12
</description>
<parameters>
-<parameter name="data">
-<parameter_description> a #ClutterLayoutMeta
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterLayoutManager
+<return> %TRUE if the event has the Shift modifier mask set
</return>
</function>
-<function name="clutter_path_get_description">
+<function name="clutter_event_is_pointer_emulated">
<description>
-Returns a newly allocated string describing the path in the same
-format as used by clutter_path_add_string().
+Checks whether a pointer @event has been generated by the windowing
+system. The returned value can be used to distinguish between events
+synthesized by the windowing system itself (as opposed by Clutter).
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> a string description of the path. Free with g_free().
+<return> %TRUE if the event is pointer emulated
</return>
</function>
-<function name="clutter_actor_get_stage">
+<function name="clutter_event_new">
<description>
-Retrieves the #ClutterStage where @actor is contained.
+Creates a new #ClutterEvent of the specified type.
-Since: 0.8
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="type">
+<parameter_description> The type of event.
</parameter_description>
</parameter>
</parameters>
-<return> the stage containing the actor, or %NULL
+<return> A newly allocated #ClutterEvent.
+</return>
+</function>
+
+<function name="clutter_event_peek">
+<description>
+Returns a pointer to the first event from the event queue but
+does not remove it.
+
+Since: 0.4
+
+</description>
+<parameters>
+</parameters>
+<return> A #ClutterEvent or NULL if queue empty.
</return>
</function>
-<function name="clutter_flow_layout_get_homogeneous">
+<function name="clutter_event_put">
<description>
-Retrieves whether the @layout is homogeneous
+Puts a copy of the event on the back of the event queue. The event will
+have the %CLUTTER_EVENT_FLAG_SYNTHETIC flag set. If the source is set
+event signals will be emitted for this source and capture/bubbling for
+its ancestors. If the source is not set it will be generated by picking
+or use the actor that currently has keyboard focus
-Since: 1.2
+Since: 0.6
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterFlowLayout is homogeneous
+<return></return>
+</function>
-</return>
+<function name="clutter_event_remove_filter">
+<description>
+Removes an event filter that was previously added with
+clutter_event_add_filter().
+
+Since: 1.18
+
+</description>
+<parameters>
+<parameter name="id">
+<parameter_description> The ID of the event filter, as returned from clutter_event_add_filter()
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_param_spec_units">
+<function name="clutter_event_set_button">
<description>
-Creates a #GParamSpec for properties using #ClutterUnits.
+Sets the button number of @event
-Since: 1.0
+Since: 1.8
</description>
<parameters>
-<parameter name="name">
-<parameter_description> name of the property
+<parameter name="event">
+<parameter_description> a #ClutterEvent or type %CLUTTER_BUTTON_PRESS or
+of type %CLUTTER_BUTTON_RELEASE
</parameter_description>
</parameter>
-<parameter name="nick">
-<parameter_description> short name
+<parameter name="button">
+<parameter_description> the button number
</parameter_description>
</parameter>
-<parameter name="blurb">
-<parameter_description> description (can be translatable)
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_event_set_coords">
+<description>
+Sets the coordinates of the @event.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="default_type">
-<parameter_description> the default type for the #ClutterUnits
+<parameter name="x">
+<parameter_description> the X coordinate of the event
</parameter_description>
</parameter>
-<parameter name="minimum">
-<parameter_description> lower boundary
+<parameter name="y">
+<parameter_description> the Y coordinate of the event
</parameter_description>
</parameter>
-<parameter name="maximum">
-<parameter_description> higher boundary
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_event_set_device">
+<description>
+Sets the device for @event.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="default_value">
-<parameter_description> default value
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_event_set_flags">
+<description>
+Sets the #ClutterEventFlags of @event
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> flags for the param spec
+<parameter_description> a binary OR of #ClutterEventFlags values
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GParamSpec
-
-</return>
+<return></return>
</function>
-<function name="clutter_x11_has_event_retrieval">
+<function name="clutter_event_set_key_code">
<description>
-Queries the X11 backend to check if event collection has been disabled.
+Sets the keycode of the @event.
-Since: 0.8
+Since: 1.8
</description>
<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS
+or %CLUTTER_KEY_RELEASE
+</parameter_description>
+</parameter>
+<parameter name="key_code">
+<parameter_description> the keycode representing the key
+</parameter_description>
+</parameter>
</parameters>
-<return> TRUE if event retrival has been disabled. FALSE otherwise.
+<return></return>
+</function>
-</return>
+<function name="clutter_event_set_key_symbol">
+<description>
+Sets the key symbol of @event.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS
+or %CLUTTER_KEY_RELEASE
+</parameter_description>
+</parameter>
+<parameter name="key_sym">
+<parameter_description> the key symbol representing the key
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_event_get_device">
+<function name="clutter_event_set_key_unicode">
<description>
-Retrieves the #ClutterInputDevice for the event.
+Sets the Unicode value of @event.
-The #ClutterInputDevice structure is completely opaque and should
-be cast to the platform-specific implementation.
+Since: 1.8
-Since: 1.0
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS
+or %CLUTTER_KEY_RELEASE
+</parameter_description>
+</parameter>
+<parameter name="key_unicode">
+<parameter_description> the Unicode value representing the key
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_event_set_related">
+<description>
+Sets the related actor of a crossing event
+
+Since: 1.8
</description>
<parameters>
<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter_description> a #ClutterEvent of type %CLUTTER_ENTER or %CLUTTER_LEAVE
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterInputDevice or %NULL
+<return></return>
+</function>
-</return>
+<function name="clutter_event_set_scroll_delta">
+<description>
+Sets the precise scrolling information of @event.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_SCROLL
+</parameter_description>
+</parameter>
+<parameter name="dx">
+<parameter_description> delta on the horizontal axis
+</parameter_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> delta on the vertical axis
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_width">
+<function name="clutter_event_set_scroll_direction">
<description>
-Sets the width of the elliptical path.
+Sets the direction of the scrolling of @event
-Since: 0.4
+Since: 1.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of the ellipse
+<parameter name="direction">
+<parameter_description> the scrolling direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_get_current_event_time">
+<function name="clutter_event_set_source">
<description>
-Retrieves the timestamp of the last X11 event processed by
-Clutter. This might be different from the timestamp returned
-by clutter_get_current_event_time(), as Clutter may synthesize
-or throttle events.
+Sets the source #ClutterActor of @event.
-Since: 1.0
+Since: 1.8
</description>
<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> a timestamp, in milliseconds
+<return></return>
+</function>
-</return>
+<function name="clutter_event_set_source_device">
+<description>
+Sets the source #ClutterInputDevice for @event.
+
+The #ClutterEvent must have been created using clutter_event_new().
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_stage_get_key_focus">
+<function name="clutter_event_set_stage">
<description>
-Retrieves the actor that is currently under key focus.
+Sets the source #ClutterStage of the event.
-Since: 0.6
+Since: 1.8
</description>
<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter_description> a #ClutterStage, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the actor with key focus, or the stage
-
-</return>
+<return></return>
</function>
-<function name="clutter_animation_set_duration">
+<function name="clutter_event_set_state">
<description>
-Sets the duration of @animation in milliseconds.
+Sets the modifier state of the event.
-This function will set #ClutterAnimation:alpha and
-#ClutterAnimation:timeline if needed.
-
-Since: 1.0
+Since: 1.8
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> the duration in milliseconds
+<parameter name="state">
+<parameter_description> the modifier state to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_text">
+<function name="clutter_event_set_time">
<description>
-Retrieves a pointer to the current contents of a #ClutterText
-actor.
+Sets the time of the event.
-If you need a copy of the contents for manipulating, either
-use g_strdup() on the returned string, or use:
+Since: 1.8
-|[
-copy = clutter_text_get_chars (text, 0, -1);
-]|
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> the time of the event
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Which will return a newly allocated string.
+<function name="clutter_event_type">
+<description>
+Retrieves the type of the event.
-Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return> the contents of the actor. The returned string
-is owned by the #ClutterText actor and should never be
-modified or freed
+<return> a #ClutterEventType
+</return>
+</function>
+
+<function name="clutter_events_pending">
+<description>
+Checks if events are pending in the event queue.
+
+Since: 0.4
+
+</description>
+<parameters>
+</parameters>
+<return> TRUE if there are pending events, FALSE otherwise.
</return>
</function>
-<function name="clutter_behaviour_path_new_with_description">
+<function name="clutter_feature_available">
<description>
-Creates a new path behaviour using the path described by @desc. See
-clutter_path_add_string() for a description of the format.
+Checks whether @feature is available. @feature can be a logical
+OR of #ClutterFeatureFlags.
-Since: 1.0
+Since: 0.1.1
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter name="feature">
+<parameter_description> a #ClutterFeatureFlags
</parameter_description>
</parameter>
-<parameter name="desc">
-<parameter_description> a string description of the path
+</parameters>
+<return> %TRUE if a feature is available
+
+</return>
+</function>
+
+<function name="clutter_feature_get_all">
+<description>
+Returns all the supported features.
+
+Since: 0.1.1
+
+</description>
+<parameters>
+</parameters>
+<return> a logical OR of all the supported features.
+
+</return>
+</function>
+
+<function name="clutter_fixed_layout_new">
+<description>
+Creates a new #ClutterFixedLayout
+
+Since: 1.2
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterFixedLayout
+
+</return>
+</function>
+
+<function name="clutter_flow_layout_get_column_spacing">
+<description>
+Retrieves the spacing between columns
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterBehaviour
+<return> the spacing between columns of the #ClutterFlowLayout,
+in pixels
</return>
</function>
-<function name="json_node_set_int">
+<function name="clutter_flow_layout_get_column_width">
<description>
-Sets @value as the integer content of the @node, replacing any existing
-content.
+Retrieves the minimum and maximum column widths
+
+Since: 1.2
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an integer value
+<parameter name="min_width">
+<parameter_description> return location for the minimum column width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="max_width">
+<parameter_description> return location for the maximum column width, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_get_array">
+<function name="clutter_flow_layout_get_homogeneous">
<description>
-Retrieves the #JsonArray stored inside a #JsonNode
+Retrieves whether the @layout is homogeneous
+Since: 1.2
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
</parameters>
-<return> the #JsonArray
+<return> %TRUE if the #ClutterFlowLayout is homogeneous
+
</return>
</function>
-<function name="clutter_model_set_types">
+<function name="clutter_flow_layout_get_orientation">
<description>
-Sets the types of the columns inside a #ClutterModel.
+Retrieves the orientation of the @layout
-This function is meant primarily for #GObjects that inherit from
-#ClutterModel, and should only be used when contructing a #ClutterModel.
-It will not work after the initial creation of the #ClutterModel.
+Since: 1.2
-Since: 0.6
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the orientation of the #ClutterFlowLayout
+
+</return>
+</function>
+
+<function name="clutter_flow_layout_get_row_height">
+<description>
+Retrieves the minimum and maximum row heights
+
+Since: 1.2
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> number of columns for the model
+<parameter name="min_height">
+<parameter_description> return location for the minimum row height, or %NULL
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> an array of #GType types
+<parameter name="max_height">
+<parameter_description> return location for the maximum row height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_knot_equal">
+<function name="clutter_flow_layout_get_row_spacing">
<description>
-Compares to knot and checks if the point to the same location.
+Retrieves the spacing between rows
-Since: 0.2
+Since: 1.2
</description>
<parameters>
-<parameter name="knot_a">
-<parameter_description> First knot
-</parameter_description>
-</parameter>
-<parameter name="knot_b">
-<parameter_description> Second knot
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the knots point to the same location.
+<return> the spacing between rows of the #ClutterFlowLayout,
+in pixels
</return>
</function>
-<function name="clutter_shader_compile">
+<function name="clutter_flow_layout_get_snap_to_grid">
<description>
-Compiles and links GLSL sources set for vertex and fragment shaders for
-a #ClutterShader. If the compilation fails and a #GError return location is
-provided the error will contain the errors from the compiler, if any.
+Retrieves the value of #ClutterFlowLayout:snap-to-grid property
-Since: 0.8
+Since: 1.16
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+</parameters>
+<return> %TRUE if the @layout is placing its children on a grid
+
+</return>
+</function>
+
+<function name="clutter_flow_layout_new">
+<description>
+Creates a new #ClutterFlowLayout with the given @orientation
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="orientation">
+<parameter_description> the orientation of the flow layout
</parameter_description>
</parameter>
</parameters>
-<return> returns TRUE if the shader was succesfully compiled.
+<return> the newly created #ClutterFlowLayout
</return>
</function>
-<function name="clutter_backend_set_resolution">
+<function name="clutter_flow_layout_set_column_spacing">
<description>
-Sets the resolution for font handling on the screen. This is a
-scale factor between points specified in a #PangoFontDescription
-and cairo units. The default value is 96, meaning that a 10 point
-font will be 13 units high. (10 * 96. / 72. = 13.3).
-
-Applications should never need to call this function.
+Sets the space between columns, in pixels
-Since: 0.4
+Since: 1.2
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="dpi">
-<parameter_description> the resolution in "dots per inch" (Physical inches aren't
-actually involved; the terminology is conventional).
+<parameter name="spacing">
+<parameter_description> the space between columns
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_layout_manager_allocate">
+<function name="clutter_flow_layout_set_column_width">
<description>
-Allocates the children of @container given an area
-
-See also clutter_actor_allocate()
+Sets the minimum and maximum widths that a column can have
Since: 1.2
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="container">
-<parameter_description> the #ClutterContainer using @manager
+<parameter name="min_width">
+<parameter_description> minimum width of a column
</parameter_description>
</parameter>
-<parameter name="allocation">
-<parameter_description> the #ClutterActorBox containing the allocated area
-of @container
+<parameter name="max_width">
+<parameter_description> maximum width of a column
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the allocation flags
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_flow_layout_set_homogeneous">
+<description>
+Sets whether the @layout should allocate the same space for
+each child
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
+</parameter_description>
+</parameter>
+<parameter name="homogeneous">
+<parameter_description> whether the layout should be homogeneous or not
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_preferred_width">
+<function name="clutter_flow_layout_set_orientation">
<description>
-Computes the requested minimum and natural widths for an actor,
-optionally depending on the specified height, or if they are
-already computed, returns the cached values.
-
-An actor may not get its request - depending on the layout
-manager that's in effect.
+Sets the orientation of the flow layout
-A request should not incorporate the actor's scale or anchor point;
-those transformations do not affect layout, only rendering.
+The orientation controls the direction used to allocate
+the children: either horizontally or vertically. The
+orientation also controls the direction of the overflowing
-Since: 0.8
+Since: 1.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="for_height">
-<parameter_description> available height when computing the preferred width,
-or a negative value to indicate that no height is defined
+<parameter name="orientation">
+<parameter_description> the orientation of the layout
</parameter_description>
</parameter>
-<parameter name="min_width_p">
-<parameter_description> return location for minimum width,
-or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_flow_layout_set_row_height">
+<description>
+Sets the minimum and maximum heights that a row can have
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="natural_width_p">
-<parameter_description> return location for the natural
-width, or %NULL
+<parameter name="min_height">
+<parameter_description> the minimum height of a row
+</parameter_description>
+</parameter>
+<parameter name="max_height">
+<parameter_description> the maximum height of a row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_get_easing_duration">
+<function name="clutter_flow_layout_set_row_spacing">
<description>
-Retrieves the duration set using clutter_box_layout_set_easing_duration()
+Sets the spacing between rows, in pixels
Since: 1.2
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter_description> a #ClutterFlowLayout
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the space between rows
</parameter_description>
</parameter>
</parameters>
-<return> the duration of the animations, in milliseconds
-
-</return>
+<return></return>
</function>
-<function name="clutter_script_get_type_from_name">
+<function name="clutter_flow_layout_set_snap_to_grid">
<description>
-Looks up a type by name, using the virtual function that
-#ClutterScript has for that purpose. This function should
-rarely be used.
+Whether the @layout should place its children on a grid.
-Since: 0.6
+Since: 1.16
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="layout">
+<parameter_description> a #ClutterFlowLayout
</parameter_description>
</parameter>
-<parameter name="type_name">
-<parameter_description> name of the type to look up
+<parameter name="snap_to_grid">
+<parameter_description> %TRUE if @layout should place its children on a grid
</parameter_description>
</parameter>
</parameters>
-<return> the type for the requested type name, or
-%G_TYPE_INVALID if not corresponding type was found.
-
-</return>
+<return></return>
</function>
-<function name="clutter_texture_get_base_size">
+<function name="clutter_frame_source_add">
<description>
-Gets the size in pixels of the untransformed underlying image
+Simple wrapper around clutter_frame_source_add_full().
+
+Since: 0.8
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="fps">
+<parameter_description> the number of times per second to call the function
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for the width, or %NULL
+<parameter name="func">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the height, or %NULL
+<parameter name="data">
+<parameter_description> data to pass to the function
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
<function name="clutter_frame_source_add_full">
@@ -11159,6 +21783,8 @@ multiple times to catch up missing frames if @func takes more than
Since: 0.8
+Deprecated: 1.6
+
</description>
<parameters>
<parameter name="priority">
@@ -11188,592 +21814,1780 @@ range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
</return>
</function>
-<function name="clutter_backend_get_resolution">
+<function name="clutter_gdk_disable_event_retrieval">
<description>
-Gets the resolution for font handling on the screen; see
-clutter_backend_set_resolution() for full details.
+Disable the event retrieval in Clutter.
-Since: 0.4
+Callers of this function have to set up an event filter using the
+GDK API, and call clutter_gdk_handle_event().
+
+This function should only be used when embedding Clutter into
+a GDK based toolkit.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_gdk_get_default_display">
+<description>
+Retrieves the pointer to the default display.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the default display
+
+</return>
+</function>
+
+<function name="clutter_gdk_get_stage_from_window">
+<description>
+Gets the stage for a particular X window.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the current resolution, or -1 if no resolution
-has been set.
+<return> A #ClutterStage, or% NULL if a stage
+does not exist for the window
</return>
</function>
-<function name="json_array_add_element">
+<function name="clutter_gdk_get_stage_window">
<description>
-Appends @node inside @array. The array will take ownership of the
-#JsonNode.
+Gets the stages GdkWindow.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> a #JsonNode
+</parameters>
+<return> A GdkWindow* for the stage window.
+
+</return>
+</function>
+
+<function name="clutter_gdk_handle_event">
+<description>
+This function processes a single GDK event; it can be used to hook
+into external event processing
+
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> #GdkFilterReturn. %GDK_FILTER_REMOVE indicates that
+Clutter has internally handled the event and the caller should do
+no further processing. %GDK_FILTER_CONTINUE indicates that Clutter
+is either not interested in the event, or has used the event to
+update internal state without taking any exclusive action.
+%GDK_FILTER_TRANSLATE will not occur.
+
+</return>
</function>
-<function name="clutter_script_lookup_filename">
+<function name="clutter_gdk_set_display">
<description>
-Looks up @filename inside the search paths of @script. If @filename
-is found, its full path will be returned .
+Sets the display connection Clutter should use; must be called
+before clutter_init(), clutter_init_with_args() or other functions
+pertaining Clutter's initialization process.
+
+If you are parsing the command line arguments by retrieving Clutter's
+#GOptionGroup with clutter_get_option_group() and calling
+g_option_context_parse() yourself, you should also call
+clutter_gdk_set_display() before g_option_context_parse().
Since: 0.8
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="display">
+<parameter_description> pointer to a GDK display connection.
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the name of the file to lookup
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_gdk_set_stage_foreign">
+<description>
+Target the #ClutterStage to use an existing external #GdkWindow
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> an existing #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the full path of @filename or %NULL if no path was
-found.
+<return> %TRUE if foreign window is valid
</return>
</function>
-<function name="clutter_container_foreach_with_internals">
+<function name="clutter_geometry_intersects">
<description>
-Calls @callback for each child of @container, including "internal"
-children built in to the container itself that were never added
-by the application.
+Determines if @geometry0 and geometry1 intersect returning %TRUE if
+they do else %FALSE.
-Since: 1.0
+Since: 1.4
+
+Deprecated: 1.16: Use #ClutterRect and clutter_rect_intersection()
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="geometry0">
+<parameter_description> The first geometry to test
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> a function to be called for each child
+<parameter name="geometry1">
+<parameter_description> The second geometry to test
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to be passed to the function, or %NULL
+</parameters>
+<return> %TRUE of @geometry0 and geometry1 intersect else
+%FALSE.
+
+</return>
+</function>
+
+<function name="clutter_geometry_union">
+<description>
+Find the union of two rectangles represented as #ClutterGeometry.
+
+Since: 1.4
+
+Deprecated: 1.16: Use #ClutterRect and clutter_rect_union()
+
+</description>
+<parameters>
+<parameter name="geometry_a">
+<parameter_description> a #ClutterGeometry
+</parameter_description>
+</parameter>
+<parameter name="geometry_b">
+<parameter_description> another #ClutterGeometry
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> location to store the result
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_get_valist">
+<function name="clutter_gesture_action_cancel">
<description>
-See clutter_model_iter_get(). This version takes a va_list for language
-bindings.
+Cancel a #ClutterGestureAction before it begins
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
-<parameter name="args">
-<parameter_description> a list of column/return location pairs, terminated by -1
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_gesture_action_get_device">
+<description>
+Retrieves the #ClutterInputDevice of a touch point.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #ClutterInputDevice of a touch point.
+
+</return>
</function>
-<function name="clutter_container_add">
+<function name="clutter_gesture_action_get_last_event">
<description>
-Adds a list of #ClutterActor<!-- -->s to @container. Each time and
-actor is added, the "actor-added" signal is emitted. Each actor should
-be parented to @container, which takes a reference on the actor. You
-cannot add a #ClutterActor to more than one #ClutterContainer.
+Retrieves a reference to the last #ClutterEvent for a touch point. Call
+clutter_event_copy() if you need to store the reference somewhere.
-Since: 0.4
+Since: 1.14
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
-<parameter name="first_actor">
-<parameter_description> the first #ClutterActor to add
+<parameter name="point">
+<parameter_description> index of a point currently active
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> %NULL terminated list of actors to add
+</parameters>
+<return> the last #ClutterEvent for a touch point.
+
+</return>
+</function>
+
+<function name="clutter_gesture_action_get_motion_coords">
+<description>
+Retrieves the coordinates, in stage space, of the latest motion
+event during the dragging.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
+</parameter_description>
+</parameter>
+<parameter name="motion_x">
+<parameter_description> return location for the latest motion
+event's X coordinate
+</parameter_description>
+</parameter>
+<parameter name="motion_y">
+<parameter_description> return location for the latest motion
+event's Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_get_length">
+<function name="clutter_gesture_action_get_motion_delta">
<description>
-Retrieves an approximation of the total length of the path.
+Retrieves the incremental delta since the last motion event
+during the dragging.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
+</parameter_description>
+</parameter>
+<parameter name="delta_x">
+<parameter_description> return location for the X axis
+component of the incremental motion delta
+</parameter_description>
+</parameter>
+<parameter name="delta_y">
+<parameter_description> return location for the Y axis
+component of the incremental motion delta
</parameter_description>
</parameter>
</parameters>
-<return> the length of the path.
+<return> the distance since last motion event
</return>
</function>
-<function name="clutter_text_get_line_wrap">
+<function name="clutter_gesture_action_get_n_current_points">
<description>
-Retrieves the value set using clutter_text_set_line_wrap().
+Retrieves the number of points currently active.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterText actor should wrap
-its contents
+<return> the number of points currently active.
</return>
</function>
-<function name="clutter_animation_set_object">
+<function name="clutter_gesture_action_get_n_touch_points">
<description>
-Attaches @animation to @object. The #ClutterAnimation will take a
-reference on @object.
+Retrieves the number of requested points to trigger the gesture.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+</parameters>
+<return> the number of points to trigger the gesture.
+
+</return>
+</function>
+
+<function name="clutter_gesture_action_get_press_coords">
+<description>
+Retrieves the coordinates, in stage space, of the press event
+that started the dragging for a specific touch point.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
+</parameter_description>
+</parameter>
+<parameter name="press_x">
+<parameter_description> return location for the press
+event's X coordinate
+</parameter_description>
+</parameter>
+<parameter name="press_y">
+<parameter_description> return location for the press
+event's Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_set_array">
+<function name="clutter_gesture_action_get_release_coords">
<description>
-Sets @array inside @node and increases the #JsonArray reference count
+Retrieves the coordinates, in stage space, where the touch point was
+last released.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
</parameter_description>
</parameter>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="release_x">
+<parameter_description> return location for the X coordinate of
+the last release
+</parameter_description>
+</parameter>
+<parameter name="release_y">
+<parameter_description> return location for the Y coordinate of
+the last release
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_get_height">
+<function name="clutter_gesture_action_get_sequence">
<description>
-Retrieves the height of the @box
+Retrieves the #ClutterEventSequence of a touch point.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> index of a point currently active
</parameter_description>
</parameter>
</parameters>
-<return> the height of the box
+<return> the #ClutterEventSequence of a touch point.
</return>
</function>
-<function name="json_object_set_object_member">
+<function name="clutter_gesture_action_get_threshold_trigger_distance">
<description>
-Convenience function for setting an object @value of
- member_name inside @object.
+Retrieves the threshold trigger distance of the gesture @action,
+as set using clutter_gesture_action_set_threshold_trigger_distance().
-The @object will take ownership of the passed #JsonObject
-
-See also: json_object_set_member()
-
-Since: 0.8
+Since: 1.18
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="x">
+<parameter_description> The return location for the horizontal distance, or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+<parameter name="y">
+<parameter_description> The return location for the vertical distance, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_get_loop">
+<function name="clutter_gesture_action_get_threshold_trigger_egde">
<description>
-Gets whether @score is looping
+Retrieves the edge trigger of the gesture @action, as set using
+clutter_gesture_action_set_threshold_trigger_edge().
-Since: 0.6
+Since: 1.18
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the score is looping
+<return> the edge trigger
</return>
</function>
-<function name="clutter_backend_get_double_click_time">
+<function name="clutter_gesture_action_get_velocity">
<description>
-Gets the maximum time between two button press events, as set
-by clutter_backend_set_double_click_time().
+Retrieves the velocity, in stage pixels per millisecond, of the
+latest motion event during the dragging.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
+</parameter_description>
+</parameter>
+<parameter name="velocity_x">
+<parameter_description> return location for the latest motion
+event's X velocity
+</parameter_description>
+</parameter>
+<parameter name="velocity_y">
+<parameter_description> return location for the latest motion
+event's Y velocity
</parameter_description>
</parameter>
</parameters>
-<return> a time in milliseconds
+<return></return>
+</function>
+
+<function name="clutter_gesture_action_new">
+<description>
+Creates a new #ClutterGestureAction instance.
+
+Since: 1.8
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterGestureAction
</return>
</function>
-<function name="json_node_take_array">
+<function name="clutter_gesture_action_set_n_touch_points">
<description>
-Sets @array into @node without increasing the #JsonArray reference count.
+Sets the number of points needed to trigger the gesture.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
</parameter_description>
</parameter>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="nb_points">
+<parameter_description> a number of points
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_cursor_position">
+<function name="clutter_gesture_action_set_threshold_trigger_distance">
<description>
-Retrieves the cursor position.
+Sets the threshold trigger distance for the gesture drag threshold, if any.
-Since: 1.0
+This function should only be called by sub-classes of
+#ClutterGestureAction during their construction phase.
+
+Since: 1.18
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the distance on the horizontal axis
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the distance on the vertical axis
</parameter_description>
</parameter>
</parameters>
-<return> the cursor position, in characters
+<return></return>
+</function>
+
+<function name="clutter_gesture_action_set_threshold_trigger_edge">
+<description>
+Sets the edge trigger for the gesture drag threshold, if any.
+
+This function should only be called by sub-classes of
+#ClutterGestureAction during their construction phase.
+
+Since: 1.18
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterGestureAction
+</parameter_description>
+</parameter>
+<parameter name="edge">
+<parameter_description> the %ClutterGestureTriggerEdge
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_get_accessibility_enabled">
+<description>
+Returns whether Clutter has accessibility support enabled. As
+least, a value of TRUE means that there are a proper AtkUtil
+implementation available
+
+Since: 1.4
+
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if Clutter has accessibility support enabled
</return>
</function>
-<function name="clutter_container_find_child_by_name">
+<function name="clutter_get_actor_by_gid">
<description>
-Finds a child actor of a container by its name. Search recurses
-into any child container.
+Retrieves the #ClutterActor with @id_.
Since: 0.6
+Deprecated: 1.8: The id is not used any longer.
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="id_">
+<parameter_description> a #ClutterActor unique id.
</parameter_description>
</parameter>
-<parameter name="child_name">
-<parameter_description> the name of the requested child.
+</parameters>
+<return> the actor with the passed id or %NULL.
+The returned actor does not have its reference count increased.
+
+</return>
+</function>
+
+<function name="clutter_get_current_event">
+<description>
+If an event is currently being processed, return that event.
+This function is intended to be used to access event state
+that might not be exposed by higher-level widgets. For
+example, to get the key modifier state from a Button 'clicked'
+event.
+
+Since: 1.2
+
+</description>
+<parameters>
+</parameters>
+<return> The current ClutterEvent, or %NULL if none
+
+</return>
+</function>
+
+<function name="clutter_get_current_event_time">
+<description>
+Retrieves the timestamp of the last event, if there is an
+event or if the event has a timestamp.
+
+Since: 1.0
+
+</description>
+<parameters>
+</parameters>
+<return> the event timestamp, or %CLUTTER_CURRENT_TIME
+
+</return>
+</function>
+
+<function name="clutter_get_debug_enabled">
+<description>
+Check if Clutter has debugging enabled.
+
+Deprecated: 1.10: This function does not do anything.
+
+</description>
+<parameters>
+</parameters>
+<return> %FALSE
+
+</return>
+</function>
+
+<function name="clutter_get_default_backend">
+<description>
+Retrieves the default #ClutterBackend used by Clutter. The
+#ClutterBackend holds backend-specific configuration options.
+
+Since: 0.4
+
+</description>
+<parameters>
+</parameters>
+<return> the default backend. You should
+not ref or unref the returned object. Applications should rarely
+need to use this.
+
+</return>
+</function>
+
+<function name="clutter_get_default_frame_rate">
+<description>
+Retrieves the default frame rate. See clutter_set_default_frame_rate().
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the default frame rate
+
+</return>
+</function>
+
+<function name="clutter_get_default_text_direction">
+<description>
+Retrieves the default direction for the text. The text direction is
+determined by the locale and/or by the <varname>CLUTTER_TEXT_DIRECTION</varname>
+environment variable.
+
+The default text direction can be overridden on a per-actor basis by using
+clutter_actor_set_text_direction().
+
+Since: 1.2
+
+</description>
+<parameters>
+</parameters>
+<return> the default text direction
+
+</return>
+</function>
+
+<function name="clutter_get_font_flags">
+<description>
+Gets the current font flags for rendering text. See
+clutter_set_font_flags().
+
+Since: 1.0
+
+Deprecated: 1.10: Use clutter_backend_get_font_options() and the
+#cairo_font_options_t API.
+
+</description>
+<parameters>
+</parameters>
+<return> The font flags
+
+</return>
+</function>
+
+<function name="clutter_get_font_map">
+<description>
+Retrieves the #PangoFontMap instance used by Clutter.
+You can use the global font map object with the COGL
+Pango API.
+
+Since: 1.0
+
+</description>
+<parameters>
+</parameters>
+<return> the #PangoFontMap instance. The returned
+value is owned by Clutter and it should never be unreferenced.
+
+</return>
+</function>
+
+<function name="clutter_get_input_device_for_id">
+<description>
+Retrieves the #ClutterInputDevice from its @id_. This is a convenience
+wrapper for clutter_device_manager_get_device() and it is functionally
+equivalent to:
+
+|[
+ClutterDeviceManager *manager;
+ClutterInputDevice *device;
+
+manager = clutter_device_manager_get_default ();
+device = clutter_device_manager_get_device (manager, id);
+]|
+
+Since: 0.8
+
+Deprecated: 1.10: Use clutter_device_manager_get_device() instead.
+
+</description>
+<parameters>
+<parameter name="id_">
+<parameter_description> the unique id for a device
</parameter_description>
</parameter>
</parameters>
-<return> The child actor with the requested name,
-or %NULL if no actor with that name was found.
+<return> a #ClutterInputDevice, or %NULL
</return>
</function>
-<function name="clutter_model_iter_get_model">
+<function name="clutter_get_keyboard_grab">
<description>
-Retrieves a pointer to the #ClutterModel that this iter is part of.
+Queries the current keyboard grab of clutter.
Since: 0.6
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+</parameters>
+<return> the actor currently holding the keyboard grab, or NULL if there is no grab.
+
+</return>
+</function>
+
+<function name="clutter_get_motion_events_enabled">
+<description>
+Gets whether the per-actor motion events are enabled.
+
+Since: 0.6
+
+Deprecated: 1.8: Use clutter_stage_get_motion_events_enabled() instead.
+
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if the motion events are enabled
+
+</return>
+</function>
+
+<function name="clutter_get_option_group">
+<description>
+Returns a #GOptionGroup for the command line arguments recognized
+by Clutter. You should add this group to your #GOptionContext with
+g_option_context_add_group(), if you are using g_option_context_parse()
+to parse your commandline arguments.
+
+Calling g_option_context_parse() with Clutter's #GOptionGroup will result
+in Clutter's initialization. That is, the following code:
+
+|[
+g_option_context_set_main_group (context, clutter_get_option_group ());
+res = g_option_context_parse (context, &argc, &argc, NULL);
+]|
+
+is functionally equivalent to:
+
+|[
+clutter_init (&argc, &argv);
+]|
+
+After g_option_context_parse() on a #GOptionContext containing the
+Clutter #GOptionGroup has returned %TRUE, Clutter is guaranteed to be
+initialized.
+
+Since: 0.2
+
+</description>
+<parameters>
+</parameters>
+<return> a #GOptionGroup for the commandline arguments
+recognized by Clutter
+
+</return>
+</function>
+
+<function name="clutter_get_option_group_without_init">
+<description>
+Returns a #GOptionGroup for the command line arguments recognized
+by Clutter. You should add this group to your #GOptionContext with
+g_option_context_add_group(), if you are using g_option_context_parse()
+to parse your commandline arguments.
+
+Unlike clutter_get_option_group(), calling g_option_context_parse() with
+the #GOptionGroup returned by this function requires a subsequent explicit
+call to clutter_init(); use this function when needing to set foreign
+display connection with clutter_x11_set_display(), or with
+<function>gtk_clutter_init()</function>.
+
+Since: 0.8.2
+
+</description>
+<parameters>
+</parameters>
+<return> a #GOptionGroup for the commandline arguments
+recognized by Clutter
+
+</return>
+</function>
+
+<function name="clutter_get_pointer_grab">
+<description>
+Queries the current pointer grab of clutter.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the actor currently holding the pointer grab, or NULL if there is no grab.
+
+</return>
+</function>
+
+<function name="clutter_get_script_id">
+<description>
+Retrieves the Clutter script id, if any.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="gobject">
+<parameter_description> a #GObject
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a #ClutterModel.
+<return> the script id, or %NULL if @object was not defined inside
+a UI definition file. The returned string is owned by the object and
+should never be modified or freed.
+
+</return>
+</function>
+
+<function name="clutter_get_show_fps">
+<description>
+Returns whether Clutter should print out the frames per second on the
+console. You can enable this setting either using the
+<literal>CLUTTER_SHOW_FPS</literal> environment variable or passing
+the <literal>--clutter-show-fps</literal> command line argument. *
+
+Since: 0.4
+
+Deprecated: 1.10: This function does not do anything. Use the environment
+variable or the configuration file to determine whether Clutter should
+print out the FPS counter on the console.
+
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if Clutter should show the FPS.
+
+</return>
+</function>
+
+<function name="clutter_get_timestamp">
+<description>
+Returns the approximate number of microseconds passed since Clutter was
+intialised.
+
+This function shdould not be used by application code.
+
+The output of this function depends on whether Clutter was configured to
+enable its debugging code paths, so it's less useful than intended.
+
+Since Clutter 1.10, this function is an alias to g_get_monotonic_time()
+if Clutter was configured to enable the debugging code paths.
+
+Deprecated: 1.10: Use #GTimer or g_get_monotonic_time() for a proper
+timing source
+
+</description>
+<parameters>
+</parameters>
+<return> Number of microseconds since clutter_init() was called, or
+zero if Clutter was not configured with debugging code paths.
</return>
</function>
-<function name="json_array_add_string_element">
+<function name="clutter_glx_texture_pixmap_new">
<description>
-Conveniently adds a string @value into @array
+Creates a new, empty #ClutterGLXTexturePixmap
+
+Since: 0.8
+
+Deprecated: 1.6: Use clutter_x11_texture_pixmap_new() instead
+
+</description>
+<parameters>
+</parameters>
+<return> A new #ClutterGLXTexturePixmap
-See also: json_array_add_element(), json_node_set_string()
+</return>
+</function>
+
+<function name="clutter_glx_texture_pixmap_new_with_pixmap">
+<description>
+Creates a new #ClutterGLXTexturePixmap for @pixmap
Since: 0.8
+Deprecated: 1.6: Use clutter_x11_texture_pixmap_new_with_pixmap() instead
+
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="pixmap">
+<parameter_description> the X Pixmap to which this texture should be bound
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a string value
+</parameters>
+<return> A new #ClutterGLXTexturePixmap bound to the given X Pixmap
+
+</return>
+</function>
+
+<function name="clutter_glx_texture_pixmap_new_with_window">
+<description>
+Creates a new #ClutterGLXTexturePixmap for @window
+
+Since: 0.8
+
+Deprecated: 1.6: Use clutter_x11_texture_pixmap_new_with_window() instead
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> the X window to which this texture should be bound
+</parameter_description>
+</parameter>
+</parameters>
+<return> A new #ClutterGLXTexturePixmap bound to the given X window
+
+</return>
+</function>
+
+<function name="clutter_glx_texture_pixmap_using_extension">
+<description>
+Checks whether @texture is using the GLX_EXT_texture_from_pixmap
+extension; this extension can be optionally (though it is strongly
+encouraged) implemented as a zero-copy between a GLX pixmap and
+a GL texture.
+
+Deprecated: 1.6: Use cogl_texture_pixmap_x11_is_using_tfp_extension()
+on the texture handle instead.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> A #ClutterGLXTexturePixmap
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the texture is using the
+GLX_EXT_texture_from_pixmap OpenGL extension or falling back to the
+slower software mechanism.
+
+</return>
+</function>
+
+<function name="clutter_grab_keyboard">
+<description>
+Grabs keyboard events, after the grab is done keyboard
+events (#ClutterActor::key-press-event and #ClutterActor::key-release-event)
+are delivered to this actor directly. The source set in the event will be
+the actor that would have received the event if the keyboard grab was not
+in effect.
+
+Like pointer grabs, keyboard grabs should only be used as a last
+resource.
+
+See also clutter_stage_set_key_focus() and clutter_actor_grab_key_focus()
+to perform a "soft" key grab and assign key focus to a specific actor.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_update_interval">
+<function name="clutter_grab_pointer">
<description>
-Changes the @interval for @property_name. The #ClutterAnimation
-will take ownership of the passed #ClutterInterval.
+Grabs pointer events, after the grab is done all pointer related events
+(press, motion, release, enter, leave and scroll) are delivered to this
+actor directly without passing through both capture and bubble phases of
+the event delivery chain. The source set in the event will be the actor
+that would have received the event if the pointer grab was not in effect.
-Since: 1.0
+<note><para>Grabs completely override the entire event delivery chain
+done by Clutter. Pointer grabs should only be used as a last resource;
+using the #ClutterActor::captured-event signal should always be the
+preferred way to intercept event delivery to reactive actors.</para></note>
+
+This function should rarely be used.
+
+If a grab is required, you are strongly encouraged to use a specific
+input device by calling clutter_input_device_grab().
+
+Since: 0.6
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> name of the property
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grab_pointer_for_device">
+<description>
+Grabs all the pointer events coming from the device @id for @actor.
+
+If @id is -1 then this function is equivalent to clutter_grab_pointer().
+
+Since: 0.8
+
+Deprecated: 1.10: Use clutter_input_device_grab() instead.
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="id_">
+<parameter_description> a device id, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_set_font_name">
+<function name="clutter_grid_layout_attach">
<description>
-Sets the font used by a #ClutterText. The @font_name string
-must either be %NULL, which means that the font name from the
-default #ClutterBackend will be used; or be something that can
-be parsed by the pango_font_description_from_string() function,
-like:
+Adds a widget to the grid.
-|[
-clutter_text_set_font_name (text, "Sans 10pt");
-clutter_text_set_font_name (text, "Serif 16px");
-clutter_text_set_font_name (text, "Helvetica 10");
-]|
+The position of @child is determined by @left and @top. The
+number of 'cells' that @child will occupy is determined by
+ width and @height.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
</parameter_description>
</parameter>
-<parameter name="font_name">
-<parameter_description> a font name, or %NULL to set the default font name
+<parameter name="child">
+<parameter_description> the #ClutterActor to add
+</parameter_description>
+</parameter>
+<parameter name="left">
+<parameter_description> the column number to attach the left side of @child to
+</parameter_description>
+</parameter>
+<parameter name="top">
+<parameter_description> the row number to attach the top side of @child to
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the number of columns that @child will span
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the number of rows that @child will span
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_scale_center">
+<function name="clutter_grid_layout_attach_next_to">
<description>
-Retrieves the scale center coordinate in pixels relative to the top
-left corner of the actor. If the scale center was specified using a
-#ClutterGravity this will calculate the pixel offset using the
-current size of the actor.
+Adds a actor to the grid.
-Since: 1.0
+The actor is placed next to @sibling, on the side determined by
+ side When @sibling is %NULL, the actor is placed in row (for
+left or right placement) or column 0 (for top or bottom placement),
+at the end indicated by @side.
+
+Attaching widgets labeled [1], [2], [3] with @sibling == %NULL and
+ side == %CLUTTER_GRID_POSITION_LEFT yields a layout of [3][2][1].
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
</parameter_description>
</parameter>
-<parameter name="center_x">
-<parameter_description> Location to store the X position
-of the scale center, or %NULL.
+<parameter name="child">
+<parameter_description> the actor to add
</parameter_description>
</parameter>
-<parameter name="center_y">
-<parameter_description> Location to store the Y position
-of the scale center, or %NULL.
+<parameter name="sibling">
+<parameter_description> the child of @layout that @child will be placed
+next to, or %NULL to place @child at the beginning or end
+</parameter_description>
+</parameter>
+<parameter name="side">
+<parameter_description> the side of @sibling that @child is positioned next to
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the number of columns that @child will span
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the number of rows that @child will span
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_get_object">
+<function name="clutter_grid_layout_get_child_at">
<description>
-Retrieves the #JsonObject stored inside a #JsonNode
+Gets the child of @layout whose area covers the grid
+cell whose upper left corner is at @left, @top.
+Since: 1.12
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="left">
+<parameter_description> the left edge of the cell
+</parameter_description>
+</parameter>
+<parameter name="top">
+<parameter_description> the top edge of the cell
</parameter_description>
</parameter>
</parameters>
-<return> the #JsonObject
+<return> the child at the given position, or %NULL
+
</return>
</function>
-<function name="clutter_model_get_n_rows">
+<function name="clutter_grid_layout_get_column_homogeneous">
<description>
-Retrieves the number of rows inside @model, eventually taking
-into account any filtering function set using clutter_model_set_filter().
+Returns whether all columns of @layout have the same width.
-Since: 0.6
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
</parameter_description>
</parameter>
</parameters>
-<return> The length of the @model. If there is a filter set, then
-the length of the filtered @model is returned.
+<return> whether all columns of @layout have the same width.
+</return>
+</function>
+
+<function name="clutter_grid_layout_get_column_spacing">
+<description>
+Retrieves the spacing set using clutter_grid_layout_set_column_spacing()
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the spacing between coluns of @layout
</return>
</function>
-<function name="clutter_text_set_justify">
+<function name="clutter_grid_layout_get_orientation">
<description>
-Sets whether the text of the #ClutterText actor should be justified
-on both margins. This setting is ignored if Clutter is compiled
-against Pango < 1.18.
+Retrieves the orientation of the @layout.
-Since: 1.0
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the orientation of the layout
+
+</return>
+</function>
+
+<function name="clutter_grid_layout_get_row_homogeneous">
+<description>
+Returns whether all rows of @layout have the same height.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether all rows of @layout have the same height.
+
+</return>
+</function>
+
+<function name="clutter_grid_layout_get_row_spacing">
+<description>
+Retrieves the spacing set using clutter_grid_layout_set_row_spacing()
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the spacing between rows of @layout
+
+</return>
+</function>
+
+<function name="clutter_grid_layout_insert_column">
+<description>
+Inserts a column at the specified position.
+
+Children which are attached at or to the right of this position
+are moved one column to the right. Children which span across this
+position are grown to span the new column.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position to insert the column at
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_insert_next_to">
+<description>
+Inserts a row or column at the specified position.
+
+The new row or column is placed next to @sibling, on the side
+determined by @side. If @side is %CLUTTER_GRID_POSITION_LEFT or
+%CLUTTER_GRID_POSITION_BOTTOM, a row is inserted. If @side is
+%CLUTTER_GRID_POSITION_LEFT of %CLUTTER_GRID_POSITION_RIGHT,
+a column is inserted.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> the child of @layout that the new row or column will be
+placed next to
+</parameter_description>
+</parameter>
+<parameter name="side">
+<parameter_description> the side of @sibling that @child is positioned next to
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_insert_row">
+<description>
+Inserts a row at the specified position.
+
+Children which are attached at or below this position
+are moved one row down. Children which span across this
+position are grown to span the new row.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position to insert the row at
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_new">
+<description>
+Creates a new #ClutterGridLayout
+
+
+</description>
+<parameters>
+</parameters>
+<return> the new #ClutterGridLayout
+</return>
+</function>
+
+<function name="clutter_grid_layout_set_column_homogeneous">
+<description>
+Sets whether all columns of @layout will have the same width.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="homogeneous">
+<parameter_description> %TRUE to make columns homogeneous
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_set_column_spacing">
+<description>
+Sets the spacing between columns of @layout
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the spacing between columns of the layout, in pixels
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_set_orientation">
+<description>
+Sets the orientation of the @layout
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation of the #ClutterGridLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_set_row_homogeneous">
+<description>
+Sets whether all rows of @layout will have the same height.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="homogeneous">
+<parameter_description> %TRUE to make rows homogeneous
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_grid_layout_set_row_spacing">
+<description>
+Sets the spacing between rows of @layout
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterGridLayout
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the spacing between rows of the layout, in pixels
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_group_get_n_children">
+<description>
+Gets the number of actors held in the group.
+
+Since: 0.2
+
+Deprecated: 1.10: Use clutter_actor_get_n_children() instead.
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter_description> A #ClutterGroup
</parameter_description>
</parameter>
-<parameter name="justify">
-<parameter_description> whether the text should be justified
+</parameters>
+<return> The number of child actors held in the group.
+
+</return>
+</function>
+
+<function name="clutter_group_get_nth_child">
+<description>
+Gets a groups child held at @index_ in stack.
+
+Since: 0.2
+
+Deprecated: 1.10: Use clutter_actor_get_child_at_index() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterGroup
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the position of the requested actor.
+</parameter_description>
+</parameter>
+</parameters>
+<return> A Clutter actor, or %NULL if
+ index_ is invalid.
+
+</return>
+</function>
+
+<function name="clutter_group_new">
+<description>
+Create a new #ClutterGroup.
+
+Deprecated: 1.10: Use clutter_actor_new() instead.
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterGroup actor
+
+</return>
+</function>
+
+<function name="clutter_group_remove_all">
+<description>
+Removes all children actors from the #ClutterGroup.
+
+Deprecated: 1.10: Use clutter_actor_remove_all_children() instead.
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterGroup
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_set_area_from_rgb_data">
+<function name="clutter_image_get_texture">
<description>
-Updates a sub-region of the pixel data in a #ClutterTexture.
+Retrieves a pointer to the Cogl texture used by @image.
-Since: 0.6
+If you change the contents of the returned Cogl texture you will need
+to manually invalidate the @image with clutter_content_invalidate()
+in order to update the actors using @image as their content.
+
+Since: 1.10
+Stability: unstable
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="image">
+<parameter_description> a #ClutterImage
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the Cogl texture, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_image_new">
+<description>
+Creates a new #ClutterImage instance.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterImage instance.
+Use g_object_unref() when done.
+
+</return>
+</function>
+
+<function name="clutter_image_set_area">
+<description>
+Sets the image data to be display by @image, using @rect to indicate
+the position and size of the image data to be set.
+
+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
+height of the rectangle, i.e. calling this function on a newly created
+#ClutterImage will be the equivalent of calling clutter_image_set_data().
+
+If the image data was successfully loaded, the @image will be invalidated.
+
+In case of error, the @error value will be set, and this function will
+return %FALSE.
+
+The image data is copied in texture memory.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="image">
+<parameter_description> a #ClutterImage
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> Image data in RGB type colorspace.
+<parameter_description> the image data, as an array of bytes
</parameter_description>
</parameter>
-<parameter name="has_alpha">
-<parameter_description> Set to TRUE if image data has an alpha channel.
+<parameter name="pixel_format">
+<parameter_description> the Cogl pixel format of the image data
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate of upper left corner of region to update.
+<parameter name="rect">
+<parameter_description> a rectangle indicating the area that should be set
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate of upper left corner of region to update.
+<parameter name="row_stride">
+<parameter_description> the length of each row inside @data
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the image data was successfully loaded,
+and %FALSE otherwise.
+
+</return>
+</function>
+
+<function name="clutter_image_set_bytes">
+<description>
+Sets the image data stored inside a #GBytes to be displayed by @image.
+
+If the image data was successfully loaded, the @image will be invalidated.
+
+In case of error, the @error value will be set, and this function will
+return %FALSE.
+
+The image data contained inside the #GBytes is copied in texture memory,
+and no additional reference is acquired on the @data.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="image">
+<parameter_description> a #ClutterImage
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the image data, as a #GBytes
+</parameter_description>
+</parameter>
+<parameter name="pixel_format">
+<parameter_description> the Cogl pixel format of the image data
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> Width in pixels of region to update.
+<parameter_description> the width of the image data
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> Height in pixels of region to update.
+<parameter_description> the height of the image data
</parameter_description>
</parameter>
-<parameter name="rowstride">
-<parameter_description> Distance in bytes between row starts on source buffer.
+<parameter name="row_stride">
+<parameter_description> the length of each row inside @data
</parameter_description>
</parameter>
-<parameter name="bpp">
-<parameter_description> bytes per pixel (Currently only 3 and 4 supported,
-depending on @has_alpha)
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> #ClutterTextureFlags
+</parameters>
+<return> %TRUE if the image data was successfully loaded,
+and %FALSE otherwise.
+
+</return>
+</function>
+
+<function name="clutter_image_set_data">
+<description>
+Sets the image data to be displayed by @image.
+
+If the image data was successfully loaded, the @image will be invalidated.
+
+In case of error, the @error value will be set, and this function will
+return %FALSE.
+
+The image data is copied in texture memory.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="image">
+<parameter_description> a #ClutterImage
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> the image data, as an array of bytes
+</parameter_description>
+</parameter>
+<parameter name="pixel_format">
+<parameter_description> the Cogl pixel format of the image data
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the image data
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the image data
+</parameter_description>
+</parameter>
+<parameter name="row_stride">
+<parameter_description> the length of each row inside @data
</parameter_description>
</parameter>
<parameter name="error">
@@ -11781,679 +23595,1681 @@ depending on @has_alpha)
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE on failure.
+<return> %TRUE if the image data was successfully loaded,
+and %FALSE otherwise.
</return>
</function>
-<function name="clutter_shader_get_cogl_fragment_shader">
+<function name="clutter_init">
<description>
-Retrieves the underlying #CoglHandle for the fragment shader.
+Initialises everything needed to operate with Clutter and parses some
+standard command line options; @argc and @argv are adjusted accordingly
+so your own code will never see those standard arguments.
+
+It is safe to call this function multiple times.
+
+<note>This function will not abort in case of errors during
+initialization; clutter_init() will print out the error message on
+stderr, and will return an error code. It is up to the application
+code to handle this case. If you need to display the error message
+yourself, you can use clutter_init_with_args(), which takes a #GError
+pointer.</note>
+
+If this function fails, and returns an error code, any subsequent
+Clutter API will have undefined behaviour - including segmentation
+faults and assertion failures. Make sure to handle the returned
+#ClutterInitError enumeration value.
-Since: 1.0
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="argc">
+<parameter_description> The number of arguments in @argv
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> A pointer to an array
+of arguments.
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterInitError value
+</return>
+</function>
+
+<function name="clutter_init_with_args">
+<description>
+This function does the same work as clutter_init(). Additionally,
+it allows you to add your own command line options, and it
+automatically generates nicely formatted <option>--help</option>
+output. Note that your program will be terminated after writing
+out the help output. Also note that, in case of error, the
+error message will be placed inside @error instead of being
+printed on the display.
+
+Just like clutter_init(), if this function returns an error code then
+any subsequent call to any other Clutter API will result in undefined
+behaviour - including segmentation faults.
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="argc">
+<parameter_description> a pointer to the number of command line arguments
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> a pointer to the array
+of command line arguments
+</parameter_description>
+</parameter>
+<parameter name="parameter_string">
+<parameter_description> a string which is displayed in the
+first line of <option>--help</option> output, after
+<literal><replaceable>programname</replaceable> [OPTION...]</literal>
+</parameter_description>
+</parameter>
+<parameter name="entries">
+<parameter_description> a %NULL terminated array of
+#GOptionEntry<!-- -->s describing the options of your program
+</parameter_description>
+</parameter>
+<parameter name="translation_domain">
+<parameter_description> a translation domain to use for
+translating the <option>--help</option> output for the options in
+ entries with gettext(), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return> A #CoglHandle for the fragment shader, or %NULL
+<return> %CLUTTER_INIT_SUCCESS if Clutter has been successfully
+initialised, or other values or #ClutterInitError in case of
+error.
</return>
</function>
-<function name="clutter_stage_manager_get_default_stage">
+<function name="clutter_input_device_get_associated_device">
<description>
-Returns the default #ClutterStage.
+Retrieves a pointer to the #ClutterInputDevice that has been
+associated to @device.
-Since: 0.8
+If the #ClutterInputDevice:device-mode property of @device is
+set to %CLUTTER_INPUT_MODE_MASTER, this function will return
+%NULL.
+
+Since: 1.6
</description>
<parameters>
-<parameter name="stage_manager">
-<parameter_description> a #ClutterStageManager
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return> the default stage. The returned object
-is owned by Clutter and you should never reference or unreference it
+<return> a #ClutterInputDevice, or %NULL
</return>
</function>
-<function name="clutter_score_append_at_marker">
+<function name="clutter_input_device_get_axis">
<description>
-Appends @timeline at the given @marker_name on the @parent
-#ClutterTimeline.
+Retrieves the type of axis on @device at the given index.
-If you want to append @timeline at the end of @parent, use
-clutter_score_append().
+Since: 1.6
-The #ClutterScore will take a reference on @timeline.
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the axis
+</parameter_description>
+</parameter>
+</parameters>
+<return> the axis type
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_input_device_get_axis_value">
+<description>
+Extracts the value of the given @axis of a #ClutterInputDevice from
+an array of axis values.
+
+An example of typical usage for this function is:
+
+|[
+ClutterInputDevice *device = clutter_event_get_device (event);
+gdouble *axes = clutter_event_get_axes (event, NULL);
+gdouble pressure_value = 0;
+
+clutter_input_device_get_axis_value (device, axes,
+CLUTTER_INPUT_AXIS_PRESSURE,
+&pressure_value);
+]|
+
+Since: 1.6
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> the parent #ClutterTimeline
+<parameter name="axes">
+<parameter_description> an array of axes values, typically
+coming from clutter_event_get_axes()
</parameter_description>
</parameter>
-<parameter name="marker_name">
-<parameter_description> the name of the marker to use
+<parameter name="axis">
+<parameter_description> the axis to extract
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> the #ClutterTimeline to append
+<parameter name="value">
+<parameter_description> return location for the axis value
</parameter_description>
</parameter>
</parameters>
-<return> the id of the #ClutterTimeline inside the score, or
-0 on failure. The returned id can be used with clutter_score_remove()
-or clutter_score_get_timeline().
+<return> %TRUE if the value was set, and %FALSE otherwise
</return>
</function>
-<function name="clutter_actor_move_anchor_point_from_gravity">
+<function name="clutter_input_device_get_coords">
<description>
-Sets an anchor point on the actor based on the given gravity, adjusting the
-actor postion so that its relative position within its parent remains
-unchanged.
+Retrieves the latest coordinates of a pointer or touch point of
+ device
-Since version 1.0 the anchor point will be stored as a gravity so
-that if the actor changes size then the anchor point will move. For
-example, if you set the anchor point to %CLUTTER_GRAVITY_SOUTH_EAST
-and later double the size of the actor, the anchor point will move
-to the bottom right.
+Since: 1.12
-Since: 0.6
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="sequence">
+<parameter_description> a #ClutterEventSequence, or %NULL if
+the device is not touch-based
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> return location for the pointer
+or touch point
+</parameter_description>
+</parameter>
+</parameters>
+<return> %FALSE if the device's sequence hasn't been found,
+and %TRUE otherwise.
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_device_coords">
+<description>
+Retrieves the latest coordinates of the pointer of @device
+
+Since: 1.2
+
+Deprecated: 1.12: Use clutter_input_device_get_coords() instead.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
</parameter_description>
</parameter>
-<parameter name="gravity">
-<parameter_description> #ClutterGravity.
+<parameter name="x">
+<parameter_description> return location for the X coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for the Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_depth">
+<function name="clutter_input_device_get_device_id">
<description>
-Sets the Z coordinate of @self to @depth.
+Retrieves the unique identifier of @device
-The unit used by @depth is dependant on the perspective setup. See
-also clutter_stage_set_perspective().
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> Z co-ord
+</parameters>
+<return> the identifier of the device
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_device_mode">
+<description>
+Retrieves the #ClutterInputMode of @device.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the device mode
+
+</return>
</function>
-<function name="clutter_stage_set_fullscreen">
+<function name="clutter_input_device_get_device_name">
<description>
-Asks to place the stage window in the fullscreen or unfullscreen
-states.
+Retrieves the name of the @device
- ( Note that you shouldn't assume the window is definitely full screen
-afterward, because other entities (e.g. the user or window manager)
-could unfullscreen it again, and not all window managers honor
-requests to fullscreen windows.
+Since: 1.2
-If you want to receive notification of the fullscreen state you
-should either use the #ClutterStage::fullscreen and
-#ClutterStage::unfullscreen signals, or use the notify signal
-for the #ClutterStage:fullscreen-set property
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the device, or %NULL. The returned string
+is owned by the #ClutterInputDevice and should never be modified
+or freed
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_device_type">
+<description>
+Retrieves the type of @device
Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="fullscreen">
-<parameter_description> %TRUE to to set the stage fullscreen
+</parameters>
+<return> the type of the device
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_enabled">
+<description>
+Retrieves whether @device is enabled.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the device is enabled
+
+</return>
</function>
-<function name="json_node_set_string">
+<function name="clutter_input_device_get_grabbed_actor">
<description>
-Sets @value as the string content of the @node, replacing any existing
-content.
+Retrieves a pointer to the #ClutterActor currently grabbing all
+the events coming from @device.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a string value
+</parameters>
+<return> a #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_has_cursor">
+<description>
+Retrieves whether @device has a pointer that follows the
+device motion.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the device has a cursor
+
+</return>
</function>
-<function name="json_node_dup_object">
+<function name="clutter_input_device_get_key">
<description>
-Retrieves the #JsonObject inside @node. The reference count of
-the returned object is increased.
+Retrieves the key set using clutter_input_device_set_key()
+Since: 1.6
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the key
+</parameter_description>
+</parameter>
+<parameter name="keyval">
+<parameter_description> return location for the keyval at @index_
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> return location for the modifiers at @index_
</parameter_description>
</parameter>
</parameters>
-<return> the #JsonObject
+<return> %TRUE if a key was set at the given index
+
</return>
</function>
-<function name="clutter_bin_layout_add">
+<function name="clutter_input_device_get_modifier_state">
<description>
-Adds a #ClutterActor to the container using @self and
-sets the alignment policies for it
+Retrieves the current modifiers state of the device, as seen
+by the last event Clutter processed.
-This function is equivalent to clutter_container_add_actor()
-and clutter_layout_manager_child_set_property() but it does not
-require a pointer to the #ClutterContainer associated to the
-#ClutterBinLayout
+Since: 1.16
-Since: 1.2
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return> the last known modifier state
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_n_axes">
+<description>
+Retrieves the number of axes available on @device.
+
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBinLayout
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #ClutterActor
+</parameters>
+<return> the number of axes on the device
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_n_keys">
+<description>
+Retrieves the number of keys registered for @device.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> horizontal alignment policy for @child
+</parameters>
+<return> the number of registered keys
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_pointer_actor">
+<description>
+Retrieves the #ClutterActor underneath the pointer of @device
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> vertical alignment policy for @child
+</parameters>
+<return> a pointer to the #ClutterActor or %NULL
+
+</return>
+</function>
+
+<function name="clutter_input_device_get_pointer_stage">
+<description>
+Retrieves the #ClutterStage underneath the pointer of @device
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the #ClutterStage or %NULL
+
+</return>
</function>
-<function name="clutter_path_node_free">
+<function name="clutter_input_device_get_slave_devices">
<description>
-Frees the memory of an allocated node.
+Retrieves the slave devices attached to @device.
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #ClutterPathNode
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+</parameters>
+<return> a
+list of #ClutterInputDevice, or %NULL. The contents of the list are
+owned by the device. Use g_list_free() when done
+
+</return>
+</function>
+
+<function name="clutter_input_device_grab">
+<description>
+Acquires a grab on @actor for the given @device.
+
+Any event coming from @device will be delivered to @actor, bypassing
+the usual event delivery mechanism, until the grab is released by
+calling clutter_input_device_ungrab().
+
+The grab is client-side: even if the windowing system used by the Clutter
+backend has the concept of "device grabs", Clutter will not use them.
+
+Only #ClutterInputDevice of types %CLUTTER_POINTER_DEVICE and
+%CLUTTER_KEYBOARD_DEVICE can hold a grab.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_list_markers">
+<function name="clutter_input_device_keycode_to_evdev">
<description>
-Retrieves the list of markers at time @msecs. If @frame_num is a
-negative integer, all the markers attached to @timeline will be
-returned.
+Translates a hardware keycode from a #ClutterKeyEvent to the
+equivalent evdev keycode. Note that depending on the input backend
+used by Clutter this function can fail if there is no obvious
+mapping between the key codes. The hardware keycode can be taken
+from the #ClutterKeyEvent.hardware_keycode member of #ClutterKeyEvent.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="device">
+<parameter_description> A #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> the time to check, or -1
+<parameter name="hardware_keycode">
+<parameter_description> The hardware keycode from a #ClutterKeyEvent
</parameter_description>
</parameter>
-<parameter name="n_markers">
-<parameter_description> the number of markers returned
+<parameter name="evdev_keycode">
+<parameter_description> The return location for the evdev keycode
</parameter_description>
</parameter>
</parameters>
-<return> a newly
-allocated, %NULL terminated string array containing the names of
-the markers. Use g_strfreev() when done.
+<return> %TRUE if the conversion succeeded, %FALSE otherwise.
</return>
</function>
-<function name="clutter_actor_set_anchor_point_from_gravity">
+<function name="clutter_input_device_sequence_get_grabbed_actor">
<description>
-Sets an anchor point on the actor, based on the given gravity (this is a
-convenience function wrapping clutter_actor_set_anchor_point()).
+Retrieves a pointer to the #ClutterActor currently grabbing the
+touch events coming from @device given the @sequence.
-Since version 1.0 the anchor point will be stored as a gravity so
-that if the actor changes size then the anchor point will move. For
-example, if you set the anchor point to %CLUTTER_GRAVITY_SOUTH_EAST
-and later double the size of the actor, the anchor point will move
-to the bottom right.
+Since: 1.12
-Since: 0.6
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="sequence">
+<parameter_description> a #ClutterEventSequence
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #ClutterActor, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_input_device_sequence_grab">
+<description>
+Acquires a grab on @actor for the given @device and the given touch
+ sequence
+
+Any touch event coming from @device and from @sequence will be
+delivered to @actor, bypassing the usual event delivery mechanism,
+until the grab is released by calling
+clutter_input_device_sequence_ungrab().
+
+The grab is client-side: even if the windowing system used by the Clutter
+backend has the concept of "device grabs", Clutter will not use them.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="sequence">
+<parameter_description> a #ClutterEventSequence
+</parameter_description>
+</parameter>
+<parameter name="actor">
<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
-<parameter name="gravity">
-<parameter_description> #ClutterGravity.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_input_device_sequence_ungrab">
+<description>
+Releases the grab on the @device for the given @sequence, if one is
+in place.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="sequence">
+<parameter_description> a #ClutterEventSequence
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_get_column_spacing">
+<function name="clutter_input_device_set_enabled">
<description>
-Retrieves the spacing between columns
+Enables or disables a #ClutterInputDevice.
-Since: 1.2
+Only devices with a #ClutterInputDevice:device-mode property set
+to %CLUTTER_INPUT_MODE_SLAVE or %CLUTTER_INPUT_MODE_FLOATING can
+be disabled.
+
+Since: 1.6
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="enabled">
+<parameter_description> %TRUE to enable the @device
</parameter_description>
</parameter>
</parameters>
-<return> the spacing between columns of the #ClutterFlowLayout,
-in pixels
+<return></return>
+</function>
-</return>
+<function name="clutter_input_device_set_key">
+<description>
+Sets the keyval and modifiers at the given @index_ for @device.
+
+Clutter will use the keyval and modifiers set when filling out
+an event coming from the same input device.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the key
+</parameter_description>
+</parameter>
+<parameter name="keyval">
+<parameter_description> the keyval
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> a bitmask of modifiers
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_x11_texture_pixmap_sync_window">
+<function name="clutter_input_device_ungrab">
<description>
-Resets the texture's pixmap from its window, perhaps in response to the
-pixmap's invalidation as the window changed size.
+Releases the grab on the @device, if one is in place.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> the texture to bind
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_set_value">
+<function name="clutter_input_device_update_from_event">
<description>
-Sets @value inside @node. The passed #GValue is copied into the #JsonNode
+Forcibly updates the state of the @device using a #ClutterEvent
+
+This function should never be used by applications: it is meant
+for integration with embedding toolkits, like clutter-gtk
+
+Embedding toolkits that disable the event collection inside Clutter
+need to use this function to update the state of input devices depending
+on a #ClutterEvent that they are going to submit to the event handling code
+in Clutter though clutter_do_event(). Since the input devices hold the state
+that is going to be used to fill in fields like the #ClutterButtonEvent
+click count, or to emit synthesized events like %CLUTTER_ENTER and
+%CLUTTER_LEAVE, it is necessary for embedding toolkits to also be
+responsible of updating the input device state.
+
+For instance, this might be the code to translate an embedding toolkit
+native motion notification into a Clutter #ClutterMotionEvent and ask
+Clutter to process it:
+
+|[
+ClutterEvent c_event;
+
+translate_native_event_to_clutter (native_event, &c_event);
+
+clutter_do_event (&c_event);
+]|
+
+Before letting clutter_do_event() process the event, it is necessary to call
+clutter_input_device_update_from_event():
+
+|[
+ClutterEvent c_event;
+ClutterDeviceManager *manager;
+ClutterInputDevice *device;
+
+translate_native_event_to_clutter (native_event, &c_event);
+
+/ * get the device manager * /
+manager = clutter_device_manager_get_default ();
+
+/ * use the default Core Pointer that Clutter
+* backends register by default
+* /
+device = clutter_device_manager_get_core_device (manager, %CLUTTER_POINTER_DEVICE);
+
+/ * update the state of the input device * /
+clutter_input_device_update_from_event (device, &c_event, FALSE);
+
+clutter_do_event (&c_event);
+]|
+
+The @update_stage boolean argument should be used when the input device
+enters and leaves a #ClutterStage; it will use the #ClutterStage field
+of the passed @event to update the stage associated to the input device.
+
+Since: 1.2
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the #GValue to set
+<parameter name="event">
+<parameter_description> a #ClutterEvent
+</parameter_description>
+</parameter>
+<parameter name="update_stage">
+<parameter_description> whether to update the #ClutterStage of the @device
+using the stage of the event
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_override_action">
+<function name="clutter_interval_clone">
<description>
-Allows overriding the action for @key_val and @modifiers inside a
-#ClutterBindingPool. See clutter_binding_pool_install_action().
+Creates a copy of @interval.
-When an action has been activated using clutter_binding_pool_activate()
-the passed @callback will be invoked (with @data).
+Since: 1.0
-Actions can be blocked with clutter_binding_pool_block_action()
-and then unblocked using clutter_binding_pool_unblock_action().
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #ClutterInterval
+
+</return>
+</function>
+
+<function name="clutter_interval_compute">
+<description>
+Computes the value between the @interval boundaries given the
+progress @factor
+
+Unlike clutter_interval_compute_value(), this function will
+return a const pointer to the computed value
+
+You should use this function if you immediately pass the computed
+value to another function that makes a copy of it, like
+g_object_set_property()
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="factor">
+<parameter_description> the progress factor, between 0 and 1
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the computed value,
+or %NULL if the computation was not successfull
+
+</return>
+</function>
+
+<function name="clutter_interval_compute_value">
+<description>
+Computes the value between the @interval boundaries given the
+progress @factor and copies it into @value.
Since: 1.0
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> key symbol
+<parameter name="factor">
+<parameter_description> the progress factor, between 0 and 1
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> bitmask of modifiers
+<parameter name="value">
+<parameter_description> return location for an initialized #GValue
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> function to be called when the action is activated
+</parameters>
+<return> %TRUE if the operation was successful
+
+</return>
+</function>
+
+<function name="clutter_interval_get_final_value">
+<description>
+Retrieves the final value of @interval and copies
+it into @value.
+
+The passed #GValue must be initialized to the value held by
+the #ClutterInterval.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to be passed to @callback
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to be called when the action is removed
-from the pool
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_interval_get_initial_value">
+<description>
+Retrieves the initial value of @interval and copies
+it into @value.
+
+The passed #GValue must be initialized to the value held by
+the #ClutterInterval.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_advance_to_marker">
+<function name="clutter_interval_get_interval">
<description>
-Advances @timeline to the time of the given @marker_name.
+Variable arguments wrapper for clutter_interval_get_initial_value()
+and clutter_interval_get_final_value() that avoids using the
+#GValue arguments:
-<note><para>Like clutter_timeline_advance(), this function will not
-emit the #ClutterTimeline::new-frame for the time where @marker_name
-is set, nor it will emit #ClutterTimeline::marker-reached for
- marker_name </para></note>
+|[
+gint a = 0, b = 0;
+clutter_interval_get_interval (interval, &a, &b);
+]|
-Since: 0.8
+This function is meant for the convenience of the C API; bindings
+should reimplement this function using the #GValue-based API.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
-<parameter name="marker_name">
-<parameter_description> the name of the marker
+<parameter name="Varargs">
+<parameter_description> return locations for the initial and final values of
+the interval
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_script_list_objects">
+<function name="clutter_interval_get_value_type">
<description>
-Retrieves all the objects created by @script.
+Retrieves the #GType of the values inside @interval.
-Note: this function does not increment the reference count of the
-objects it returns.
+Since: 1.0
-Since: 0.8.2
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+</parameters>
+<return> the type of the value, or G_TYPE_INVALID
+
+</return>
+</function>
+
+<function name="clutter_interval_is_valid">
+<description>
+Checks if the @interval has a valid initial and final values.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
</parameters>
-<return> a list of #GObject<!-- -->s,
-or %NULL. The objects are owned by the #ClutterScript instance. Use g_list_free() on the
-returned value when done.
+<return> %TRUE if the #ClutterInterval has an initial and
+final values, and %FALSE otherwise
</return>
</function>
-<function name="clutter_texture_new_from_file">
+<function name="clutter_interval_new">
<description>
-Creates a new ClutterTexture actor to display the image contained a
-file. If the image failed to load then NULL is returned and @error
-is set.
+Creates a new #ClutterInterval holding values of type @gtype.
-Since: 0.8
+This function avoids using a #GValue for the initial and final values
+of the interval:
+
+|[
+interval = clutter_interval_new (G_TYPE_FLOAT, 0.0, 1.0);
+interval = clutter_interval_new (G_TYPE_BOOLEAN, FALSE, TRUE);
+interval = clutter_interval_new (G_TYPE_INT, 0, 360);
+]|
+
+Since: 1.0
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> The name of an image file to load.
+<parameter name="gtype">
+<parameter_description> the type of the values in the interval
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> Return locatoin for an error.
+<parameter name="Varargs">
+<parameter_description> the initial value and the final value of the interval
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #ClutterTexture object or NULL on
-error.
+<return> the newly created #ClutterInterval
</return>
</function>
-<function name="clutter_texture_get_filter_quality">
+<function name="clutter_interval_new_with_values">
<description>
-Gets the filter quality used when scaling a texture.
+Creates a new #ClutterInterval of type @gtype, between @initial
+and @final.
-Since: 0.8
+This function is useful for language bindings.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="gtype">
+<parameter_description> the type of the values in the interval
+</parameter_description>
+</parameter>
+<parameter name="initial">
+<parameter_description> a #GValue holding the initial value of the interval
+</parameter_description>
+</parameter>
+<parameter name="final">
+<parameter_description> a #GValue holding the final value of the interval
</parameter_description>
</parameter>
</parameters>
-<return> The filter quality value.
+<return> the newly created #ClutterInterval
</return>
</function>
-<function name="clutter_layout_manager_end_animation">
+<function name="clutter_interval_peek_final_value">
<description>
-Ends an animation started by clutter_layout_manager_begin_animation()
+Gets the pointer to the final value of @interval
-The result of this call depends on the @manager implementation
+Since: 1.0
-Since: 1.2
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+</parameters>
+<return> the final value of the interval.
+The value is owned by the #ClutterInterval and it should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="clutter_interval_peek_initial_value">
+<description>
+Gets the pointer to the initial value of @interval
+
+Since: 1.0
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+</parameters>
+<return> the initial value of the interval.
+The value is owned by the #ClutterInterval and it should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="clutter_interval_register_progress_func">
+<description>
+Sets the progress function for a given @value_type, like:
+
+|[
+clutter_interval_register_progress_func (MY_TYPE_FOO,
+my_foo_progress);
+]|
+
+Whenever a #ClutterInterval instance using the default
+#ClutterInterval::compute_value implementation is set as an
+interval between two #GValue of type @value_type, it will call
+ func to establish the value depending on the given progress,
+for instance:
+
+|[
+static gboolean
+my_int_progress (const GValue *a,
+const GValue *b,
+gdouble progress,
+GValue *retval)
+{
+gint ia = g_value_get_int (a);
+gint ib = g_value_get_int (b);
+gint res = factor * (ib - ia) + ia;
+
+g_value_set_int (retval, res);
+
+return TRUE;
+}
+
+clutter_interval_register_progress_func (G_TYPE_INT, my_int_progress);
+]|
+
+To unset a previously set progress function of a #GType, pass %NULL
+for @func.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="value_type">
+<parameter_description> a #GType
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #ClutterProgressFunc, or %NULL to unset a previously
+set progress function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_input_device_get_device_coords">
+<function name="clutter_interval_set_final">
<description>
-Retrieves the latest coordinates of the pointer of @device
+Variadic arguments version of clutter_interval_set_final_value().
-Since: 1.2
+This function is meant as a convenience for the C API.
+
+Language bindings should use clutter_interval_set_final_value() instead.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate
+<parameter name="Varargs">
+<parameter_description> the final value of the interval
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_interval_set_final_value">
+<description>
+Sets the final value of @interval to @value. The value is
+copied inside the #ClutterInterval.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_get_n_nodes">
+<function name="clutter_interval_set_initial">
<description>
-Retrieves the number of nodes in the path.
+Variadic arguments version of clutter_interval_set_initial_value().
+
+This function is meant as a convenience for the C API.
+
+Language bindings should use clutter_interval_set_initial_value()
+instead.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the initial value of the interval.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_interval_set_initial_value">
+<description>
+Sets the initial value of @interval to @value. The value is copied
+inside the #ClutterInterval.
Since: 1.0
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
</parameters>
-<return> the number of nodes.
+<return></return>
+</function>
+
+<function name="clutter_interval_set_interval">
+<description>
+Variable arguments wrapper for clutter_interval_set_initial_value()
+and clutter_interval_set_final_value() that avoids using the
+#GValue arguments:
+
+|[
+clutter_interval_set_interval (interval, 0, 50);
+clutter_interval_set_interval (interval, 1.0, 0.0);
+clutter_interval_set_interval (interval, FALSE, TRUE);
+]|
+
+This function is meant for the convenience of the C API; bindings
+should reimplement this function using the #GValue-based API.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the initial and final values of the interval
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_interval_validate">
+<description>
+Validates the initial and final values of @interval against
+a #GParamSpec.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="interval">
+<parameter_description> a #ClutterInterval
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the #ClutterInterval is valid, %FALSE otherwise
</return>
</function>
-<function name="clutter_stage_get_perspective">
+<function name="clutter_keyframe_transition_clear">
<description>
-Retrieves the stage perspective.
+Removes all key frames from @transition.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
</parameter_description>
</parameter>
-<parameter name="perspective">
-<parameter_description> return location for a #ClutterPerspective
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_keyframe_transition_get_key_frame">
+<description>
+Retrieves the details of the key frame at @index_ inside @transition.
+
+The @transition must already have key frames set, and @index_ must be
+smaller than the number of key frames.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> the index of the key frame
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> return location for the key, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> return location for the easing mode, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue initialized with the type of
+the values
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_handle_event">
+<function name="clutter_keyframe_transition_get_n_key_frames">
<description>
-This function processes a single X event; it can be used to hook
-into external X event retrieval (for example that done by GDK).
+Retrieves the number of key frames inside @transition.
-Since: 0.8
+Since: 1.12
</description>
<parameters>
-<parameter name="xevent">
-<parameter_description> pointer to XEvent structure
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
</parameter_description>
</parameter>
</parameters>
-<return> #ClutterX11FilterReturn. %CLUTTER_X11_FILTER_REMOVE
-indicates that Clutter has internally handled the event and the
-caller should do no further processing. %CLUTTER_X11_FILTER_CONTINUE
-indicates that Clutter is either not interested in the event,
-or has used the event to update internal state without taking
-any exclusive action. %CLUTTER_X11_FILTER_TRANSLATE will not
-occur.
+<return> the number of key frames
</return>
</function>
-<function name="clutter_get_default_frame_rate">
+<function name="clutter_keyframe_transition_new">
<description>
-Retrieves the default frame rate. See clutter_set_default_frame_rate().
+Creates a new #ClutterKeyframeTransition for @property_name.
-Since: 0.6
+Since: 1.12
</description>
<parameters>
+<parameter name="property_name">
+<parameter_description> the property to animate
+</parameter_description>
+</parameter>
</parameters>
-<return> the default frame rate
+<return> the newly allocated
+#ClutterKeyframeTransition instance. Use g_object_unref() when
+done to free its resources.
</return>
</function>
-<function name="clutter_actor_animate_with_alphav">
+<function name="clutter_keyframe_transition_set">
<description>
-Animates the given list of properties of @actor between the current
-value for each property and a new final value. The animation has a
-definite behaviour given by the passed @alpha.
+Sets the key frames of the @transition.
-See clutter_actor_animate() for further details.
+This variadic arguments function is a convenience for C developers;
+language bindings should use clutter_keyframe_transition_set_key_frames(),
+clutter_keyframe_transition_set_modes(), and
+clutter_keyframe_transition_set_values() instead.
-This function is useful if you want to use an existing #ClutterAlpha
-to animate @actor.
+Since: 1.12
-This is the vector-based variant of clutter_actor_animate_with_alpha(),
-useful for language bindings.
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
+</parameter_description>
+</parameter>
+<parameter name="gtype">
+<parameter_description> the type of the values to use for the key frames
+</parameter_description>
+</parameter>
+<parameter name="n_key_frames">
+<parameter_description> the number of key frames between the initial
+and final values
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of tuples, containing the key frame index, the value
+at the key frame, and the animation mode
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-<warning>Unlike clutter_actor_animate_with_alpha(), this function will
-not allow you to specify "signal::" names and callbacks.</warning>
+<function name="clutter_keyframe_transition_set_key_frame">
+<description>
+Sets the details of the key frame at @index_ inside @transition.
-Since: 1.0
+The @transition must already have a key frame at @index_, and @index_
+must be smaller than the number of key frames inside @transition.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter name="index_">
+<parameter_description> the index of the key frame
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> number of property names and values
+<parameter name="key">
+<parameter_description> the key of the key frame
</parameter_description>
</parameter>
-<parameter name="properties">
-<parameter_description> a vector
-containing the property names to set
+<parameter name="mode">
+<parameter_description> the easing mode of the key frame
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue containing the value of the key frame
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_keyframe_transition_set_key_frames">
+<description>
+Sets the keys for each key frame inside @transition.
+
+If @transition does not hold any key frame, @n_key_frames key frames
+will be created; if @transition already has key frames, @key_frames must
+have at least as many elements as the number of key frames.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
+</parameter_description>
+</parameter>
+<parameter name="n_key_frames">
+<parameter_description> the number of values
+</parameter_description>
+</parameter>
+<parameter name="key_frames">
+<parameter_description> an array of keys between 0.0
+and 1.0, one for each key frame
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_keyframe_transition_set_modes">
+<description>
+Sets the easing modes for each key frame inside @transition.
+
+If @transition does not hold any key frame, @n_modes key frames will
+be created; if @transition already has key frames, @modes must have
+at least as many elements as the number of key frames.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
+</parameter_description>
+</parameter>
+<parameter name="n_modes">
+<parameter_description> the number of easing modes
+</parameter_description>
+</parameter>
+<parameter name="modes">
+<parameter_description> an array of easing modes, one for
+each key frame
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_keyframe_transition_set_values">
+<description>
+Sets the values for each key frame inside @transition.
+
+If @transition does not hold any key frame, @n_values key frames will
+be created; if @transition already has key frames, @values must have
+at least as many elements as the number of key frames.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterKeyframeTransition
+</parameter_description>
+</parameter>
+<parameter name="n_values">
+<parameter_description> the number of values
</parameter_description>
</parameter>
<parameter name="values">
-<parameter_description> a vector containing the
-property values to set
+<parameter_description> an array of values, one for each
+key frame
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAnimation object. The object is owned by the
-#ClutterActor and should not be unreferenced with g_object_unref()
+<return></return>
+</function>
+
+<function name="clutter_keysym_to_unicode">
+<description>
+Converts @keyval from a Clutter key symbol to the corresponding
+ISO10646 (Unicode) character.
+
+</description>
+<parameters>
+<parameter name="keyval">
+<parameter_description> a key symbol
+</parameter_description>
+</parameter>
+</parameters>
+<return> a Unicode character, or 0 if there is no corresponding
+character.
</return>
</function>
-<function name="clutter_actor_is_scaled">
+<function name="clutter_knot_copy">
<description>
-Checks whether the actor is scaled in either dimension.
+Makes an allocated copy of a knot.
-Since: 0.6
+Since: 0.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="knot">
+<parameter_description> a #ClutterKnot
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is scaled.
+<return> the copied knot.
+
+</return>
+</function>
+
+<function name="clutter_knot_equal">
+<description>
+Compares to knot and checks if the point to the same location.
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="knot_a">
+<parameter_description> First knot
+</parameter_description>
+</parameter>
+<parameter name="knot_b">
+<parameter_description> Second knot
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the knots point to the same location.
+
+</return>
+</function>
+
+<function name="clutter_knot_free">
+<description>
+Frees the memory of an allocated knot.
+
+Since: 0.2
+
+</description>
+<parameters>
+<parameter name="knot">
+<parameter_description> a #ClutterKnot
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_layout_manager_allocate">
+<description>
+Allocates the children of @container given an area
+
+See also clutter_actor_allocate()
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> the #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="allocation">
+<parameter_description> the #ClutterActorBox containing the allocated area
+of @container
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the allocation flags
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_layout_manager_begin_animation">
+<description>
+Begins an animation of @duration milliseconds, using the provided
+easing @mode
+
+The easing mode can be specified either as a #ClutterAnimationMode
+or as a logical id returned by clutter_alpha_register_func()
+
+The result of this function depends on the @manager implementation
+
+Since: 1.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="duration">
+<parameter_description> the duration of the animation, in milliseconds
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> the easing mode of the animation
+</parameter_description>
+</parameter>
+</parameters>
+<return> The #ClutterAlpha created by the
+layout manager; the returned instance is owned by the layout
+manager and should not be unreferenced
</return>
</function>
@@ -12492,57 +25308,250 @@ Since: 1.2
<return></return>
</function>
-<function name="clutter_path_add_cairo_path">
+<function name="clutter_layout_manager_child_get_property">
<description>
-Add the nodes of the Cairo path to the end of @path.
+Gets a property on the #ClutterLayoutMeta created by @manager and
+attached to a child of @container
-Since: 1.0
+The #GValue must already be initialized to the type of the property
+and has to be unset with g_value_unset() after extracting the real
+value out of it
+
+Since: 1.2
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
</parameter_description>
</parameter>
-<parameter name="cpath">
-<parameter_description> a Cairo path
+<parameter name="container">
+<parameter_description> a #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @container
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the property to get
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue with the value of the property to get
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_main_quit">
+<function name="clutter_layout_manager_child_set">
<description>
-Terminates the Clutter mainloop.
+Sets a list of properties and their values on the #ClutterLayoutMeta
+associated by @manager to a child of @container
+
+Languages bindings should use clutter_layout_manager_child_set_property()
+instead
+
+Since: 1.2
</description>
<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> a #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @container
+</parameter_description>
+</parameter>
+<parameter name="first_property">
+<parameter_description> the first property name
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of property name and value pairs
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_manager_peek_stages">
+<function name="clutter_layout_manager_child_set_property">
<description>
-Lists all currently used stages.
+Sets a property on the #ClutterLayoutMeta created by @manager and
+attached to a child of @container
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> a #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @container
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the property to set
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue with the value of the property to set
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_layout_manager_end_animation">
+<description>
+Ends an animation started by clutter_layout_manager_begin_animation()
+
+The result of this call depends on the @manager implementation
+
+Since: 1.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_layout_manager_find_child_property">
+<description>
+Retrieves the #GParamSpec for the layout property @name inside
+the #ClutterLayoutMeta sub-class used by @manager
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the property
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GParamSpec describing the property,
+or %NULL if no property with that name exists. The returned
+#GParamSpec is owned by the layout manager and should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="clutter_layout_manager_get_animation_progress">
+<description>
+Retrieves the progress of the animation, if one has been started by
+clutter_layout_manager_begin_animation()
+
+The returned value has the same semantics of the #ClutterAlpha:alpha
+value
+
+Since: 1.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+</parameters>
+<return> the progress of the animation
+
+</return>
+</function>
+
+<function name="clutter_layout_manager_get_child_meta">
+<description>
+Retrieves the #ClutterLayoutMeta that the layout @manager associated
+to the @actor child of @container, eventually by creating one if the
+#ClutterLayoutManager supports layout properties
Since: 1.0
</description>
<parameters>
-<parameter name="stage_manager">
-<parameter_description> a #ClutterStageManager
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> a #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @container
</parameter_description>
</parameter>
</parameters>
-<return> a pointer
-to the internal list of #ClutterStage objects. The returned list
-is owned by the #ClutterStageManager and should never be modified
-or freed
+<return> a #ClutterLayoutMeta, or %NULL if the
+#ClutterLayoutManager does not have layout properties. The returned
+layout meta instance is owned by the #ClutterLayoutManager and it
+should not be unreferenced
</return>
</function>
+<function name="clutter_layout_manager_get_preferred_height">
+<description>
+Computes the minimum and natural heights of the @container according
+to @manager.
+
+See also clutter_actor_get_preferred_height()
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> the #ClutterContainer using @manager
+</parameter_description>
+</parameter>
+<parameter name="for_width">
+<parameter_description> the width for which the height should be computed, or -1
+</parameter_description>
+</parameter>
+<parameter name="min_height_p">
+<parameter_description> return location for the minimum height
+of the layout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="nat_height_p">
+<parameter_description> return location for the natural height
+of the layout, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="clutter_layout_manager_get_preferred_width">
<description>
Computes the minimum and natural widths of the @container according
@@ -12580,4449 +25589,7200 @@ of the layout, or %NULL
<return></return>
</function>
-<function name="clutter_box_layout_set_easing_mode">
+<function name="clutter_layout_manager_layout_changed">
<description>
-Sets the easing mode to be used by @layout when animating changes in layout
-properties
+Emits the #ClutterLayoutManager::layout-changed signal on @manager
-Use clutter_box_layout_set_use_animations() to enable and disable the
-animations
+This function should only be called by implementations of the
+#ClutterLayoutManager class
Since: 1.2
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an easing mode, either from #ClutterAnimationMode or a logical id
-from clutter_alpha_register_func()
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_layout_manager_list_child_properties">
+<description>
+Retrieves all the #GParamSpec<!-- -->s for the layout properties
+stored inside the #ClutterLayoutMeta sub-class used by @manager
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="n_pspecs">
+<parameter_description> return location for the number of returned
+#GParamSpec<!-- -->s
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly-allocated,
+%NULL-terminated array of #GParamSpec<!-- -->s. Use g_free() to free the
+resources allocated for the array
+
+</return>
+</function>
+
+<function name="clutter_layout_manager_set_container">
+<description>
+If the #ClutterLayoutManager sub-class allows it, allow
+adding a weak reference of the @container using @manager
+from within the layout manager
+
+The layout manager should not increase the reference
+count of the @container
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #ClutterLayoutManager
+</parameter_description>
+</parameter>
+<parameter name="container">
+<parameter_description> a #ClutterContainer using @manager
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_activatable">
+<function name="clutter_layout_meta_get_manager">
<description>
-Retrieves whether a #ClutterText is activatable or not.
+Retrieves the actor wrapped by @data
-Since: 1.0
+Since: 1.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="data">
+<parameter_description> a #ClutterLayoutMeta
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is activatable
+<return> a #ClutterLayoutManager
</return>
</function>
-<function name="clutter_animator_get_timeline">
+<function name="clutter_list_model_new">
<description>
-Get the timeline hooked up for driving the #ClutterAnimator
+Creates a new default model with @n_columns columns with the types
+and names passed in.
-Since: 1.2
+For example:
+
+<informalexample><programlisting>
+model = clutter_list_model_new (3,
+G_TYPE_INT, "Score",
+G_TYPE_STRING, "Team",
+GDK_TYPE_PIXBUF, "Logo");
+</programlisting></informalexample>
+
+will create a new #ClutterModel with three columns of type int,
+string and #GdkPixbuf respectively.
+
+Note that the name of the column can be set to %NULL, in which case
+the canonical name of the type held by the column will be used as
+the title.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="n_columns">
+<parameter_description> number of columns in the model
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> @n_columns number of #GType and string pairs
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterTimeline that drives the animator
+<return> a new #ClutterListModel
</return>
</function>
-<function name="clutter_units_from_pt">
+<function name="clutter_list_model_newv">
<description>
-Stores a value in typographic points inside @units
+Non-vararg version of clutter_list_model_new(). This function is
+useful for language bindings.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="n_columns">
+<parameter_description> number of columns in the model
</parameter_description>
</parameter>
-<parameter name="pt">
-<parameter_description> typographic points
+<parameter name="types">
+<parameter_description> an array of #GType types for the columns, from first to last
+</parameter_description>
+</parameter>
+<parameter name="names">
+<parameter_description> an array of names for the columns, from first to last
</parameter_description>
</parameter>
</parameters>
+<return> a new default #ClutterModel
+
+</return>
+</function>
+
+<function name="clutter_main">
+<description>
+Starts the Clutter mainloop.
+
+</description>
+<parameters>
+</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_set_pack_start">
+<function name="clutter_main_level">
<description>
-Sets whether children of @layout should be layed out by appending
-them or by prepending them
+Retrieves the depth of the Clutter mainloop.
+
+
+</description>
+<parameters>
+</parameters>
+<return> The level of the mainloop.
+</return>
+</function>
+
+<function name="clutter_main_quit">
+<description>
+Terminates the Clutter mainloop.
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_major_version">
+<description>
+The major component of the Clutter library version, e.g. 1 if the version
+is 1.2.3
+
+This value can be used for run-time version checks
+
+For a compile-time check, use %CLUTTER_MAJOR_VERSION
Since: 1.2
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_margin_copy">
+<description>
+Creates a new #ClutterMargin and copies the contents of @margin_ into
+the newly created structure.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="margin_">
+<parameter_description> a #ClutterMargin
</parameter_description>
</parameter>
-<parameter name="pack_start">
-<parameter_description> %TRUE if the @layout should pack children at the
-beginning of the layout
+</parameters>
+<return> a copy of the #ClutterMargin.
+
+</return>
+</function>
+
+<function name="clutter_margin_free">
+<description>
+Frees the resources allocated by clutter_margin_new() and
+clutter_margin_copy().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="margin_">
+<parameter_description> a #ClutterMargin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_clear">
+<function name="clutter_margin_new">
<description>
-Removes all nodes from the path.
+Creates a new #ClutterMargin.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+</parameters>
+<return> a newly allocated #ClutterMargin. Use
+clutter_margin_free() to free the resources associated with it when
+done.
+
+</return>
+</function>
+
+<function name="clutter_matrix_alloc">
+<description>
+Allocates enough memory to hold a #ClutterMatrix.
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly allocated #ClutterMatrix
+
+</return>
+</function>
+
+<function name="clutter_matrix_free">
+<description>
+Frees the memory allocated by clutter_matrix_alloc().
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="matrix">
+<parameter_description> a #ClutterMatrix
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_scriptable_parse_custom_node">
+<function name="clutter_matrix_init_from_array">
<description>
-Parses the passed JSON node. The implementation must set the type
-of the passed #GValue pointer using g_value_init().
+Initializes @matrix with the contents of a C array of floating point
+values.
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="scriptable">
-<parameter_description> a #ClutterScriptable
-</parameter_description>
-</parameter>
-<parameter name="script">
-<parameter_description> the #ClutterScript creating the scriptable instance
+<parameter name="matrix">
+<parameter_description> a #ClutterMatrix
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the generic value to be set
+<parameter name="values">
+<parameter_description> a C array of 16 floating point values,
+representing a 4x4 matrix, with column-major order
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the node
+</parameters>
+<return> the initialzed #ClutterMatrix
+
+</return>
+</function>
+
+<function name="clutter_matrix_init_from_matrix">
+<description>
+Initializes the #ClutterMatrix @a with the contents of the
+#ClutterMatrix @b.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> the #ClutterMatrix to initialize
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the JSON node to be parsed
+<parameter name="b">
+<parameter_description> the #ClutterMatrix to copy
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the node was successfully parsed, %FALSE otherwise.
+<return> the initialized #ClutterMatrix
</return>
</function>
-<function name="json_array_remove_element">
+<function name="clutter_matrix_init_identity">
<description>
-Removes the #JsonNode inside @array at @index_ freeing its allocated
-resources.
+Initializes @matrix with the identity matrix, i.e.:
+
+|[
+.xx = 1.0, .xy = 0.0, .xz = 0.0, .xw = 0.0
+.yx = 0.0, .yy = 1.0, .yz = 0.0, .yw = 0.0
+.zx = 0.0, .zy = 0.0, .zz = 1.0, .zw = 0.0
+.wx = 0.0, .wy = 0.0, .wz = 0.0, .ww = 1.0
+]|
+
+Since: 1.12
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="matrix">
+<parameter_description> a #ClutterMatrix
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the position of the element to be removed
+</parameters>
+<return> the initialized #ClutterMatrix
+
+</return>
+</function>
+
+<function name="clutter_media_get_audio_volume">
+<description>
+Retrieves the playback volume of @media.
+
+Since: 1.0
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The playback volume between 0.0 and 1.0
+
+</return>
</function>
-<function name="clutter_media_set_audio_volume">
+<function name="clutter_media_get_buffer_fill">
<description>
-Sets the playback volume of @media to @volume.
+Retrieves the amount of the stream that is buffered.
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
<parameter name="media">
<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
-<parameter name="volume">
-<parameter_description> the volume as a double between 0.0 and 1.0
+</parameters>
+<return> the fill level, between 0.0 and 1.0
+
+</return>
+</function>
+
+<function name="clutter_media_get_can_seek">
+<description>
+Retrieves whether @media is seekable or not.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @media can seek, %FALSE otherwise.
+
+</return>
</function>
-<function name="clutter_actor_map">
+<function name="clutter_media_get_duration">
<description>
-Sets the %CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps
-and realizes its children if they are visible. Does nothing if the
-actor is not visible.
+Retrieves the duration of the media stream that @media represents.
-Calling this is allowed in only one case: you are implementing the
-#ClutterActor::map virtual function in an actor and you need to map
-the children of that actor. It is not necessary to call this
-if you implement #ClutterContainer because the default implementation
-will automatically map children of containers.
+Since: 0.2
-When overriding map, it is mandatory to chain up to the parent
-implementation.
+Deprecated: 1.12
-Since: 1.0
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
+</parameters>
+<return> the duration of the media stream, in seconds
+
+</return>
+</function>
+
+<function name="clutter_media_get_playing">
+<description>
+Retrieves the playing status of @media.
+
+Since: 0.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="media">
+<parameter_description> A #ClutterMedia object
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if playing, %FALSE if stopped.
+
+</return>
</function>
-<function name="clutter_model_get_iter_at_row">
+<function name="clutter_media_get_progress">
<description>
-Retrieves a #ClutterModelIter representing the row at the given index.
+Retrieves the playback progress of @media.
-If a filter function has been set using clutter_model_set_filter()
-then the @model implementation will return the first non filtered
-row.
+Since: 1.0
-Since: 0.6
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> position of the row to retrieve
+</parameters>
+<return> the playback progress, between 0.0 and 1.0
+
+</return>
+</function>
+
+<function name="clutter_media_get_subtitle_font_name">
+<description>
+Retrieves the font name currently used.
+
+Since: 1.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterModelIter, or %NULL if @row was
-out of bounds. When done using the iterator object, call g_object_unref()
-to deallocate its resources
+<return> a string containing the font name. Use g_free()
+to free the returned string
</return>
</function>
-<function name="json_object_new">
+<function name="clutter_media_get_subtitle_uri">
<description>
-Creates a new #JsonObject, an JSON object type representation.
+Retrieves the URI of the subtitle file in use.
+Since: 1.2
+
+Deprecated: 1.12
</description>
<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #JsonObject
+<return> the URI of the subtitle file. Use g_free()
+to free the returned string
+
</return>
</function>
-<function name="clutter_model_get_last_iter">
+<function name="clutter_media_get_uri">
<description>
-Retrieves a #ClutterModelIter representing the last non-filtered
-row in @model.
+Retrieves the URI from @media.
-Since: 0.6
+Since: 0.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterModelIter.
-Call g_object_unref() when done using it
+<return> the URI of the media stream. Use g_free()
+to free the returned string
</return>
</function>
-<function name="clutter_text_get_selectable">
+<function name="clutter_media_set_audio_volume">
<description>
-Retrieves whether a #ClutterText is selectable or not.
+Sets the playback volume of @media to @volume.
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
+<parameter name="volume">
+<parameter_description> the volume as a double between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is selectable
+<return></return>
+</function>
-</return>
+<function name="clutter_media_set_filename">
+<description>
+Sets the source of @media using a file path.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> A filename
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_container_remove_actor">
+<function name="clutter_media_set_playing">
<description>
-Removes @actor from @container. The actor should be unparented, so
-if you want to keep it around you must hold a reference to it
-yourself, using g_object_ref(). When the actor has been removed,
-the "actor-removed" signal is emitted by @container.
+Starts or stops playing of @media.
+
+The implementation might be asynchronous, so the way to know whether
+the actual playing state of the @media is to use the #GObject::notify
+signal on the #ClutterMedia:playing property and then retrieve the
+current state with clutter_media_get_playing(). ClutterGstVideoTexture
+in clutter-gst is an example of such an asynchronous implementation.
-Since: 0.4
+Since: 0.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="playing">
+<parameter_description> %TRUE to start playing
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_set_column_spacing">
+<function name="clutter_media_set_progress">
<description>
-Sets the space between columns, in pixels
+Sets the playback progress of @media. The @progress is
+a normalized value between 0.0 (begin) and 1.0 (end).
-Since: 1.2
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> the space between columns
+<parameter name="progress">
+<parameter_description> the progress of the playback, between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_name">
+<function name="clutter_media_set_subtitle_font_name">
<description>
-Sets the given name to @self. The name can be used to identify
-a #ClutterActor.
+Sets the font used by the subtitle renderer. The @font_name string must be
+either %NULL, which means that the default font name of the underlying
+implementation will be used; or must follow the grammar recognized by
+pango_font_description_from_string() like:
+
+|[
+clutter_media_set_subtitle_font_name (media, "Sans 24pt");
+]|
+
+Since: 1.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="media">
+<parameter_description> a #ClutterMedia
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> Textual tag to apply to actor
+<parameter name="font_name">
+<parameter_description> a font name, or %NULL to set the default font name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_copy">
+<function name="clutter_media_set_subtitle_uri">
<description>
-Copies the passed iterator.
+Sets the location of a subtitle file to display while playing @media.
-Since: 0.8
+Since: 1.2
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI of a subtitle file
</parameter_description>
</parameter>
</parameters>
-<return> a copy of the iterator, or %NULL
+<return></return>
+</function>
-</return>
+<function name="clutter_media_set_uri">
+<description>
+Sets the URI of @media to @uri.
+
+Since: 0.2
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="media">
+<parameter_description> a #ClutterMedia
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI of the media stream
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_get_motion_events_enabled">
+<function name="clutter_micro_version">
<description>
-Gets whether the per-actor motion events are enabled.
+The micro component of the Clutter library version, e.g. 3 if the version
+is 1.2.3
-Since: 0.6
+This value can be used for run-time version checks
+
+For a compile-time check, use %CLUTTER_MICRO_VERSION
+
+Since: 1.2
</description>
<parameters>
</parameters>
-<return> %TRUE if the motion events are enabled
+<return></return>
+</function>
-</return>
+<function name="clutter_minor_version">
+<description>
+The minor component of the Clutter library version, e.g. 2 if the version
+is 1.2.3
+
+This value can be used for run-time version checks
+
+For a compile-time check, use %CLUTTER_MINOR_VERSION
+
+Since: 1.2
+
+</description>
+<parameters>
+</parameters>
+<return></return>
</function>
-<function name="clutter_backend_set_double_click_distance">
+<function name="clutter_model_append">
<description>
-Sets the maximum distance used to verify a double click event.
+Creates and appends a new row to the #ClutterModel, setting the
+row values upon creation. For example, to append a new row where
+column 0 is type %G_TYPE_INT and column 1 is of type %G_TYPE_STRING:
-Since: 0.4
+<informalexample><programlisting>
+ClutterModel *model;
+model = clutter_model_default_new (2,
+G_TYPE_INT, "Score",
+G_TYPE_STRING, "Team");
+clutter_model_append (model, 0, 42, 1, "Team #1", -1);
+</programlisting></informalexample>
+
+Since: 0.6
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="distance">
-<parameter_description> a distance, in pixels
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_set_duration">
+<function name="clutter_model_appendv">
<description>
-Sets the duration of the timeline, in milliseconds. The speed
-of the timeline depends on the ClutterTimeline:fps setting.
+Creates and appends a new row to the #ClutterModel, setting the row
+values for the given @columns upon creation.
Since: 0.6
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> duration of the timeline in milliseconds
+<parameter name="n_columns">
+<parameter_description> the number of columns and values
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> a vector with the columns to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector with the values
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_create_pango_layout">
+<function name="clutter_model_filter_iter">
<description>
-Creates a new #PangoLayout from the same #PangoContext used
-by the #ClutterActor. The #PangoLayout is already configured
-with the font map, resolution and font options, and the
-given @text.
+Checks whether the row pointer by @iter should be filtered or not using
+the filtering function set on @model.
-If you want to keep around a #PangoLayout created by this
-function you will have to connect to the #ClutterBackend::font-changed
-and #ClutterBackend::resolution-changed signals, and call
-pango_layout_context_changed() in response to them.
+This function should be used only by subclasses of #ClutterModel.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> (allow-none) the text to set on the #PangoLayout, or %NULL
+<parameter name="iter">
+<parameter_description> the row to filter
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #PangoLayout. Use g_object_unref()
-when done
+<return> %TRUE if the row should be displayed,
+%FALSE otherwise
</return>
</function>
-<function name="clutter_event_get_source">
+<function name="clutter_model_filter_row">
<description>
-Retrieves the source #ClutterActor the event originated from, or
-NULL if the event has no source.
+Checks whether @row should be filtered or not using the
+filtering function set on @model.
+
+This function should be used only by subclasses of #ClutterModel.
Since: 0.6
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> the row to filter
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterActor
+<return> %TRUE if the row should be displayed,
+%FALSE otherwise
</return>
</function>
-<function name="clutter_actor_get_z_rotation_gravity">
+<function name="clutter_model_foreach">
<description>
-Retrieves the center for the rotation around the Z axis as a
-compass direction. If the center was specified in pixels or units
-this will return %CLUTTER_GRAVITY_NONE.
+Calls @func for each row in the model.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #ClutterModelForeachFunc
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @func
</parameter_description>
</parameter>
</parameters>
-<return> the Z rotation center
+<return></return>
+</function>
+
+<function name="clutter_model_get_column_name">
+<description>
+Retrieves the name of the @column
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column number
+</parameter_description>
+</parameter>
+</parameters>
+<return> the name of the column. The model holds the returned
+string, and it should not be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_model_get_column_type">
+<description>
+Retrieves the type of the @column.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column number
+</parameter_description>
+</parameter>
+</parameters>
+<return> the type of the column.
</return>
</function>
-<function name="cogl_pango_font_map_get_renderer">
+<function name="clutter_model_get_filter_set">
<description>
-Retrieves the #CoglPangoRenderer for the passed font map.
+Returns whether the @model has a filter in place, set
+using clutter_model_set_filter()
Since: 1.0
</description>
<parameters>
-<parameter name="fm">
-<parameter_description> a #CoglPangoFontMap
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoRenderer
+<return> %TRUE if a filter is set
</return>
</function>
-<function name="clutter_x11_get_default_display">
+<function name="clutter_model_get_first_iter">
<description>
-Retrieves the pointer to the default display.
+Retrieves a #ClutterModelIter representing the first non-filtered
+row in @model.
Since: 0.6
</description>
<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
</parameters>
-<return> the default display
+<return> A new #ClutterModelIter.
+Call g_object_unref() when done using it
</return>
</function>
-<function name="clutter_timeline_get_progress">
+<function name="clutter_model_get_iter_at_row">
<description>
-The position of the timeline in a [0, 1] interval.
+Retrieves a #ClutterModelIter representing the row at the given index.
+
+If a filter function has been set using clutter_model_set_filter()
+then the @model implementation will return the first non filtered
+row.
Since: 0.6
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> position of the row to retrieve
</parameter_description>
</parameter>
</parameters>
-<return> the position of the timeline.
+<return> A new #ClutterModelIter, or %NULL if @row was
+out of bounds. When done using the iterator object, call g_object_unref()
+to deallocate its resources
</return>
</function>
-<function name="clutter_color_to_pixel">
+<function name="clutter_model_get_last_iter">
<description>
-Converts @color into a packed 32 bit integer, containing
-all the four 8 bit channels used by #ClutterColor.
+Retrieves a #ClutterModelIter representing the last non-filtered
+row in @model.
+Since: 0.6
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
</parameters>
-<return> a packed color
+<return> A new #ClutterModelIter.
+Call g_object_unref() when done using it
+
</return>
</function>
-<function name="clutter_backend_get_double_click_distance">
+<function name="clutter_model_get_n_columns">
<description>
-Retrieves the distance used to verify a double click event
+Retrieves the number of columns inside @model.
-Since: 0.4
+Since: 0.6
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
</parameters>
-<return> a distance, in pixels.
+<return> the number of columns
</return>
</function>
-<function name="clutter_event_get_device_type">
+<function name="clutter_model_get_n_rows">
<description>
-Retrieves the type of the device for @event
+Retrieves the number of rows inside @model, eventually taking
+into account any filtering function set using clutter_model_set_filter().
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterInputDeviceType for the device, if
-any is set
+<return> The length of the @model. If there is a filter set, then
+the length of the filtered @model is returned.
</return>
</function>
-<function name="clutter_texture_get_pixel_format">
+<function name="clutter_model_get_sorting_column">
<description>
-Retrieves the pixel format used by @texture. This is
-equivalent to:
+Retrieves the number of column used for sorting the @model.
-|[
-handle = clutter_texture_get_pixel_format (texture);
+Since: 0.6
-if (handle != COGL_INVALID_HANDLE)
-format = cogl_texture_get_format (handle);
-]|
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+</parameters>
+<return> a column number, or -1 if the model is not sorted
-Since: 1.0
+</return>
+</function>
+
+<function name="clutter_model_insert">
+<description>
+Inserts a new row to the #ClutterModel at @row, setting the row
+values upon creation. For example, to insert a new row at index 100,
+where column 0 is type %G_TYPE_INT and column 1 is of type
+%G_TYPE_STRING:
+
+<informalexample><programlisting>
+ClutterModel *model;
+model = clutter_model_default_new (2,
+G_TYPE_INT, "Score",
+G_TYPE_STRING, "Team");
+clutter_model_insert (model, 3, 0, 42, 1, "Team #1", -1);
+</programlisting></informalexample>
+
+Since: 0.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> the position to insert the new row
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
</parameters>
-<return> a #CoglPixelFormat value
+<return></return>
+</function>
-</return>
+<function name="clutter_model_insert_value">
+<description>
+Sets the data in the cell specified by @iter and @column. The type of
+ value must be convertable to the type of the column. If the row does
+not exist then it is created.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> position of the row to modify
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> column to modify
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> new value for the cell
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_container_child_set">
+<function name="clutter_model_insertv">
<description>
-Sets container specific properties on the child of a container.
+Inserts data at @row into the #ClutterModel, setting the row
+values for the given @columns upon creation.
-Since: 0.8
+Since: 0.6
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor that is a child of @container.
+<parameter name="row">
+<parameter_description> row index
</parameter_description>
</parameter>
-<parameter name="first_prop">
-<parameter_description> name of the first property to be set.
+<parameter name="n_columns">
+<parameter_description> the number of columns and values to set
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> a vector containing the columns to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the values for the cells
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_model_iter_copy">
+<description>
+Copies the passed iterator.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy of the iterator, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_model_iter_get">
+<description>
+Gets the value of one or more cells in the row referenced by @iter. The
+variable argument list should contain integer column numbers, each column
+column number followed by a place to store the value being retrieved. The
+list is terminated by a -1.
+
+For example, to get a value from column 0 with type %G_TYPE_STRING use:
+<informalexample><programlisting>
+clutter_model_iter_get (iter, 0, &place_string_here, -1);
+</programlisting></informalexample>
+
+where place_string_here is a gchar* to be filled with the string. If
+appropriate, the returned values have to be freed or unreferenced.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> value for the first property, followed optionally by more name/value
-pairs terminated with NULL.
+<parameter_description> a list of column/return location pairs, terminated by -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_get_default_screen">
+<function name="clutter_model_iter_get_model">
<description>
-Gets the number of the default X Screen object.
+Retrieves a pointer to the #ClutterModel that this iter is part of.
Since: 0.6
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
</parameters>
-<return> the number of the default screen
+<return> a pointer to a #ClutterModel.
</return>
</function>
-<function name="clutter_path_add_rel_move_to">
+<function name="clutter_model_iter_get_row">
<description>
-Same as clutter_path_add_move_to() except the coordinates are
-relative to the previous node.
+Retrieves the position of the row that the @iter points to.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate
+</parameters>
+<return> the position of the @iter in the model
+
+</return>
+</function>
+
+<function name="clutter_model_iter_get_valist">
+<description>
+See clutter_model_iter_get(). This version takes a va_list for language
+bindings.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate
+<parameter name="args">
+<parameter_description> a list of column/return location pairs, terminated by -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_get_alpha">
+<function name="clutter_model_iter_get_value">
<description>
-Retrieves the #ClutterAlpha used by @animation.
+Sets an initializes @value to that at @column. When done with @value,
+g_value_unset() needs to be called to free any allocated memory.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> column number to retrieve the value from
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an empty #GValue to set
</parameter_description>
</parameter>
</parameters>
-<return> the alpha object used by the animation
+<return></return>
+</function>
+
+<function name="clutter_model_iter_is_first">
+<description>
+Gets whether the current iterator is at the beginning of the model
+to which it belongs.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> #TRUE if @iter is the first iter in the filtered model
</return>
</function>
-<function name="clutter_get_current_event_time">
+<function name="clutter_model_iter_is_last">
<description>
-Retrieves the timestamp of the last event, if there is an
-event or if the event has a timestamp.
+Gets whether the iterator is at the end of the model to which it
+belongs.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
</parameters>
-<return> the event timestamp, or %CLUTTER_CURRENT_TIME
+<return> #TRUE if @iter is the last iter in the filtered model.
</return>
</function>
-<function name="clutter_timeline_stop">
+<function name="clutter_model_iter_next">
<description>
-Stops the #ClutterTimeline and moves to frame 0
+Updates the @iter to point at the next position in the model.
+The model implementation should take into account the presence of
+a filter function.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The passed iterator, updated to point at the next
+row in the model.
+
+</return>
</function>
-<function name="clutter_get_current_event">
+<function name="clutter_model_iter_prev">
<description>
-If an event is currently being processed, return that event.
-This function is intended to be used to access event state
-that might not be exposed by higher-level widgets. For
-example, to get the key modifier state from a Button 'clicked'
-event.
+Sets the @iter to point at the previous position in the model.
+The model implementation should take into account the presence of
+a filter function.
-Since: 1.2
+Since: 0.6
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
</parameters>
-<return> The current ClutterEvent, or %NULL if none
+<return> The passed iterator, updated to point at the previous
+row in the model.
</return>
</function>
-<function name="clutter_rectangle_set_color">
+<function name="clutter_model_iter_set">
<description>
-Sets the color of @rectangle.
+Sets the value of one or more cells in the row referenced by @iter. The
+variable argument list should contain integer column numbers, each column
+column number followed by the value to be set. The list is terminated by a
+-1.
+
+For example, to set column 0 with type %G_TYPE_STRING, use:
+<informalexample><programlisting>
+clutter_model_iter_set (iter, 0, "foo", -1);
+</programlisting></informalexample>
+
+Since: 0.6
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="Varargs">
+<parameter_description> a list of column/return location pairs, terminated by -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_clear_glyph_cache">
+<function name="clutter_model_iter_set_valist">
<description>
-Clears the internal cache of glyphs used by the Pango
-renderer. This will free up some memory and GL texture
-resources. The cache will be automatically refilled as more text is
-drawn.
+See clutter_model_iter_set(); this version takes a va_list for language
+bindings.
-Since: 0.8
+Since: 0.6
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
+<parameter name="args">
+<parameter_description> va_list of column/value pairs, terminiated by -1
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_get_max_tile_waste">
+<function name="clutter_model_iter_set_value">
<description>
-Gets the maximum waste that will be used when creating a texture or
--1 if slicing is disabled.
+Sets the data in the cell specified by @iter and @column. The type of
+ value must be convertable to the type of the column.
-Since: 0.8
+Since: 0.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="iter">
+<parameter_description> a #ClutterModelIter
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> column number to retrieve the value from
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> new value for the cell
</parameter_description>
</parameter>
</parameters>
-<return> The maximum waste or -1 if the texture waste is
-unlimited.
+<return></return>
+</function>
-</return>
+<function name="clutter_model_prepend">
+<description>
+Creates and prepends a new row to the #ClutterModel, setting the row
+values upon creation. For example, to prepend a new row where column 0
+is type %G_TYPE_INT and column 1 is of type %G_TYPE_STRING:
+
+<informalexample><programlisting>
+ClutterModel *model;
+model = clutter_model_default_new (2,
+G_TYPE_INT, "Score",
+G_TYPE_STRING, "Team");
+clutter_model_prepend (model, 0, 42, 1, "Team #1", -1);
+</programlisting></informalexample>
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_text_set_markup">
+<function name="clutter_model_prependv">
<description>
-Sets @markup as the contents of a #ClutterText.
+Creates and prepends a new row to the #ClutterModel, setting the row
+values for the given @columns upon creation.
-This is a convenience function for setting a string containing
-Pango markup, and it is logically equivalent to:
+Since: 0.6
-|[
-clutter_text_set_text (CLUTTER_TEXT (actor), markup);
-clutter_text_set_use_markup (CLUTTER_TEXT (actor), TRUE);
-]|
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="n_columns">
+<parameter_description> the number of columns and values to set
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> a vector containing the columns to set
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> a vector containing the values for the cells
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.0
+<function name="clutter_model_remove">
+<description>
+Removes the row at the given position from the model.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> a string containing Pango markup. Passing %NULL is the same
-as passing "" (the empty string)
+<parameter name="row">
+<parameter_description> position of row to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_bind">
+<function name="clutter_model_resort">
<description>
-Adds a single property with name @property_name to the
-animation @animation. For more information about animations,
-see clutter_actor_animate().
+Force a resort on the @model. This function should only be
+used by subclasses of #ClutterModel.
-This method returns the animation primarily to make chained
-calls convenient in language bindings.
+Since: 0.6
-Since: 1.0
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_model_set_filter">
+<description>
+Filters the @model using the given filtering function.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the property to control
+<parameter name="func">
+<parameter_description> a #ClutterModelFilterFunc, or #NULL
</parameter_description>
</parameter>
-<parameter name="final">
-<parameter_description> The final value of the property
+<parameter name="user_data">
+<parameter_description> user data to pass to @func, or #NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> destroy notifier of @user_data, or #NULL
</parameter_description>
</parameter>
</parameters>
-<return> The animation itself.
-
-</return>
+<return></return>
</function>
-<function name="json_object_remove_member">
+<function name="clutter_model_set_names">
<description>
-Removes @member_name from @object, freeing its allocated resources.
+Assigns a name to the columns of a #ClutterModel.
+
+This function is meant primarily for #GObjects that inherit from
+#ClutterModel, and should only be used when contructing a #ClutterModel.
+It will not work after the initial creation of the #ClutterModel.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="model">
+<parameter_description> a #ClutterModel
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member to remove
+<parameter name="n_columns">
+<parameter_description> the number of column names
+</parameter_description>
+</parameter>
+<parameter name="names">
+<parameter_description> an array of strings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_vertex_copy">
+<function name="clutter_model_set_sort">
<description>
-Copies @vertex
+Sorts @model using the given sorting function.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="vertex">
-<parameter_description> a #ClutterVertex
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column to sort on
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #ClutterModelSortFunc, or #NULL
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @func, or #NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> destroy notifier of @user_data, or #NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated copy of #ClutterVertex. Use
-clutter_vertex_free() to free the allocated resources
+<return></return>
+</function>
-</return>
+<function name="clutter_model_set_sorting_column">
+<description>
+Sets the model to sort by @column. If @column is a negative value
+the sorting column will be unset.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column of the @model to sort, or -1
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_get_transformed_size">
+<function name="clutter_model_set_types">
<description>
-Gets the absolute size of an actor in pixels, taking into account the
-scaling factors.
+Sets the types of the columns inside a #ClutterModel.
-If the actor has a valid allocation, the allocated size will be used.
-If the actor has not a valid allocation then the preferred size will
-be transformed and returned.
+This function is meant primarily for #GObjects that inherit from
+#ClutterModel, and should only be used when contructing a #ClutterModel.
+It will not work after the initial creation of the #ClutterModel.
-If you want the transformed allocation, see
-clutter_actor_get_abs_allocation_vertices() instead.
+Since: 0.6
-<note>When the actor (or one of its ancestors) is rotated around the
-X or Y axis, it no longer appears as on the stage as a rectangle, but
-as a generic quadrangle; in that case this function returns the size
-of the smallest rectangle that encapsulates the entire quad. Please
-note that in this case no assumptions can be made about the relative
-position of this envelope to the absolute position of the actor, as
-returned by clutter_actor_get_transformed_position(); if you need this
-information, you need to use clutter_actor_get_abs_allocation_vertices()
-to get the coords of the actual quadrangle.</note>
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> a #ClutterModel
+</parameter_description>
+</parameter>
+<parameter name="n_columns">
+<parameter_description> number of columns for the model
+</parameter_description>
+</parameter>
+<parameter name="types">
+<parameter_description> an array of #GType types
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 0.8
+<function name="clutter_offscreen_effect_create_texture">
+<description>
+Calls the create_texture() virtual function of the @effect
+
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> return location for the width, or %NULL
+<parameter_description> the minimum width of the target texture
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> return location for the height, or %NULL
+<parameter_description> the minimum height of the target texture
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a handle to a Cogl texture, or
+%COGL_INVALID_HANDLE. The returned handle has its reference
+count increased.
+
+</return>
</function>
-<function name="clutter_behaviour_get_actors">
+<function name="clutter_offscreen_effect_get_target">
<description>
-Retrieves all the actors to which @behave applies. It is not recommended
-for derived classes to use this in there alpha notify method but use
-#clutter_behaviour_actors_foreach as it avoids alot of needless allocations.
+Retrieves the material used as a render target for the offscreen
+buffer created by @effect
-Since: 0.2
+You should only use the returned #CoglMaterial when painting. The
+returned material might change between different frames.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
</parameter_description>
</parameter>
</parameters>
-<return> a list of
-actors. You should free the returned list with g_slist_free() when
-finished using it.
+<return> a #CoglMaterial or %NULL. The
+returned material is owned by Clutter and it should not be
+modified or freed
</return>
</function>
-<function name="clutter_threads_set_lock_functions">
+<function name="clutter_offscreen_effect_get_target_rect">
<description>
-Allows the application to replace the standard method that
-Clutter uses to protect its data structures. Normally, Clutter
-creates a single #GMutex that is locked by clutter_threads_enter(),
-and released by clutter_threads_leave(); using this function an
-application provides, instead, a function @enter_fn that is
-called by clutter_threads_enter() and a function @leave_fn that is
-called by clutter_threads_leave().
+Retrieves the origin and size of the offscreen buffer used by @effect to
+paint the actor to which it has been applied.
-The functions must provide at least same locking functionality
-as the default implementation, but can also do extra application
-specific processing.
+This function should only be called by #ClutterOffscreenEffect
+implementations, from within the <function>paint_target()</function>
+virtual function.
-As an example, consider an application that has its own recursive
-lock that when held, holds the Clutter lock as well. When Clutter
-unlocks the Clutter lock when entering a recursive main loop, the
-application must temporarily release its lock as well.
+Since: 1.14
-Most threaded Clutter apps won't need to use this method.
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> return location for the target area
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the offscreen buffer has a valid rectangle,
+and %FALSE otherwise
-This method must be called before clutter_threads_init(), and cannot
-be called multiple times.
+</return>
+</function>
-Since: 0.4
+<function name="clutter_offscreen_effect_get_target_size">
+<description>
+Retrieves the size of the offscreen buffer used by @effect to
+paint the actor to which it has been applied.
+
+This function should only be called by #ClutterOffscreenEffect
+implementations, from within the <function>paint_target()</function>
+virtual function.
+
+Since: 1.8
+
+Deprecated: 1.14: Use clutter_offscreen_effect_get_target_rect() instead
</description>
<parameters>
-<parameter name="enter_fn">
-<parameter_description> function called when aquiring the Clutter main lock
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
</parameter_description>
</parameter>
-<parameter name="leave_fn">
-<parameter_description> function called when releasing the Clutter main lock
+<parameter name="width">
+<parameter_description> return location for the target width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the target height, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the offscreen buffer has a valid size,
+and %FALSE otherwise
+
+</return>
</function>
-<function name="clutter_texture_set_cogl_material">
+<function name="clutter_offscreen_effect_get_texture">
<description>
-Replaces the underlying Cogl material drawn by this actor with
- cogl_material A reference to the material is taken so if the
-handle is no longer needed it should be deref'd with
-cogl_handle_unref. Texture data is attached to the material so
-calling this function also replaces the Cogl
-texture. #ClutterTexture requires that the material have a texture
-layer so you should set one on the material before calling this
-function.
+Retrieves the texture used as a render target for the offscreen
+buffer created by @effect
-Since: 0.8
+You should only use the returned texture when painting. The texture
+may change after ClutterEffect::pre_paint is called so the effect
+implementation should update any references to the texture after
+chaining-up to the parent's pre_paint implementation. This can be
+used instead of clutter_offscreen_effect_get_target() when the
+effect subclass wants to paint using its own material.
+Since: 1.10
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
</parameter_description>
</parameter>
-<parameter name="cogl_material">
-<parameter_description> A CoglHandle for a material
+</parameters>
+<return> a #CoglHandle or %COGL_INVALID_HANDLE. The
+returned texture is owned by Clutter and it should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="clutter_offscreen_effect_paint_target">
+<description>
+Calls the paint_target() virtual function of the @effect
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterOffscreenEffect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_enable_xinput">
+<function name="clutter_page_turn_effect_get_angle">
<description>
-Enables the use of the XInput extension if present on connected
-XServer and support built into Clutter. XInput allows for multiple
-pointing devices to be used.
+Retrieves the value set using clutter_page_turn_effect_get_angle()
-This function must be called before clutter_init().
+Since: 1.4
-Since XInput might not be supported by the X server, you might
-want to use clutter_x11_has_xinput() to see if support was enabled.
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterPageTurnEffect:
+</parameter_description>
+</parameter>
+</parameters>
+<return> the angle of the page curling
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_page_turn_effect_get_period">
+<description>
+Retrieves the value set using clutter_page_turn_effect_get_period()
+
+Since: 1.4
</description>
<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterPageTurnEffect
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> the period of the page curling
+
+</return>
</function>
-<function name="clutter_event_copy">
+<function name="clutter_page_turn_effect_get_radius">
<description>
-Copies @event.
+Retrieves the value set using clutter_page_turn_effect_set_radius()
+Since: 1.4
</description>
<parameters>
-<parameter name="event">
-<parameter_description> A #ClutterEvent.
+<parameter name="effect">
+<parameter_description> a #ClutterPageTurnEffect
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #ClutterEvent
+<return> the radius of the page curling
+
</return>
</function>
-<function name="clutter_actor_is_rotated">
+<function name="clutter_page_turn_effect_new">
<description>
-Checks whether any rotation is applied to the actor.
+Creates a new #ClutterPageTurnEffect instance with the given parameters
-Since: 0.6
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="period">
+<parameter_description> the period of the page curl, between 0.0 and 1.0
+</parameter_description>
+</parameter>
+<parameter name="angle">
+<parameter_description> the angle of the page curl, between 0.0 and 360.0
+</parameter_description>
+</parameter>
+<parameter name="radius">
+<parameter_description> the radius of the page curl, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is rotated.
+<return> the newly created #ClutterPageTurnEffect
</return>
</function>
-<function name="clutter_actor_get_scale">
+<function name="clutter_page_turn_effect_set_angle">
<description>
-Retrieves an actors scale factors.
+Sets the angle of the page curling, in degrees
-Since: 0.2
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="effect">
+<parameter_description> #ClutterPageTurnEffect
</parameter_description>
</parameter>
-<parameter name="scale_x">
-<parameter_description> Location to store horizonal
-scale factor, or %NULL.
+<parameter name="angle">
+<parameter_description> the angle of the page curl, in degrees
</parameter_description>
</parameter>
-<parameter name="scale_y">
-<parameter_description> Location to store vertical
-scale factor, or %NULL.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_page_turn_effect_set_period">
+<description>
+Sets the period of the page curling, between 0.0 (no curling)
+and 1.0 (fully curled)
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterPageTurnEffect
+</parameter_description>
+</parameter>
+<parameter name="period">
+<parameter_description> the period of the page curl, between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_request_mode">
+<function name="clutter_page_turn_effect_set_radius">
<description>
-Sets the geometry request mode of @self.
+Sets the radius of the page curling
-The @mode determines the order for invoking
-clutter_actor_get_preferred_width() and
-clutter_actor_get_preferred_height()
+Since: 1.4
-Since: 1.2
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterPageTurnEffect:
+</parameter_description>
+</parameter>
+<parameter name="radius">
+<parameter_description> the radius of the page curling, in pixels
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_node_add_child">
+<description>
+Adds @child to the list of children of @node.
+
+This function will acquire a reference on @child.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> the request mode
+<parameter name="child">
+<parameter_description> the child #ClutterPaintNode to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_rectangle_get_color">
+<function name="clutter_paint_node_add_path">
<description>
-Retrieves the color of @rectangle.
+Adds a region described as a path to the @node.
+
+This function acquires a reference on the passed @path, so it
+is safe to call cogl_object_unref() when it returns.
+
+Since: 1.10
+Stability: unstable
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="path">
+<parameter_description> a Cogl path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_clone">
+<function name="clutter_paint_node_add_primitive">
<description>
-Creates a copy of @interval.
+Adds a region described by a Cogl primitive to the @node.
-Since: 1.0
+This function acquires a reference on @primitive, so it is safe
+to call cogl_object_unref() when it returns.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
+</parameter_description>
+</parameter>
+<parameter name="primitive">
+<parameter_description> a Cogl primitive
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterInterval
+<return></return>
+</function>
+
+<function name="clutter_paint_node_add_rectangle">
+<description>
+Adds a rectangle region to the @node, as described by the
+passed @rect.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_node_add_texture_rectangle">
+<description>
+Adds a rectangle region to the @node, with texture coordinates.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> a #ClutterActorBox
+</parameter_description>
+</parameter>
+<parameter name="x_1">
+<parameter_description> the left X coordinate of the texture
+</parameter_description>
+</parameter>
+<parameter name="y_1">
+<parameter_description> the top Y coordinate of the texture
+</parameter_description>
+</parameter>
+<parameter name="x_2">
+<parameter_description> the right X coordinate of the texture
+</parameter_description>
+</parameter>
+<parameter name="y_2">
+<parameter_description> the bottom Y coordinate of the texture
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_node_get_first_child">
+<description>
+Retrieves the first child of the @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the first child of
+the #ClutterPaintNode.
</return>
</function>
-<function name="clutter_box_layout_get_pack_start">
+<function name="clutter_paint_node_get_last_child">
<description>
-Retrieves the value set using clutter_box_layout_set_pack_start()
+Retrieves the last child of @node.
-Since: 1.2
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterBoxLayout should pack children
-at the beginning of the layout, and %FALSE otherwise
+<return> a pointer to the last child
+of a #ClutterPaintNode
</return>
</function>
-<function name="cogl_pango_render_layout_subpixel">
+<function name="clutter_paint_node_get_n_children">
<description>
-FIXME
+Retrieves the number of children of @node.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> FIXME
+</parameters>
+<return> the number of children of a #ClutterPaintNode
+
+</return>
+</function>
+
+<function name="clutter_paint_node_get_next_sibling">
+<description>
+Retrieves the next sibling of @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> FIXME
+</parameters>
+<return> a pointer to the next sibling
+of a #ClutterPaintNode
+
+</return>
+</function>
+
+<function name="clutter_paint_node_get_parent">
+<description>
+Retrieves the parent of @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> color to use when rendering the layout
+</parameters>
+<return> a pointer to the parent of
+a #ClutterPaintNode
+
+</return>
+</function>
+
+<function name="clutter_paint_node_get_previous_sibling">
+<description>
+Retrieves the previous sibling of @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags to pass to the renderer
+</parameters>
+<return> a pointer to the previous sibling
+of the #ClutterPaintNode.
+
+</return>
+</function>
+
+<function name="clutter_paint_node_ref">
+<description>
+Acquires a reference on @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #ClutterPaintNode
+
+</return>
+</function>
+
+<function name="clutter_paint_node_remove_all">
+<description>
+Removes all children of @node.
+
+This function releases the reference acquired by @node on its
+children.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="cogl_pango_render_layout">
+<function name="clutter_paint_node_remove_child">
<description>
-Renders @layout.
+Removes @child from the list of children of @node.
-Since: 1.0
+This function will release the reference on @child acquired by
+using clutter_paint_node_add_child().
+
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate to render the layout at
+<parameter name="child">
+<parameter_description> the #ClutterPaintNode to remove
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate to render the layout at
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_node_replace_child">
+<description>
+Atomically replaces @old_child with @new_child in the list of
+children of @node.
+
+This function will release the reference on @old_child acquired
+by @node, and will acquire a new reference on @new_child.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> color to use when rendering the layout
+<parameter name="old_child">
+<parameter_description> the child replaced by @new_child
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags to pass to the renderer
+<parameter name="new_child">
+<parameter_description> the child that replaces @old_child
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_script_add_search_paths">
+<function name="clutter_paint_node_set_name">
<description>
-Adds @paths to the list of search paths held by @script.
+Sets a user-readable @name for @node.
-The search paths are used by clutter_script_lookup_filename(), which
-can be used to define search paths for the textures source file name
-or other custom, file-based properties.
+The @name will be used for debugging purposes.
-Since: 0.8
+The @node will copy the passed string.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
-<parameter name="paths">
-<parameter_description> an array of strings containing different search paths
+<parameter name="name">
+<parameter_description> a string annotating the @node
</parameter_description>
</parameter>
-<parameter name="n_paths">
-<parameter_description> the length of the passed array
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_node_unref">
+<description>
+Releases a reference on @node.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_get_row">
+<function name="clutter_paint_volume_copy">
<description>
-Retrieves the position of the row that the @iter points to.
+Copies @pv into a new #ClutterPaintVolume
-Since: 0.6
+Since: 1.6
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
</parameters>
-<return> the position of the @iter in the model
+<return> a newly allocated copy of a #ClutterPaintVolume
</return>
</function>
-<function name="clutter_value_set_color">
+<function name="clutter_paint_volume_free">
<description>
-Sets @value to @color.
+Frees the resources allocated by @pv
-Since: 0.8.4
+Since: 1.6
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue initialized to #CLUTTER_TYPE_COLOR
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to set
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_volume_get_depth">
+<description>
+Retrieves the depth of the volume's, axis aligned, bounding box.
+
+In other words; this takes into account what actor's coordinate
+space @pv belongs too and conceptually fits an axis aligned box
+around the volume. It returns the size of that bounding box as
+measured along the z-axis.
+
+<note><para>If, for example, clutter_actor_get_transformed_paint_volume()
+is used to transform a 2D child actor that is 100px wide, 100px
+high and 0px deep into container coordinates then the depth might
+not simply be 0px if the child actor has a 3D rotation applied to
+it.</para>
+<para>Remember; after clutter_actor_get_transformed_paint_volume() is
+used then the transformed volume will be defined relative to the
+container actor and in container coordinates a 2D child actor
+can have a 3D bounding volume.</para></note>
+
+<note>There are no accuracy guarantees for the reported depth,
+except that it must always be >= to the true depth. This is
+because actors may report simple, loose fitting paint-volumes
+for efficiency.</note>
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
+</parameter_description>
+</parameter>
+</parameters>
+<return> the depth, in units of @pv's local coordinate system.
+
+</return>
+</function>
+
+<function name="clutter_paint_volume_get_height">
+<description>
+Retrieves the height of the volume's, axis aligned, bounding box.
+
+In other words; this takes into account what actor's coordinate
+space @pv belongs too and conceptually fits an axis aligned box
+around the volume. It returns the size of that bounding box as
+measured along the y-axis.
+
+<note><para>If, for example, clutter_actor_get_transformed_paint_volume()
+is used to transform a 2D child actor that is 100px wide, 100px
+high and 0px deep into container coordinates then the height might
+not simply be 100px if the child actor has a 3D rotation applied to
+it.</para>
+<para>Remember; after clutter_actor_get_transformed_paint_volume() is
+used then a transformed child volume will be defined relative to the
+ancestor container actor and so a 2D child actor
+can have a 3D bounding volume.</para></note>
+
+<note>There are no accuracy guarantees for the reported height,
+except that it must always be >= to the true height. This is
+because actors may report simple, loose fitting paint-volumes
+for efficiency</note>
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
+</parameter_description>
+</parameter>
+</parameters>
+<return> the height, in units of @pv's local coordinate system.
+
+</return>
+</function>
+
+<function name="clutter_paint_volume_get_origin">
+<description>
+Retrieves the origin of the #ClutterPaintVolume.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
+</parameter_description>
+</parameter>
+<parameter name="vertex">
+<parameter_description> the return location for a #ClutterVertex
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_add_marker_at_time">
+<function name="clutter_paint_volume_get_width">
<description>
-Adds a named marker that will be hit when the timeline has been
-running for @msecs milliseconds. Markers are unique string
-identifiers for a given time. Once @timeline reaches
- msecs, it will emit a ::marker-reached signal for each marker
-attached to that time.
+Retrieves the width of the volume's, axis aligned, bounding box.
-A marker can be removed with clutter_timeline_remove_marker(). The
-timeline can be advanced to a marker using
-clutter_timeline_advance_to_marker().
+In other words; this takes into account what actor's coordinate
+space @pv belongs too and conceptually fits an axis aligned box
+around the volume. It returns the size of that bounding box as
+measured along the x-axis.
-Since: 0.8
+<note><para>If, for example, clutter_actor_get_transformed_paint_volume()
+is used to transform a 2D child actor that is 100px wide, 100px
+high and 0px deep into container coordinates then the width might
+not simply be 100px if the child actor has a 3D rotation applied to
+it.</para>
+<para>Remember; after clutter_actor_get_transformed_paint_volume() is
+used then a transformed child volume will be defined relative to the
+ancestor container actor and so a 2D child actor
+can have a 3D bounding volume.</para></note>
+
+<note>There are no accuracy guarantees for the reported width,
+except that it must always be >= to the true width. This is
+because actors may report simple, loose fitting paint-volumes
+for efficiency</note>
+
+Since: 1.6
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="marker_name">
-<parameter_description> the unique name for this marker
+</parameters>
+<return> the width, in units of @pv's local coordinate system.
+
+</return>
+</function>
+
+<function name="clutter_paint_volume_set_depth">
+<description>
+Sets the depth of the paint volume. The depth is measured along
+the z axis in the actor coordinates that @pv is associated with.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> position of the marker in milliseconds
+<parameter name="depth">
+<parameter_description> the depth of the paint volume, in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_dup_member">
+<function name="clutter_paint_volume_set_from_allocation">
<description>
-Retrieves a copy of the #JsonNode containing the value of @member_name
-inside a #JsonObject
+Sets the #ClutterPaintVolume from the allocation of @actor.
-Since: 0.6
+This function should be used when overriding the
+#ClutterActorClass.get_paint_volume() by #ClutterActor sub-classes
+that do not paint outside their allocation.
+
+A typical example is:
+
+|[
+static gboolean
+my_actor_get_paint_volume (ClutterActor *self,
+ClutterPaintVolume *volume)
+{
+return clutter_paint_volume_set_from_allocation (volume, self);
+}
+]|
+
+Since: 1.6
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the JSON object member to access
+<parameter name="actor">
+<parameter_description> a #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> a copy of the node for the requested object member
-or %NULL. Use json_node_free() when done.
+<return> %TRUE if the paint volume was successfully set, and %FALSE
+otherwise
</return>
</function>
-<function name="clutter_actor_box_interpolate">
+<function name="clutter_paint_volume_set_height">
<description>
-Interpolates between @initial and @final #ClutterActorBox<!-- -->es
-using @progress
+Sets the height of the paint volume. The height is measured along
+the y axis in the actor coordinates that @pv is associated with.
-Since: 1.2
+Since: 1.6
</description>
<parameters>
-<parameter name="initial">
-<parameter_description> the initial #ClutterActorBox
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="final">
-<parameter_description> the final #ClutterActorBox
+<parameter name="height">
+<parameter_description> the height of the paint volume, in pixels
</parameter_description>
</parameter>
-<parameter name="progress">
-<parameter_description> the interpolation progress
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_paint_volume_set_origin">
+<description>
+Sets the origin of the paint volume.
+
+The origin is defined as the X, Y and Z coordinates of the top-left
+corner of an actor's paint volume, in actor coordinates.
+
+The default is origin is assumed at: (0, 0, 0)
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the interpolation
+<parameter name="origin">
+<parameter_description> a #ClutterVertex
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_remove">
+<function name="clutter_paint_volume_set_width">
<description>
-Removes the #ClutterTimeline with the given id inside @score. If
-the timeline has other timelines attached to it, those are removed
-as well.
+Sets the width of the paint volume. The width is measured along
+the x axis in the actor coordinates that @pv is associated with.
-Since: 0.6
+Since: 1.6
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="id">
-<parameter_description> the id of the timeline to remove
+<parameter name="width">
+<parameter_description> the width of the paint volume, in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_anchor_point_gravity">
+<function name="clutter_paint_volume_union">
<description>
-Retrieves the anchor position expressed as a #ClutterGravity. If
-the anchor point was specified using pixels or units this will
-return %CLUTTER_GRAVITY_NONE.
+Updates the geometry of @pv to encompass @pv and @another_pv.
-Since: 1.0
+<note>There are no guarantees about how precisely the two volumes
+will be encompassed.</note>
+
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="pv">
+<parameter_description> The first #ClutterPaintVolume and destination for resulting
+union
+</parameter_description>
+</parameter>
+<parameter name="another_pv">
+<parameter_description> A second #ClutterPaintVolume to union with @pv
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterGravity used by the anchor point
-
-</return>
+<return></return>
</function>
-<function name="clutter_clone_set_source">
+<function name="clutter_paint_volume_union_box">
<description>
-Sets @source as the source actor to be cloned by @clone.
+Unions the 2D region represented by @box to a #ClutterPaintVolume.
-Since: 1.0
+This function is similar to clutter_paint_volume_union(), but it is
+specific for 2D regions.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="clone">
-<parameter_description> a #ClutterClone
+<parameter name="pv">
+<parameter_description> a #ClutterPaintVolume
</parameter_description>
</parameter>
-<parameter name="source">
-<parameter_description> a #ClutterActor, or %NULL
+<parameter name="box">
+<parameter_description> a #ClutterActorBox to union to @pv
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_shader_get_cogl_program">
+<function name="clutter_pan_action_get_acceleration_factor">
<description>
-Retrieves the underlying #CoglHandle for the shader program.
+Retrieves the initial acceleration factor for interpolated ::pan events.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="self">
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
</parameters>
-<return> A #CoglHandle for the shader program, or %NULL
+<return> The initial acceleration factor for interpolated events.
</return>
</function>
-<function name="clutter_actor_get_height">
+<function name="clutter_pan_action_get_deceleration">
<description>
-Retrieves the height of a #ClutterActor.
+Retrieves the deceleration rate of interpolated ::pan events.
-If the actor has a valid allocation, this function will return the
-height of the allocated area given to the actor.
+Since: 1.12
-If the actor does not have a valid allocation, this function will
-return the actor's natural height, that is the preferred height of
-the actor.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterPanAction
+</parameter_description>
+</parameter>
+</parameters>
+<return> The deceleration rate of the interpolated events.
-If you care whether you get the preferred height or the height that
-has been assigned to the actor, you should probably call a different
-function like clutter_actor_get_allocation_box() to retrieve the
-allocated size or clutter_actor_get_preferred_height() to retrieve the
-preferred height.
+</return>
+</function>
-If an actor has a fixed height, for instance a height that has been
-assigned using clutter_actor_set_height(), the height returned will
-be the same value.
+<function name="clutter_pan_action_get_interpolate">
+<description>
+Checks if the action should emit ::pan events even after releasing
+the pointer during a panning gesture, to emulate some kind of
+kinetic inertia.
+Since: 1.12
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterPanAction
</parameter_description>
</parameter>
</parameters>
-<return> the height of the actor, in pixels
+<return> %TRUE if interpolated events emission is active.
+
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_tilt">
+<function name="clutter_pan_action_get_interpolated_coords">
<description>
-Gets the tilt of the ellipse around the center in Y axis.
+Retrieves the coordinates, in stage space, of the latest interpolated
+event, analogous to clutter_gesture_action_get_motion_coords().
-Since: 0.4
+Since: 1.12
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
-<parameter name="angle_tilt_x">
-<parameter_description> return location for tilt angle on the X axis, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="angle_tilt_y">
-<parameter_description> return location for tilt angle on the Y axis, or %NULL.
+<parameter name="interpolated_x">
+<parameter_description> return location for the latest
+interpolated event's X coordinate
</parameter_description>
</parameter>
-<parameter name="angle_tilt_z">
-<parameter_description> return location for tilt angle on the Z axis, or %NULL.
+<parameter name="interpolated_y">
+<parameter_description> return location for the latest
+interpolated event's Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_add_idle">
+<function name="clutter_pan_action_get_interpolated_delta">
<description>
-Simple wrapper around clutter_threads_add_idle_full() using the
-default priority.
+Retrieves the delta, in stage space, since the latest interpolated
+event, analogous to clutter_gesture_action_get_motion_delta().
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="func">
-<parameter_description> function to call
+<parameter name="self">
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="delta_x">
+<parameter_description> return location for the X delta since
+the latest interpolated event
+</parameter_description>
+</parameter>
+<parameter name="delta_y">
+<parameter_description> return location for the Y delta since
+the latest interpolated event
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> the distance since the latest interpolated event
</return>
</function>
-<function name="clutter_actor_get_position">
+<function name="clutter_pan_action_get_motion_coords">
<description>
-This function tries to "do what you mean" and tell you where the
-actor is, prior to any transformations. Retrieves the fixed
-position of an actor in pixels, if one has been set; otherwise, if
-the allocation is valid, returns the actor's allocated position;
-otherwise, returns 0,0.
+Retrieves the coordinates, in stage space, dependent on the current state
+of the #ClutterPanAction. If it is inactive, both fields will be
+set to 0. If it is panning by user action, the values will be equivalent
+to those returned by clutter_gesture_action_get_motion_coords().
+If it is interpolating with some form of kinetic scrolling, the values
+will be equivalent to those returned by
+clutter_pan_action_get_interpolated_coords(). This is a convenience
+method designed to be used in replacement "pan" signal handlers.
-The returned position is in pixels.
-
-Since: 0.6
+Since: 1.14
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate, or %NULL
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate, or %NULL
+<parameter name="motion_x">
+<parameter_description> return location for the X coordinate
+</parameter_description>
+</parameter>
+<parameter name="motion_y">
+<parameter_description> return location for the Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_init">
+<function name="clutter_pan_action_get_motion_delta">
<description>
-Initialises the Clutter threading mechanism, so that Clutter API can be
-called by multiple threads, using clutter_threads_enter() and
-clutter_threads_leave() to mark the critical sections.
+Retrieves the delta, in stage space, dependent on the current state
+of the #ClutterPanAction. If it is inactive, both fields will be
+set to 0. If it is panning by user action, the values will be equivalent
+to those returned by clutter_gesture_action_get_motion_delta().
+If it is interpolating with some form of kinetic scrolling, the values
+will be equivalent to those returned by
+clutter_pan_action_get_interpolated_delta(). This is a convenience
+method designed to be used in replacement "pan" signal handlers.
-You must call g_thread_init() before this function.
+Since: 1.14
-This function must be called before clutter_init().
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> A #ClutterPanAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> the touch point index, with 0 being the first touch
+point received by the action
+</parameter_description>
+</parameter>
+<parameter name="delta_x">
+<parameter_description> return location for the X delta
+</parameter_description>
+</parameter>
+<parameter name="delta_y">
+<parameter_description> return location for the Y delta
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-It is safe to call this function multiple times.
+<function name="clutter_pan_action_get_pan_axis">
+<description>
+Retrieves the axis constraint set by clutter_pan_action_set_pan_axis()
-Since: 0.4
+Since: 1.12
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterPanAction
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> the axis constraint
+
+</return>
</function>
-<function name="clutter_actor_get_allocation_box">
+<function name="clutter_pan_action_new">
<description>
-Gets the layout box an actor has been assigned. The allocation can
-only be assumed valid inside a paint() method; anywhere else, it
-may be out-of-date.
+Creates a new #ClutterPanAction instance
-An allocation does not incorporate the actor's scale or anchor point;
-those transformations do not affect layout, only rendering.
+Since: 1.12
-<note>Do not call any of the clutter_actor_get_allocation_*() family
-of functions inside the implementation of the get_preferred_width()
-or get_preferred_height() virtual functions.</note>
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterPanAction
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_pan_action_set_acceleration_factor">
+<description>
+Factor applied to the momentum velocity at the time of releasing the
+pointer when generating interpolated ::pan events.
+
+Since: 1.12
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
-<parameter name="box">
-<parameter_description> the function fills this in with the actor's allocation
+<parameter name="factor">
+<parameter_description> The acceleration factor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_foreach_element">
+<function name="clutter_pan_action_set_deceleration">
<description>
-Iterates over all elements of @array and calls @func on
-each one of them.
-
-It is safe to change the value of a #JsonNode of the @array
-from within the iterator @func, but it is not safe to add or
-remove elements from the @array.
+Sets the deceleration rate of the interpolated ::pan events generated
+after a pan gesture. This is approximately the value that the momentum
+at the time of releasing the pointer is divided by every 60th of a second.
-Since: 0.8
+Since: 1.12
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> A #ClutterPanAction
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to be called on each element
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to be passed to the function
+<parameter name="rate">
+<parameter_description> The deceleration rate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_get_sorting_column">
+<function name="clutter_pan_action_set_interpolate">
<description>
-Retrieves the number of column used for sorting the @model.
+Sets whether the action should emit interpolated ::pan events
+after the drag has ended, to emulate the gesture kinetic inertia.
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> a #ClutterPanAction
+</parameter_description>
+</parameter>
+<parameter name="should_interpolate">
+<parameter_description> whether to enable interpolated pan events
</parameter_description>
</parameter>
</parameters>
-<return> a column number, or -1 if the model is not sorted
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_paint">
+<function name="clutter_pan_action_set_pan_axis">
<description>
-Renders the actor to display.
+Restricts the panning action to a specific axis
-This function should not be called directly by applications.
-Call clutter_actor_queue_redraw() to queue paints, instead.
-
-This function will emit the #ClutterActor::paint signal.
+Since: 1.12
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterPanAction
+</parameter_description>
+</parameter>
+<parameter name="axis">
+<parameter_description> the axis to constraint the panning to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_set_description">
+<function name="clutter_param_spec_color">
<description>
-Replaces all of the nodes in the path with nodes described by
- str See clutter_path_add_string() for details of the format.
-
-If the string is invalid then %FALSE is returned and the path is
-unaltered.
+Creates a #GParamSpec for properties using #ClutterColor.
-Since: 1.0
+Since: 0.8.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> a string describing the path
+<parameter name="nick">
+<parameter_description> short name
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description (can be translatable)
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the param spec
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the path was valid, %FALSE otherwise.
+<return> the newly created #GParamSpec
</return>
</function>
-<function name="clutter_actor_set_shader_param_int">
+<function name="clutter_param_spec_fixed">
<description>
-Sets the value for a named int parameter of the shader applied to
- actor
+Creates a #GParamSpec for properties using #CoglFixed values
Since: 0.8
+Deprecated: 1.10: Use #GParamSpecInt instead.
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="param">
-<parameter_description> the name of the parameter
+<parameter name="nick">
+<parameter_description> short name
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the parameter
+<parameter name="blurb">
+<parameter_description> description (can be translatable)
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> lower boundary
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> higher boundary
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the param spec
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #GParamSpec
+
+</return>
</function>
-<function name="clutter_color_from_pixel">
+<function name="clutter_param_spec_units">
<description>
-Converts @pixel from the packed representation of a four 8 bit channel
-color to a #ClutterColor.
+Creates a #GParamSpec for properties using #ClutterUnits.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="name">
+<parameter_description> name of the property
</parameter_description>
</parameter>
-<parameter name="pixel">
-<parameter_description> a 32 bit packed integer containing a color
+<parameter name="nick">
+<parameter_description> short name
+</parameter_description>
+</parameter>
+<parameter name="blurb">
+<parameter_description> description (can be translatable)
+</parameter_description>
+</parameter>
+<parameter name="default_type">
+<parameter_description> the default type for the #ClutterUnits
+</parameter_description>
+</parameter>
+<parameter name="minimum">
+<parameter_description> lower boundary
+</parameter_description>
+</parameter>
+<parameter name="maximum">
+<parameter_description> higher boundary
+</parameter_description>
+</parameter>
+<parameter name="default_value">
+<parameter_description> default value
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags for the param spec
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #GParamSpec
+
+</return>
</function>
-<function name="clutter_model_set_sorting_column">
+<function name="clutter_path_add_cairo_path">
<description>
-Sets the model to sort by @column. If @column is a negative value
-the sorting column will be unset.
+Add the nodes of the Cairo path to the end of @path.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> the column of the @model to sort, or -1
+<parameter name="cpath">
+<parameter_description> a Cairo path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_pack_after">
+<function name="clutter_path_add_close">
<description>
-Adds @actor to @box, placing it after @sibling, and sets layout
-properties at the same time, if the #ClutterLayoutManager used by
- box supports them
+Adds a %CLUTTER_PATH_CLOSE type node to the path. This creates a
+straight line from the last node to the last %CLUTTER_PATH_MOVE_TO
+type node.
-If @sibling is %NULL then @actor is placed at the end of the
-list of children, to be allocated and painted after every other child
+Since: 1.0
-This function is a wrapper around clutter_container_add_actor(),
-clutter_container_raise_child() and clutter_layout_manager_child_set()
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.2
+<function name="clutter_path_add_curve_to">
+<description>
+Adds a %CLUTTER_PATH_CURVE_TO type node to the path. This causes
+the actor to follow a bezier from the last node to (@x_3, @y_3) using
+(@x_1, @y_1) and (@x_2,@y_2) as control points.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="x_1">
+<parameter_description> the x coordinate of the first control point
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> a #ClutterActor or %NULL
+<parameter name="y_1">
+<parameter_description> the y coordinate of the first control point
</parameter_description>
</parameter>
-<parameter name="first_property">
-<parameter_description> the name of the first property to set, or %NULL
+<parameter name="x_2">
+<parameter_description> the x coordinate of the second control point
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of property name and value pairs, terminated by %NULL
+<parameter name="y_2">
+<parameter_description> the y coordinate of the second control point
+</parameter_description>
+</parameter>
+<parameter name="x_3">
+<parameter_description> the x coordinate of the third control point
+</parameter_description>
+</parameter>
+<parameter name="y_3">
+<parameter_description> the y coordinate of the third control point
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_set_selection_color">
+<function name="clutter_path_add_line_to">
<description>
-Sets the color of the selection of a #ClutterText actor.
-
-If @color is %NULL, the selection color will be the same as the
-cursor color, or if no cursor color is set either then it will be
-the same as the text color.
+Adds a %CLUTTER_PATH_LINE_TO type node to the path. This causes the
+actor to move to the new coordinates in a straight line.
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color of the selection, or %NULL to unset it
+<parameter name="x">
+<parameter_description> the x coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_backend_get_font_options">
+<function name="clutter_path_add_move_to">
<description>
-Retrieves the font options for @backend.
+Adds a %CLUTTER_PATH_MOVE_TO type node to the path. This is usually
+used as the first node in a path. It can also be used in the middle
+of the path to cause the actor to jump to the new coordinate.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="path">
+<parameter_description> a #ClutterPath
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the font options of the #ClutterBackend.
-The returned #cairo_font_options_t is owned by the backend and should
-not be modified or freed
-
-</return>
+<return></return>
</function>
-<function name="clutter_box_layout_set_spacing">
+<function name="clutter_path_add_node">
<description>
-Sets the spacing between children of @layout
+Adds @node to the end of the path.
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> the spacing between children of the layout, in pixels
+<parameter name="node">
+<parameter_description> a #ClutterPathNode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_cairo_texture_new">
+<function name="clutter_path_add_rel_curve_to">
<description>
-Creates a new #ClutterCairoTexture actor, with a surface of @width by
- height pixels.
+Same as clutter_path_add_curve_to() except the coordinates are
+relative to the previous node.
Since: 1.0
</description>
<parameters>
-<parameter name="width">
-<parameter_description> the width of the surface
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the surface
+<parameter name="x_1">
+<parameter_description> the x coordinate of the first control point
+</parameter_description>
+</parameter>
+<parameter name="y_1">
+<parameter_description> the y coordinate of the first control point
+</parameter_description>
+</parameter>
+<parameter name="x_2">
+<parameter_description> the x coordinate of the second control point
+</parameter_description>
+</parameter>
+<parameter name="y_2">
+<parameter_description> the y coordinate of the second control point
+</parameter_description>
+</parameter>
+<parameter name="x_3">
+<parameter_description> the x coordinate of the third control point
+</parameter_description>
+</parameter>
+<parameter name="y_3">
+<parameter_description> the y coordinate of the third control point
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterCairoTexture actor
-
-</return>
+<return></return>
</function>
-<function name="clutter_model_iter_get">
+<function name="clutter_path_add_rel_line_to">
<description>
-Gets the value of one or more cells in the row referenced by @iter. The
-variable argument list should contain integer column numbers, each column
-column number followed by a place to store the value being retrieved. The
-list is terminated by a -1.
-
-For example, to get a value from column 0 with type %G_TYPE_STRING use:
-<informalexample><programlisting>
-clutter_model_iter_get (iter, 0, &place_string_here, -1);
-</programlisting></informalexample>
-
-where place_string_here is a gchar* to be filled with the string. If
-appropriate, the returned values have to be freed or unreferenced.
+Same as clutter_path_add_line_to() except the coordinates are
+relative to the previous node.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of column/return location pairs, terminated by -1
+<parameter name="x">
+<parameter_description> the x coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_angle_start">
+<function name="clutter_path_add_rel_move_to">
<description>
-Sets the angle at which movement starts; angles >= 360 degress get clamped
-to the canonical interval <0, 360).
+Same as clutter_path_add_move_to() except the coordinates are
+relative to the previous node.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="angle_start">
-<parameter_description> angle at which movement starts in degrees, between 0 and 360.
+<parameter name="x">
+<parameter_description> the x coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_appendv">
+<function name="clutter_path_add_string">
<description>
-Creates and appends a new row to the #ClutterModel, setting the row
-values for the given @columns upon creation.
+Adds new nodes to the end of the path as described in @str. The
+format is a subset of the SVG path format. Each node is represented
+by a letter and is followed by zero, one or three pairs of
+coordinates. The coordinates can be separated by spaces or a
+comma. The types are:
-Since: 0.6
+<variablelist>
+<varlistentry><term>M</term>
+<listitem><para>
+Adds a %CLUTTER_PATH_MOVE_TO node. Takes one pair of coordinates.
+</para></listitem></varlistentry>
+<varlistentry><term>L</term>
+<listitem><para>
+Adds a %CLUTTER_PATH_LINE_TO node. Takes one pair of coordinates.
+</para></listitem></varlistentry>
+<varlistentry><term>C</term>
+<listitem><para>
+Adds a %CLUTTER_PATH_CURVE_TO node. Takes three pairs of coordinates.
+</para></listitem></varlistentry>
+<varlistentry><term>z</term>
+<listitem><para>
+Adds a %CLUTTER_PATH_CLOSE node. No coordinates are needed.
+</para></listitem></varlistentry>
+</variablelist>
+
+The M, L and C commands can also be specified in lower case which
+means the coordinates are relative to the previous node.
+
+For example, to move an actor in a 100 by 100 pixel square centered
+on the point 300,300 you could use the following path:
+
+<informalexample>
+<programlisting>
+M 250,350 l 0 -100 L 350,250 l 0 100 z
+</programlisting>
+</informalexample>
+
+If the path description isn't valid %FALSE will be returned and no
+nodes will be added.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> the number of columns and values
+<parameter name="str">
+<parameter_description> a string describing the new nodes
</parameter_description>
</parameter>
-<parameter name="columns">
-<parameter_description> a vector with the columns to set
+</parameters>
+<return> %TRUE is the path description was valid or %FALSE
+otherwise.
+
+</return>
+</function>
+
+<function name="clutter_path_clear">
+<description>
+Removes all nodes from the path.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector with the values
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_path_constraint_get_offset">
+<description>
+Retrieves the offset along the #ClutterPath used by @constraint.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterPathConstraint
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the offset
+
+</return>
</function>
-<function name="clutter_actor_move_by">
+<function name="clutter_path_constraint_get_path">
<description>
-Moves an actor by the specified distance relative to its current
-position in pixels.
+Retrieves a pointer to the #ClutterPath used by @constraint.
-This function modifies the fixed position of an actor and thus removes
-it from any layout management. Another way to move an actor is with an
-anchor point, see clutter_actor_set_anchor_point().
+Since: 1.6
-Since: 0.2
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterPathConstraint
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #ClutterPath used by the
+#ClutterPathConstraint, or %NULL. The returned #ClutterPath is owned
+by the constraint and it should not be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_path_constraint_new">
+<description>
+Creates a new #ClutterPathConstraint with the given @path and @offset
+
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="path">
+<parameter_description> a #ClutterPath, or %NULL
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> Distance to move Actor on X axis.
+<parameter name="offset">
+<parameter_description> the offset along the #ClutterPath
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> Distance to move Actor on Y axis.
+</parameters>
+<return> the newly created #ClutterPathConstraint
+
+</return>
+</function>
+
+<function name="clutter_path_constraint_set_offset">
+<description>
+Sets the offset along the #ClutterPath used by @constraint.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterPathConstraint
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> the offset along the path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_set_attributes">
+<function name="clutter_path_constraint_set_path">
<description>
-Sets the attributes list that are going to be applied to the
-#ClutterText contents.
+Sets the @path to be followed by the #ClutterPathConstraint.
-The #ClutterText actor will take a reference on the #PangoAttrList
-passed to this function.
+The @constraint will take ownership of the #ClutterPath passed to this
+function.
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="constraint">
+<parameter_description> a #ClutterPathConstraint
</parameter_description>
</parameter>
-<parameter name="attrs">
-<parameter_description> a #PangoAttrList or %NULL to unset the attributes
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_cairo_texture_set_surface_size">
+<function name="clutter_path_foreach">
<description>
-Resizes the Cairo surface used by @self to @width and @height.
+Calls a function for each node of the path.
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterCairoTexture
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the new width of the surface
+<parameter name="callback">
+<parameter_description> the function to call with each node
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the new height of the surface
+<parameter name="user_data">
+<parameter_description> user data to pass to the function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_cairo_texture_clear">
+<function name="clutter_path_get_description">
<description>
-Clears @self's internal drawing surface, so that the next upload
-will replace the previous contents of the #ClutterCairoTexture
-rather than adding to it.
+Returns a newly allocated string describing the path in the same
+format as used by clutter_path_add_string().
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterCairoTexture
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a string description of the path. Free with g_free().
+
+</return>
</function>
-<function name="clutter_threads_add_frame_source_full">
+<function name="clutter_path_get_length">
<description>
-Sets a function to be called at regular intervals holding the Clutter
-threads lock, with the given priority. The function is called repeatedly
-until it returns %FALSE, at which point the timeout is automatically
-removed and the function will not be called again. The @notify function
-is called when the timeout is removed.
+Retrieves an approximation of the total length of the path.
-This function is similar to clutter_threads_add_timeout_full()
-except that it will try to compensate for delays. For example, if
- func takes half the interval time to execute then the function
-will be called again half the interval time after it finished. In
-contrast clutter_threads_add_timeout_full() would not fire until a
-full interval after the function completes so the delay between
-calls would be @interval * 1.5. This function does not however try
-to invoke the function multiple times to catch up missing frames if
- func takes more than @interval ms to execute.
+Since: 1.0
-See also clutter_threads_add_idle_full().
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
+</parameter_description>
+</parameter>
+</parameters>
+<return> the length of the path.
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_path_get_n_nodes">
+<description>
+Retrieves the number of nodes in the path.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the frame source. Typically this will be in the
-range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="fps">
-<parameter_description> the number of times per second to call the function
+</parameters>
+<return> the number of nodes.
+
+</return>
+</function>
+
+<function name="clutter_path_get_node">
+<description>
+Retrieves the node of the path indexed by @index.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+<parameter name="index_">
+<parameter_description> the node number to retrieve
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="node">
+<parameter_description> a location to store a copy of the node
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout source is removed
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_path_get_nodes">
+<description>
+Returns a #GSList of #ClutterPathNode<!-- -->s. The list should be
+freed with g_slist_free(). The nodes are owned by the path and
+should not be freed. Altering the path may cause the nodes in the
+list to become invalid so you should copy them if you want to keep
+the list.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> a
+list of nodes in the path.
</return>
</function>
-<function name="clutter_behaviour_scale_new">
+<function name="clutter_path_get_position">
<description>
-Creates a new #ClutterBehaviourScale instance.
+The value in @progress represents a position along the path where
+0.0 is the beginning and 1.0 is the end of the path. An
+interpolated position is then stored in @position.
-Since: 0.2
+Since: 1.0
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="x_scale_start">
-<parameter_description> initial scale factor on the X axis
+<parameter name="progress">
+<parameter_description> a position along the path as a fraction of its length
</parameter_description>
</parameter>
-<parameter name="y_scale_start">
-<parameter_description> initial scale factor on the Y axis
+<parameter name="position">
+<parameter_description> location to store the position
</parameter_description>
</parameter>
-<parameter name="x_scale_end">
-<parameter_description> final scale factor on the X axis
+</parameters>
+<return> index of the node used to calculate the position.
+
+</return>
+</function>
+
+<function name="clutter_path_insert_node">
+<description>
+Inserts @node into the path before the node at the given offset. If
+ index_ is negative it will append the node to the end of the path.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="y_scale_end">
-<parameter_description> final scale factor on the Y axis
+<parameter name="index_">
+<parameter_description> offset of where to insert the node
+</parameter_description>
+</parameter>
+<parameter name="node">
+<parameter_description> the node to insert
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterBehaviourScale
+<return></return>
+</function>
+
+<function name="clutter_path_new">
+<description>
+Creates a new #ClutterPath instance with no nodes.
+
+The object has a floating reference so if you add it to a
+#ClutterBehaviourPath then you do not need to unref it.
+
+Since: 1.0
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterPath
</return>
</function>
-<function name="clutter_animation_set_alpha">
+<function name="clutter_path_new_with_description">
<description>
-Sets @alpha as the #ClutterAlpha used by @animation.
+Creates a new #ClutterPath instance with the nodes described in
+ desc See clutter_path_add_string() for details of the format of
+the string.
-If @alpha is not %NULL, the #ClutterAnimation will take ownership
-of the #ClutterAlpha instance.
+The object has a floating reference so if you add it to a
+#ClutterBehaviourPath then you do not need to unref it.
Since: 1.0
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="desc">
+<parameter_description> a string describing the path
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha, or %NULL to unset the current #ClutterAlpha
+</parameters>
+<return> the newly created #ClutterPath
+
+</return>
+</function>
+
+<function name="clutter_path_node_copy">
+<description>
+Makes an allocated copy of a node.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPathNode
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the copied node.
+
+</return>
</function>
-<function name="clutter_stage_manager_get_default">
+<function name="clutter_path_node_equal">
<description>
-Returns the default #ClutterStageManager.
+Compares two nodes and checks if they are the same type with the
+same coordinates.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
+<parameter name="node_a">
+<parameter_description> First node
+</parameter_description>
+</parameter>
+<parameter name="node_b">
+<parameter_description> Second node
+</parameter_description>
+</parameter>
</parameters>
-<return> the default stage manager instance. The returned
-object is owned by Clutter and you should not reference or unreference it.
+<return> %TRUE if the nodes are the same.
</return>
</function>
-<function name="clutter_behaviour_set_alpha">
+<function name="clutter_path_node_free">
<description>
-Binds @alpha to a #ClutterBehaviour. The #ClutterAlpha object
-is what makes a behaviour work: for each tick of the timeline
-used by #ClutterAlpha a new value of the alpha parameter is
-computed by the alpha function; the value should be used by
-the #ClutterBehaviour to update one or more properties of the
-actors to which the behaviour applies.
+Frees the memory of an allocated node.
-If @alpha is not %NULL, the #ClutterBehaviour will take ownership
-of the #ClutterAlpha instance.
+Since: 1.0
-Since: 0.2
+</description>
+<parameters>
+<parameter name="node">
+<parameter_description> a #ClutterPathNode
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_path_remove_node">
+<description>
+Removes the node at the given offset from the path.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha or %NULL to unset a previously set alpha
+<parameter name="index_">
+<parameter_description> index of the node to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_set_mode">
+<function name="clutter_path_replace_node">
<description>
-Sets the progress function of @alpha using the symbolic value
-of @mode, as taken by the #ClutterAnimationMode enumeration or
-using the value returned by clutter_alpha_register_func().
+Replaces the node at offset @index_ with @node.
Since: 1.0
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> a #ClutterAnimationMode
+<parameter name="index_">
+<parameter_description> index to the existing node
+</parameter_description>
+</parameter>
+<parameter name="node">
+<parameter_description> the replacement node
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_get_array_element">
+<function name="clutter_path_set_description">
<description>
-Conveniently retrieves the array from the element at @index_
-inside @array
+Replaces all of the nodes in the path with nodes described by
+ str See clutter_path_add_string() for details of the format.
-See also: json_array_get_element(), json_node_get_array()
+If the string is invalid then %FALSE is returned and the path is
+unaltered.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="path">
+<parameter_description> a #ClutterPath
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="str">
+<parameter_description> a string describing the path
</parameter_description>
</parameter>
</parameters>
-<return> the array
+<return> %TRUE is the path was valid, %FALSE otherwise.
</return>
</function>
-<function name="clutter_stage_get_user_resizable">
+<function name="clutter_path_to_cairo_path">
<description>
-Retrieves the value set with clutter_stage_set_user_resizable().
+Add the nodes of the ClutterPath to the path in the Cairo context.
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="path">
+<parameter_description> a #ClutterPath
+</parameter_description>
+</parameter>
+<parameter name="cr">
+<parameter_description> a Cairo context
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the stage is resizable by the user.
-
-</return>
+<return></return>
</function>
-<function name="clutter_box_layout_get_expand">
+<function name="clutter_pipeline_node_new">
<description>
-Retrieves whether @actor should expand inside @layout
+Creates a new #ClutterPaintNode that will use the @pipeline to
+paint its contents.
-Since: 1.2
+This function will acquire a reference on the passed @pipeline,
+so it is safe to call cogl_object_unref() when it returns.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
-</parameter_description>
-</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @layout
+<parameter name="pipeline">
+<parameter_description> a Cogl pipeline state object, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterActor should expand, %FALSE otherwise
+<return> the newly created #ClutterPaintNode.
+Use clutter_paint_node_unref() when done.
</return>
</function>
-<function name="clutter_get_debug_enabled">
+<function name="clutter_point_alloc">
<description>
-Check if clutter has debugging turned on.
+Allocates a new #ClutterPoint.
+Since: 1.12
</description>
<parameters>
</parameters>
-<return> TRUE if debugging is turned on, FALSE otherwise.
+<return> the newly allocated #ClutterPoint.
+Use clutter_point_free() to free its resources.
+
</return>
</function>
-<function name="clutter_behaviour_rotate_get_direction">
+<function name="clutter_point_copy">
<description>
-Retrieves the #ClutterRotateDirection used by the rotate behaviour.
+Creates a new #ClutterPoint with the same coordinates of @point.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="point">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
</parameters>
-<return> the rotation direction
+<return> a newly allocated #ClutterPoint.
+Use clutter_point_free() to free its resources.
</return>
</function>
-<function name="clutter_score_remove_all">
+<function name="clutter_point_distance">
<description>
-Removes all the timelines inside @score.
+Computes the distance between two #ClutterPoint.
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="score">
-<parameter_description> a #ClutterScore
+<parameter name="a">
+<parameter_description> a #ClutterPoint
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #ClutterPoint
+</parameter_description>
+</parameter>
+<parameter name="x_distance">
+<parameter_description> return location for the horizontal
+distance between the points
+</parameter_description>
+</parameter>
+<parameter name="y_distance">
+<parameter_description> return location for the vertical
+distance between the points
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the distance between the points.
+
+</return>
</function>
-<function name="clutter_behaviour_ellipse_set_direction">
+<function name="clutter_point_equals">
<description>
-Sets the rotation direction used by the ellipse behaviour.
+Compares two #ClutterPoint for equality.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="a">
+<parameter_description> the first #ClutterPoint to compare
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> the rotation direction
+<parameter name="b">
+<parameter_description> the second #ClutterPoint to compare
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the #ClutterPoints are equal
+
+</return>
</function>
-<function name="clutter_text_get_cursor_color">
+<function name="clutter_point_free">
<description>
-Retrieves the color of the cursor of a #ClutterText actor.
+Frees the resources allocated for @point.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> return location for a #ClutterColor
+<parameter name="point">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_texture_pixmap_new_with_window">
+<function name="clutter_point_init">
<description>
-Creates a new #ClutterX11TexturePixmap for @window
+Initializes @point with the given coordinates.
-Since: 0.8
+Since: 1.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> the X window to which this texture should be bound
+<parameter name="point">
+<parameter_description> a #ClutterPoint
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the X coordinate of the point
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the Y coordinate of the point
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterX11TexturePixmap bound to the given X window.
+<return> the initialized #ClutterPoint
</return>
</function>
-<function name="clutter_ungrab_keyboard">
+<function name="clutter_point_zero">
<description>
-Removes an existing grab of the keyboard.
+A point centered at (0, 0).
-Since: 0.6
+The returned value can be used as a guard.
+
+Since: 1.12
</description>
<parameters>
</parameters>
-<return></return>
+<return> a point centered in (0, 0); the returned #ClutterPoint
+is owned by Clutter and it should not be modified or freed.
+
+</return>
</function>
-<function name="clutter_text_get_single_line_mode">
+<function name="clutter_property_transition_get_property_name">
<description>
-Retrieves whether the #ClutterText actor is in single line mode.
+Retrieves the value of the #ClutterPropertyTransition:property-name
+property.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="transition">
+<parameter_description> a #ClutterPropertyTransition
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterText actor is in single line mode
+<return> the name of the property being animated, or %NULL if
+none is set. The returned string is owned by the @transition and
+it should not be freed.
</return>
</function>
-<function name="cogl_pango_font_map_set_use_mipmapping">
+<function name="clutter_property_transition_new">
<description>
-Sets whether the renderer for the passed font map should use
-mipmapping when rendering a #PangoLayout.
+Creates a new #ClutterPropertyTransition.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="fm">
-<parameter_description> a #CoglPangoFontMap
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> %TRUE to enable the use of mipmapping
+<parameter name="property_name">
+<parameter_description> a property of @animatable, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #ClutterPropertyTransition.
+Use g_object_unref() when done
+
+</return>
</function>
-<function name="clutter_binding_pool_block_action">
+<function name="clutter_property_transition_set_property_name">
<description>
-Blocks all the actions with name @action_name inside @pool.
+Sets the #ClutterPropertyTransition:property-name property of @transition.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="transition">
+<parameter_description> a #ClutterPropertyTransition
</parameter_description>
</parameter>
-<parameter name="action_name">
-<parameter_description> an action name
+<parameter name="property_name">
+<parameter_description> a property name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animator_key_get_object">
+<function name="clutter_rect_alloc">
<description>
-Retrieves the object a key applies to.
+Creates a new, empty #ClutterRect.
-Since: 1.2
+You can use clutter_rect_init() to initialize the returned rectangle,
+for instance:
+
+|[
+rect = clutter_rect_init (clutter_rect_alloc (), x, y, width, height);
+]|
+
+Since: 1.12
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
-</parameter_description>
-</parameter>
</parameters>
-<return> the object an animator_key exist for.
+<return> the newly allocated #ClutterRect.
+Use clutter_rect_free() to free its resources
</return>
</function>
-<function name="clutter_behaviour_rotate_set_bounds">
+<function name="clutter_rect_clamp_to_pixel">
<description>
-Sets the initial and final angles of a rotation behaviour; angles >= 360
-degrees get clamped to the canonical interval <0, 360).
+Rounds the origin of @rect downwards to the nearest integer, and rounds
+the size of @rect upwards to the nearest integer, so that @rect is
+updated to the smallest rectangle capable of fully containing the
+original, fractional rectangle.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="angle_start">
-<parameter_description> initial angle in degrees, between 0 and 360.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_rect_contains_point">
+<description>
+Checks whether @point is contained by @rect, after normalizing the
+rectangle.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="angle_end">
-<parameter_description> final angle in degrees, between 0 and 360.
+<parameter name="point">
+<parameter_description> the point to check
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the @point is contained by @rect.
+
+</return>
</function>
-<function name="clutter_cairo_texture_create">
+<function name="clutter_rect_contains_rect">
<description>
-Creates a new Cairo context for the @cairo texture. It is
-similar to using clutter_cairo_texture_create_region() with @x_offset
-and @y_offset of 0, @width equal to the @cairo texture surface width
-and @height equal to the @cairo texture surface height.
+Checks whether @a contains @b.
-<warning><para>Do not call this function within the paint virtual
-function or from a callback to the #ClutterActor::paint
-signal.</para></warning>
+The first rectangle contains the second if the union of the
+two #ClutterRect is equal to the first rectangle.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterCairoTexture
+<parameter name="a">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
-<return> a newly created Cairo context. Use cairo_destroy()
-to upload the contents of the context when done drawing
+<return> %TRUE if the first rectangle contains the second.
</return>
</function>
-<function name="clutter_animator_property_set_interpolation">
+<function name="clutter_rect_copy">
<description>
-Set the interpolation method to use, %CLUTTER_INTERPOLATION_LINEAR causes
-the values to linearly change between the values, and
-%CLUTTER_INTERPOLATION_CUBIC causes the values to smoothly change between
-the values.
+Copies @rect into a new #ClutterRect instance.
-Since: 1.2
+Since: 1.12
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+</parameters>
+<return> the newly allocate copy of @rect.
+Use clutter_rect_free() to free the associated resources
+
+</return>
+</function>
+
+<function name="clutter_rect_equals">
+<description>
+Checks whether @a and @b are equals.
+
+This function will normalize both @a and @b before comparing
+their origin and size.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of a property on object
+<parameter name="b">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="interpolation">
-<parameter_description> the #ClutterInterpolation to use
+</parameters>
+<return> %TRUE if the rectangles match in origin and size.
+
+</return>
+</function>
+
+<function name="clutter_rect_free">
+<description>
+Frees the resources allocated by @rect.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_add_close">
+<function name="clutter_rect_get_center">
<description>
-Adds a %CLUTTER_PATH_CLOSE type node to the path. This creates a
-straight line from the last node to the last %CLUTTER_PATH_MOVE_TO
-type node.
+Retrieves the center of @rect, after normalizing the rectangle,
+and updates @center with the correct coordinates.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="rect">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="center">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_audio_volume">
+<function name="clutter_rect_get_height">
<description>
-Retrieves the playback volume of @media.
+Retrieves the height of @rect.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
-<return> The playback volume between 0.0 and 1.0
+<return> the height of the rectangle
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_angle_start">
+<function name="clutter_rect_get_width">
<description>
-Gets the angle at which movements starts.
+Retrieves the width of @rect.
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
-<return> angle in degrees
+<return> the width of the rectangle
</return>
</function>
-<function name="clutter_texture_get_cogl_texture">
+<function name="clutter_rect_get_x">
<description>
-Retrieves the handle to the underlying COGL texture used for drawing
-the actor. No extra reference is taken so if you need to keep the
-handle then you should call cogl_handle_ref() on it.
+Retrieves the X coordinate of the origin of @rect.
-The texture handle returned is the first layer of the material
-handle used by the #ClutterTexture. If you need to access the other
-layers you should use clutter_texture_get_cogl_material() instead
-and use the #CoglMaterial API.
+Since: 1.12
-Since: 0.8
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+</parameters>
+<return> the X coordinate of the origin of the rectangle
+
+</return>
+</function>
+
+<function name="clutter_rect_get_y">
+<description>
+Retrieves the Y coordinate of the origin of @rect.
+Since: 1.12
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
-<return> COGL texture handle
+<return> the Y coordinate of the origin of the rectangle
+
</return>
</function>
-<function name="json_object_unref">
+<function name="clutter_rect_init">
<description>
-Decreases by one the reference count of a #JsonObject. If the
-reference count reaches zero, the object is destroyed and all
-its allocated resources are freed.
+Initializes a #ClutterRect with the given origin and size.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="rect">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate of the origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate of the origin
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the rectangle
+</parameter_description>
+</parameter>
+</parameters>
+<return> the updated rectangle
+
+</return>
+</function>
+
+<function name="clutter_rect_inset">
+<description>
+Normalizes the @rect and offsets its origin by the @d_x and @d_y values;
+the size is adjusted by (2 * @d_x, 2 * @d_y).
+
+If @d_x and @d_y are positive the size of the rectangle is decreased; if
+the values are negative, the size of the rectangle is increased.
+
+If the resulting rectangle has a negative width or height, the size is
+set to 0.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="d_x">
+<parameter_description> an horizontal value; a positive @d_x will create an inset rectangle,
+and a negative value will create a larger rectangle
+</parameter_description>
+</parameter>
+<parameter name="d_y">
+<parameter_description> a vertical value; a positive @d_x will create an inset rectangle,
+and a negative value will create a larger rectangle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_set_fill">
+<function name="clutter_rect_intersection">
<description>
-Sets the horizontal and vertical fill policies for @actor
-inside @layout
+Computes the intersection of @a and @b, and places it in @res, if @res
+is not %NULL.
-Since: 1.2
+This function will normalize both @a and @b prior to computing their
+intersection.
+
+This function can be used to simply check if the intersection of @a and @b
+is not empty, by using %NULL for @res.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="a">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @layout
+<parameter name="b">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
-<parameter name="x_fill">
-<parameter_description> whether @actor should fill horizontally the allocated space
+<parameter name="res">
+<parameter_description> a #ClutterRect, or %NULL
</parameter_description>
</parameter>
-<parameter name="y_fill">
-<parameter_description> whether @actor should fill vertically the allocated space
+</parameters>
+<return> %TRUE if the intersection of @a and @b is not empty
+
+</return>
+</function>
+
+<function name="clutter_rect_normalize">
+<description>
+Normalizes a #ClutterRect.
+
+A #ClutterRect is defined by the area covered by its size; this means
+that a #ClutterRect with #ClutterRect.origin in [ 0, 0 ] and a
+#ClutterRect.size of [ 10, 10 ] is equivalent to a #ClutterRect with
+#ClutterRect.origin in [ 10, 10 ] and a #ClutterRect.size of [ -10, -10 ].
+
+This function is useful to ensure that a rectangle has positive width
+and height; it will modify the passed @rect and normalize its size.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_opacity">
+<function name="clutter_rect_offset">
<description>
-Retrieves the opacity value of an actor, as set by
-clutter_actor_set_opacity().
+Offsets the origin of @rect by the given values, after normalizing
+the rectangle.
-For retrieving the absolute opacity of the actor inside a paint
-virtual function, see clutter_actor_get_paint_opacity().
+Since: 1.12
+</description>
+<parameters>
+<parameter name="rect">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="d_x">
+<parameter_description> the horizontal offset value
+</parameter_description>
+</parameter>
+<parameter name="d_y">
+<parameter_description> the vertical offset value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_rect_union">
+<description>
+Computes the smallest possible rectangle capable of fully containing
+both @a and @b, and places it into @res.
+
+This function will normalize both @a and @b prior to computing their
+union.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="a">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #ClutterRect
+</parameter_description>
+</parameter>
+<parameter name="res">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
-<return> the opacity of the actor
+<return></return>
+</function>
+
+<function name="clutter_rect_zero">
+<description>
+A #ClutterRect with #ClutterRect.origin set at (0, 0) and a size
+of 0.
+
+The returned value can be used as a guard.
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> a rectangle with origin in (0, 0) and a size of 0.
+The returned #ClutterRect is owned by Clutter and it should not
+be modified or freed.
+
</return>
</function>
-<function name="clutter_actor_get_depth">
+<function name="clutter_rectangle_get_border_color">
<description>
-Retrieves the depth of @self.
+Gets the color of the border used by @rectangle and places
+it into @color.
+Since: 0.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> the depth of the actor
-</return>
+<return></return>
</function>
-<function name="clutter_text_get_line_wrap_mode">
+<function name="clutter_rectangle_get_border_width">
<description>
-Retrieves the line wrap mode used by the #ClutterText actor.
+Gets the width (in pixels) of the border used by @rectangle
-See clutter_text_set_line_wrap_mode ().
+Since: 0.2
-Since: 1.0
+</description>
+<parameters>
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
+</parameter_description>
+</parameter>
+</parameters>
+<return> the border's width
+
+</return>
+</function>
+
+<function name="clutter_rectangle_get_color">
+<description>
+Retrieves the color of @rectangle.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> the wrap mode used by the #ClutterText
+<return></return>
+</function>
+
+<function name="clutter_rectangle_new">
+<description>
+Creates a new #ClutterActor with a rectangular shape.
+
+</description>
+<parameters>
+</parameters>
+<return> a new #ClutterActor
</return>
</function>
-<function name="clutter_actor_set_anchor_point">
+<function name="clutter_rectangle_new_with_color">
<description>
-Sets an anchor point for @self. The anchor point is a point in the
-coordinate space of an actor to which the actor position within its
-parent is relative; the default is (0, 0), i.e. the top-left corner
-of the actor.
+Creates a new #ClutterActor with a rectangular shape
+and of the given @color.
-Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="anchor_x">
-<parameter_description> X coordinate of the anchor point
+</parameters>
+<return> a new #ClutterActor
+</return>
+</function>
+
+<function name="clutter_rectangle_set_border_color">
+<description>
+Sets the color of the border used by @rectangle using @color
+
+</description>
+<parameters>
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
</parameter_description>
</parameter>
-<parameter name="anchor_y">
-<parameter_description> Y coordinate of the anchor point
+<parameter name="color">
+<parameter_description> the color of the border
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_can_seek">
+<function name="clutter_rectangle_set_border_width">
<description>
-Retrieves whether @media is seekable or not.
+Sets the width (in pixel) of the border used by @rectangle.
+A @width of 0 will unset the border.
Since: 0.2
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the border
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @media can seek, %FALSE otherwise.
+<return></return>
+</function>
+
+<function name="clutter_rectangle_set_color">
+<description>
+Sets the color of @rectangle.
+
+</description>
+<parameters>
+<parameter name="rectangle">
+<parameter_description> a #ClutterRectangle
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #ClutterColor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_redraw">
+<description>
+Forces a redraw of the entire stage. Applications should never use this
+function, but queue a redraw using clutter_actor_queue_redraw().
+
+This function should only be used by libraries integrating Clutter from
+within another toolkit.
+
+Deprecated: 1.10: Use clutter_stage_ensure_redraw() instead.
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_rotate_action_new">
+<description>
+Creates a new #ClutterRotateAction instance
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterRotateAction
</return>
</function>
-<function name="json_array_get_string_element">
+<function name="clutter_score_append">
<description>
-Conveniently retrieves the string value of the element at @index_
-inside @array
+Appends a timeline to another one existing in the score; the newly
+appended timeline will be started when @parent is complete.
-See also: json_array_get_element(), json_node_get_string()
+If @parent is %NULL, the new #ClutterTimeline will be started when
+clutter_score_start() is called.
-Since: 0.8
+#ClutterScore will take a reference on @timeline.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="score">
+<parameter_description> a #ClutterScore
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="parent">
+<parameter_description> a #ClutterTimeline in the score, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return> the string value; the returned string is owned by
-the #JsonArray and should not be modified or freed
+<return> the id of the #ClutterTimeline inside the score, or
+0 on failure. The returned id can be used with clutter_score_remove()
+or clutter_score_get_timeline().
</return>
</function>
-<function name="clutter_actor_get_name">
+<function name="clutter_score_append_at_marker">
<description>
-Retrieves the name of @self.
+Appends @timeline at the given @marker_name on the @parent
+#ClutterTimeline.
+If you want to append @timeline at the end of @parent, use
+clutter_score_append().
+
+The #ClutterScore will take a reference on @timeline.
+
+Since: 0.8
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="score">
+<parameter_description> a #ClutterScore
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> the parent #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="marker_name">
+<parameter_description> the name of the marker to use
+</parameter_description>
+</parameter>
+<parameter name="timeline">
+<parameter_description> the #ClutterTimeline to append
</parameter_description>
</parameter>
</parameters>
-<return> the name of the actor, or %NULL. The returned string is
-owned by the actor and should not be modified or freed.
+<return> the id of the #ClutterTimeline inside the score, or
+0 on failure. The returned id can be used with clutter_score_remove()
+or clutter_score_get_timeline().
+
</return>
</function>
-<function name="json_object_set_null_member">
+<function name="clutter_score_get_loop">
<description>
-Convenience function for setting a null @value of
- member_name inside @object.
+Gets whether @score is looping
-See also: json_object_set_member()
+Since: 0.6
+Deprecated: 1.8
-Since: 0.8
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> a #ClutterScore
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the score is looping
+
+</return>
+</function>
+
+<function name="clutter_score_get_timeline">
+<description>
+Retrieves the #ClutterTimeline for @id_ inside @score.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="score">
+<parameter_description> a #ClutterScore
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="id_">
+<parameter_description> the id of the timeline
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the requested timeline, or %NULL. This
+function does not increase the reference count on the returned
+#ClutterTimeline
+
+</return>
</function>
-<function name="clutter_stage_get_use_alpha">
+<function name="clutter_score_is_playing">
<description>
-Retrieves the value set using clutter_stage_set_use_alpha()
+Query state of a #ClutterScore instance.
-Since: 1.2
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="score">
+<parameter_description> A #ClutterScore
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the stage should honour the opacity and the
-alpha channel of the stage color
+<return> %TRUE if score is currently playing
</return>
</function>
-<function name="clutter_animation_new">
+<function name="clutter_score_list_timelines">
<description>
-Creates a new #ClutterAnimation instance. You should set the
-#GObject to be animated using clutter_animation_set_object(),
-set the duration with clutter_animation_set_duration() and the
-easing mode using clutter_animation_set_mode().
+Retrieves a list of all the #ClutterTimelines managed by @score.
-Use clutter_animation_bind() or clutter_animation_bind_interval()
-to define the properties to be animated. The interval and the
-animated properties can be updated at runtime.
+Since: 0.6
+Deprecated: 1.8
-The clutter_actor_animate() and relative family of functions provide
-an easy way to animate a #ClutterActor and automatically manage the
-lifetime of a #ClutterAnimation instance, so you should consider using
-those functions instead of manually creating an animation.
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> a #ClutterScore
+</parameter_description>
+</parameter>
+</parameters>
+<return> a
+#GSList containing all the timelines in the score. This function does
+not increase the reference count of the returned timelines. Use
+g_slist_free() on the returned list to deallocate its resources.
-Since: 1.0
+</return>
+</function>
+
+<function name="clutter_score_new">
+<description>
+Creates a new #ClutterScore. A #ClutterScore is an object that can
+hold multiple #ClutterTimeline<!-- -->s in a sequential order.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
</parameters>
-<return> the newly created #ClutterAnimation. Use g_object_unref()
-to release the associated resources
+<return> the newly created #ClutterScore. Use g_object_unref()
+when done.
</return>
</function>
-<function name="clutter_text_set_password_char">
+<function name="clutter_score_pause">
<description>
-Sets the character to use in place of the actual text in a
-password text actor.
+Pauses a playing score @score.
-If @wc is 0 the text will be displayed as it is entered in the
-#ClutterText actor.
+Since: 0.6
+Deprecated: 1.8
-Since: 1.0
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> a #ClutterScore
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_score_remove">
+<description>
+Removes the #ClutterTimeline with the given id inside @score. If
+the timeline has other timelines attached to it, those are removed
+as well.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="score">
+<parameter_description> a #ClutterScore
</parameter_description>
</parameter>
-<parameter name="wc">
-<parameter_description> a Unicode character, or 0 to unset the password character
+<parameter name="id_">
+<parameter_description> the id of the timeline to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_set_timeline">
+<function name="clutter_score_remove_all">
<description>
-Sets the #ClutterTimeline used by @animation.
+Removes all the timelines inside @score.
-Since: 1.0
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="score">
+<parameter_description> a #ClutterScore
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline, or %NULL to unset the
-current #ClutterTimeline
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_score_rewind">
+<description>
+Rewinds a #ClutterScore to its initial state.
+
+Since: 0.6
+Deprecated: 1.8
+
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> A #ClutterScore
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_get_interval">
+<function name="clutter_score_set_loop">
<description>
-Variable arguments wrapper for clutter_interval_get_initial_value()
-and clutter_interval_get_final_value() that avoids using the
-#GValue arguments:
+Sets whether @score should loop. A looping #ClutterScore will start
+from its initial state after the ::complete signal has been fired.
-|[
-gint a = 0, b = 0;
-clutter_interval_get_interval (interval, &a, &b);
-]|
+Since: 0.6
+Deprecated: 1.8
-This function is meant for the convenience of the C API; bindings
-should reimplement this function using the #GValue-based API.
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> a #ClutterScore
+</parameter_description>
+</parameter>
+<parameter name="loop">
+<parameter_description> %TRUE for enable looping
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.0
+<function name="clutter_score_start">
+<description>
+Starts the score.
+
+Since: 0.6
+Deprecated: 1.8
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="score">
+<parameter_description> A #ClutterScore
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> return locations for the initial and final values of
-the interval
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_score_stop">
+<description>
+Stops and rewinds a playing #ClutterScore instance.
+
+Since: 0.6
+Deprecated: 1.8
+
+</description>
+<parameters>
+<parameter name="score">
+<parameter_description> A #ClutterScore
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animator_property_set_ease_in">
+<function name="clutter_script_add_search_paths">
<description>
-Sets whether a property value is to be eased into the animation.
+Adds @paths to the list of search paths held by @script.
-Since: 1.2
+The search paths are used by clutter_script_lookup_filename(), which
+can be used to define search paths for the textures source file name
+or other custom, file-based properties.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+<parameter name="paths">
+<parameter_description> an array of strings containing
+different search paths
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of a property on object
+<parameter name="n_paths">
+<parameter_description> the length of the passed array
</parameter_description>
</parameter>
-<parameter name="ease_in">
-<parameter_description> we are going to be easing in this property
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_script_add_states">
+<description>
+Associates a #ClutterState to the #ClutterScript instance using the given
+name.
+
+The #ClutterScript instance will use @state to resolve target states when
+connecting signal handlers.
+
+The #ClutterScript instance will take a reference on the #ClutterState
+passed to this function.
+
+Since: 1.8
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> a name for the @state, or %NULL to
+set the default #ClutterState
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> a #ClutterState
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_geometry">
+<function name="clutter_script_connect_signals">
<description>
-Gets the size and position of an actor relative to its parent
-actor. This is the same as calling clutter_actor_get_position() and
-clutter_actor_get_size(). It tries to "do what you mean" and get the
-requested size and position if the actor's allocation is invalid.
+Connects all the signals defined into a UI definition file to their
+handlers.
+
+This method invokes clutter_script_connect_signals_full() internally
+and uses #GModule's introspective features (by opening the current
+module's scope) to look at the application's symbol table.
+
+Note that this function will not work if #GModule is not supported by
+the platform Clutter is running on.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="geometry">
-<parameter_description> A location to store actors #ClutterGeometry
+<parameter name="user_data">
+<parameter_description> data to be passed to the signal handlers, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_child_meta_get_container">
+<function name="clutter_script_connect_signals_full">
<description>
-Retrieves the container using @data
+Connects all the signals defined into a UI definition file to their
+handlers.
-Since: 0.8
+This function allows to control how the signal handlers are
+going to be connected to their respective signals. It is meant
+primarily for language bindings to allow resolving the function
+names using the native API, but it can also be used on platforms
+that do not support GModule.
+
+Applications should use clutter_script_connect_signals().
+
+Since: 0.6
</description>
<parameters>
-<parameter name="data">
-<parameter_description> a #ClutterChildMeta
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> signal connection function
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to be passed to the signal handlers, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterContainer
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_event">
+<function name="clutter_script_ensure_objects">
<description>
-This function is used to emit an event on the main stage.
-You should rarely need to use this function, except for
-synthetising events.
+Ensure that every object defined inside @script is correctly
+constructed. You should rarely need to use this function.
Since: 0.6
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_script_get_object">
+<description>
+Retrieves the object bound to @name. This function does not increment
+the reference count of the returned object.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="capture">
-<parameter_description> TRUE if event in in capture phase, FALSE otherwise.
+<parameter name="name">
+<parameter_description> the name of the object to retrieve
</parameter_description>
</parameter>
</parameters>
-<return> the return value from the signal emission: %TRUE
-if the actor handled the event, or %FALSE if the event was
-not handled
+<return> the named object, or %NULL if no object
+with the given name was available
</return>
</function>
-<function name="clutter_text_set_preedit_string">
+<function name="clutter_script_get_objects">
<description>
-Sets, or unsets, the pre-edit string. This function is useful
-for input methods to display a string (with eventual specific
-Pango attributes) before it is entered inside the #ClutterText
-buffer.
+Retrieves a list of objects for the given names. After @script, object
+names/return location pairs should be listed, with a %NULL pointer
+ending the list, like:
-The preedit string and attributes are ignored if the #ClutterText
-actor is not editable.
+<informalexample><programlisting>
+GObject *my_label, *a_button, *main_timeline;
-This function should not be used by applications
+clutter_script_get_objects (script,
+"my-label", &my_label,
+"a-button", &a_button,
+"main-timeline", &main_timeline,
+NULL);
+</programlisting></informalexample>
-Since: 1.2
+Note: This function does not increment the reference count of the
+returned objects.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
-</parameter_description>
-</parameter>
-<parameter name="preedit_str">
-<parameter_description> the pre-edit string, or %NULL to unset it
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="preedit_attrs">
-<parameter_description> the pre-edit string attributes
+<parameter name="first_name">
+<parameter_description> the name of the first object to retrieve
</parameter_description>
</parameter>
-<parameter name="cursor_pos">
-<parameter_description> the cursor position for the pre-edit string
+<parameter name="Varargs">
+<parameter_description> return location for a #GObject, then additional names, ending
+with %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of objects returned.
+
+</return>
</function>
-<function name="clutter_actor_get_allocation_geometry">
+<function name="clutter_script_get_states">
<description>
-Gets the layout box an actor has been assigned. The allocation can
-only be assumed valid inside a paint() method; anywhere else, it
-may be out-of-date.
+Retrieves the #ClutterState for the given @state_name.
-An allocation does not incorporate the actor's scale or anchor point;
-those transformations do not affect layout, only rendering.
+If @name is %NULL, this function will return the default
+#ClutterState instance.
-The returned rectangle is in pixels.
+Since: 1.8
-Since: 0.8
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="geom">
-<parameter_description> allocation geometry in pixels
+<parameter name="name">
+<parameter_description> the name of the #ClutterState, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the #ClutterState for the
+given name. The #ClutterState is owned by the #ClutterScript instance
+and it should not be unreferenced
+
+</return>
</function>
-<function name="clutter_actor_pop_internal">
+<function name="clutter_script_get_translation_domain">
<description>
-Disables the effects of clutter_actor_pop_internal()
+Retrieves the translation domain set using
+clutter_script_set_translation_domain().
-Since: 1.2
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the translation domain, if any is set,
+or %NULL
+
+</return>
</function>
-<function name="json_array_dup_element">
+<function name="clutter_script_get_type_from_name">
<description>
-Retrieves a copy of the #JsonNode containing the value of the
-element at @index_ inside a #JsonArray
+Looks up a type by name, using the virtual function that
+#ClutterScript has for that purpose. This function should
+rarely be used.
Since: 0.6
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="type_name">
+<parameter_description> name of the type to look up
</parameter_description>
</parameter>
</parameters>
-<return> a copy of the #JsonNode at the requested index.
-Use json_node_free() when done.
+<return> the type for the requested type name, or
+%G_TYPE_INVALID if not corresponding type was found.
</return>
</function>
-<function name="clutter_text_get_attributes">
+<function name="clutter_script_list_objects">
<description>
-Gets the attribute list that was set on the #ClutterText actor
-clutter_text_set_attributes(), if any.
+Retrieves all the objects created by @script.
-Since: 1.0
+Note: this function does not increment the reference count of the
+objects it returns.
+
+Since: 0.8.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
</parameters>
-<return> the attribute list, or %NULL if none was set. The
-returned value is owned by the #ClutterText and should not be unreferenced.
+<return> a list
+of #GObject<!-- -->s, or %NULL. The objects are owned by the
+#ClutterScript instance. Use g_list_free() on the returned list when
+done.
</return>
</function>
-<function name="json_object_get_members">
+<function name="clutter_script_load_from_data">
<description>
-Retrieves all the names of the members of a #JsonObject. You can
-obtain the value for each member using json_object_get_member().
+Loads the definitions from @data into @script and merges with
+the currently loaded ones, if any.
+Since: 0.6
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> a buffer containing the definitions
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the length of the buffer, or -1 if @data is a NUL-terminated
+buffer
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of member names. The content of the list
-is owned by the #JsonObject and should never be modified or
-freed. When you have finished using the returned list, use
-g_list_free() to free the resources it has allocated.
+<return> on error, zero is returned and @error is set
+accordingly. On success, the merge id for the UI definitions is
+returned. You can use the merge id with clutter_script_unmerge_objects().
+
</return>
</function>
-<function name="clutter_model_insert">
+<function name="clutter_script_load_from_file">
<description>
-Inserts a new row to the #ClutterModel at @row, setting the row
-values upon creation. For example, to insert a new row at index 100,
-where column 0 is type %G_TYPE_INT and column 1 is of type
-%G_TYPE_STRING:
-
-<informalexample><programlisting>
-ClutterModel *model;
-model = clutter_model_default_new (2,
-G_TYPE_INT, "Score",
-G_TYPE_STRING, "Team");
-clutter_model_insert (model, 3, 0, 42, 1, "Team #1", -1);
-</programlisting></informalexample>
+Loads the definitions from @filename into @script and merges with
+the currently loaded ones, if any.
Since: 0.6
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> the position to insert the new row
+<parameter name="filename">
+<parameter_description> the full path to the definition file
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> on error, zero is returned and @error is set
+accordingly. On success, the merge id for the UI definitions is
+returned. You can use the merge id with clutter_script_unmerge_objects().
+
+</return>
</function>
-<function name="json_array_unref">
+<function name="clutter_script_load_from_resource">
<description>
-Decreases by one the reference count of a #JsonArray. If the
-reference count reaches zero, the array is destroyed and all
-its allocated resources are freed.
+Loads the definitions from a resource file into @script and merges with
+the currently loaded ones, if any.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="resource_path">
+<parameter_description> the resource path of the file to parse
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> on error, zero is returned and @error is set
+accordingly. On success, the merge id for the UI definitions is
+returned. You can use the merge id with clutter_script_unmerge_objects().
+
+</return>
</function>
-<function name="clutter_color_shade">
+<function name="clutter_script_lookup_filename">
<description>
-Shades @color by @factor and saves the modified color into @result.
+Looks up @filename inside the search paths of @script. If @filename
+is found, its full path will be returned .
+
+Since: 0.8
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="script">
+<parameter_description> a #ClutterScript
</parameter_description>
</parameter>
-<parameter name="factor">
-<parameter_description> the shade factor to apply
+<parameter name="filename">
+<parameter_description> the name of the file to lookup
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the shaded color
+</parameters>
+<return> the full path of @filename or %NULL if no path was
+found.
+
+</return>
+</function>
+
+<function name="clutter_script_new">
+<description>
+Creates a new #ClutterScript instance. #ClutterScript can be used
+to load objects definitions for scenegraph elements, like actors,
+or behavioural elements, like behaviours and timelines. The
+definitions must be encoded using the JavaScript Object Notation (JSON)
+language.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterScript instance. Use
+g_object_unref() when done.
+
+</return>
+</function>
+
+<function name="clutter_script_set_translation_domain">
+<description>
+Sets the translation domain for @script.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="domain">
+<parameter_description> the translation domain, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_color_hash">
+<function name="clutter_script_unmerge_objects">
<description>
-Converts a #ClutterColor to a hash value.
+Unmerges the objects identified by @merge_id.
-This function can be passed to g_hash_table_new() as the @hash_func
-parameter, when using #ClutterColor<!-- -->s as keys in a #GHashTable.
+Since: 0.6
-Since: 1.0
+</description>
+<parameters>
+<parameter name="script">
+<parameter_description> a #ClutterScript
+</parameter_description>
+</parameter>
+<parameter name="merge_id">
+<parameter_description> merge id returned when loading a UI definition
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_scriptable_get_id">
+<description>
+Retrieves the id of @scriptable set using clutter_scriptable_set_id().
+
+Since: 0.6
</description>
<parameters>
-<parameter name="v">
-<parameter_description> a #ClutterColor
+<parameter name="scriptable">
+<parameter_description> a #ClutterScriptable
</parameter_description>
</parameter>
</parameters>
-<return> a hash value corresponding to the color
+<return> the id of the object. The returned string is owned by
+the scriptable object and should never be modified of freed
</return>
</function>
-<function name="clutter_value_set_shader_int">
+<function name="clutter_scriptable_parse_custom_node">
<description>
-Sets @ints as the contents of @value. The passed #GValue
-must have been initialized using %CLUTTER_TYPE_SHADER_INT.
+Parses the passed JSON node. The implementation must set the type
+of the passed #GValue pointer using g_value_init().
-Since: 0.8
+Since: 0.6
</description>
<parameters>
+<parameter name="scriptable">
+<parameter_description> a #ClutterScriptable
+</parameter_description>
+</parameter>
+<parameter name="script">
+<parameter_description> the #ClutterScript creating the scriptable instance
+</parameter_description>
+</parameter>
<parameter name="value">
-<parameter_description> a #GValue
+<parameter_description> the generic value to be set
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> number of integer values in @ints
+<parameter name="name">
+<parameter_description> the name of the node
</parameter_description>
</parameter>
-<parameter name="ints">
-<parameter_description> an array of integer values
+<parameter name="node">
+<parameter_description> the JSON node to be parsed
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the node was successfully parsed, %FALSE otherwise.
+
+</return>
</function>
-<function name="clutter_model_insert_value">
+<function name="clutter_scriptable_set_custom_property">
<description>
-Sets the data in the cell specified by @iter and @column. The type of
- value must be convertable to the type of the column. If the row does
-not exist then it is created.
+Overrides the common properties setting. The underlying virtual
+function should be used when implementing custom properties.
Since: 0.6
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="scriptable">
+<parameter_description> a #ClutterScriptable
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> position of the row to modify
+<parameter name="script">
+<parameter_description> the #ClutterScript creating the scriptable instance
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> column to modify
+<parameter name="name">
+<parameter_description> the name of the property
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> new value for the cell
+<parameter_description> the value of the property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_get_timeline">
+<function name="clutter_scriptable_set_id">
<description>
-Gets the #ClutterTimeline bound to @alpha.
+Sets @id_ as the unique Clutter script it for this instance of
+#ClutterScriptableIface.
-Since: 0.2
+This name can be used by user interface designer applications to
+define a unique name for an object constructable using the UI
+definition language parsed by #ClutterScript.
+
+Since: 0.6
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> A #ClutterAlpha
+<parameter name="scriptable">
+<parameter_description> a #ClutterScriptable
+</parameter_description>
+</parameter>
+<parameter name="id_">
+<parameter_description> the #ClutterScript id of the object
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterTimeline instance
+<return></return>
+</function>
+
+<function name="clutter_scroll_actor_get_scroll_mode">
+<description>
+Retrieves the #ClutterScrollActor:scroll-mode property
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="actor">
+<parameter_description> a #ClutterScrollActor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the scrolling mode
</return>
</function>
-<function name="json_object_set_int_member">
+<function name="clutter_scroll_actor_new">
<description>
-Convenience function for setting an integer @value of
- member_name inside @object.
+Creates a new #ClutterScrollActor.
-See also: json_object_set_member()
+Since: 1.12
-Since: 0.8
+</description>
+<parameters>
+</parameters>
+<return> The newly created #ClutterScrollActor
+instance.
+
+</return>
+</function>
+
+<function name="clutter_scroll_actor_scroll_to_point">
+<description>
+Scrolls the contents of @actor so that @point is the new origin
+of the visible area.
+
+The coordinates of @point must be relative to the @actor.
+
+This function will use the currently set easing state of the @actor
+to transition from the current scroll origin to the new one.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
-</parameter_description>
-</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="actor">
+<parameter_description> a #ClutterScrollActor
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+<parameter name="point">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_ellipse_get_center">
+<function name="clutter_scroll_actor_scroll_to_rect">
<description>
-Gets the center of the elliptical path path.
+Scrolls @actor so that @rect is in the visible portion.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate of the center, or %NULL
+<parameter name="actor">
+<parameter_description> a #ClutterScrollActor
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate of the center, or %NULL
+<parameter name="rect">
+<parameter_description> a #ClutterRect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_unbind_property">
+<function name="clutter_scroll_actor_set_scroll_mode">
<description>
-Removes @property_name from the list of animated properties.
+Sets the #ClutterScrollActor:scroll-mode property.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="actor">
+<parameter_description> a #ClutterScrollActor
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> name of the property
+<parameter name="mode">
+<parameter_description> a #ClutterScrollMode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_get_minimum_size">
+<function name="clutter_set_default_frame_rate">
<description>
-Retrieves the minimum size for a stage window as set using
-clutter_stage_set_minimum_size().
+Sets the default frame rate. This frame rate will be used to limit
+the number of frames drawn if Clutter is not able to synchronize
+with the vertical refresh rate of the display. When synchronization
+is possible, this value is ignored.
-The returned size may not correspond to the actual minimum size and
-it is specific to the #ClutterStage implementation inside the
-Clutter backend
+Since: 0.6
-Since: 1.2
+Deprecated: 1.10: This function does not do anything any more.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> return location for the minimum width, in pixels,
-or %NULL
+<parameter name="frames_per_sec">
+<parameter_description> the new default frame rate
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the minimum height, in pixels,
-or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_set_font_flags">
+<description>
+Sets the font quality options for subsequent text rendering
+operations.
+
+Using mipmapped textures will improve the quality for scaled down
+text but will use more texture memory.
+
+Enabling hinting improves text quality for static text but may
+introduce some artifacts if the text is animated.
+
+Since: 1.0
+
+Deprecated: 1.10: Use clutter_backend_set_font_options() and the
+#cairo_font_option_t API.
+
+</description>
+<parameters>
+<parameter name="flags">
+<parameter_description> The new flags
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_append">
+<function name="clutter_set_motion_events_enabled">
<description>
-Creates and appends a new row to the #ClutterModel, setting the
-row values upon creation. For example, to append a new row where
-column 0 is type %G_TYPE_INT and column 1 is of type %G_TYPE_STRING:
+Sets whether per-actor motion events should be enabled or not on
+all #ClutterStage<!-- -->s managed by Clutter.
-<informalexample><programlisting>
-ClutterModel *model;
-model = clutter_model_default_new (2,
-G_TYPE_INT, "Score",
-G_TYPE_STRING, "Team");
-clutter_model_append (model, 0, 42, 1, "Team #1", -1);
-</programlisting></informalexample>
+If @enable is %FALSE the following events will not work:
+<itemizedlist>
+<listitem><para>ClutterActor::motion-event, unless on the
+#ClutterStage</para></listitem>
+<listitem><para>ClutterActor::enter-event</para></listitem>
+<listitem><para>ClutterActor::leave-event</para></listitem>
+</itemizedlist>
Since: 0.6
+Deprecated: 1.8: Use clutter_stage_set_motion_events_enabled() instead.
+
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="enable">
+<parameter_description> %TRUE to enable per-actor motion events
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_set_windowing_backend">
+<description>
+Restricts clutter to only use the specified backend.
+This must be called before the first API call to clutter, including
+clutter_get_option_context()
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="backend_type">
+<parameter_description> the name of a clutter window backend
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_bin_layout_new">
+<function name="clutter_settings_get_default">
<description>
-Creates a new #ClutterBinLayout layout manager
+Retrieves the singleton instance of #ClutterSettings
-Since: 1.2
+Since: 1.4
</description>
<parameters>
-<parameter name="x_align">
-<parameter_description> the default alignment policy to be used on the
-horizontal axis
+</parameters>
+<return> the instance of #ClutterSettings. The
+returned object is owned by Clutter and it should not be unreferenced
+directly
+
+</return>
+</function>
+
+<function name="clutter_shader_compile">
+<description>
+Compiles and links GLSL sources set for vertex and fragment shaders for
+a #ClutterShader. If the compilation fails and a #GError return location is
+provided the error will contain the errors from the compiler, if any.
+
+Since: 0.8
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> the default alignment policy to be used on the
-vertical axis
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the newly created layout manager
+<return> returns TRUE if the shader was succesfully compiled.
</return>
</function>
-<function name="clutter_grab_pointer_for_device">
+<function name="clutter_shader_effect_get_program">
<description>
-Grabs all the pointer events coming from the device @id for @actor.
+Retrieves a pointer to the program's handle
-If @id is -1 then this function is equivalent to clutter_grab_pointer().
-
-Since: 0.8
+Since: 1.4
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="effect">
+<parameter_description> a #ClutterShaderEffect
</parameter_description>
</parameter>
-<parameter name="id">
-<parameter_description> a device id, or -1
+</parameters>
+<return> a pointer to the program's handle,
+or %COGL_INVALID_HANDLE
+
+</return>
+</function>
+
+<function name="clutter_shader_effect_get_shader">
+<description>
+Retrieves a pointer to the shader's handle
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="effect">
+<parameter_description> a #ClutterShaderEffect
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the shader's handle,
+or %COGL_INVALID_HANDLE
+
+</return>
</function>
-<function name="clutter_text_set_color">
+<function name="clutter_shader_effect_new">
<description>
-Sets the color of the contents of a #ClutterText actor.
+Creates a new #ClutterShaderEffect, to be applied to an actor using
+clutter_actor_add_effect().
-The overall opacity of the #ClutterText actor will be the
-result of the alpha value of @color and the composited
-opacity of the actor itself on the scenegraph, as returned
-by clutter_actor_get_paint_opacity().
+The effect will be empty until clutter_shader_effect_set_shader_source()
+is called.
-Since: 1.0
+Since: 1.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="shader_type">
+<parameter_description> the type of the shader, either %CLUTTER_FRAGMENT_SHADER,
+or %CLUTTER_VERTEX_SHADER
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #ClutterShaderEffect.
+Use g_object_unref() when done.
+
+</return>
</function>
-<function name="clutter_flow_layout_get_orientation">
+<function name="clutter_shader_effect_set_shader_source">
<description>
-Retrieves the orientation of the @layout
+Sets the source of the GLSL shader used by @effect
-Since: 1.2
+This function should only be called by implementations of
+the #ClutterShaderEffect class, and not by application code.
+
+This function can only be called once; subsequent calls will
+yield no result.
+
+Since: 1.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter name="effect">
+<parameter_description> a #ClutterShaderEffect
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> the source of a GLSL shader
</parameter_description>
</parameter>
</parameters>
-<return> the orientation of the #ClutterFlowLayout
+<return> %TRUE if the source was set
</return>
</function>
-<function name="clutter_text_set_cursor_size">
+<function name="clutter_shader_effect_set_uniform">
<description>
-Sets the size of the cursor of a #ClutterText. The cursor
-will only be visible if the #ClutterText:cursor-visible property
-is set to %TRUE.
+Sets a list of values as the payload for the uniform @name inside
+the shader effect
-Since: 1.0
+The @gtype must be one of: %G_TYPE_INT, for 1 or more integer values;
+%G_TYPE_FLOAT, for 1 or more floating point values;
+%CLUTTER_TYPE_SHADER_INT, for a pointer to an array of integer values;
+%CLUTTER_TYPE_SHADER_FLOAT, for a pointer to an array of floating point
+values; and %CLUTTER_TYPE_SHADER_MATRIX, for a pointer to an array of
+floating point values mapping a matrix
+
+The number of values interepreted is defined by the @n_value
+argument, and by the @gtype argument. For instance, a uniform named
+"sampler0" and containing a single integer value is set using:
+
+|[
+clutter_shader_effect_set_uniform (effect, "sampler0",
+G_TYPE_INT, 1,
+0);
+]|
+
+While a uniform named "components" and containing a 3-elements vector
+of floating point values (a "vec3") can be set using:
+
+|[
+gfloat component_r, component_g, component_b;
+
+clutter_shader_effect_set_uniform (effect, "components",
+G_TYPE_FLOAT, 3,
+component_r,
+component_g,
+component_b);
+]|
+
+or can be set using:
+
+|[
+gfloat component_vec[3];
+
+clutter_shader_effect_set_uniform (effect, "components",
+CLUTTER_TYPE_SHADER_FLOAT, 3,
+component_vec);
+]|
+
+Finally, a uniform named "map" and containing a matrix can be set using:
+
+|[
+clutter_shader_effect_set_uniform (effect, "map",
+CLUTTER_TYPE_SHADER_MATRIX, 1,
+cogl_matrix_get_array (&matrix));
+]|
+
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="effect">
+<parameter_description> a #ClutterShaderEffect
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> the size of the cursor, in pixels, or -1 to use the
-default value
+<parameter name="name">
+<parameter_description> the name of the uniform to set
+</parameter_description>
+</parameter>
+<parameter name="gtype">
+<parameter_description> the type of the uniform to set
+</parameter_description>
+</parameter>
+<parameter name="n_values">
+<parameter_description> the number of values
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of values
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_size">
+<function name="clutter_shader_effect_set_uniform_value">
<description>
-This function tries to "do what you mean" and return
-the size an actor will have. If the actor has a valid
-allocation, the allocation will be returned; otherwise,
-the actors natural size request will be returned.
+Sets @value as the payload for the uniform @name inside the shader
+effect
-If you care whether you get the request vs. the allocation, you
-should probably call a different function like
-clutter_actor_get_allocation_box() or
-clutter_actor_get_preferred_width().
+The #GType of the @value must be one of: %G_TYPE_INT, for a single
+integer value; %G_TYPE_FLOAT, for a single floating point value;
+%CLUTTER_TYPE_SHADER_INT, for an array of integer values;
+%CLUTTER_TYPE_SHADER_FLOAT, for an array of floating point values;
+and %CLUTTER_TYPE_SHADER_MATRIX, for a matrix of floating point
+values. It also accepts %G_TYPE_DOUBLE for compatibility with other
+languages than C.
-Since: 0.2
+Since: 1.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="effect">
+<parameter_description> a #ClutterShaderEffect
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for the width, or %NULL.
+<parameter name="name">
+<parameter_description> the name of the uniform to set
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for the height, or %NULL.
+<parameter name="value">
+<parameter_description> a #GValue with the value of the uniform to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_param_spec_color">
+<function name="clutter_shader_get_cogl_fragment_shader">
<description>
-Creates a #GParamSpec for properties using #ClutterColor.
+Retrieves the underlying #CoglHandle for the fragment shader.
-Since: 0.8.4
+Since: 1.0
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="name">
-<parameter_description> name of the property
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="nick">
-<parameter_description> short name
+</parameters>
+<return> A #CoglHandle for the fragment
+shader, or %NULL. The handle is owned by the #ClutterShader
+and it should not be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_shader_get_cogl_program">
+<description>
+Retrieves the underlying #CoglHandle for the shader program.
+
+Since: 1.0
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="blurb">
-<parameter_description> description (can be translatable)
+</parameters>
+<return> A #CoglHandle for the shader program,
+or %NULL. The handle is owned by the #ClutterShader and it should
+not be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_shader_get_cogl_vertex_shader">
+<description>
+Retrieves the underlying #CoglHandle for the vertex shader.
+
+Since: 1.0
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="default_value">
-<parameter_description> default value
+</parameters>
+<return> A #CoglHandle for the vertex
+shader, or %NULL. The handle is owned by the #ClutterShader
+and it should not be unreferenced
+
+</return>
+</function>
+
+<function name="clutter_shader_get_fragment_source">
+<description>
+Query the current GLSL fragment source set on @shader.
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags for the param spec
+</parameters>
+<return> the source of the fragment shader for this
+ClutterShader object or %NULL. The returned string is owned by the
+shader object and should never be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_shader_get_is_enabled">
+<description>
+Checks whether @shader is enabled.
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GParamSpec
+<return> %TRUE if the shader is enabled.
</return>
</function>
-<function name="json_object_get_size">
+<function name="clutter_shader_get_vertex_source">
<description>
-Retrieves the number of members of a #JsonObject.
+Query the current GLSL vertex source set on @shader.
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
</parameters>
-<return> the number of members
+<return> the source of the vertex shader for this
+ClutterShader object or %NULL. The returned string is owned by the
+shader object and should never be modified or freed
+
</return>
</function>
-<function name="clutter_stage_set_title">
+<function name="clutter_shader_is_compiled">
<description>
-Sets the stage title.
+Checks whether @shader is is currently compiled, linked and bound
+to the GL context.
-Since: 0.4
+Since: 0.8
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> A utf8 string for the stage windows title.
+</parameters>
+<return> %TRUE if the shader is compiled, linked and ready for use.
+
+</return>
+</function>
+
+<function name="clutter_shader_new">
+<description>
+Create a new #ClutterShader instance.
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+</parameters>
+<return> a new #ClutterShader.
+
+</return>
+</function>
+
+<function name="clutter_shader_release">
+<description>
+Frees up any GL context resources held by the shader.
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
+</description>
+<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_subtitle_uri">
+<function name="clutter_shader_set_fragment_source">
<description>
-Retrieves the URI of the subtitle file in use.
+Sets the GLSL source code to be used by a #ClutterShader for the fragment
+program.
-Since: 1.2
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="shader">
+<parameter_description> a #ClutterShader
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> GLSL source code.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of source buffer (currently ignored)
</parameter_description>
</parameter>
</parameters>
-<return> the URI of the subtitle file. Use g_free()
-to free the returned string
-
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_height">
+<function name="clutter_shader_set_is_enabled">
<description>
-Sets the height of the elliptical path.
+Enables a shader. This function will attempt to compile and link
+the shader, if it isn't already.
-Since: 0.4
+When @enabled is %FALSE the default state of the GL pipeline will be
+used instead.
+
+Since: 0.6
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="shader">
+<parameter_description> a #ClutterShader
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of the ellipse
+<parameter name="enabled">
+<parameter_description> The new state of the shader.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_rectangle_set_border_color">
+<function name="clutter_shader_set_uniform">
<description>
-Sets the color of the border used by @rectangle using @color
+Sets a user configurable variable in the GLSL shader programs attached to
+a #ClutterShader.
+
+Since: 1.0
+
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
+<parameter name="shader">
+<parameter_description> a #ClutterShader.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color of the border
+<parameter name="name">
+<parameter_description> name of uniform in GLSL shader program to set.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #ClutterShaderFloat, #ClutterShaderInt or #ClutterShaderMatrix
+#GValue.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_shader_new">
+<function name="clutter_shader_set_vertex_source">
<description>
-Create a new #ClutterShader instance.
+Sets the GLSL source code to be used by a #ClutterShader for the vertex
+program.
Since: 0.6
+Deprecated: 1.8: Use #ClutterShaderEffect instead.
+
</description>
<parameters>
+<parameter name="shader">
+<parameter_description> a #ClutterShader
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> GLSL source code.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of source buffer (currently ignored)
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #ClutterShader.
-
-</return>
+<return></return>
</function>
-<function name="clutter_feature_get_all">
+<function name="clutter_size_alloc">
<description>
-Returns all the supported features.
+Allocates a new #ClutterSize.
-Since: 0.1.1
+Since: 1.12
</description>
<parameters>
</parameters>
-<return> a logical OR of all the supported features.
+<return> the newly allocated #ClutterSize.
+Use clutter_size_free() to free its resources.
</return>
</function>
-<function name="clutter_actor_create_pango_context">
+<function name="clutter_size_copy">
<description>
-Creates a #PangoContext for the given actor. The #PangoContext
-is already configured using the appropriate font map, resolution
-and font options.
+Creates a new #ClutterSize and duplicates @size.
-See also clutter_actor_get_pango_context().
-
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="size">
+<parameter_description> a #ClutterSize
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #PangoContext. Use g_object_unref()
-on the returned value to deallocate its resources
+<return> the newly allocated #ClutterSize.
+Use clutter_size_free() to free its resources.
</return>
</function>
-<function name="clutter_media_get_uri">
+<function name="clutter_size_equals">
<description>
-Retrieves the URI from @media.
+Compares two #ClutterSize for equality.
-Since: 0.2
+Since: 1.12
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="a">
+<parameter_description> a #ClutterSize to compare
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> a #ClutterSize to compare
</parameter_description>
</parameter>
</parameters>
-<return> the URI of the media stream. Use g_free()
-to free the returned string
+<return> %TRUE if the two #ClutterSize are equal
</return>
</function>
-<function name="clutter_actor_queue_redraw">
+<function name="clutter_size_free">
<description>
-Queues up a redraw of an actor and any children. The redraw occurs
-once the main loop becomes idle (after the current batch of events
-has been processed, roughly).
-
-Applications rarely need to call this, as redraws are handled
-automatically by modification functions.
-
-This function will not do anything if @self is not visible, or
-if the actor is inside an invisible part of the scenegraph.
+Frees the resources allocated for @size.
-Also be aware that painting is a NOP for actors with an opacity of
-0
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="size">
+<parameter_description> a #ClutterSize
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_add_timeout">
+<function name="clutter_size_init">
<description>
-Simple wrapper around clutter_threads_add_timeout_full().
+Initializes a #ClutterSize with the given dimensions.
-Since: 0.4
+Since: 1.12
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in milliseconds
+<parameter name="size">
+<parameter_description> a #ClutterSize
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+<parameter name="width">
+<parameter_description> the width
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="height">
+<parameter_description> the height
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> the initialized #ClutterSize
</return>
</function>
-<function name="clutter_behaviour_path_set_path">
+<function name="clutter_snap_constraint_get_edges">
<description>
-Change the path that the actors will follow. This will take the
-floating reference on the #ClutterPath so you do not need to unref
-it.
+Retrieves the edges used by the @constraint
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="pathb">
-<parameter_description> the path behaviour
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> the new path to follow
+<parameter name="from_edge">
+<parameter_description> return location for the actor's edge, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="to_edge">
+<parameter_description> return location for the source's edge, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_flags">
+<function name="clutter_snap_constraint_get_offset">
<description>
-Retrieves the flags set on @self
+Retrieves the offset set using clutter_snap_constraint_set_offset()
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
</parameter_description>
</parameter>
</parameters>
-<return> a bitwise or of #ClutterActorFlags or 0
+<return> the offset, in pixels
</return>
</function>
-<function name="clutter_text_set_selection_bound">
+<function name="clutter_snap_constraint_get_source">
<description>
-Sets the other end of the selection, starting from the current
-cursor position.
-
-If @selection_bound is -1, the selection unset.
+Retrieves the #ClutterActor set using clutter_snap_constraint_set_source()
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
-</parameter_description>
-</parameter>
-<parameter name="selection_bound">
-<parameter_description> the position of the end of the selection, in characters
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the source actor
+
+</return>
</function>
-<function name="clutter_texture_set_from_rgb_data">
+<function name="clutter_snap_constraint_new">
<description>
-Sets #ClutterTexture image data.
+Creates a new #ClutterSnapConstraint that will snap a #ClutterActor
+to the @edge of @source, with the given @offset.
-Since: 0.4.
+Since: 1.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="source">
+<parameter_description> the #ClutterActor to use as the source of
+the constraint, or %NULL
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> Image data in RGBA type colorspace.
+<parameter name="from_edge">
+<parameter_description> the edge of the actor to use in the constraint
</parameter_description>
</parameter>
-<parameter name="has_alpha">
-<parameter_description> Set to TRUE if image data has an alpha channel.
+<parameter name="to_edge">
+<parameter_description> the edge of @source to use in the constraint
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width in pixels of image data.
+<parameter name="offset">
+<parameter_description> the offset to apply to the constraint, in pixels
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height in pixels of image data
+</parameters>
+<return> the newly created #ClutterSnapConstraint
+
+</return>
+</function>
+
+<function name="clutter_snap_constraint_set_edges">
+<description>
+Sets the edges to be used by the @constraint
+
+The @from_edge is the edge on the #ClutterActor to which @constraint
+has been added. The @to_edge is the edge of the #ClutterActor inside
+the #ClutterSnapConstraint:source property.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
</parameter_description>
</parameter>
-<parameter name="rowstride">
-<parameter_description> Distance in bytes between row starts.
+<parameter name="from_edge">
+<parameter_description> the edge on the actor
</parameter_description>
</parameter>
-<parameter name="bpp">
-<parameter_description> bytes per pixel (Currently only 3 and 4 supported,
-depending on @has_alpha)
+<parameter name="to_edge">
+<parameter_description> the edge on the source
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> #ClutterTextureFlags
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_snap_constraint_set_offset">
+<description>
+Sets the offset to be applied to the constraint
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL.
+<parameter name="offset">
+<parameter_description> the offset to apply, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE on failure.
+<return></return>
+</function>
-</return>
+<function name="clutter_snap_constraint_set_source">
+<description>
+Sets the source #ClutterActor for the constraint
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="constraint">
+<parameter_description> a #ClutterSnapConstraint
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> a #ClutterActor, or %NULL to unset the source
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_text_set_line_alignment">
+<function name="clutter_stage_ensure_current">
<description>
-Sets the way that the lines of a wrapped label are aligned with
-respect to each other. This does not affect the overall alignment
-of the label within its allocated or specified width.
+This function essentially makes sure the right GL context is
+current for the passed stage. It is not intended to
+be used by applications.
-To align a #ClutterText actor you should add it to a container
-that supports alignment, or use the anchor point.
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the #ClutterStage
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_ensure_redraw">
+<description>
+Ensures that @stage is redrawn
+
+This function should not be called by applications: it is
+used when embedding a #ClutterStage into a toolkit with
+another windowing system, like GTK+.
Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="alignment">
-<parameter_description> A #PangoAlignment
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_ensure_viewport">
+<description>
+Ensures that the GL viewport is updated with the current
+stage window size.
+
+This function will queue a redraw of @stage.
+
+This function should not be called by applications; it is used
+when embedding a #ClutterStage into a toolkit with another
+windowing system, like GTK+.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_set_use_fog">
+<function name="clutter_stage_event">
<description>
-Sets whether the depth cueing effect on the stage should be enabled
-or not.
-
-Depth cueing is a 3D effect that makes actors farther away from the
-viewing point less opaque, by fading them with the stage color.
+This function is used to emit an event on the main stage.
-The parameters of the GL fog used can be changed using the
-clutter_stage_set_fog() function.
+You should rarely need to use this function, except for
+synthetised events.
-Since: 0.6
+Since: 0.4
</description>
<parameters>
<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="fog">
-<parameter_description> %TRUE for enabling the depth cueing effect
+<parameter name="event">
+<parameter_description> a #ClutterEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the return value from the signal emission
+
+</return>
</function>
-<function name="clutter_animator_property_get_interpolation">
+<function name="clutter_stage_get_accept_focus">
<description>
-Get the interpolation used by animator for a property on a particular
-object.
+Retrieves the value set with clutter_stage_set_accept_focus().
-Since: 1.2
+Since: 1.6
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
+</parameters>
+<return> %TRUE if the #ClutterStage should accept focus, and %FALSE
+otherwise
+
+</return>
+</function>
+
+<function name="clutter_stage_get_actor_at_pos">
+<description>
+Checks the scene at the coordinates @x and @y and returns a pointer
+to the #ClutterActor at those coordinates.
+
+By using @pick_mode it is possible to control which actors will be
+painted and thus available.
+
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of a property on object
+<parameter name="pick_mode">
+<parameter_description> how the scene graph should be painted
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate to check
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate to check
</parameter_description>
</parameter>
</parameters>
-<return> a ClutterInterpolation value.
+<return> the actor at the specified coordinates,
+if any
</return>
</function>
-<function name="clutter_shader_set_fragment_source">
+<function name="clutter_stage_get_color">
<description>
-Sets the GLSL source code to be used by a #ClutterShader for the fragment
-program.
+Retrieves the stage color.
-Since: 0.6
+Deprecated: 1.10: Use clutter_actor_get_background_color() instead.
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="stage">
+<parameter_description> A #ClutterStage
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> GLSL source code.
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of source buffer (currently ignored)
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_get_default">
+<description>
+Retrieves a #ClutterStage singleton.
+
+This function is not as useful as it sounds, and will most likely
+by deprecated in the future. Application code should only create
+a #ClutterStage instance using clutter_stage_new(), and manage the
+lifetime of the stage manually.
+
+The default stage singleton has a platform-specific behaviour: on
+platforms without the %CLUTTER_FEATURE_STAGE_MULTIPLE feature flag
+set, the first #ClutterStage instance will also be set to be the
+default stage instance, and this function will always return a
+pointer to it.
+
+On platforms with the %CLUTTER_FEATURE_STAGE_MULTIPLE feature flag
+set, the default stage will be created by the first call to this
+function, and every following call will return the same pointer to
+it.
+
+Deprecated: 1.10: Use clutter_stage_new() instead.
+
+</description>
+<parameters>
+</parameters>
+<return> the main
+#ClutterStage. You should never destroy or unref the returned
+actor.
+
+</return>
+</function>
+
+<function name="clutter_stage_get_fog">
+<description>
+Retrieves the current depth cueing settings from the stage.
+
+Since: 0.6
+
+Deprecated: 1.10: This function will always return the default
+values of #ClutterFog
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="fog">
+<parameter_description> return location for a #ClutterFog structure
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_get_easing_mode">
+<function name="clutter_stage_get_fullscreen">
<description>
-Retrieves the easing mode set using clutter_box_layout_set_easing_mode()
+Retrieves whether the stage is full screen or not
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
-<return> an easing mode
+<return> %TRUE if the stage is full screen
</return>
</function>
-<function name="clutter_actor_unmap">
+<function name="clutter_stage_get_key_focus">
<description>
-Unsets the %CLUTTER_ACTOR_MAPPED flag on the actor and possibly
-unmaps its children if they were mapped.
+Retrieves the actor that is currently under key focus.
-Calling this is allowed in only one case: you are implementing the
-#ClutterActor::unmap virtual function in an actor and you need to
-unmap the children of that actor. It is not necessary to call this
-if you implement #ClutterContainer because the default implementation
-will automatically unmap children of containers.
+Since: 0.6
-When overriding unmap, it is mandatory to chain up to the parent
-implementation.
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the #ClutterStage
+</parameter_description>
+</parameter>
+</parameters>
+<return> the actor with key focus, or the stage
-Since: 1.0
+</return>
+</function>
+
+<function name="clutter_stage_get_minimum_size">
+<description>
+Retrieves the minimum size for a stage window as set using
+clutter_stage_set_minimum_size().
+
+The returned size may not correspond to the actual minimum size and
+it is specific to the #ClutterStage implementation inside the
+Clutter backend
+
+Since: 1.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> return location for the minimum width, in pixels,
+or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> return location for the minimum height, in pixels,
+or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_new">
+<function name="clutter_stage_get_motion_events_enabled">
<description>
-Creates a new #ClutterEvent of the specified type.
+Retrieves the value set using clutter_stage_set_motion_events_enabled().
+Since: 1.8
</description>
<parameters>
-<parameter name="type">
-<parameter_description> The type of event.
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #ClutterEvent.
+<return> %TRUE if the per-actor motion event delivery is enabled
+and %FALSE otherwise
+
</return>
</function>
-<function name="json_object_set_array_member">
+<function name="clutter_stage_get_no_clear_hint">
<description>
-Convenience function for setting an array @value of
- member_name inside @object.
+Retrieves the hint set with clutter_stage_set_no_clear_hint()
-The @object will take ownership of the passed #JsonArray
+Since: 1.4
-See also: json_object_set_member()
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the stage should not clear itself on every paint
+cycle, and %FALSE otherwise
-Since: 0.8
+</return>
+</function>
+
+<function name="clutter_stage_get_perspective">
+<description>
+Retrieves the stage perspective.
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="stage">
+<parameter_description> A #ClutterStage
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="perspective">
+<parameter_description> return location for a
+#ClutterPerspective
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_get_redraw_clip_bounds">
+<description>
+Gets the bounds of the current redraw for @stage in stage pixel
+coordinates. E.g., if only a single actor has queued a redraw then
+Clutter may redraw the stage with a clip so that it doesn't have to
+paint every pixel in the stage. This function would then return the
+bounds of that clip. An application can use this information to
+avoid some extra work if it knows that some regions of the stage
+aren't going to be painted. This should only be called while the
+stage is being painted. If there is no current redraw clip then
+this function will set @clip to the full extents of the stage.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> A #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="clip">
+<parameter_description> Return location for the clip bounds
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_add_string">
+<function name="clutter_stage_get_throttle_motion_events">
<description>
-Adds new nodes to the end of the path as described in @str. The
-format is a subset of the SVG path format. Each node is represented
-by a letter and is followed by zero, one or three pairs of
-coordinates. The coordinates can be separated by spaces or a
-comma. The types are:
-
-<variablelist>
-<varlistentry><term>M</term>
-<listitem><para>
-Adds a %CLUTTER_PATH_MOVE_TO node. Takes one pair of coordinates.
-</para></listitem></varlistentry>
-<varlistentry><term>L</term>
-<listitem><para>
-Adds a %CLUTTER_PATH_LINE_TO node. Takes one pair of coordinates.
-</para></listitem></varlistentry>
-<varlistentry><term>C</term>
-<listitem><para>
-Adds a %CLUTTER_PATH_CURVE_TO node. Takes three pairs of coordinates.
-</para></listitem></varlistentry>
-<varlistentry><term>z</term>
-<listitem><para>
-Adds a %CLUTTER_PATH_CLOSE node. No coordinates are needed.
-</para></listitem></varlistentry>
-</variablelist>
+Retrieves the value set with clutter_stage_set_throttle_motion_events()
-The M, L and C commands can also be specified in lower case which
-means the coordinates are relative to the previous node.
+Since: 1.0
-For example, to move an actor in a 100 by 100 pixel square centered
-on the point 300,300 you could use the following path:
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the motion events are being throttled,
+and %FALSE otherwise
-<informalexample>
-<programlisting>
-M 250,350 l 0 -100 L 350,250 l 0 100 z
-</programlisting>
-</informalexample>
+</return>
+</function>
-If the path description isn't valid %FALSE will be returned and no
-nodes will be added.
+<function name="clutter_stage_get_title">
+<description>
+Gets the stage title.
-Since: 1.0
+Since: 0.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="stage">
+<parameter_description> A #ClutterStage
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> a string describing the new nodes
+</parameters>
+<return> pointer to the title string for the stage. The
+returned string is owned by the actor and should not
+be modified or freed.
+
+</return>
+</function>
+
+<function name="clutter_stage_get_use_alpha">
+<description>
+Retrieves the value set using clutter_stage_set_use_alpha()
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is the path description was valid or %FALSE
-otherwise.
+<return> %TRUE if the stage should honour the opacity and the
+alpha channel of the stage color
</return>
</function>
-<function name="clutter_script_load_from_data">
+<function name="clutter_stage_get_use_fog">
<description>
-Loads the definitions from @data into @script and merges with
-the currently loaded ones, if any.
+Gets whether the depth cueing effect is enabled on @stage.
Since: 0.6
+Deprecated: 1.10: This function will always return %FALSE
+
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="stage">
+<parameter_description> the #ClutterStage
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> a buffer containing the definitions
+</parameters>
+<return> %TRUE if the depth cueing effect is enabled
+
+</return>
+</function>
+
+<function name="clutter_stage_get_user_resizable">
+<description>
+Retrieves the value set with clutter_stage_set_user_resizable().
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of the buffer, or -1 if @data is a NUL-terminated
-buffer
+</parameters>
+<return> %TRUE if the stage is resizable by the user.
+
+</return>
+</function>
+
+<function name="clutter_stage_hide_cursor">
+<description>
+Makes the cursor invisible on the stage window
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_is_default">
+<description>
+Checks if @stage is the default stage, or an instance created using
+clutter_stage_new() but internally using the same implementation.
+
+Since: 0.8
+
+Deprecated: 1.10: Track the stage pointer inside your application
+code, or use clutter_actor_get_stage() to retrieve the stage for
+a given actor.
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
-<return> on error, zero is returned and @error is set
-accordingly. On success, the merge id for the UI definitions is
-returned. You can use the merge id with clutter_script_unmerge().
+<return> %TRUE if the passed stage is the default one
</return>
</function>
-<function name="json_object_get_int_member">
+<function name="clutter_stage_manager_get_default">
<description>
-Convenience function that retrieves the integer value
-stored in @member_name of @object
+Returns the default #ClutterStageManager.
+
+Since: 0.8
+
+</description>
+<parameters>
+</parameters>
+<return> the default stage manager instance. The returned
+object is owned by Clutter and you should not reference or unreference it.
+
+</return>
+</function>
-See also: json_object_get_member()
+<function name="clutter_stage_manager_get_default_stage">
+<description>
+Returns the default #ClutterStage.
Since: 0.8
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
-</parameter_description>
-</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="stage_manager">
+<parameter_description> a #ClutterStageManager
</parameter_description>
</parameter>
</parameters>
-<return> the integer value of the object's member
+<return> the default stage. The returned object
+is owned by Clutter and you should never reference or unreference it
</return>
</function>
-<function name="clutter_x11_texture_pixmap_new_with_pixmap">
+<function name="clutter_stage_manager_list_stages">
<description>
-Creates a new #ClutterX11TexturePixmap for @pixmap
+Lists all currently used stages.
Since: 0.8
</description>
<parameters>
-<parameter name="pixmap">
-<parameter_description> the X Pixmap to which this texture should be bound
+<parameter name="stage_manager">
+<parameter_description> a #ClutterStageManager
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterX11TexturePixmap bound to the given X Pixmap
+<return> a newly
+allocated list of #ClutterStage objects. Use g_slist_free() to
+deallocate it when done.
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_angle_tilt">
+<function name="clutter_stage_manager_peek_stages">
<description>
-Gets the tilt of the ellipse around the center in the given axis.
+Lists all currently used stages.
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
-</parameter_description>
-</parameter>
-<parameter name="axis">
-<parameter_description> a #ClutterRotateAxis
+<parameter name="stage_manager">
+<parameter_description> a #ClutterStageManager
</parameter_description>
</parameter>
</parameters>
-<return> angle in degrees.
+<return> a pointer
+to the internal list of #ClutterStage objects. The returned list
+is owned by the #ClutterStageManager and should never be modified
+or freed
</return>
</function>
@@ -17049,750 +32809,1500 @@ Deprecated: 1.2: Calling this function has no effect
<return></return>
</function>
-<function name="clutter_interval_set_final_value">
+<function name="clutter_stage_new">
<description>
-Sets the final value of @interval to @value. The value is
-copied inside the #ClutterInterval.
+Creates a new, non-default stage. A non-default stage is a new
+top-level actor which can be used as another container. It works
+exactly like the default stage, but while clutter_stage_get_default()
+will always return the same instance, you will have to keep a pointer
+to any #ClutterStage returned by clutter_stage_new().
-Since: 1.0
+The ability to support multiple stages depends on the current
+backend. Use clutter_feature_available() and
+%CLUTTER_FEATURE_STAGE_MULTIPLE to check at runtime whether a
+backend supports multiple stages.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+</parameters>
+<return> a new stage, or %NULL if the default backend does
+not support multiple stages. Use clutter_actor_destroy() to
+programmatically close the returned stage.
+
+</return>
+</function>
+
+<function name="clutter_stage_queue_redraw">
+<description>
+Queues a redraw for the passed stage.
+
+<note>Applications should call clutter_actor_queue_redraw() and not
+this function.</note>
+
+Since: 0.8
+
+Deprecated: 1.10: Use clutter_actor_queue_redraw() instead.
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the #ClutterStage
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_read_pixels">
+<description>
+Makes a screenshot of the stage in RGBA 8bit data, returns a
+linear buffer with @width * 4 as rowstride.
+
+The alpha data contained in the returned buffer is driver-dependent,
+and not guaranteed to hold any sensible value.
+
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> A #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x coordinate of the first pixel that is read from stage
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y coordinate of the first pixel that is read from stage
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> Width dimention of pixels to be read, or -1 for the
+entire stage width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> Height dimention of pixels to be read, or -1 for the
+entire stage height
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to newly allocated memory with the buffer
+or %NULL if the read failed. Use g_free() on the returned data
+to release the resources it has allocated.
+</return>
+</function>
+
+<function name="clutter_stage_set_accept_focus">
+<description>
+Sets whether the @stage should accept the key focus when shown.
+
+This function should be called before showing @stage using
+clutter_actor_show().
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="accept_focus">
+<parameter_description> %TRUE to accept focus on show
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_set_delay">
+<function name="clutter_stage_set_color">
<description>
-Sets the delay, in milliseconds, before @timeline should start.
+Sets the stage color.
-Since: 0.4
+Deprecated: 1.10: Use clutter_actor_set_background_color() instead.
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="stage">
+<parameter_description> A #ClutterStage
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> delay in milliseconds
+<parameter name="color">
+<parameter_description> A #ClutterColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_pause">
+<function name="clutter_stage_set_fog">
<description>
-Pauses the #ClutterTimeline on current frame
+Sets the fog (also known as "depth cueing") settings for the @stage.
+
+A #ClutterStage will only use a linear fog progression, which
+depends solely on the distance from the viewer. The cogl_set_fog()
+function in COGL exposes more of the underlying implementation,
+and allows changing the for progression function. It can be directly
+used by disabling the #ClutterStage:use-fog property and connecting
+a signal handler to the #ClutterActor::paint signal on the @stage,
+like:
+
+|[
+clutter_stage_set_use_fog (stage, FALSE);
+g_signal_connect (stage, "paint", G_CALLBACK (on_stage_paint), NULL);
+]|
+
+The paint signal handler will call cogl_set_fog() with the
+desired settings:
+
+|[
+static void
+on_stage_paint (ClutterActor *actor)
+{
+ClutterColor stage_color = { 0, };
+CoglColor fog_color = { 0, };
+
+/ * set the fog color to the stage background color * /
+clutter_stage_get_color (CLUTTER_STAGE (actor), &stage_color);
+cogl_color_init_from_4ub (&fog_color,
+stage_color.red,
+stage_color.green,
+stage_color.blue,
+stage_color.alpha);
+
+/ * enable fog * /
+cogl_set_fog (&fog_color,
+COGL_FOG_MODE_EXPONENTIAL, / * mode * /
+0.5, / * density * /
+5.0, 30.0); / * z_near and z_far * /
+}
+]|
+
+<note>The fogging functions only work correctly when the visible actors use
+unmultiplied alpha colors. By default Cogl will premultiply textures and
+cogl_set_source_color() will premultiply colors, so unless you explicitly
+load your textures requesting an unmultiplied internal format and use
+cogl_material_set_color() you can only use fogging with fully opaque actors.
+Support for premultiplied colors will improve in the future when we can
+depend on fragment shaders.</note>
+
+Since: 0.6
+
+Deprecated: 1.10: Fog settings are ignored.
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="stage">
+<parameter_description> the #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="fog">
+<parameter_description> a #ClutterFog structure
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_position">
+<function name="clutter_stage_set_fullscreen">
<description>
-Sets the actor's fixed position in pixels relative to any parent
-actor.
+Asks to place the stage window in the fullscreen or unfullscreen
+states.
-If a layout manager is in use, this position will override the
-layout manager and force a fixed position.
+ ( Note that you shouldn't assume the window is definitely full screen
+afterward, because other entities (e.g. the user or window manager)
+could unfullscreen it again, and not all window managers honor
+requests to fullscreen windows.
+
+If you want to receive notification of the fullscreen state you
+should either use the #ClutterStage::fullscreen and
+#ClutterStage::unfullscreen signals, or use the notify signal
+for the #ClutterStage:fullscreen-set property
+
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> New left position of actor in pixels.
+<parameter name="fullscreen">
+<parameter_description> %TRUE to to set the stage fullscreen
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> New top position of actor in pixels.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_set_key_focus">
+<description>
+Sets the key focus on @actor. An actor with key focus will receive
+all the key events. If @actor is %NULL, the stage will receive
+focus.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> the #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> the actor to set key focus to, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_height">
+<function name="clutter_stage_set_minimum_size">
<description>
-Forces a height on an actor, causing the actor's preferred width
-and height (if any) to be ignored.
+Sets the minimum size for a stage window, if the default backend
+uses #ClutterStage inside a window
-If @height is -1 the actor will use its preferred height instead of
-overriding it, i.e. you can "unset" the height with -1.
+This is a convenience function, and it is equivalent to setting the
+#ClutterActor:min-width and #ClutterActor:min-height on @stage
-This function sets both the minimum and natural size of the actor.
+If the current size of @stage is smaller than the minimum size, the
+ stage will be resized to the new @width and @height
-since: 0.2
+This function has no effect if @stage is fullscreen
+
+Since: 1.2
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width, in pixels
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> Requested new height for the actor, in pixels, or -1
+<parameter_description> height, in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_get_cogl_material">
+<function name="clutter_stage_set_motion_events_enabled">
<description>
-Returns a handle to the underlying COGL material used for drawing
-the actor. No extra reference is taken so if you need to keep the
-handle then you should call cogl_handle_ref() on it.
+Sets whether per-actor motion events (and relative crossing
+events) should be disabled or not.
-Since: 1.0
+The default is %TRUE.
+
+If @enable is %FALSE the following events will not be delivered
+to the actors children of @stage.
+
+<itemizedlist>
+<listitem><para>#ClutterActor::motion-event</para></listitem>
+<listitem><para>#ClutterActor::enter-event</para></listitem>
+<listitem><para>#ClutterActor::leave-event</para></listitem>
+</itemizedlist>
+
+The events will still be delivered to the #ClutterStage.
+
+The main side effect of this function is that disabling the motion
+events will disable picking to detect the #ClutterActor underneath
+the pointer for each motion event. This is useful, for instance,
+when dragging a #ClutterActor across the @stage: the actor underneath
+the pointer is not going to change, so it's meaningless to perform
+a pick.
+Since: 1.8
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="enabled">
+<parameter_description> %TRUE to enable the motion events delivery, and %FALSE
+otherwise
</parameter_description>
</parameter>
</parameters>
-<return> COGL material handle
-</return>
+<return></return>
</function>
-<function name="json_parser_get_current_line">
+<function name="clutter_stage_set_no_clear_hint">
<description>
-Retrieves the line currently parsed, starting from 1.
+Sets whether the @stage should clear itself at the beginning
+of each paint cycle or not.
+
+Clearing the #ClutterStage can be a costly operation, especially
+if the stage is always covered - for instance, in a full-screen
+video player or in a game with a background texture.
+
+<note><para>This setting is a hint; Clutter might discard this
+hint depending on its internal state.</para></note>
+
+<warning><para>If parts of the stage are visible and you disable
+clearing you might end up with visual artifacts while painting the
+contents of the stage.</para></warning>
+Since: 1.4
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #JsonParser
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="no_clear">
+<parameter_description> %TRUE if the @stage should not clear itself on every
+repaint cycle
</parameter_description>
</parameter>
</parameters>
-<return> the currently parsed line.
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_is_applied">
+<function name="clutter_stage_set_paint_callback">
<description>
-Check if @behave applied to @actor.
+Sets a callback function to be invoked after the @stage has been
+painted.
-Since: 0.4
+Since: 1.14
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="callback">
+<parameter_description> a callback
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to be passed to @callback
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when the callback is removed
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if actor has behaviour. FALSE otherwise.
+<return></return>
+</function>
-</return>
+<function name="clutter_stage_set_perspective">
+<description>
+Sets the stage perspective. Using this function is not recommended
+because it will disable Clutter's attempts to generate an
+appropriate perspective based on the size of the stage.
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> A #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="perspective">
+<parameter_description> A #ClutterPerspective
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="json_generator_to_file">
+<function name="clutter_stage_set_sync_delay">
<description>
-Creates a JSON data stream and puts it inside @filename, overwriting the
-current file contents. This operation is atomic.
+This function enables an alternate behavior where Clutter draws at
+a fixed point in time after the frame presentation time (also known
+as the VBlank time). This is most useful when the application
+wants to show incoming data with predictable latency. (The primary
+example of this would be a window system compositor.) By synchronizing
+to provide new data before Clutter redraws, an external source of
+updates (in the compositor, an application) can get a reliable latency.
+The appropriate value of @sync_delay depends on the complexity of
+drawing the stage's scene graph - in general a value of between 0
+and 8 ms (up to one-half of a typical 60hz frame rate) is appropriate.
+using a larger value will reduce latency but risks skipping a frame if
+drawing the stage takes too long.
+
+Since: 1.14
+Stability: unstable
</description>
<parameters>
-<parameter name="generator">
-<parameter_description> a #JsonGenerator
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> path to the target file
+<parameter name="sync_delay">
+<parameter_description> number of milliseconds after frame presentation to wait
+before painting the next frame. If less than zero, restores the
+default behavior where redraw is throttled to the refresh rate but
+not synchronized to it.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_set_throttle_motion_events">
+<description>
+Sets whether motion events received between redraws should
+be throttled or not. If motion events are throttled, those
+events received by the windowing system between redraws will
+be compressed so that only the last event will be propagated
+to the @stage and its actors.
+
+This function should only be used if you want to have all
+the motion events delivered to your application code.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="throttle">
+<parameter_description> %TRUE to throttle motion events
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if saving was successful.
-</return>
+<return></return>
</function>
-<function name="clutter_container_child_set_property">
+<function name="clutter_stage_set_title">
<description>
-Sets a container-specific property on a child of @container.
+Sets the stage title.
-Since: 0.8
+Since: 0.4
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="stage">
+<parameter_description> A #ClutterStage
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #ClutterActor that is a child of @container.
+<parameter name="title">
+<parameter_description> A utf8 string for the stage windows title.
</parameter_description>
</parameter>
-<parameter name="property">
-<parameter_description> the name of the property to set.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_set_use_alpha">
+<description>
+Sets whether the @stage should honour the #ClutterActor:opacity and
+the alpha channel of the #ClutterStage:color
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value.
+<parameter name="use_alpha">
+<parameter_description> whether the stage should honour the opacity or the
+alpha channel of the stage color
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_script_unmerge_objects">
+<function name="clutter_stage_set_use_fog">
<description>
-Unmerges the objects identified by @merge_id.
+Sets whether the depth cueing effect on the stage should be enabled
+or not.
+
+Depth cueing is a 3D effect that makes actors farther away from the
+viewing point less opaque, by fading them with the stage color.
+
+The parameters of the GL fog used can be changed using the
+clutter_stage_set_fog() function.
Since: 0.6
+Deprecated: 1.10: Calling this function produces no visible effect
+
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="stage">
+<parameter_description> the #ClutterStage
</parameter_description>
</parameter>
-<parameter name="merge_id">
-<parameter_description> merge id returned when loading a UI definition
+<parameter name="fog">
+<parameter_description> %TRUE for enabling the depth cueing effect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_is_first">
+<function name="clutter_stage_set_user_resizable">
<description>
-Gets whether the current iterator is at the beginning of the model
-to which it belongs.
+Sets if the stage is resizable by user interaction (e.g. via
+window manager controls)
-Since: 0.6
+Since: 0.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="resizable">
+<parameter_description> whether the stage should be user resizable.
</parameter_description>
</parameter>
</parameters>
-<return> #TRUE if @iter is the first iter in the filtered model
-
-</return>
+<return></return>
</function>
-<function name="clutter_animator_set_duration">
+<function name="clutter_stage_show_cursor">
<description>
-Runs the timeline of the #ClutterAnimator with a duration in msecs
-as specified.
-
-Since: 1.2
+Shows the cursor on the stage window
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="duration">
-<parameter_description> milliseconds a run of the animator should last.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_stage_skip_sync_delay">
+<description>
+Causes the next frame for the stage to be drawn as quickly as
+possible, ignoring any delay that clutter_stage_set_sync_delay()
+would normally cause.
+
+Since: 1.14
+Stability: unstable
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_input_device_get_device_name">
+<function name="clutter_state_get_animator">
<description>
-Retrieves the name of the @device
+Retrieves the #ClutterAnimator that is being used for transitioning
+between the two states, if any has been set
-Since: 1.2
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
+</parameter_description>
+</parameter>
+<parameter name="source_state_name">
+<parameter_description> the name of a source state
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of a target state
</parameter_description>
</parameter>
</parameters>
-<return> the name of the device, or %NULL. The returned string
-is owned by the #ClutterInputDevice and should never be modified
-or freed
+<return> a #ClutterAnimator instance, or %NULL
</return>
</function>
-<function name="clutter_event_free">
+<function name="clutter_state_get_duration">
<description>
-Frees all resources used by @event.
+Queries the duration used for transitions between a source and
+target state pair
+
+The semantics for the query are the same as the semantics used for
+setting the duration with clutter_state_set_duration()
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="event">
-<parameter_description> A #ClutterEvent.
+<parameter name="state">
+<parameter_description> a #ClutterState
+</parameter_description>
+</parameter>
+<parameter name="source_state_name">
+<parameter_description> the name of the source state to
+get the duration of, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of the source state to
+get the duration of, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the duration, in milliseconds
+
+</return>
</function>
-<function name="clutter_text_set_cursor_position">
+<function name="clutter_state_get_keys">
<description>
-Sets the cursor of a #ClutterText actor at @position.
+Returns a list of pointers to opaque structures with accessor functions
+that describe the keys added to an animator.
-The position is expressed in characters, not in bytes.
-
-Since: 1.0
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the new cursor position, in characters
+<parameter name="source_state_name">
+<parameter_description> the source transition name to query,
+or %NULL for all source states
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the target transition name to query,
+or %NULL for all target states
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> the specific object instance to list keys for,
+or %NULL for all managed objects
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the property name to search for, or %NULL
+for all properties.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a
+newly allocated #GList of #ClutterStateKey<!-- -->s. The contents of
+the returned list are owned by the #ClutterState and should not be
+modified or freed. Use g_list_free() to free the resources allocated
+by the returned list when done using it
+
+</return>
</function>
-<function name="json_parser_get_root">
+<function name="clutter_state_get_state">
<description>
-Retrieves the top level node from the parsed JSON stream.
+Queries the currently set target state.
+
+During a transition this function will return the target of the transition.
+This function is useful when called from handlers of the
+#ClutterState::completed signal.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="parser">
-<parameter_description> a #JsonParser
+<parameter name="state">
+<parameter_description> a #ClutterState
</parameter_description>
</parameter>
</parameters>
-<return> the root #JsonNode . The returned node
-is owned by the #JsonParser and should never be modified or freed.
+<return> a string containing the target state. The returned string
+is owned by the #ClutterState and should not be modified or freed
+
</return>
</function>
-<function name="clutter_event_get_related">
+<function name="clutter_state_get_states">
<description>
-Retrieves the related actor of a crossing event.
+Gets a list of all the state names managed by this #ClutterState.
-Since: 1.0
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_ENTER or of
-type %CLUTTER_LEAVE
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
</parameters>
-<return> the related #ClutterActor, or %NULL
+<return> a newly allocated
+#GList of state names. The contents of the returned #GList are owned
+by the #ClutterState and should not be modified or freed. Use
+g_list_free() to free the resources allocated by the returned list when
+done using it
</return>
</function>
-<function name="clutter_actor_box_copy">
+<function name="clutter_state_get_timeline">
<description>
-Copies @box
+Gets the timeline driving the #ClutterState
-Since: 1.0
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="state">
+<parameter_description> a #ClutterState
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated copy of #ClutterActorBox. Use
-clutter_actor_box_free() to free the allocated resources
+<return> the #ClutterTimeline that drives
+the state change animations. The returned timeline is owned
+by the #ClutterState and it should not be unreferenced directly
</return>
</function>
-<function name="clutter_script_connect_signals">
+<function name="clutter_state_key_get_mode">
<description>
-Connects all the signals defined into a UI definition file to their
-handlers.
+Retrieves the easing mode used for @state_key.
-This method invokes clutter_script_connect_signals_full() internally
-and uses #GModule's introspective features (by opening the current
-module's scope) to look at the application's symbol table.
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
-Note that this function will not work if #GModule is not supported by
-the platform Clutter is running on.
+</description>
+<parameters>
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
+</parameter_description>
+</parameter>
+</parameters>
+<return> the mode of a #ClutterStateKey
-Since: 0.6
+</return>
+</function>
+
+<function name="clutter_state_key_get_object">
+<description>
+Retrieves the object instance this #ClutterStateKey applies to.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to be passed to the signal handlers, or %NULL
+</parameters>
+<return> the object this state key applies to.
+
+</return>
+</function>
+
+<function name="clutter_state_key_get_post_delay">
+<description>
+Retrieves the duration of the pause after transitioning is complete
+as a fraction of the total transition time.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
+
+</description>
+<parameters>
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the post delay, used after doing the transition.
+
+</return>
</function>
-<function name="clutter_actor_show">
+<function name="clutter_state_key_get_pre_delay">
<description>
-Flags an actor to be displayed. An actor that isn't shown will not
-be rendered on the stage.
+Retrieves the pause before transitioning starts as a fraction of
+the total transition time.
-Actors are visible by default.
-
-If this function is called on an actor without a parent, the
-#ClutterActor:show-on-set-parent will be set to %TRUE as a side
-effect.
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the pre delay used before starting the transition.
+
+</return>
</function>
-<function name="clutter_stage_get_fog">
+<function name="clutter_state_key_get_property_name">
<description>
-Retrieves the current depth cueing settings from the stage.
+Retrieves the name of the property this #ClutterStateKey applies to
-Since: 0.6
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
-<parameter name="fog">
-<parameter_description> return location for a #ClutterFog structure
+</parameters>
+<return> the name of the property. The returned string is owned
+by the #ClutterStateKey and should never be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_state_key_get_property_type">
+<description>
+Retrieves the #GType of the property a key applies to
+
+You can use this type to initialize the #GValue to pass to
+clutter_state_key_get_value()
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GType of the property
+
+</return>
</function>
-<function name="clutter_flow_layout_new">
+<function name="clutter_state_key_get_source_state_name">
<description>
-Creates a new #ClutterFlowLayout with the given @orientation
+Retrieves the name of the source state of the @state_key
-Since: 1.2
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the orientation of the flow layout
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterFlowLayout
+<return> the name of the source state for this key, or %NULL
+if this is the generic state key for the given property when
+transitioning to the target state. The returned string is owned
+by the #ClutterStateKey and should never be modified or freed
</return>
</function>
-<function name="clutter_interval_compute_value">
+<function name="clutter_state_key_get_target_state_name">
<description>
-Computes the value between the @interval boundaries given the
-progress @factor and puts it into @value.
+Get the name of the source state this #ClutterStateKey contains,
+or NULL if this is the generic state key for the given property
+when transitioning to the target state.
-Since: 1.0
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
-<parameter name="factor">
-<parameter_description> the progress factor, between 0 and 1
+</parameters>
+<return> the name of the source state for this key, or NULL if
+the key is generic
+
+</return>
+</function>
+
+<function name="clutter_state_key_get_value">
+<description>
+Retrieves a copy of the value for a #ClutterStateKey.
+
+The #GValue needs to be already initialized for the value type
+of the property or to a type that allow transformation from the value
+type of the key.
+
+Use g_value_unset() when done.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
+
+</description>
+<parameters>
+<parameter name="state_key">
+<parameter_description> a #ClutterStateKey
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> return location for an initialized #GValue
+<parameter_description> a #GValue initialized with the correct type for the @state_key
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation was successful
+<return> %TRUE if the value was successfully retrieved,
+and %FALSE otherwise
</return>
</function>
-<function name="clutter_actor_get_rotation">
+<function name="clutter_state_new">
<description>
-Retrieves the angle and center of rotation on the given axis,
-set using clutter_actor_set_rotation().
+Creates a new #ClutterState
-Since: 0.8
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+</parameters>
+<return> the newly create #ClutterState instance
+
+</return>
+</function>
+
+<function name="clutter_state_remove_key">
+<description>
+Removes all keys matching the search criteria passed in arguments.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
+
+</description>
+<parameters>
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
-<parameter name="axis">
-<parameter_description> the axis of rotation
+<parameter name="source_state_name">
+<parameter_description> the source state name to query,
+or %NULL for all source states
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return value for the X coordinate of the center of rotation
+<parameter name="target_state_name">
+<parameter_description> the target state name to query,
+or %NULL for all target states
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return value for the Y coordinate of the center of rotation
+<parameter name="object">
+<parameter_description> the specific object instance to list keys for,
+or %NULL for all managed objects
</parameter_description>
</parameter>
-<parameter name="z">
-<parameter_description> return value for the Z coordinate of the center of rotation
+<parameter name="property_name">
+<parameter_description> the property name to search for,
+or %NULL for all properties.
</parameter_description>
</parameter>
</parameters>
-<return> the angle of rotation
-
-</return>
+<return></return>
</function>
-<function name="clutter_timeline_set_loop">
+<function name="clutter_state_set">
<description>
-Sets whether @timeline should loop.
+Adds multiple keys to a named state of a #ClutterState instance, specifying
+the easing mode and value a given property of an object should have at a
+given progress of the animation.
+
+The mode specified is the easing mode used when going to from the previous
+key to the specified key.
+
+For instance, the code below:
+
+|[
+clutter_state_set (state, NULL, "hover",
+button, "opacity", CLUTTER_LINEAR, 255,
+button, "scale-x", CLUTTER_EASE_OUT_CUBIC, 1.2,
+button, "scale-y", CLUTTER_EASE_OUT_CUBIC, 1.2,
+NULL);
+]|
+
+will create a transition from any state (a @source_state_name or NULL is
+treated as a wildcard) and a state named "hover"; the
+<emphasis>button</emphasis> object will have the #ClutterActor:opacity
+property animated to a value of 255 using %CLUTTER_LINEAR as the animation
+mode, and the #ClutterActor:scale-x and #ClutterActor:scale-y properties
+animated to a value of 1.2 using %CLUTTER_EASE_OUT_CUBIC as the animation
+mode. To change the state (and start the transition) you can use the
+clutter_state_set_state() function:
+
+|[
+clutter_state_set_state (state, "hover");
+]|
+
+If a given object, state_name, property tuple already exist in the
+#ClutterState instance, then the mode and value will be replaced with
+the new specified values.
+
+If a property name is prefixed with "delayed::" two additional
+arguments per key are expected: a value relative to the full state time
+to pause before transitioning and a similar value to pause after
+transitioning, e.g.:
+
+|[
+clutter_state_set (state, "hover", "toggled",
+button, "delayed::scale-x", CLUTTER_LINEAR, 1.0, 0.2, 0.2,
+button, "delayed::scale-y", CLUTTER_LINEAR, 1.0, 0.2, 0.2,
+NULL);
+]|
+
+will pause for 20% of the duration of the transition before animating,
+and 20% of the duration after animating.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
-<parameter name="loop">
-<parameter_description> %TRUE for enable looping
+<parameter name="source_state_name">
+<parameter_description> the name of the source state keys are being added for
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of the target state keys are being added for
+</parameter_description>
+</parameter>
+<parameter name="first_object">
+<parameter_description> a #GObject
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> a property of @first_object to specify a key for
+</parameter_description>
+</parameter>
+<parameter name="first_mode">
+<parameter_description> the id of the alpha function to use
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the value @first_property_name should have in @target_state_name,
+followed by object, property name, mode, value tuples, terminated
+by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_equal">
+<function name="clutter_state_set_animator">
<description>
-Checks @box_a and @box_b for equality
+Specifies a #ClutterAnimator to be used when transitioning between
+the two named states.
-Since: 1.0
+The @animator allows specifying a transition between the state that is
+more elaborate than the basic transitions allowed by the tweening of
+properties defined in the #ClutterState keys.
+
+If @animator is %NULL it will unset an existing animator.
+
+#ClutterState will take a reference on the passed @animator, if any
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="box_a">
-<parameter_description> a #ClutterActorBox
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
-<parameter name="box_b">
-<parameter_description> a #ClutterActorBox
+<parameter name="source_state_name">
+<parameter_description> the name of a source state
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of a target state
+</parameter_description>
+</parameter>
+<parameter name="animator">
+<parameter_description> a #ClutterAnimator instance, or %NULL to
+unset an existing #ClutterAnimator
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the passed #ClutterActorBox are equal
-
-</return>
+<return></return>
</function>
-<function name="clutter_x11_has_xinput">
+<function name="clutter_state_set_duration">
<description>
-Gets whether Clutter has XInput support.
+Sets the duration of a transition.
-Since: 0.8
+If both state names are %NULL the default duration for @state is set.
+
+If only @target_state_name is specified, the passed @duration becomes
+the default duration for transitions to the target state.
+
+If both states names are specified, the passed @duration only applies
+to the specified transition.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
+<parameter name="state">
+<parameter_description> a #ClutterState
+</parameter_description>
+</parameter>
+<parameter name="source_state_name">
+<parameter_description> the name of the source state, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of the target state, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="duration">
+<parameter_description> the duration of the transition, in milliseconds
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if Clutter was compiled with XInput support
-and XInput support is available at run time.
-
-</return>
+<return></return>
</function>
-<function name="clutter_model_iter_set_value">
+<function name="clutter_state_set_key">
<description>
-Sets the data in the cell specified by @iter and @column. The type of
- value must be convertable to the type of the column.
+Sets one specific end key for a state name, @object, @property_name
+combination.
-Since: 0.6
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="state">
+<parameter_description> a #ClutterState instance.
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> column number to retrieve the value from
+<parameter name="source_state_name">
+<parameter_description> the source transition to specify
+transition for, or %NULL to specify the default fallback when a
+more specific source state doesn't exist.
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the name of the transition to set a key value for.
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> the #GObject to set a key for
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the property to set a key for
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> the id of the alpha function to use
</parameter_description>
</parameter>
<parameter name="value">
-<parameter_description> new value for the cell
+<parameter_description> the value for property_name of object in state_name
+</parameter_description>
+</parameter>
+<parameter name="pre_delay">
+<parameter_description> relative time of the transition to be idle in the beginning
+of the transition
+</parameter_description>
+</parameter>
+<parameter name="post_delay">
+<parameter_description> relative time of the transition to be idle in the end of
+the transition
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #ClutterState instance, allowing
+chaining of multiple calls
+
+</return>
</function>
-<function name="clutter_timeline_new">
+<function name="clutter_state_set_state">
<description>
-Creates a new #ClutterTimeline with a duration of @msecs.
+Change the current state of #ClutterState to @target_state_name.
-Since: 0.6
+The state will animate during its transition, see
+#clutter_state_warp_to_state for animation-free state switching.
+
+Setting a %NULL state will stop the current animation and unset
+the current state, but keys will be left intact.
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="msecs">
-<parameter_description> Duration of the timeline in milliseconds
+<parameter name="state">
+<parameter_description> a #ClutterState
+</parameter_description>
+</parameter>
+<parameter name="target_state_name">
+<parameter_description> the state to transition to
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterTimeline instance. Use
-g_object_unref() when done using it
+<return> the #ClutterTimeline that drives the
+state transition. The returned timeline is owned by the #ClutterState
+and it should not be unreferenced
</return>
</function>
-<function name="cogl_pango_font_map_set_resolution">
+<function name="clutter_state_warp_to_state">
<description>
-Sets the resolution to be used by @font_map at @dpi.
+Change to the specified target state immediately with no animation.
-Since: 1.0
+See clutter_state_set_state().
+
+Since: 1.4
+Deprecated: 1.12: Use #ClutterKeyframeTransition and
+#ClutterTransitionGroup instead
</description>
<parameters>
-<parameter name="font_map">
-<parameter_description> a #CoglPangoFontMap
+<parameter name="state">
+<parameter_description> a #ClutterState
</parameter_description>
</parameter>
-<parameter name="dpi">
-<parameter_description> DPI to set
+<parameter name="target_state_name">
+<parameter_description> the state to transition to
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #ClutterTimeline that drives the
+state transition. The returned timeline is owned by the #ClutterState
+and it should not be unreferenced
+
+</return>
</function>
-<function name="clutter_text_set_use_markup">
+<function name="clutter_swipe_action_new">
<description>
-Sets whether the contents of the #ClutterText actor contains markup
-in <link linkend="PangoMarkupFormat">Pango's text markup language</link>.
+Creates a new #ClutterSwipeAction instance
-Setting #ClutterText:use-markup on an editable #ClutterText will
-make the actor discard any markup.
+Since: 1.8
-Since: 1.0
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterSwipeAction
+
+</return>
+</function>
+
+<function name="clutter_table_layout_get_alignment">
+<description>
+Retrieves the horizontal and vertical alignment policies for @actor
+as set using clutter_table_layout_pack() or
+clutter_table_layout_set_alignment().
+
+Since: 1.4
+
+Deprecated: 1.12: Use clutter_actor_get_x_align() and
+clutter_actor_get_y_align() instead.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if the text should be parsed for markup.
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> return location for the horizontal alignment policy
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> return location for the vertical alignment policy
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_x11_get_stage_visual">
+<function name="clutter_table_layout_get_column_count">
<description>
-Returns an XVisualInfo suitable for creating a foreign window for the given
-stage. NOTE: It doesn't do as the name may suggest, which is return the
-XVisualInfo that was used to create an existing window for the given stage.
+Retrieve the current number of columns in @layout
-XXX: It might be best to deprecate this function and replace with something
-along the lines of clutter_backend_x11_get_foreign_visual () or perhaps
-clutter_stage_x11_get_foreign_visual ()
+Since: 1.4
-Deprecated: 1.2: Use clutter_x11_get_visual_info() instead
+Deprecated: 1.18: Use #ClutterGridLayout instead
-Since: 0.4
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> A #ClutterTableLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of columns
+
+</return>
+</function>
+
+<function name="clutter_table_layout_get_column_spacing">
+<description>
+Retrieves the spacing set using clutter_table_layout_set_column_spacing()
+
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
</parameters>
-<return> An XVisualInfo suitable for creating a foreign stage. Use
-XFree() to free the returned value instead
+<return> the spacing between columns of the #ClutterTableLayout
</return>
</function>
-<function name="clutter_scriptable_set_id">
+<function name="clutter_table_layout_get_easing_duration">
<description>
-Sets @id as the unique Clutter script it for this instance of
-#ClutterScriptableIface.
+Retrieves the duration set using clutter_table_layout_set_easing_duration()
-This name can be used by user interface designer applications to
-define a unique name for an object constructable using the UI
-definition language parsed by #ClutterScript.
+Since: 1.4
-Since: 0.6
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="scriptable">
-<parameter_description> a #ClutterScriptable
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="id">
-<parameter_description> the #ClutterScript id of the object
+</parameters>
+<return> the duration of the animations, in milliseconds
+
+</return>
+</function>
+
+<function name="clutter_table_layout_get_easing_mode">
+<description>
+Retrieves the easing mode set using clutter_table_layout_set_easing_mode()
+
+Since: 1.4
+
+Deprecated: 1.12: #ClutterTableLayout will honour the easing state
+of the children when allocating them
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> an easing mode
+
+</return>
+</function>
+
+<function name="clutter_table_layout_get_expand">
+<description>
+Retrieves the horizontal and vertical expand policies for @actor
+as set using clutter_table_layout_pack() or clutter_table_layout_set_expand()
+
+Since: 1.4
+
+Deprecated: 1.12: Use clutter_actor_get_x_expand() and
+clutter_actor_get_y_expand() instead.
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_expand">
+<parameter_description> return location for the horizontal expand policy
+</parameter_description>
+</parameter>
+<parameter name="y_expand">
+<parameter_description> return location for the vertical expand policy
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_get_fill">
+<function name="clutter_table_layout_get_fill">
<description>
Retrieves the horizontal and vertical fill policies for @actor
-as set using clutter_box_layout_pack() or clutter_box_layout_set_fill()
+as set using clutter_table_layout_pack() or clutter_table_layout_set_fill()
-Since: 1.2
+Since: 1.4
+
+Deprecated: 1.12: Use clutter_actor_get_x_align() and
+clutter_actor_get_y_align() instead.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
<parameter name="actor">
@@ -17811,394 +34321,572 @@ Since: 1.2
<return></return>
</function>
-<function name="clutter_model_iter_prev">
+<function name="clutter_table_layout_get_row_count">
<description>
-Sets the @iter to point at the previous position in the model.
-The model implementation should take into account the presence of
-a filter function.
+Retrieve the current number rows in the @layout
-Since: 0.6
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="layout">
+<parameter_description> A #ClutterTableLayout
</parameter_description>
</parameter>
</parameters>
-<return> The passed iterator, updated to point at the previous
-row in the model.
+<return> the number of rows
</return>
</function>
-<function name="clutter_eglx_display">
+<function name="clutter_table_layout_get_row_spacing">
<description>
-Gets the current EGLDisplay.
+Retrieves the spacing set using clutter_table_layout_set_row_spacing()
-Since: 0.4
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
</parameters>
-<return> an EGLDisplay
+<return> the spacing between rows of the #ClutterTableLayout
</return>
</function>
-<function name="clutter_actor_set_z_rotation_from_gravity">
+<function name="clutter_table_layout_get_span">
<description>
-Sets the rotation angle of @self around the Z axis using the center
-point specified as a compass point. For example to rotate such that
-the center of the actor remains static you can use
-%CLUTTER_GRAVITY_CENTER. If the actor changes size the center point
-will move accordingly.
+Retrieves the row and column span for @actor as set using
+clutter_table_layout_pack() or clutter_table_layout_set_span()
-Since: 1.0
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="angle">
-<parameter_description> the angle of rotation
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
</parameter_description>
</parameter>
-<parameter name="gravity">
-<parameter_description> the center point of the rotation
+<parameter name="column_span">
+<parameter_description> return location for the col span
+</parameter_description>
+</parameter>
+<parameter name="row_span">
+<parameter_description> return location for the row span
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="cogl_sqrti">
+<function name="clutter_table_layout_get_use_animations">
<description>
-Very fast fixed point implementation of square root for integers.
+Retrieves whether @layout should animate changes in the layout properties
-This function is at least 6x faster than clib sqrt() on x86, and (this is
-not a typo!) about 500x faster on ARM without FPU. It's error is < 5%
-for arguments < %COGL_SQRTI_ARG_5_PERCENT and < 10% for arguments <
-%COGL_SQRTI_ARG_10_PERCENT. The maximum argument that can be passed to
-this function is COGL_SQRTI_ARG_MAX.
+Since clutter_table_layout_set_use_animations()
-Since: 0.2
+Since: 1.4
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="x">
-<parameter_description> integer value
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
</parameters>
-<return> integer square root.
+<return> %TRUE if the animations should be used, %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_table_layout_new">
+<description>
+Creates a new #ClutterTableLayout layout manager
+
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterTableLayout
</return>
</function>
-<function name="clutter_actor_set_geometry">
+<function name="clutter_table_layout_pack">
<description>
-Sets the actor's fixed position and forces its minimum and natural
-size, in pixels. This means the untransformed actor will have the
-given geometry. This is the same as calling clutter_actor_set_position()
-and clutter_actor_set_size().
+Packs @actor inside the #ClutterContainer associated to @layout
+at the given row and column.
+
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="geometry">
-<parameter_description> A #ClutterGeometry
+<parameter name="actor">
+<parameter_description> a #ClutterActor
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> the column the @actor should be put, or -1 to append
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> the row the @actor should be put, or -1 to append
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_get_timestamp">
+<function name="clutter_table_layout_set_alignment">
<description>
-Returns the approximate number of microseconds passed since clutter was
-intialised.
+Sets the horizontal and vertical alignment policies for @actor
+inside @layout
+
+Since: 1.4
+Deprecated: 1.12: Use clutter_actor_set_x_align() and
+clutter_actor_set_y_align() instead.
</description>
<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="x_align">
+<parameter_description> Horizontal alignment policy for @actor
+</parameter_description>
+</parameter>
+<parameter name="y_align">
+<parameter_description> Vertical alignment policy for @actor
+</parameter_description>
+</parameter>
</parameters>
-<return> Number of microseconds since clutter_init() was called.
-</return>
+<return></return>
</function>
-<function name="clutter_x11_set_stage_foreign">
+<function name="clutter_table_layout_set_column_spacing">
<description>
-Target the #ClutterStage to use an existing external X Window
+Sets the spacing between columns of @layout
-Since: 0.4
+Since: 1.4
+
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="xwindow">
-<parameter_description> an existing X Window id
+<parameter name="spacing">
+<parameter_description> the spacing between columns of the layout, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if foreign window is valid
-
-</return>
+<return></return>
</function>
-<function name="clutter_animator_key_get_property_type">
+<function name="clutter_table_layout_set_easing_duration">
<description>
-Retrieves the #GType of the property a key applies to
+Sets the duration of the animations used by @layout when animating changes
+in the layout properties
-You can use this type to initialize the #GValue to pass to
-clutter_animator_key_get_value()
+Use clutter_table_layout_set_use_animations() to enable and disable the
+animations
-Since: 1.2
+Since: 1.4
+
+Deprecated: 1.12: #ClutterTableLayout will honour the easing state
+of the children when allocating them
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> the duration of the animations, in milliseconds
</parameter_description>
</parameter>
</parameters>
-<return> the #GType of the property
+<return></return>
+</function>
-</return>
+<function name="clutter_table_layout_set_easing_mode">
+<description>
+Sets the easing mode to be used by @layout when animating changes in layout
+properties
+
+Use clutter_table_layout_set_use_animations() to enable and disable the
+animations
+
+Since: 1.4
+
+Deprecated: 1.12: #ClutterTableLayout will honour the easing state
+of the children when allocating them
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> an easing mode, either from #ClutterAnimationMode or a logical id
+from clutter_alpha_register_func()
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_actor_box_new">
+<function name="clutter_table_layout_set_expand">
<description>
-Allocates a new #ClutterActorBox using the passed coordinates
-for the top left and bottom right points
+Sets the horizontal and vertical expand policies for @actor
+inside @layout
-Since: 1.0
+Since: 1.4
+
+Deprecated: 1.12: Use clutter_actor_set_x_expand() or
+clutter_actor_set_y_expand() instead.
</description>
<parameters>
-<parameter name="x_1">
-<parameter_description> X coordinate of the top left point
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="y_1">
-<parameter_description> Y coordinate of the top left point
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
</parameter_description>
</parameter>
-<parameter name="x_2">
-<parameter_description> X coordinate of the bottom right point
+<parameter name="x_expand">
+<parameter_description> whether @actor should allocate extra space horizontally
</parameter_description>
</parameter>
-<parameter name="y_2">
-<parameter_description> Y coordinate of the bottom right point
+<parameter name="y_expand">
+<parameter_description> whether @actor should allocate extra space vertically
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocated #ClutterActorBox. Use
-clutter_actor_box_free() to free the resources
-
-</return>
+<return></return>
</function>
-<function name="clutter_flow_layout_get_row_height">
+<function name="clutter_table_layout_set_fill">
<description>
-Retrieves the minimum and maximum row heights
+Sets the horizontal and vertical fill policies for @actor
+inside @layout
-Since: 1.2
+Since: 1.4
+
+Deprecated: 1.12: Use clutter_actor_set_x_align() and
+clutter_actor_set_y_align() instead.
</description>
<parameters>
<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="min_height">
-<parameter_description> return location for the minimum row height, or %NULL
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
</parameter_description>
</parameter>
-<parameter name="max_height">
-<parameter_description> return location for the maximum row height, or %NULL
+<parameter name="x_fill">
+<parameter_description> whether @actor should fill horizontally the allocated space
+</parameter_description>
+</parameter>
+<parameter name="y_fill">
+<parameter_description> whether @actor should fill vertically the allocated space
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_get_device_id">
+<function name="clutter_table_layout_set_row_spacing">
<description>
-Retrieves the events device id if set.
+Sets the spacing between rows of @layout
+
+Since: 1.4
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a clutter event
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the spacing between rows of the layout, in pixels
</parameter_description>
</parameter>
</parameters>
-<return> A unique identifier for the device or -1 if the event has
-no specific device set.
-</return>
+<return></return>
</function>
-<function name="json_node_get_parent">
+<function name="clutter_table_layout_set_span">
<description>
-Retrieves the parent #JsonNode of @node.
+Sets the row and column span for @actor
+inside @layout
+
+Since: 1.4
+Deprecated: 1.18: Use #ClutterGridLayout instead
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
+</parameter_description>
+</parameter>
+<parameter name="actor">
+<parameter_description> a #ClutterActor child of @layout
+</parameter_description>
+</parameter>
+<parameter name="column_span">
+<parameter_description> Column span for @actor
+</parameter_description>
+</parameter>
+<parameter name="row_span">
+<parameter_description> Row span for @actor
</parameter_description>
</parameter>
</parameters>
-<return> the parent node, or %NULL if @node is the root node
-</return>
+<return></return>
</function>
-<function name="clutter_actor_set_shader_param_float">
+<function name="clutter_table_layout_set_use_animations">
<description>
-Sets the value for a named float parameter of the shader applied
-to @actor.
+Sets whether @layout should animate changes in the layout properties
-Since: 0.8
+The duration of the animations is controlled by
+clutter_table_layout_set_easing_duration(); the easing mode to be used
+by the animations is controlled by clutter_table_layout_set_easing_mode()
+
+Since: 1.4
+
+Deprecated: 1.12: #ClutterTableLayout will honour the easing state
+of the children when allocating them
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
-</parameter_description>
-</parameter>
-<parameter name="param">
-<parameter_description> the name of the parameter
+<parameter name="layout">
+<parameter_description> a #ClutterTableLayout
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the parameter
+<parameter name="animate">
+<parameter_description> %TRUE if the @layout should use animations
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_get_default_text_direction">
+<function name="clutter_tap_action_new">
<description>
-Retrieves the default direction for the text. The text direction is
-determined by the locale and/or by the %CLUTTER_TEXT_DIRECTION environment
-variable
-
-The default text direction can be overridden on a per-actor basis by using
-clutter_actor_set_text_direction()
+Creates a new #ClutterTapAction instance
-Since: 1.2
+Since: 1.14
</description>
<parameters>
</parameters>
-<return> the default text direction
+<return> the newly created #ClutterTapAction
</return>
</function>
-<function name="clutter_animator_set_timeline">
+<function name="clutter_test_add">
<description>
-Sets an external timeline that will be used for driving the animation
+Adds a test unit to the Clutter test environment.
-Since: 1.2
+See also: g_test_add()
+
+Since: 1.18
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="test_path">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="test_func">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_texture_set_from_file">
+<function name="clutter_test_add_data">
<description>
-Sets the #ClutterTexture image data from an image file. In case of
-failure, %FALSE is returned and @error is set.
+Adds a test unit to the Clutter test environment.
-If #ClutterTexture:load-async is set to %TRUE, this function
-will return as soon as possible, and the actual image loading
-from disk will be performed asynchronously. #ClutterTexture::size-change
-will be emitten when the size of the texture is available and
-#ClutterTexture::load-finished will be emitted when the image has been
-loaded or if an error occurred.
+See also: g_test_add_data_func()
-Since: 0.8
+Since: 1.18
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="test_path">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> The filename of the image in GLib file name encoding
+<parameter name="test_func">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> Return location for a #GError, or %NULL
+<parameter name="test_data">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the image was successfully loaded and set
+<return></return>
+</function>
-</return>
+<function name="clutter_test_add_data_full">
+<description>
+Adds a test unit to the Clutter test environment.
+
+See also: g_test_add_data_func_full()
+
+Since: 1.18
+
+</description>
+<parameters>
+<parameter name="test_path">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="test_func">
+<parameter_description> (scope notified)
+</parameter_description>
+</parameter>
+<parameter name="test_data">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="test_notify">
+<parameter_description>
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_texture_new">
+<function name="clutter_test_get_stage">
<description>
-Creates a new empty #ClutterTexture object.
+Retrieves the #ClutterStage used for testing.
+Since: 1.18
</description>
<parameters>
</parameters>
-<return> A newly created #ClutterTexture object.
+<return> the stage used for testing
+
</return>
</function>
-<function name="clutter_texture_get_load_data_async">
+<function name="clutter_test_init">
<description>
-Retrieves the value set by clutter_texture_set_load_data_async()
+Initializes the Clutter test environment.
-Since: 1.0
+Since: 1.18
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="argc">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #ClutterTexture should load the image
-data from a file asynchronously
+<return></return>
+</function>
+
+<function name="clutter_test_run">
+<description>
+Runs the test suite using the units added by calling
+clutter_test_add().
+
+The typical test suite is composed of a list of functions
+called by clutter_test_run(), for instance:
+
+|[
+static void unit_foo (void) { ... }
+
+static void unit_bar (void) { ... }
+
+static void unit_baz (void) { ... }
+
+int
+main (int argc, char *argv[])
+{
+clutter_test_init (&argc, &argv);
+
+clutter_test_add ("/unit/foo", unit_foo);
+clutter_test_add ("/unit/bar", unit_bar);
+clutter_test_add ("/unit/baz", unit_baz);
+
+return clutter_test_run ();
+}
+]|
+
+Since: 1.18
+
+</description>
+<parameters>
+</parameters>
+<return> the exit code for the test suite
</return>
</function>
-<function name="clutter_text_set_max_length">
+<function name="clutter_text_activate">
<description>
-Sets the maximum allowed length of the contents of the actor. If the
-current contents are longer than the given length, then they will be
-truncated to fit.
+Emits the #ClutterText::activate signal, if @self has been set
+as activatable using clutter_text_set_activatable().
+
+This function can be used to emit the ::activate signal inside
+a #ClutterActor::captured-event or #ClutterActor::key-press-event
+signal handlers before the default signal handler for the
+#ClutterText is invoked.
Since: 1.0
@@ -18208,409 +34896,540 @@ Since: 1.0
<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> the maximum number of characters allowed in the text actor; 0
-to disable or -1 to set the length of the current string
+</parameters>
+<return> %TRUE if the ::activate signal has been emitted,
+and %FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_text_buffer_delete_text">
+<description>
+Deletes a sequence of characters from the buffer. @n_chars characters are
+deleted starting at @position. If @n_chars is negative, then all characters
+until the end of the text are deleted.
+
+If @position or @n_chars are out of bounds, then they are coerced to sane
+values.
+
+Note that the positions are specified in characters, not bytes.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position at which to delete text
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters to delete
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The number of characters deleted.
+
+</return>
</function>
-<function name="clutter_model_iter_set_valist">
+<function name="clutter_text_buffer_emit_deleted_text">
<description>
-See clutter_model_iter_set(); this version takes a va_list for language
-bindings.
+Emits the #ClutterTextBuffer::deleted-text signal on @buffer.
-Since: 0.6
+Used when subclassing #ClutterTextBuffer
+
+Since: 1.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
-<parameter name="args">
-<parameter_description> va_list of column/value pairs, terminiated by -1
+<parameter name="position">
+<parameter_description> position at which text was deleted
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters deleted
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_animate">
+<function name="clutter_text_buffer_emit_inserted_text">
<description>
-Animates the given list of properties of @actor between the current
-value for each property and a new final value. The animation has a
-definite duration and a speed given by the @mode.
+Emits the #ClutterTextBuffer::inserted-text signal on @buffer.
-For example, this:
+Used when subclassing #ClutterTextBuffer
-|[
-clutter_actor_animate (rectangle, CLUTTER_LINEAR, 250,
-"width", 100.0,
-"height", 100.0,
-NULL);
-]|
+Since: 1.10
-will make width and height properties of the #ClutterActor "rectangle"
-grow linearly between the current value and 100 pixels, in 250 milliseconds.
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position at which text was inserted
+</parameter_description>
+</parameter>
+<parameter name="chars">
+<parameter_description> text that was inserted
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters inserted
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-The animation @mode is a logical id, either from the #ClutterAnimationMode
-enumeration of from clutter_alpha_register_func().
+<function name="clutter_text_buffer_get_bytes">
+<description>
+Retrieves the length in bytes of the buffer.
+See clutter_text_buffer_get_length().
-All the properties specified will be animated between the current value
-and the final value. If a property should be set at the beginning of
-the animation but not updated during the animation, it should be prefixed
-by the "fixed::" string, for instance:
+Since: 1.10
-|[
-clutter_actor_animate (actor, CLUTTER_EASE_IN_SINE, 100,
-"rotation-angle-z", 360.0,
-"fixed::rotation-center-z", &center,
-NULL);
-]|
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+</parameters>
+<return> The byte length of the buffer.
-Will animate the "rotation-angle-z" property between the current value
-and 360 degrees, and set the "rotation-center-z" property to the fixed
-value of the #ClutterVertex "center".
+</return>
+</function>
-This function will implicitly create a #ClutterAnimation object which
-will be assigned to the @actor and will be returned to the developer
-to control the animation or to know when the animation has been
-completed.
+<function name="clutter_text_buffer_get_length">
+<description>
+Retrieves the length in characters of the buffer.
-If a name argument starts with "signal::", "signal-after::",
-"signal-swapped::" or "signal-swapped-after::" the two following arguments
-are used as callback function and data for a signal handler installed on
-the #ClutterAnimation object for the specified signal name, for instance:
+Since: 1.10
-|[
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+</parameters>
+<return> The number of characters in the buffer.
-static void
-on_animation_completed (ClutterAnimation *animation,
-ClutterActor *actor)
-{
-clutter_actor_hide (actor);
-}
+</return>
+</function>
-clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 100,
-"opacity", 0,
-"signal::completed", on_animation_completed, actor,
-NULL);
-]|
+<function name="clutter_text_buffer_get_max_length">
+<description>
+Retrieves the maximum allowed length of the text in
+ buffer See clutter_text_buffer_set_max_length().
-or, to automatically destroy an actor at the end of the animation:
+Since: 1.10
-|[
-clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 100,
-"opacity", 0,
-"signal-swapped-after::completed",
-clutter_actor_destroy,
-actor,
-NULL);
-]|
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+</parameters>
+<return> the maximum allowed number of characters
+in #ClutterTextBuffer, or 0 if there is no maximum.
-The "signal::" modifier is the equivalent of using g_signal_connect();
-the "signal-after::" modifier is the equivalent of using
-g_signal_connect_after() or g_signal_connect_data() with the
-%G_CONNECT_AFTER; the "signal-swapped::" modifier is the equivalent
-of using g_signal_connect_swapped() or g_signal_connect_data() with the
-%G_CONNECT_SWAPPED flah; finally, the "signal-swapped-after::" modifier
-is the equivalent of using g_signal_connect_data() with both the
-%G_CONNECT_AFTER and %G_CONNECT_SWAPPED flags. The clutter_actor_animate()
-function will not keep track of multiple connections to the same signal,
-so it is your responsability to avoid them when calling
-clutter_actor_animate() multiple times on the same actor.
+</return>
+</function>
-Calling this function on an actor that is already being animated
-will cause the current animation to change with the new final values,
-the new easing mode and the new duration - that is, this code:
+<function name="clutter_text_buffer_get_text">
+<description>
+Retrieves the contents of the buffer.
-|[
-clutter_actor_animate (actor, CLUTTER_LINEAR, 250,
-"width", 100.0,
-"height", 100.0,
-NULL);
-clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 500,
-"x", 100.0,
-"y", 100.0,
-"width", 200.0,
-NULL);
-]|
+The memory pointer returned by this call will not change
+unless this object emits a signal, or is finalized.
-is the equivalent of:
+Since: 1.10
-|[
-clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 500,
-"x", 100.0,
-"y", 100.0,
-"width", 200.0,
-"height", 100.0,
-NULL);
-]|
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the contents of the widget as a
+string. This string points to internally allocated
+storage in the buffer and must not be freed, modified or
+stored.
-<note>Unless the animation is looping, the #ClutterAnimation created by
-clutter_actor_animate() will become invalid as soon as it is
-complete.</note>
+</return>
+</function>
-Since the created #ClutterAnimation instance attached to @actor
-is guaranteed to be valid throughout the #ClutterAnimation::completed
-signal emission chain, you will not be able to create a new animation
-using clutter_actor_animate() on the same @actor from within the
-#ClutterAnimation::completed signal handler unless you use
-g_signal_connect_after() to connect the callback function, for instance:
+<function name="clutter_text_buffer_insert_text">
+<description>
+Inserts @n_chars characters of @chars into the contents of the
+buffer, at position @position.
-|[
-static void
-on_animation_completed (ClutterAnimation *animation,
-ClutterActor *actor)
-{
-clutter_actor_animate (actor, CLUTTER_EASE_OUT_CUBIC, 250,
-"x", 500.0,
-"y", 500.0,
-NULL);
-}
+If @n_chars is negative, then characters from chars will be inserted
+until a null-terminator is found. If @position or @n_chars are out of
+bounds, or the maximum buffer text length is exceeded, then they are
+coerced to sane values.
-...
-animation = clutter_actor_animate (actor, CLUTTER_EASE_IN_CUBIC, 250,
-"x", 100.0,
-"y", 100.0,
-NULL);
-g_signal_connect (animation, "completed",
-G_CALLBACK (on_animation_completed),
-actor);
-...
-]|
+Note that the position and length are in characters, not in bytes.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an animation mode logical id
+<parameter name="position">
+<parameter_description> the position at which to insert text.
</parameter_description>
</parameter>
-<parameter name="duration">
-<parameter_description> duration of the animation, in milliseconds
+<parameter name="chars">
+<parameter_description> the text to insert into the buffer.
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of a property
+<parameter name="n_chars">
+<parameter_description> the length of the text in characters, or -1
</parameter_description>
</parameter>
-<parameter name="VarArgs">
-<parameter_description> a %NULL terminated list of property names and
-property values
+</parameters>
+<return> The number of characters actually inserted.
+
+</return>
+</function>
+
+<function name="clutter_text_buffer_new">
+<description>
+Create a new ClutterTextBuffer object.
+
+Since: 1.10
+
+</description>
+<parameters>
+</parameters>
+<return> A new ClutterTextBuffer object.
+
+</return>
+</function>
+
+<function name="clutter_text_buffer_new_with_text">
+<description>
+Create a new ClutterTextBuffer object with some text.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="text">
+<parameter_description> initial buffer text
+</parameter_description>
+</parameter>
+<parameter name="text_len">
+<parameter_description> initial buffer text length, or -1 for null-terminated.
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAnimation object. The object is
-owned by the #ClutterActor and should not be unreferenced with
-g_object_unref()
+<return> A new ClutterTextBuffer object.
</return>
</function>
-<function name="clutter_texture_set_from_yuv_data">
+<function name="clutter_text_buffer_set_max_length">
<description>
-Sets a #ClutterTexture from YUV image data. If an error occurred,
-%FALSE is returned and @error is set.
+Sets the maximum allowed length of the contents of the buffer. If
+the current contents are longer than the given length, then they
+will be truncated to fit.
-Since: 0.4
+Since: 1.10
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> A #ClutterTexture
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> Image data in YUV type colorspace.
+<parameter name="max_length">
+<parameter_description> the maximum length of the entry buffer, or 0 for no maximum.
+(other than the maximum length of entries.) The value passed in will
+be clamped to the range [ 0, %CLUTTER_TEXT_BUFFER_MAX_SIZE ].
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width in pixels of image data.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_text_buffer_set_text">
+<description>
+Sets the text in the buffer.
+
+This is roughly equivalent to calling clutter_text_buffer_delete_text()
+and clutter_text_buffer_insert_text().
+
+Note that @n_chars is in characters, not in bytes.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height in pixels of image data
+<parameter name="chars">
+<parameter_description> the new text
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> #ClutterTextureFlags
+<parameter name="n_chars">
+<parameter_description> the number of characters in @text, or -1
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> Return location for a #GError, or %NULL.
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_text_coords_to_position">
+<description>
+Retrieves the position of the character at the given coordinates.
+
+Return: the position of the character
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the X coordinate, relative to the actor
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the Y coordinate, relative to the actor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the texture was successfully updated
-
-</return>
+<return></return>
</function>
-<function name="clutter_stage_set_perspective">
+<function name="clutter_text_delete_chars">
<description>
-Sets the stage perspective.
+Deletes @n_chars inside a #ClutterText actor, starting from the
+current cursor position.
+
+Somewhat awkwardly, the cursor position is decremented by the same
+number of characters you've deleted.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="perspective">
-<parameter_description> A #ClutterPerspective
+<parameter name="n_chars">
+<parameter_description> the number of characters to delete
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_register_closure">
+<function name="clutter_text_delete_selection">
<description>
-#GClosure variant of clutter_alpha_register_func().
-
-Registers a global alpha function and returns its logical id
-to be used by clutter_alpha_set_mode() or by #ClutterAnimation.
+Deletes the currently selected text
-The logical id is always greater than %CLUTTER_ANIMATION_LAST.
+This function is only useful in subclasses of #ClutterText
Since: 1.0
</description>
<parameters>
-<parameter name="closure">
-<parameter_description> a #GClosure
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> the logical id of the alpha function
+<return> %TRUE if text was deleted or if the text actor
+is empty, and %FALSE otherwise
</return>
</function>
-<function name="clutter_actor_apply_relative_transform_to_point">
+<function name="clutter_text_delete_text">
<description>
-Transforms @point in coordinates relative to the actor into
-ancestor-relative coordinates using the relevant transform
-stack (i.e. scale, rotation, etc).
+Deletes the text inside a #ClutterText actor between @start_pos
+and @end_pos.
-If @ancestor is %NULL the ancestor will be the #ClutterStage. In
-this case, the coordinates returned will be the coordinates on
-the stage before the projection is applied. This is different from
-the behaviour of clutter_actor_apply_transform_to_point().
+The starting and ending positions are expressed in characters,
+not in bytes.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
-</parameter_description>
-</parameter>
-<parameter name="ancestor">
-<parameter_description> A #ClutterActor ancestor, or %NULL to use the
-default #ClutterStage
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="point">
-<parameter_description> A point as #ClutterVertex
+<parameter name="start_pos">
+<parameter_description> starting position
</parameter_description>
</parameter>
-<parameter name="vertex">
-<parameter_description> The translated #ClutterVertex
+<parameter name="end_pos">
+<parameter_description> ending position
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_add_timeout_full">
+<function name="clutter_text_get_activatable">
<description>
-Sets a function to be called at regular intervals holding the Clutter
-threads lock, with the given priority. The function is called repeatedly
-until it returns %FALSE, at which point the timeout is automatically
-removed and the function will not be called again. The @notify function
-is called when the timeout is removed.
+Retrieves whether a #ClutterText is activatable or not.
-The first call to the function will be at the end of the first @interval.
+Since: 1.0
-It is important to note that, due to how the Clutter main loop is
-implemented, the timing will not be accurate and it will not try to
-"keep up" with the interval. A more reliable source is available
-using clutter_threads_add_frame_source_full(), which is also internally
-used by #ClutterTimeline.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the actor is activatable
-See also clutter_threads_add_idle_full().
+</return>
+</function>
-Since: 0.4
+<function name="clutter_text_get_attributes">
+<description>
+Gets the attribute list that was set on the #ClutterText actor
+clutter_text_set_attributes(), if any.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="priority">
-<parameter_description> the priority of the timeout source. Typically this will be in the
-range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in milliseconds
+</parameters>
+<return> the attribute list, or %NULL if none was set. The
+returned value is owned by the #ClutterText and should not be unreferenced.
+
+</return>
+</function>
+
+<function name="clutter_text_get_buffer">
+<description>
+Get the #ClutterTextBuffer object which holds the text for
+this widget.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> function to call
+</parameters>
+<return> A #GtkEntryBuffer object.
+
+</return>
+</function>
+
+<function name="clutter_text_get_chars">
+<description>
+Retrieves the contents of the #ClutterText actor between
+ start_pos and @end_pos, but not including @end_pos.
+
+The positions are specified in characters, not in bytes.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to the function
+<parameter name="start_pos">
+<parameter_description> start of text, in characters
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the timeout source is removed
+<parameter name="end_pos">
+<parameter_description> end of text, in characters
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> a newly allocated string with the contents of
+the text actor between the specified positions. Use g_free()
+to free the resources when done
</return>
</function>
-<function name="clutter_actor_set_width">
+<function name="clutter_text_get_color">
<description>
-Forces a width on an actor, causing the actor's preferred width
-and height (if any) to be ignored.
+Retrieves the text color as set by clutter_text_set_color().
-If @width is -1 the actor will use its preferred width request
-instead of overriding it, i.e. you can "unset" the width with -1.
+Since: 1.0
-This function sets both the minimum and natural size of the actor.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-since: 0.2
+<function name="clutter_text_get_cursor_color">
+<description>
+Retrieves the color of the cursor of a #ClutterText actor.
+
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Requested new width for the actor, in pixels, or -1
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_ellipsize">
+<function name="clutter_text_get_cursor_position">
<description>
-Returns the ellipsizing position of a #ClutterText actor, as
-set by clutter_text_set_ellipsize().
+Retrieves the cursor position.
Since: 1.0
@@ -18621,38 +35440,55 @@ Since: 1.0
</parameter_description>
</parameter>
</parameters>
-<return> #PangoEllipsizeMode
+<return> the cursor position, in characters
</return>
</function>
-<function name="clutter_alpha_set_timeline">
+<function name="clutter_text_get_cursor_rect">
<description>
-Binds @alpha to @timeline.
+Retrieves the rectangle that contains the cursor.
-Since: 0.2
+The coordinates of the rectangle's origin are in actor-relative
+coordinates.
+
+Since: 1.16
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> A #ClutterAlpha
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="rect">
+<parameter_description> return location of a #ClutterRect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_delete_text">
+<function name="clutter_text_get_cursor_size">
<description>
-Deletes the text inside a #ClutterText actor between @start_pos
-and @end_pos.
+Retrieves the size of the cursor of a #ClutterText actor.
-The starting and ending positions are expressed in characters,
-not in bytes.
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+</parameters>
+<return> the size of the cursor, in pixels
+
+</return>
+</function>
+
+<function name="clutter_text_get_cursor_visible">
+<description>
+Retrieves whether the cursor of a #ClutterText actor is visible.
Since: 1.0
@@ -18662,631 +35498,820 @@ Since: 1.0
<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="start_pos">
-<parameter_description> starting position
+</parameters>
+<return> %TRUE if the cursor is visible
+
+</return>
+</function>
+
+<function name="clutter_text_get_editable">
+<description>
+Retrieves whether a #ClutterText is editable or not.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> ending position
+</parameters>
+<return> %TRUE if the actor is editable
+
+</return>
+</function>
+
+<function name="clutter_text_get_ellipsize">
+<description>
+Returns the ellipsizing position of a #ClutterText actor, as
+set by clutter_text_set_ellipsize().
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> #PangoEllipsizeMode
+
+</return>
</function>
-<function name="clutter_timeline_get_duration">
+<function name="clutter_text_get_font_description">
<description>
-Retrieves the duration of a #ClutterTimeline in milliseconds.
-See clutter_timeline_set_duration().
+Retrieves the #PangoFontDescription used by @self
-Since: 0.6
+Since: 1.2
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> the duration of the timeline, in milliseconds.
+<return> a #PangoFontDescription. The returned value is owned
+by the #ClutterText actor and it should not be modified or freed
</return>
</function>
-<function name="clutter_get_font_map">
+<function name="clutter_text_get_font_name">
<description>
-Retrieves the #PangoFontMap instance used by Clutter.
-You can use the global font map object with the COGL
-Pango API.
+Retrieves the font name as set by clutter_text_set_font_name().
Since: 1.0
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
</parameters>
-<return> the #PangoFontMap instance. The returned
-value is owned by Clutter and it should never be unreferenced.
+<return> a string containing the font name. The returned
+string is owned by the #ClutterText actor and should not be
+modified or freed
</return>
</function>
-<function name="clutter_behaviour_path_get_path">
+<function name="clutter_text_get_justify">
<description>
-Get the current path of the behaviour
+Retrieves whether the #ClutterText actor should justify its contents
+on both margins.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="pathb">
-<parameter_description> a #ClutterBehaviourPath instance
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> the path
+<return> %TRUE if the text should be justified
</return>
</function>
-<function name="json_object_set_member">
+<function name="clutter_text_get_layout">
<description>
-Sets @node as the value of @member_name inside @object.
+Retrieves the current #PangoLayout used by a #ClutterText actor.
-If @object already contains a member called @member_name then
-the member's current value is overwritten. Otherwise, a new
-member is added to @object.
+Since: 1.0
-Since: 0.8
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #PangoLayout. The returned object is owned by
+the #ClutterText actor and should not be modified or freed
+
+</return>
+</function>
+
+<function name="clutter_text_get_layout_offsets">
+<description>
+Obtains the coordinates where the #ClutterText will draw the #PangoLayout
+representing the text.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="x">
+<parameter_description> location to store X offset of layout, or %NULL
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the value of the member
+<parameter name="y">
+<parameter_description> location to store Y offset of layout, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_box_contains">
+<function name="clutter_text_get_line_alignment">
<description>
-Checks whether a point with @x, @y coordinates is contained
-withing @box
+Retrieves the alignment of a #ClutterText, as set by
+clutter_text_set_line_alignment().
Since: 1.0
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate of the point
+</parameters>
+<return> a #PangoAlignment
+
+</return>
+</function>
+
+<function name="clutter_text_get_line_wrap">
+<description>
+Retrieves the value set using clutter_text_set_line_wrap().
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate of the point
+</parameters>
+<return> %TRUE if the #ClutterText actor should wrap
+its contents
+
+</return>
+</function>
+
+<function name="clutter_text_get_line_wrap_mode">
+<description>
+Retrieves the line wrap mode used by the #ClutterText actor.
+
+See clutter_text_set_line_wrap_mode ().
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the point is contained by the #ClutterActorBox
+<return> the wrap mode used by the #ClutterText
</return>
</function>
-<function name="clutter_timeline_get_delay">
+<function name="clutter_text_get_max_length">
<description>
-Retrieves the delay set using clutter_timeline_set_delay().
+Gets the maximum length of text that can be set into a text actor.
-Since: 0.4
+See clutter_text_set_max_length().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> the delay in milliseconds.
+<return> the maximum number of characters.
</return>
</function>
-<function name="clutter_container_lower_child">
+<function name="clutter_text_get_password_char">
<description>
-Lowers @actor to @sibling level, in the depth ordering.
+Retrieves the character to use in place of the actual text
+as set by clutter_text_set_password_char().
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> the actor to raise
+</parameters>
+<return> a Unicode character or 0 if the password
+character is not set
+
+</return>
+</function>
+
+<function name="clutter_text_get_selectable">
+<description>
+Retrieves whether a #ClutterText is selectable or not.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> the sibling to lower to, or %NULL to lower to the bottom
+</parameters>
+<return> %TRUE if the actor is selectable
+
+</return>
+</function>
+
+<function name="clutter_text_get_selected_text_color">
+<description>
+Retrieves the color of selected text of a #ClutterText actor.
+
+Since: 1.8
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_score_is_playing">
+<function name="clutter_text_get_selection">
<description>
-Query state of a #ClutterScore instance.
+Retrieves the currently selected text.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="score">
-<parameter_description> A #ClutterScore
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if score is currently playing
+<return> a newly allocated string containing the currently
+selected text, or %NULL. Use g_free() to free the returned
+string.
</return>
</function>
-<function name="clutter_bin_layout_get_alignment">
+<function name="clutter_text_get_selection_bound">
<description>
-Retrieves the horizontal and vertical alignment policies for
-a child of @self
-
-If @child is %NULL the default alignment policies will be returned
-instead
+Retrieves the other end of the selection of a #ClutterText actor,
+in characters from the current cursor position.
-Since: 1.2
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterBinLayout
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a child of @container
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> return location for the horizontal
-alignment policy
+</parameters>
+<return> the position of the other end of the selection
+
+</return>
+</function>
+
+<function name="clutter_text_get_selection_color">
+<description>
+Retrieves the color of the selection of a #ClutterText actor.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> return location for the vertical
-alignment policy
+<parameter name="color">
+<parameter_description> return location for a #ClutterColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_rectangle_set_border_width">
+<function name="clutter_text_get_single_line_mode">
<description>
-Sets the width (in pixel) of the border used by @rectangle.
-A @width of 0 will unset the border.
+Retrieves whether the #ClutterText actor is in single line mode.
-Since: 0.2
+Since: 1.0
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #ClutterRectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the border
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the #ClutterText actor is in single line mode
+
+</return>
</function>
-<function name="clutter_actor_realize">
+<function name="clutter_text_get_text">
<description>
-Creates any underlying graphics resources needed by the actor to be
-displayed.
+Retrieves a pointer to the current contents of a #ClutterText
+actor.
-Realization means the actor is now tied to a specific rendering context
-(that is, a specific toplevel stage).
+If you need a copy of the contents for manipulating, either
+use g_strdup() on the returned string, or use:
-This function does nothing if the actor is already realized.
+|[
+copy = clutter_text_get_chars (text, 0, -1);
+]|
-Because a realized actor must have realized parent actors, calling
-clutter_actor_realize() will also realize all parents of the actor.
+Which will return a newly allocated string.
-This function does not realize child actors, except in the special
-case that realizing the stage, when the stage is visible, will
-suddenly map (and thus realize) the children of the stage.
+If the #ClutterText actor is empty, this function will return
+an empty string, and not %NULL.
+
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the contents of the actor. The returned
+string is owned by the #ClutterText actor and should never be modified
+or freed
+
+</return>
</function>
-<function name="clutter_stage_show_cursor">
+<function name="clutter_text_get_use_markup">
<description>
-Shows the cursor on the stage window
+Retrieves whether the contents of the #ClutterText actor should be
+parsed for the Pango text markup.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the contents will be parsed for markup
+
+</return>
</function>
-<function name="clutter_actor_hide_all">
+<function name="clutter_text_insert_text">
<description>
-Calls clutter_actor_hide() on all child actors (if any).
+Inserts @text into a #ClutterActor at the given position.
-Since: 0.2
+If @position is a negative number, the text will be appended
+at the end of the current contents of the #ClutterText.
+
+The position is expressed in characters, not in bytes.
+
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the text to be inserted
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of the insertion, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_skip">
+<function name="clutter_text_insert_unichar">
<description>
-Advance timeline by the requested time in milliseconds
+Inserts @wc at the current cursor position of a
+#ClutterText actor.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> Amount of time to skip
+<parameter name="wc">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_activate">
+<function name="clutter_text_new">
<description>
-Activates the callback associated to the action that is
-bound to the @key_val and @modifiers pair.
+Creates a new #ClutterText actor. This actor can be used to
+display and edit text.
-The callback has the following signature:
+Since: 1.0
-|[
-void (* callback) (GObject *gobject,
-const gchar *action_name,
-guint key_val,
-ClutterModifierType modifiers,
-gpointer user_data);
-]|
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterText actor
-Where the #GObject instance is @gobject and the user data
-is the one passed when installing the action with
-clutter_binding_pool_install_action().
+</return>
+</function>
-If the action bound to the @key_val, @modifiers pair has been
-blocked using clutter_binding_pool_block_action(), the callback
-will not be invoked, and this function will return %FALSE.
+<function name="clutter_text_new_full">
+<description>
+Creates a new #ClutterText actor, using @font_name as the font
+description; @text will be used to set the contents of the actor;
+and @color will be used as the color to render @text.
+
+This function is equivalent to calling clutter_text_new(),
+clutter_text_set_font_name(), clutter_text_set_text() and
+clutter_text_set_color().
Since: 1.0
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
-</parameter_description>
-</parameter>
-<parameter name="key_val">
-<parameter_description> the key symbol
+<parameter name="font_name">
+<parameter_description> a string with a font description
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> bitmask for the modifiers
+<parameter name="text">
+<parameter_description> the contents of the actor
</parameter_description>
</parameter>
-<parameter name="gobject">
-<parameter_description> a #GObject
+<parameter name="color">
+<parameter_description> the color to be used to render @text
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an action was found and was activated
+<return> the newly created #ClutterText actor
</return>
</function>
-<function name="clutter_behaviour_get_n_actors">
+<function name="clutter_text_new_with_buffer">
<description>
-Gets the number of actors this behaviour is applied too.
+Creates a new entry with the specified text buffer.
-Since: 0.2
+Since: 1.10
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="buffer">
+<parameter_description> The buffer to use for the new #ClutterText.
</parameter_description>
</parameter>
</parameters>
-<return> The number of applied actors
+<return> a new #ClutterText
</return>
</function>
-<function name="clutter_animation_set_mode">
+<function name="clutter_text_new_with_text">
<description>
-Sets the animation @mode of @animation. The animation @mode is
-a logical id, either coming from the #ClutterAnimationMode enumeration
-or the return value of clutter_alpha_register_func().
+Creates a new #ClutterText actor, using @font_name as the font
+description; @text will be used to set the contents of the actor.
-This function will also set #ClutterAnimation:alpha if needed.
+This function is equivalent to calling clutter_text_new(),
+clutter_text_set_font_name(), and clutter_text_set_text().
Since: 1.0
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="font_name">
+<parameter_description> a string with a font description
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> an animation mode logical id
+<parameter name="text">
+<parameter_description> the contents of the actor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #ClutterText actor
+
+</return>
</function>
-<function name="clutter_animation_get_interval">
+<function name="clutter_text_node_new">
<description>
-Retrieves the #ClutterInterval associated to @property_name
-inside @animation.
+Creates a new #ClutterPaintNode that will paint a #PangoLayout
+with the given color.
-Since: 1.0
+This function takes a reference on the passed @layout, so it
+is safe to call g_object_unref() after it returns.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="layout">
+<parameter_description> a #PangoLayout, or %NULL
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> name of the property
+<parameter name="color">
+<parameter_description> the color used to paint the layout,
+or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterInterval or %NULL if no
-property with the same name was found. The returned interval is
-owned by the #ClutterAnimation and should not be unreferenced
+<return> the newly created #ClutterPaintNode.
+Use clutter_paint_node_unref() when done
</return>
</function>
-<function name="clutter_animator_get_duration">
+<function name="clutter_text_position_to_coords">
<description>
-Retrieves the current duration of an animator
+Retrieves the coordinates of the given @position.
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position in characters
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return location for the X coordinate, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for the Y coordinate, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="line_height">
+<parameter_description> return location for the line height, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the duration of the animation, in milliseconds
+<return> %TRUE if the conversion was successful
</return>
</function>
-<function name="json_object_set_double_member">
+<function name="clutter_text_set_activatable">
<description>
-Convenience function for setting a floating point @value
-of @member_name inside @object.
+Sets whether a #ClutterText actor should be activatable.
-See also: json_object_set_member()
+An activatable #ClutterText actor will emit the #ClutterText::activate
+signal whenever the 'Enter' (or 'Return') key is pressed; if it is not
+activatable, a new line will be appended to the current content.
-Since: 0.8
+An activatable #ClutterText must also be set as editable using
+clutter_text_set_editable().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
-</parameter_description>
-</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+<parameter name="activatable">
+<parameter_description> whether the #ClutterText actor should be activatable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_script_connect_signals_full">
+<function name="clutter_text_set_attributes">
<description>
-Connects all the signals defined into a UI definition file to their
-handlers.
-
-This function allows to control how the signal handlers are
-going to be connected to their respective signals. It is meant
-primarily for language bindings to allow resolving the function
-names using the native API.
+Sets the attributes list that are going to be applied to the
+#ClutterText contents.
-Applications should use clutter_script_connect_signals().
+The #ClutterText actor will take a reference on the #PangoAttrList
+passed to this function.
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> signal connection function
+<parameter name="attrs">
+<parameter_description> a #PangoAttrList or %NULL to unset the attributes
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to be passed to the signal handlers, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_text_set_buffer">
+<description>
+Set the #ClutterTextBuffer object which holds the text for
+this widget.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> a #ClutterTextBuffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_model_filter_iter">
+<function name="clutter_text_set_color">
<description>
-Checks whether the row pointer by @iter should be filtered or not using
-the filtering function set on @model.
+Sets the color of the contents of a #ClutterText actor.
-This function should be used only by subclasses of #ClutterModel.
+The overall opacity of the #ClutterText actor will be the
+result of the alpha value of @color and the composited
+opacity of the actor itself on the scenegraph, as returned
+by clutter_actor_get_paint_opacity().
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> the row to filter
+<parameter name="color">
+<parameter_description> a #ClutterColor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row should be displayed,
-%FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_event_get_key_unicode">
+<function name="clutter_text_set_cursor_color">
<description>
-Retrieves the unicode value for the key that caused @keyev.
+Sets the color of the cursor of a #ClutterText actor.
+If @color is %NULL, the cursor color will be the same as the
+text color.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="event">
-<parameter_description> A #ClutterKeyEvent
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the color of the cursor, or %NULL to unset it
</parameter_description>
</parameter>
</parameters>
-<return> The unicode value representing the key
-</return>
+<return></return>
</function>
-<function name="clutter_container_destroy_child_meta">
+<function name="clutter_text_set_cursor_position">
<description>
-Destroys the #ClutterChildMeta wrapping @actor inside the
- container, if any.
-
-This function is only useful when removing a #ClutterActor to
-a #ClutterContainer implementation outside of the
-#ClutterContainer::add() virtual function implementation.
+Sets the cursor of a #ClutterText actor at @position.
-Applications should not call this function.
+The position is expressed in characters, not in bytes.
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="position">
+<parameter_description> the new cursor position, in characters
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_transformed_position">
+<function name="clutter_text_set_cursor_size">
<description>
-Gets the absolute position of an actor, in pixels relative to the stage.
+Sets the size of the cursor of a #ClutterText. The cursor
+will only be visible if the #ClutterText:cursor-visible property
+is set to %TRUE.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
<parameter name="self">
-<parameter_description> A #ClutterActor
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate, or %NULL
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate, or %NULL
+<parameter name="size">
+<parameter_description> the size of the cursor, in pixels, or -1 to use the
+default value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_advance">
+<function name="clutter_text_set_cursor_visible">
<description>
-Advance timeline to the requested point. The point is given as a
-time in milliseconds since the timeline started.
+Sets whether the cursor of a #ClutterText actor should be
+visible or not.
-<note><para>The @timeline will not emit the #ClutterTimeline::new-frame
-signal for the given time. The first ::new-frame signal after the call to
-clutter_timeline_advance() will be emit the skipped markers.
-</para></note>
+The color of the cursor will be the same as the text color
+unless clutter_text_set_cursor_color() has been called.
+
+The size of the cursor can be set using clutter_text_set_cursor_size().
+
+The position of the cursor can be changed programmatically using
+clutter_text_set_cursor_position().
+
+Since: 1.0
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> A #ClutterTimeline
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="msecs">
-<parameter_description> Time to advance to
+<parameter name="cursor_visible">
+<parameter_description> whether the cursor should be visible
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_use_markup">
+<function name="clutter_text_set_editable">
<description>
-Retrieves whether the contents of the #ClutterText actor should be
-parsed for the Pango text markup.
+Sets whether the #ClutterText actor should be editable.
+
+An editable #ClutterText with key focus set using
+clutter_actor_grab_key_focus() or clutter_stage_set_key_focus()
+will receive key events and will update its contents accordingly.
Since: 1.0
@@ -19296,41 +36321,45 @@ Since: 1.0
<parameter_description> a #ClutterText
</parameter_description>
</parameter>
+<parameter name="editable">
+<parameter_description> whether the #ClutterText should be editable
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the contents will be parsed for markup
-
-</return>
+<return></return>
</function>
-<function name="clutter_model_foreach">
+<function name="clutter_text_set_ellipsize">
<description>
-Calls @func for each row in the model.
+Sets the mode used to ellipsize (add an ellipsis: "...") to the
+text if there is not enough space to render the entire contents
+of a #ClutterText actor
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a #ClutterModelForeachFunc
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @func
+<parameter name="mode">
+<parameter_description> a #PangoEllipsizeMode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_text_get_selection">
+<function name="clutter_text_set_font_description">
<description>
-Retrieves the currently selected text.
+Sets @font_desc as the font description for a #ClutterText
-Since: 1.0
+The #PangoFontDescription is copied by the #ClutterText actor
+so you can safely call pango_font_description_free() on it after
+calling this function.
+
+Since: 1.2
</description>
<parameters>
@@ -19338,1987 +36367,3220 @@ Since: 1.0
<parameter_description> a #ClutterText
</parameter_description>
</parameter>
+<parameter name="font_desc">
+<parameter_description> a #PangoFontDescription
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly allocated string containing the currently
-selected text, or %NULL. Use g_free() to free the returned
-string.
-
-</return>
+<return></return>
</function>
-<function name="json_generator_to_data">
+<function name="clutter_text_set_font_name">
<description>
-Generates a JSON data stream from @generator and returns it as a
-buffer.
+Sets the font used by a #ClutterText. The @font_name string
+must either be %NULL, which means that the font name from the
+default #ClutterBackend will be used; or be something that can
+be parsed by the pango_font_description_from_string() function,
+like:
+|[
+clutter_text_set_font_name (text, "Sans 10pt");
+clutter_text_set_font_name (text, "Serif 16px");
+clutter_text_set_font_name (text, "Helvetica 10");
+]|
+
+Since: 1.0
</description>
<parameters>
-<parameter name="generator">
-<parameter_description> a #JsonGenerator
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the length of the returned buffer, or %NULL
+<parameter name="font_name">
+<parameter_description> a font name, or %NULL to set the default font name
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated buffer holding a JSON data stream. Use
-g_free() to free the allocated resources.
-</return>
+<return></return>
</function>
-<function name="clutter_glx_texture_pixmap_new_with_pixmap">
+<function name="clutter_text_set_justify">
<description>
-Creates a new #ClutterGLXTexturePixmap for @pixmap
+Sets whether the text of the #ClutterText actor should be justified
+on both margins. This setting is ignored if Clutter is compiled
+against Pango < 1.18.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="pixmap">
-<parameter_description> the X Pixmap to which this texture should be bound
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="justify">
+<parameter_description> whether the text should be justified
</parameter_description>
</parameter>
</parameters>
-<return> A new #ClutterGLXTexturePixmap bound to the given X Pixmap
-
-</return>
+<return></return>
</function>
-<function name="clutter_get_option_group">
+<function name="clutter_text_set_line_alignment">
<description>
-Returns a #GOptionGroup for the command line arguments recognized
-by Clutter. You should add this group to your #GOptionContext with
-g_option_context_add_group(), if you are using g_option_context_parse()
-to parse your commandline arguments.
-
-Calling g_option_context_parse() with Clutter's #GOptionGroup will result
-in Clutter's initialization. That is, the following code:
+Sets the way that the lines of a wrapped label are aligned with
+respect to each other. This does not affect the overall alignment
+of the label within its allocated or specified width.
-|[
-g_option_context_set_main_group (context, clutter_get_option_group ());
-res = g_option_context_parse (context, &argc, &argc, NULL);
-]|
+To align a #ClutterText actor you should add it to a container
+that supports alignment, or use the anchor point.
-is functionally equivalent to:
+Since: 1.0
-|[
-clutter_init (&argc, &argv);
-]|
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="alignment">
+<parameter_description> A #PangoAlignment
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-After g_option_context_parse() on a #GOptionContext containing the
-Clutter #GOptionGroup has returned %TRUE, Clutter is guaranteed to be
-initialized.
+<function name="clutter_text_set_line_wrap">
+<description>
+Sets whether the contents of a #ClutterText actor should wrap,
+if they don't fit the size assigned to the actor.
-Since: 0.2
+Since: 1.0
</description>
<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="line_wrap">
+<parameter_description> whether the contents should wrap
+</parameter_description>
+</parameter>
</parameters>
-<return> a #GOptionGroup for the commandline arguments
-recognized by Clutter
-
-</return>
+<return></return>
</function>
-<function name="clutter_stage_set_color">
+<function name="clutter_text_set_line_wrap_mode">
<description>
-Sets the stage color.
+If line wrapping is enabled (see clutter_text_set_line_wrap()) this
+function controls how the line wrapping is performed. The default is
+%PANGO_WRAP_WORD which means wrap on word boundaries.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> A #ClutterColor
+<parameter name="wrap_mode">
+<parameter_description> the line wrapping mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_array_add_double_element">
+<function name="clutter_text_set_markup">
<description>
-Conveniently adds a floating point @value into @array
+Sets @markup as the contents of a #ClutterText.
-See also: json_array_add_element(), json_node_set_double()
+This is a convenience function for setting a string containing
+Pango markup, and it is logically equivalent to:
-Since: 0.8
+|[
+/ * the order is important * /
+clutter_text_set_text (CLUTTER_TEXT (actor), markup);
+clutter_text_set_use_markup (CLUTTER_TEXT (actor), TRUE);
+]|
+
+Since: 1.0
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a floating point value
+<parameter name="markup">
+<parameter_description> a string containing Pango markup.
+Passing %NULL is the same as passing "" (the empty string)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_input_device_get_pointer_stage">
+<function name="clutter_text_set_max_length">
<description>
-Retrieves the #ClutterStage underneath the pointer of @device
+Sets the maximum allowed length of the contents of the actor. If the
+current contents are longer than the given length, then they will be
+truncated to fit.
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice of type %CLUTTER_POINTER_DEVICE
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="max">
+<parameter_description> the maximum number of characters allowed in the text actor; 0
+to disable or -1 to set the length of the current string
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the #ClutterStage or %NULL
-
-</return>
+<return></return>
</function>
-<function name="json_object_set_boolean_member">
+<function name="clutter_text_set_password_char">
<description>
-Convenience function for setting a boolean @value of
- member_name inside @object.
+Sets the character to use in place of the actual text in a
+password text actor.
-See also: json_object_set_member()
+If @wc is 0 the text will be displayed as it is entered in the
+#ClutterText actor.
-Since: 0.8
+Since: 1.0
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
-</parameter_description>
-</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the member
+<parameter name="wc">
+<parameter_description> a Unicode character, or 0 to unset the password character
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_init">
+<function name="clutter_text_set_preedit_string">
<description>
-It will initialise everything needed to operate with Clutter and
-parses some standard command line options. @argc and @argv are
-adjusted accordingly so your own code will never see those standard
-arguments.
+Sets, or unsets, the pre-edit string. This function is useful
+for input methods to display a string (with eventual specific
+Pango attributes) before it is entered inside the #ClutterText
+buffer.
+The preedit string and attributes are ignored if the #ClutterText
+actor is not editable.
+
+This function should not be used by applications
+
+Since: 1.2
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> The number of arguments in @argv
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> A pointer to an array
-of arguments.
+<parameter name="preedit_str">
+<parameter_description> the pre-edit string, or %NULL to unset it
+</parameter_description>
+</parameter>
+<parameter name="preedit_attrs">
+<parameter_description> the pre-edit string attributes
+</parameter_description>
+</parameter>
+<parameter name="cursor_pos">
+<parameter_description> the cursor position for the pre-edit string
</parameter_description>
</parameter>
</parameters>
-<return> 1 on success, < 0 on failure.
-</return>
+<return></return>
</function>
-<function name="clutter_media_get_playing">
+<function name="clutter_text_set_selectable">
<description>
-Retrieves the playing status of @media.
+Sets whether a #ClutterText actor should be selectable.
-Since: 0.2
+A selectable #ClutterText will allow selecting its contents using
+the pointer or the keyboard.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="media">
-<parameter_description> A #ClutterMedia object
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="selectable">
+<parameter_description> whether the #ClutterText actor should be selectable
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if playing, %FALSE if stopped.
-
-</return>
+<return></return>
</function>
-<function name="clutter_box_packv">
+<function name="clutter_text_set_selected_text_color">
<description>
-Vector-based variant of clutter_box_pack(), intended for language
-bindings to use
+Sets the selected text color of a #ClutterText actor.
-Since: 1.2
+If @color is %NULL, the selected text color will be the same as the
+selection color, which then falls back to cursor, and then text color.
+
+Since: 1.8
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="color">
+<parameter_description> the selected text color, or %NULL to unset it
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> the number of properties to set
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_text_set_selection">
+<description>
+Selects the region of text between @start_pos and @end_pos.
+
+This function changes the position of the cursor to match
+ start_pos and the selection bound to match @end_pos.
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="properties">
-<parameter_description> a vector
-containing the property names to set
+<parameter name="start_pos">
+<parameter_description> start of the selection, in characters
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector containing the property
-values to set
+<parameter name="end_pos">
+<parameter_description> end of the selection, in characters
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_new">
+<function name="clutter_text_set_selection_bound">
<description>
-Creates a new #ClutterBindingPool that can be used to store
-key bindings for an actor. The @name must be a unique identifier
-for the binding pool, so that clutter_binding_pool_find() will
-be able to return the correct binding pool.
+Sets the other end of the selection, starting from the current
+cursor position.
+
+If @selection_bound is -1, the selection unset.
Since: 1.0
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the binding pool
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="selection_bound">
+<parameter_description> the position of the end of the selection, in characters
</parameter_description>
</parameter>
</parameters>
-<return> the newly created binding pool with the given
-name. Use g_object_unref() when done.
-
-</return>
+<return></return>
</function>
-<function name="clutter_texture_set_repeat">
+<function name="clutter_text_set_selection_color">
<description>
-Sets whether the @texture should repeat horizontally or
-vertically when the actor size is bigger than the image size
+Sets the color of the selection of a #ClutterText actor.
+
+If @color is %NULL, the selection color will be the same as the
+cursor color, or if no cursor color is set either then it will be
+the same as the text color.
Since: 1.0
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
-</parameter_description>
-</parameter>
-<parameter name="repeat_x">
-<parameter_description> %TRUE if the texture should repeat horizontally
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="repeat_y">
-<parameter_description> %TRUE if the texture should repeat vertically
+<parameter name="color">
+<parameter_description> the color of the selection, or %NULL to unset it
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_ensure_viewport">
+<function name="clutter_text_set_single_line_mode">
<description>
-Ensures that the GL viewport is updated with the current
-stage window size.
+Sets whether a #ClutterText actor should be in single line mode
+or not. Only editable #ClutterText<!-- -->s can be in single line
+mode.
-This function will queue a redraw of @stage.
+A text actor in single line mode will not wrap text and will clip
+the visible area to the predefined size. The contents of the
+text actor will scroll to display the end of the text if its length
+is bigger than the allocated width.
-This function should not be called by applications; it is used
-when embedding a #ClutterStage into a toolkit with another
-windowing system, like GTK+.
+When setting the single line mode the #ClutterText:activatable
+property is also set as a side effect. Instead of entering a new
+line character, the text actor will emit the #ClutterText::activate
+signal.
Since: 1.0
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="self">
+<parameter_description> a #ClutterText
+</parameter_description>
+</parameter>
+<parameter name="single_line">
+<parameter_description> whether to enable single line mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_backend_set_font_name">
+<function name="clutter_text_set_text">
<description>
-Sets the default font to be used by Clutter. The @font_name string
-must either be %NULL, which means that the font name from the
-default #ClutterBackend will be used; or be something that can
-be parsed by the pango_font_description_from_string() function.
+Sets the contents of a #ClutterText actor.
+
+If the #ClutterText:use-markup property was set to %TRUE it
+will be reset to %FALSE as a side effect. If you want to
+maintain the #ClutterText:use-markup you should use the
+clutter_text_set_markup() function instead
Since: 1.0
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="font_name">
-<parameter_description> the name of the font
+<parameter name="text">
+<parameter_description> the text to set. Passing %NULL is the same
+as passing "" (the empty string)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_actors_foreach">
+<function name="clutter_text_set_use_markup">
<description>
-Calls @func for every actor driven by @behave.
+Sets whether the contents of the #ClutterText actor contains markup
+in <link linkend="PangoMarkupFormat">Pango's text markup language</link>.
-Since: 0.2
+Setting #ClutterText:use-markup on an editable #ClutterText will
+not have any effect except hiding the markup.
+
+See also #ClutterText:use-markup.
+
+Since: 1.0
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a function called for each actor
+<parameter name="self">
+<parameter_description> a #ClutterText
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> optional data to be passed to the function, or %NULL
+<parameter name="setting">
+<parameter_description> %TRUE if the text should be parsed for markup.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_rotate_set_center">
+<function name="clutter_texture_get_base_size">
<description>
-Sets the center of rotation. The coordinates are relative to the plane
-normal to the rotation axis set with clutter_behaviour_rotate_set_axis().
+Gets the size in pixels of the untransformed underlying image
-Since: 0.4
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="rotate">
-<parameter_description> a #ClutterBehaviourRotate
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X axis center of rotation
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y axis center of rotation
+<parameter name="width">
+<parameter_description> return location for the width, or %NULL
</parameter_description>
</parameter>
-<parameter name="z">
-<parameter_description> Z axis center of rotation
+<parameter name="height">
+<parameter_description> return location for the height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_grab_key_focus">
+<function name="clutter_texture_get_cogl_material">
<description>
-Sets the key focus of the #ClutterStage including @self
-to this #ClutterActor.
+Returns a handle to the underlying COGL material used for drawing
+the actor.
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a handle for a #CoglMaterial. The
+material is owned by the #ClutterTexture and it should not be
+unreferenced
+
+</return>
</function>
-<function name="clutter_x11_get_input_devices">
+<function name="clutter_texture_get_cogl_texture">
<description>
-Retrieves a pointer to the list of input devices
+Retrieves the handle to the underlying COGL texture used for drawing
+the actor. No extra reference is taken so if you need to keep the
+handle then you should call cogl_handle_ref() on it.
-Deprecated: 1.2: Use clutter_device_manager_peek_devices() instead
+The texture handle returned is the first layer of the material
+handle used by the #ClutterTexture. If you need to access the other
+layers you should use clutter_texture_get_cogl_material() instead
+and use the #CoglMaterial API.
Since: 0.8
+Deprecated: 1.12
</description>
<parameters>
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
+</parameter_description>
+</parameter>
</parameters>
-<return> a pointer to the internal list of input devices; the
-returned list is owned by Clutter and should not be modified or
-freed
+<return> a #CoglHandle for the texture. The returned
+handle is owned by the #ClutterTexture and it should not be unreferenced
+
</return>
</function>
-<function name="json_node_is_null">
+<function name="clutter_texture_get_filter_quality">
<description>
-Checks whether @node is a %JSON_NODE_NULL
-
-<note>A null node is not the same as a %NULL #JsonNode</note>
+Gets the filter quality used when scaling a texture.
Since: 0.8
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the node is null
+<return> The filter quality value.
</return>
</function>
-<function name="clutter_color_to_string">
+<function name="clutter_texture_get_keep_aspect_ratio">
<description>
-Returns a textual specification of @color in the hexadecimal form
-<literal>rrggbbaa</literal>, where <literal>r</literal>,
-<literal>g</literal>, <literal>b</literal> and <literal>a</literal> are
-hex digits representing the red, green, blue and alpha components
-respectively.
+Retrieves the value set using clutter_texture_set_keep_aspect_ratio()
-Since: 0.2
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated text string
+<return> %TRUE if the #ClutterTexture should maintain the
+aspect ratio of the underlying image
</return>
</function>
-<function name="clutter_actor_show_all">
+<function name="clutter_texture_get_load_async">
<description>
-Calls clutter_actor_show() on all children of an actor (if any).
+Retrieves the value set using clutter_texture_set_load_async()
-Since: 0.2
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the #ClutterTexture should load the data from
+disk asynchronously
+
+</return>
</function>
-<function name="clutter_shader_get_cogl_vertex_shader">
+<function name="clutter_texture_get_load_data_async">
<description>
-Retrieves the underlying #CoglHandle for the vertex shader.
+Retrieves the value set by clutter_texture_set_load_data_async()
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return> A #CoglHandle for the vertex shader, or %NULL
+<return> %TRUE if the #ClutterTexture should load the image
+data from a file asynchronously
</return>
</function>
-<function name="clutter_stage_new">
+<function name="clutter_texture_get_max_tile_waste">
<description>
-Creates a new, non-default stage. A non-default stage is a new
-top-level actor which can be used as another container. It works
-exactly like the default stage, but while clutter_stage_get_default()
-will always return the same instance, you will have to keep a pointer
-to any #ClutterStage returned by clutter_stage_create().
-
-The ability to support multiple stages depends on the current
-backend. Use clutter_feature_available() and
-%CLUTTER_FEATURE_STAGE_MULTIPLE to check at runtime whether a
-backend supports multiple stages.
+Gets the maximum waste that will be used when creating a texture or
+-1 if slicing is disabled.
Since: 0.8
+Deprecated: 1.12
+
</description>
<parameters>
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
+</parameter_description>
+</parameter>
</parameters>
-<return> a new stage, or %NULL if the default backend does
-not support multiple stages. Use clutter_actor_destroy() to
-programmatically close the returned stage.
+<return> The maximum waste or -1 if the texture waste is
+unlimited.
</return>
</function>
-<function name="clutter_units_from_em_for_font">
+<function name="clutter_texture_get_pick_with_alpha">
<description>
-Stores a value in em inside @units using @font_name
+Retrieves the value set by clutter_texture_set_load_data_async()
-Since: 1.0
+Since: 1.4
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
-</parameter_description>
-</parameter>
-<parameter name="font_name">
-<parameter_description> the font name and size
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="em">
-<parameter_description> em
+</parameters>
+<return> %TRUE if the #ClutterTexture should define its shape
+using the alpha channel when picking.
+
+</return>
+</function>
+
+<function name="clutter_texture_get_pixel_format">
+<description>
+Retrieves the pixel format used by @texture. This is
+equivalent to:
+
+|[
+handle = clutter_texture_get_pixel_format (texture);
+
+if (handle != COGL_INVALID_HANDLE)
+format = cogl_texture_get_format (handle);
+]|
+
+Since: 1.0
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #CoglPixelFormat value
+
+</return>
</function>
-<function name="clutter_text_set_selection">
+<function name="clutter_texture_get_repeat">
<description>
-Selects the region of text between @start_pos and @end_pos.
-
-This function changes the position of the cursor to match
- start_pos and the selection bound to match @end_pos.
+Retrieves the horizontal and vertical repeat values set
+using clutter_texture_set_repeat()
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="start_pos">
-<parameter_description> start of the selection, in characters
+<parameter name="repeat_x">
+<parameter_description> return location for the horizontal repeat
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> end of the selection, in characters
+<parameter name="repeat_y">
+<parameter_description> return location for the vertical repeat
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_device_manager_get_device">
+<function name="clutter_texture_get_sync_size">
<description>
-Retrieves the #ClutterInputDevice with the given @device_id
+Retrieves the value set with clutter_texture_set_sync_size()
-Since: 1.2
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="device_manager">
-<parameter_description> a #ClutterDeviceManager
-</parameter_description>
-</parameter>
-<parameter name="device_id">
-<parameter_description> the integer id of a device
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterInputDevice or %NULL. The
-returned device is owned by the #ClutterDeviceManager and should
-never be modified or freed
+<return> %TRUE if the #ClutterTexture should have the same
+preferred size of the underlying image data
</return>
</function>
-<function name="clutter_actor_get_reactive">
+<function name="clutter_texture_new">
<description>
-Checks whether @actor is marked as reactive.
+Creates a new empty #ClutterTexture object.
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> A newly created #ClutterTexture object.
+
+</return>
+</function>
+
+<function name="clutter_texture_new_from_actor">
+<description>
+Creates a new #ClutterTexture object with its source a prexisting
+actor (and associated children). The textures content will contain
+'live' redirected output of the actors scene.
+
+Note this function is intented as a utility call for uniformly applying
+shaders to groups and other potential visual effects. It requires that
+the %CLUTTER_FEATURE_OFFSCREEN feature is supported by the current backend
+and the target system.
+
+Some tips on usage:
+
+<itemizedlist>
+<listitem>
+<para>The source actor must be made visible (i.e by calling
+#clutter_actor_show).</para>
+</listitem>
+<listitem>
+<para>The source actor must have a parent in order for it to be
+allocated a size from the layouting mechanism. If the source
+actor does not have a parent when this function is called then
+the ClutterTexture will adopt it and allocate it at its
+preferred size. Using this you can clone an actor that is
+otherwise not displayed. Because of this feature if you do
+intend to display the source actor then you must make sure that
+the actor is parented before calling
+clutter_texture_new_from_actor() or that you unparent it before
+adding it to a container.</para>
+</listitem>
+<listitem>
+<para>When getting the image for the clone texture, Clutter
+will attempt to render the source actor exactly as it would
+appear if it was rendered on screen. The source actor's parent
+transformations are taken into account. Therefore if your
+source actor is rotated along the X or Y axes so that it has
+some depth, the texture will appear differently depending on
+the on-screen location of the source actor. While painting the
+source actor, Clutter will set up a temporary asymmetric
+perspective matrix as the projection matrix so that the source
+actor will be projected as if a small section of the screen was
+being viewed. Before version 0.8.2, an orthogonal identity
+projection was used which meant that the source actor would be
+clipped if any part of it was not on the zero Z-plane.</para>
+</listitem>
+<listitem>
+<para>Avoid reparenting the source with the created texture.</para>
+</listitem>
+<listitem>
+<para>A group can be padded with a transparent rectangle as to
+provide a border to contents for shader output (blurring text
+for example).</para>
+</listitem>
+<listitem>
+<para>The texture will automatically resize to contain a further
+transformed source. However, this involves overhead and can be
+avoided by placing the source actor in a bounding group
+sized large enough to contain any child tranformations.</para>
+</listitem>
+<listitem>
+<para>Uploading pixel data to the texture (e.g by using
+clutter_texture_set_from_file()) will destroy the offscreen texture
+data and end redirection.</para>
+</listitem>
+<listitem>
+<para>cogl_texture_get_data() with the handle returned by
+clutter_texture_get_cogl_texture() can be used to read the
+offscreen texture pixels into a pixbuf.</para>
+</listitem>
+</itemizedlist>
Since: 0.6
+Deprecated: 1.8: Use the #ClutterOffscreenEffect and #ClutterShaderEffect
+directly on the intended #ClutterActor to replace the functionality of
+this function.
+
</description>
<parameters>
<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter_description> A source #ClutterActor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the actor is reactive
+<return> A newly created #ClutterTexture object, or %NULL on failure.
</return>
</function>
-<function name="clutter_animator_compute_value">
+<function name="clutter_texture_new_from_file">
<description>
-Compute the value for a managed property at a given progress.
+Creates a new ClutterTexture actor to display the image contained a
+file. If the image failed to load then NULL is returned and @error
+is set.
-If the property is an ease-in property, the current value of the property
-on the object will be used as the starting point for computation.
+Since: 0.8
-Since: 1.2
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
-</parameter_description>
-</parameter>
-<parameter name="object">
-<parameter_description> a #GObject
-</parameter_description>
-</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property on object to check
-</parameter_description>
-</parameter>
-<parameter name="progress">
-<parameter_description> a value between 0.0 and 1.0
+<parameter name="filename">
+<parameter_description> The name of an image file to load.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an initialized value to store the computed result
+<parameter name="error">
+<parameter_description> Return locatoin for an error.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the computation yields has a value, otherwise (when
-an error occurs or the progress is before any of the keys) %FALSE is
-returned and the #GValue is left untouched
+<return> A newly created #ClutterTexture object or NULL on
+error.
</return>
</function>
-<function name="clutter_actor_allocate_available_size">
+<function name="clutter_texture_node_new">
<description>
-Allocates @self taking into account the #ClutterActor<!-- -->'s
-preferred size, but limiting it to the maximum available width
-and height provided.
+Creates a new #ClutterPaintNode that will paint the passed @texture.
-This function will do the right thing when dealing with the
-actor's request mode.
+This function will take a reference on @texture, so it is safe to
+call cogl_object_unref() on @texture when it returns.
-The implementation of this function is equivalent to:
+The @color must not be pre-multiplied with its #ClutterColor.alpha
+channel value; if @color is %NULL, a fully opaque white color will
+be used for blending.
-|[
-if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH)
-{
-clutter_actor_get_preferred_width (self, available_height,
-&min_width,
-&natural_width);
-width = CLAMP (natural_width, min_width, available_width);
+Since: 1.10
-clutter_actor_get_preferred_height (self, width,
-&min_height,
-&natural_height);
-height = CLAMP (natural_height, min_height, available_height);
-}
-else
-{
-clutter_actor_get_preferred_height (self, available_width,
-&min_height,
-&natural_height);
-height = CLAMP (natural_height, min_height, available_height);
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> a #CoglTexture
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #ClutterColor used for blending, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="min_filter">
+<parameter_description> the minification filter for the texture
+</parameter_description>
+</parameter>
+<parameter name="mag_filter">
+<parameter_description> the magnification filter for the texture
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly created #ClutterPaintNode.
+Use clutter_paint_node_unref() when done
-clutter_actor_get_preferred_width (self, height,
-&min_width,
-&natural_width);
-width = CLAMP (natural_width, min_width, available_width);
-}
+</return>
+</function>
-box.x1 = x; box.y1 = y;
-box.x2 = box.x1 + available_width;
-box.y2 = box.y1 + available_height;
-clutter_actor_allocate (self, &box, flags);
-]|
+<function name="clutter_texture_set_area_from_rgb_data">
+<description>
+Updates a sub-region of the pixel data in a #ClutterTexture.
-This function can be used by fluid layout managers to allocate
-an actor's preferred size without making it bigger than the area
-available for the container.
+Since: 0.6
-Since: 1.0
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> Image data in RGB type colorspace.
+</parameter_description>
+</parameter>
+<parameter name="has_alpha">
+<parameter_description> Set to TRUE if image data has an alpha channel.
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the actor's X coordinate
+<parameter_description> X coordinate of upper left corner of region to update.
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the actor's Y coordinate
+<parameter_description> Y coordinate of upper left corner of region to update.
</parameter_description>
</parameter>
-<parameter name="available_width">
-<parameter_description> the maximum available width, or -1 to use the
-actor's natural width
+<parameter name="width">
+<parameter_description> Width in pixels of region to update.
</parameter_description>
</parameter>
-<parameter name="available_height">
-<parameter_description> the maximum available height, or -1 to use the
-actor's natural height
+<parameter name="height">
+<parameter_description> Height in pixels of region to update.
+</parameter_description>
+</parameter>
+<parameter name="rowstride">
+<parameter_description> Distance in bytes between row starts on source buffer.
+</parameter_description>
+</parameter>
+<parameter name="bpp">
+<parameter_description> bytes per pixel (Currently only 3 and 4 supported,
+depending on @has_alpha)
</parameter_description>
</parameter>
<parameter name="flags">
-<parameter_description> flags controlling the allocation
+<parameter_description> #ClutterTextureFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success, %FALSE on failure.
+
+</return>
</function>
-<function name="clutter_model_prependv">
+<function name="clutter_texture_set_cogl_material">
<description>
-Creates and prepends a new row to the #ClutterModel, setting the row
-values for the given @columns upon creation.
+Replaces the underlying Cogl material drawn by this actor with
+ cogl_material A reference to the material is taken so if the
+handle is no longer needed it should be deref'd with
+cogl_handle_unref. Texture data is attached to the material so
+calling this function also replaces the Cogl
+texture. #ClutterTexture requires that the material have a texture
+layer so you should set one on the material before calling this
+function.
-Since: 0.6
+Since: 0.8
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> the number of columns and values to set
+<parameter name="cogl_material">
+<parameter_description> A CoglHandle for a material
</parameter_description>
</parameter>
-<parameter name="columns">
-<parameter_description> a vector containing the columns to set
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_texture_set_cogl_texture">
+<description>
+Replaces the underlying COGL texture drawn by this actor with
+ cogl_tex A reference to the texture is taken so if the handle is
+no longer needed it should be deref'd with cogl_handle_unref.
+
+Since: 0.8
+
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a vector containing the values for the cells
+<parameter name="cogl_tex">
+<parameter_description> A CoglHandle for a texture
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_event_get_coords">
+<function name="clutter_texture_set_filter_quality">
<description>
-Retrieves the coordinates of @event and puts them into @x and @y.
+Sets the filter quality when scaling a texture. The quality is an
+enumeration currently the following values are supported:
+%CLUTTER_TEXTURE_QUALITY_LOW which is fast but only uses nearest neighbour
+interpolation. %CLUTTER_TEXTURE_QUALITY_MEDIUM which is computationally a
+bit more expensive (bilinear interpolation), and
+%CLUTTER_TEXTURE_QUALITY_HIGH which uses extra texture memory resources to
+improve scaled down rendering as well (by using mipmaps). The default value
+is %CLUTTER_TEXTURE_QUALITY_MEDIUM.
-Since: 0.4
+Since: 0.8
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate
+<parameter name="filter_quality">
+<parameter_description> new filter quality value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_container_get_child_meta">
+<function name="clutter_texture_set_from_file">
<description>
-Retrieves the #ClutterChildMeta which contains the data about the
- container specific state for @actor.
+Sets the #ClutterTexture image data from an image file. In case of
+failure, %FALSE is returned and @error is set.
+
+If #ClutterTexture:load-async is set to %TRUE, this function
+will return as soon as possible, and the actual image loading
+from disk will be performed asynchronously. #ClutterTexture::size-change
+will be emitten when the size of the texture is available and
+#ClutterTexture::load-finished will be emitted when the image has been
+loaded or if an error occurred.
Since: 0.8
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor that is a child of @container.
+<parameter name="filename">
+<parameter_description> The filename of the image in GLib file name encoding
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterChildMeta for the @actor child
-of @container or %NULL if the specifiec actor does not exist or the
-container is not configured to provide #ClutterChildMeta<!-- -->s
+<return> %TRUE if the image was successfully loaded and set
</return>
</function>
-<function name="clutter_interval_new_with_values">
+<function name="clutter_texture_set_from_rgb_data">
<description>
-Creates a new #ClutterInterval of type @gtype, between @initial
-and @final.
+Sets #ClutterTexture image data.
-This function is useful for language bindings.
+Since: 0.4
-Since: 1.0
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="gtype">
-<parameter_description> the type of the values in the interval
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="initial">
-<parameter_description> a #GValue holding the initial value of the interval
+<parameter name="data">
+<parameter_description> image data in RGBA type colorspace.
</parameter_description>
</parameter>
-<parameter name="final">
-<parameter_description> a #GValue holding the final value of the interval
+<parameter name="has_alpha">
+<parameter_description> set to %TRUE if image data has an alpha channel.
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width in pixels of image data.
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height in pixels of image data
+</parameter_description>
+</parameter>
+<parameter name="rowstride">
+<parameter_description> distance in bytes between row starts.
+</parameter_description>
+</parameter>
+<parameter name="bpp">
+<parameter_description> bytes per pixel (currently only 3 and 4 supported, depending
+on the value of @has_alpha)
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #ClutterTextureFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterInterval
+<return> %TRUE on success, %FALSE on failure.
</return>
</function>
-<function name="clutter_text_new_full">
+<function name="clutter_texture_set_from_yuv_data">
<description>
-Creates a new #ClutterText actor, using @font_name as the font
-description; @text will be used to set the contents of the actor;
-and @color will be used as the color to render @text.
+Sets a #ClutterTexture from YUV image data. If an error occurred,
+%FALSE is returned and @error is set.
-This function is equivalent to calling clutter_text_new(),
-clutter_text_set_font_name(), clutter_text_set_text() and
-clutter_text_set_color().
+The YUV support depends on the driver; the format supported by the
+few drivers exposing this capability are not really useful.
-Since: 1.0
+The proper way to convert image data in any YUV colorspace to any
+RGB colorspace is to use a fragment shader associated with the
+#ClutterTexture material.
+
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_texture_get_cogl_material() and
+the Cogl API to install a fragment shader for decoding YUV
+formats on the GPU
</description>
<parameters>
-<parameter name="font_name">
-<parameter_description> a string with a font description
+<parameter name="texture">
+<parameter_description> A #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the contents of the actor
+<parameter name="data">
+<parameter_description> Image data in YUV type colorspace.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to be used to render @text
+<parameter name="width">
+<parameter_description> Width in pixels of image data.
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> Height in pixels of image data
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> #ClutterTextureFlags
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for a #GError, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterText actor
+<return> %TRUE if the texture was successfully updated
</return>
</function>
-<function name="clutter_units_to_string">
+<function name="clutter_texture_set_keep_aspect_ratio">
<description>
-Converts @units into a string
+Sets whether @texture should have a preferred size maintaining
+the aspect ratio of the underlying image
-See clutter_units_from_string() for the units syntax and for
-examples of output
+Since: 1.0
-<note>Fractional values are truncated to the second decimal
-position for em, mm and cm, and to the first decimal position for
-typographic points. Pixels are integers.</note>
+Deprecated: 1.12
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
+</parameter_description>
+</parameter>
+<parameter name="keep_aspect">
+<parameter_description> %TRUE to maintain aspect ratio
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_texture_set_load_async">
+<description>
+Sets whether @texture should use a worker thread to load the data
+from disk asynchronously. Setting @load_async to %TRUE will make
+clutter_texture_set_from_file() return immediately.
+
+See the #ClutterTexture:load-async property documentation, and
+clutter_texture_set_load_data_async().
Since: 1.0
+Deprecated: 1.12
+
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
+</parameter_description>
+</parameter>
+<parameter name="load_async">
+<parameter_description> %TRUE if the texture should asynchronously load data
+from a filename
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing the encoded
-#ClutterUnits value. Use g_free() to free the string
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_set_x">
+<function name="clutter_texture_set_load_data_async">
<description>
-Sets the actor's X coordinate, relative to its parent, in pixels.
+Sets whether @texture should use a worker thread to load the data
+from disk asynchronously. Setting @load_async to %TRUE will make
+clutter_texture_set_from_file() block until the #ClutterTexture has
+determined the width and height of the image data.
-Overrides any layout manager and forces a fixed position for
-the actor.
+See the #ClutterTexture:load-async property documentation, and
+clutter_texture_set_load_async().
-Since: 0.6
+Since: 1.0
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the actor's position on the X axis
+<parameter name="load_async">
+<parameter_description> %TRUE if the texture should asynchronously load data
+from a filename
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_y">
+<function name="clutter_texture_set_pick_with_alpha">
<description>
-Sets the actor's Y coordinate, relative to its parent, in pixels.#
+Sets whether @texture should have it's shape defined by the alpha
+channel when picking.
-Overrides any layout manager and forces a fixed position for
-the actor.
+Be aware that this is a bit more costly than the default picking
+due to the texture lookup, extra test against the alpha value and
+the fact that it will also interrupt the batching of geometry done
+internally.
-Since: 0.6
+Also there is currently no control over the threshold used to
+determine what value of alpha is considered pickable, and so only
+fully opaque parts of the texture will react to picking.
+
+Since: 1.4
+
+Deprecated: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the actor's position on the Y axis
+<parameter name="pick_with_alpha">
+<parameter_description> %TRUE if the alpha channel should affect the
+picking shape
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_input_device_update_from_event">
+<function name="clutter_texture_set_repeat">
<description>
-Forcibly updates the state of the @device using a #ClutterEvent
+Sets whether the @texture should repeat horizontally or
+vertically when the actor size is bigger than the image size
-This function should never be used by applications: it is meant
-for integration with embedding toolkits, like clutter-gtk
+Since: 1.0
-Embedding toolkits that disable the event collection inside Clutter
-need to use this function to update the state of input devices depending
-on a #ClutterEvent that they are going to submit to the event handling code
-in Clutter though clutter_do_event(). Since the input devices hold the state
-that is going to be used to fill in fields like the #ClutterButtonEvent
-click count, or to emit synthesized events like %CLUTTER_ENTER and
-%CLUTTER_LEAVE, it is necessary for embedding toolkits to also be
-responsible of updating the input device state.
+Deprecated: 1.12
-For instance, this might be the code to translate an embedding toolkit
-native motion notification into a Clutter #ClutterMotionEvent and ask
-Clutter to process it:
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
+</parameter_description>
+</parameter>
+<parameter name="repeat_x">
+<parameter_description> %TRUE if the texture should repeat horizontally
+</parameter_description>
+</parameter>
+<parameter name="repeat_y">
+<parameter_description> %TRUE if the texture should repeat vertically
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-|[
-ClutterEvent c_event;
+<function name="clutter_texture_set_sync_size">
+<description>
+Sets whether @texture should have the same preferred size as the
+underlying image data.
-translate_native_event_to_clutter (native_event, &c_event);
+Since: 1.0
-clutter_do_event (&c_event);
-]|
+Deprecated: 1.12
-Before letting clutter_do_event() process the event, it is necessary to call
-clutter_input_device_update_from_event():
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> a #ClutterTexture
+</parameter_description>
+</parameter>
+<parameter name="sync_size">
+<parameter_description> %TRUE if the texture should have the same size of the
+underlying image data
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-|[
-ClutterEvent c_event;
-ClutterDeviceManager *manager;
-ClutterInputDevice *device;
+<function name="clutter_threads_add_frame_source">
+<description>
+Simple wrapper around clutter_threads_add_frame_source_full().
-translate_native_event_to_clutter (native_event, &c_event);
+Since: 0.8
-/ * get the device manager * /
-manager = clutter_device_manager_get_default ();
+Deprecated: 1.6
-/ * use the default Core Pointer that Clutter
-* backends register by default
-* /
-device = clutter_device_manager_get_core_device (manager, %CLUTTER_POINTER_DEVICE);
+</description>
+<parameters>
+<parameter name="fps">
+<parameter_description> the number of times per second to call the function
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to the function
+</parameter_description>
+</parameter>
+</parameters>
+<return> the ID (greater than 0) of the event source.
-/ * update the state of the input device * /
-clutter_input_device_update_from_event (device, &c_event, FALSE);
+</return>
+</function>
-clutter_do_event (&c_event);
-]|
+<function name="clutter_threads_add_frame_source_full">
+<description>
+Sets a function to be called at regular intervals holding the Clutter
+threads lock, with the given priority. The function is called repeatedly
+until it returns %FALSE, at which point the timeout is automatically
+removed and the function will not be called again. The @notify function
+is called when the timeout is removed.
-The @update_stage boolean argument should be used when the input device
-enters and leaves a #ClutterStage; it will use the #ClutterStage field
-of the passed @event to update the stage associated to the input device.
+This function is similar to clutter_threads_add_timeout_full()
+except that it will try to compensate for delays. For example, if
+ func takes half the interval time to execute then the function
+will be called again half the interval time after it finished. In
+contrast clutter_threads_add_timeout_full() would not fire until a
+full interval after the function completes so the delay between
+calls would be @interval * 1.5. This function does not however try
+to invoke the function multiple times to catch up missing frames if
+ func takes more than @interval ms to execute.
-Since: 1.2
+See also clutter_threads_add_idle_full().
+
+Since: 0.8
+
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #ClutterInputDevice
+<parameter name="priority">
+<parameter_description> the priority of the frame source. Typically this will be in the
+range between %G_PRIORITY_DEFAULT and %G_PRIORITY_HIGH.
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="fps">
+<parameter_description> the number of times per second to call the function
</parameter_description>
</parameter>
-<parameter name="update_stage">
-<parameter_description> whether to update the #ClutterStage of the @device
-using the stage of the event
+<parameter name="func">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to the function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the timeout source is removed
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="clutter_behaviour_depth_new">
+<function name="clutter_threads_add_idle">
<description>
-Creates a new #ClutterBehaviourDepth which can be used to control
-the ClutterActor:depth property of a set of #ClutterActor<!-- -->s.
+Simple wrapper around clutter_threads_add_idle_full() using the
+default priority.
Since: 0.4
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha or %NULL
-</parameter_description>
-</parameter>
-<parameter name="depth_start">
-<parameter_description> initial value of the depth
+<parameter name="func">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="depth_end">
-<parameter_description> final value of the depth
+<parameter name="data">
+<parameter_description> data to pass to the function
</parameter_description>
</parameter>
</parameters>
-<return> the newly created behaviour
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="clutter_binding_pool_find">
+<function name="clutter_threads_add_idle_full">
<description>
-Finds the #ClutterBindingPool with @name.
+Adds a function to be called whenever there are no higher priority
+events pending. If the function returns %FALSE it is automatically
+removed from the list of event sources and will not be called again.
-Since: 1.0
+This function can be considered a thread-safe variant of g_idle_add_full():
+it will call @function while holding the Clutter lock. It is logically
+equivalent to the following implementation:
+
+|[
+static gboolean
+idle_safe_callback (gpointer data)
+{
+SafeClosure *closure = data;
+gboolean res = FALSE;
+
+/ * mark the critical section * /
+
+clutter_threads_enter();
+
+/ * the callback does not need to acquire the Clutter
+* lock itself, as it is held by the this proxy handler
+* /
+res = closure->callback (closure->data);
+
+clutter_threads_leave();
+
+return res;
+}
+static gulong
+add_safe_idle (GSourceFunc callback,
+gpointer data)
+{
+SafeClosure *closure = g_new0 (SafeClosure, 1);
+
+closure->callback = callback;
+closure->data = data;
+
+return g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
+idle_safe_callback,
+closure,
+g_free)
+}
+]|
+
+This function should be used by threaded applications to make sure
+that @func is emitted under the Clutter threads lock and invoked
+from the same thread that started the Clutter main loop. For instance,
+it can be used to update the UI using the results from a worker
+thread:
+
+|[
+static gboolean
+update_ui (gpointer data)
+{
+SomeClosure *closure = data;
+
+/ * it is safe to call Clutter API from this function because
+* it is invoked from the same thread that started the main
+* loop and under the Clutter thread lock
+* /
+clutter_label_set_text (CLUTTER_LABEL (closure->label),
+closure->text);
+
+g_object_unref (closure->label);
+g_free (closure);
+
+return FALSE;
+}
+
+/ * within another thread * /
+closure = g_new0 (SomeClosure, 1);
+/ * always take a reference on GObject instances * /
+closure->label = g_object_ref (my_application->label);
+closure->text = g_strdup (processed_text_to_update_the_label);
+
+clutter_threads_add_idle_full (G_PRIORITY_HIGH_IDLE,
+update_ui,
+closure,
+NULL);
+]|
+
+Since: 0.4
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the binding pool to find
+<parameter name="priority">
+<parameter_description> the priority of the timeout source. Typically this will be in the
+range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to the function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> functio to call when the idle source is removed
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the #ClutterBindingPool, or %NULL
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="clutter_model_get_n_columns">
+<function name="clutter_threads_add_repaint_func">
<description>
-Retrieves the number of columns inside @model.
+Adds a function to be called whenever Clutter is processing a new
+frame.
-Since: 0.6
+If the function returns %FALSE it is automatically removed from the
+list of repaint functions and will not be called again.
+
+This function is guaranteed to be called from within the same thread
+that called clutter_main(), and while the Clutter lock is being held;
+the function will be called within the main loop, so it is imperative
+that it does not block, otherwise the frame time budget may be lost.
+
+A repaint function is useful to ensure that an update of the scenegraph
+is performed before the scenegraph is repainted; for instance, uploading
+a frame from a video into a #ClutterTexture. By default, a repaint
+function added using this function will be invoked prior to the frame
+being processed.
+
+Adding a repaint function does not automatically ensure that a new
+frame will be queued.
+
+When the repaint function is removed (either because it returned %FALSE
+or because clutter_threads_remove_repaint_func() has been called) the
+ notify function will be called, if any is set.
+
+See also: clutter_threads_add_repaint_func_full()
+
+Since: 1.0
</description>
<parameters>
-<parameter name="model">
-<parameter_description> a #ClutterModel
+<parameter name="func">
+<parameter_description> the function to be called within the paint cycle
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to be passed to the function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to be called when removing the repaint
+function, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the number of columns
+<return> the ID (greater than 0) of the repaint function. You
+can use the returned integer to remove the repaint function by
+calling clutter_threads_remove_repaint_func().
</return>
</function>
-<function name="clutter_scriptable_set_custom_property">
+<function name="clutter_threads_add_repaint_func_full">
<description>
-Overrides the common properties setting. The underlying virtual
-function should be used when implementing custom properties.
+Adds a function to be called whenever Clutter is processing a new
+frame.
-Since: 0.6
+If the function returns %FALSE it is automatically removed from the
+list of repaint functions and will not be called again.
+
+This function is guaranteed to be called from within the same thread
+that called clutter_main(), and while the Clutter lock is being held;
+the function will be called within the main loop, so it is imperative
+that it does not block, otherwise the frame time budget may be lost.
+
+A repaint function is useful to ensure that an update of the scenegraph
+is performed before the scenegraph is repainted; for instance, uploading
+a frame from a video into a #ClutterTexture. The @flags passed to this
+function will determine the section of the frame processing that will
+result in @func being called.
+
+Adding a repaint function does not automatically ensure that a new
+frame will be queued.
+
+When the repaint function is removed (either because it returned %FALSE
+or because clutter_threads_remove_repaint_func() has been called) the
+ notify function will be called, if any is set.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="scriptable">
-<parameter_description> a #ClutterScriptable
+<parameter name="flags">
+<parameter_description> flags for the repaint function
</parameter_description>
</parameter>
-<parameter name="script">
-<parameter_description> the #ClutterScript creating the scriptable instance
+<parameter name="func">
+<parameter_description> the function to be called within the paint cycle
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the property
+<parameter name="data">
+<parameter_description> data to be passed to the function, or %NULL
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value of the property
+<parameter name="notify">
+<parameter_description> function to be called when removing the repaint
+function, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the repaint function. You
+can use the returned integer to remove the repaint function by
+calling clutter_threads_remove_repaint_func().
+
+</return>
</function>
-<function name="clutter_animator_start">
+<function name="clutter_threads_add_timeout">
<description>
-Start the ClutterAnimator, this is a thin wrapper that rewinds
-and starts the animators current timeline.
+Simple wrapper around clutter_threads_add_timeout_full().
-Since: 1.2
+Since: 0.4
</description>
<parameters>
-<parameter name="animator">
-<parameter_description> a #ClutterAnimator
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in milliseconds
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to the function
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterTimeline that drives the animator.
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="clutter_box_layout_get_alignment">
+<function name="clutter_threads_add_timeout_full">
<description>
-Retrieves the horizontal and vertical alignment policies for @actor
-as set using clutter_box_layout_pack() or clutter_box_layout_set_alignment()
+Sets a function to be called at regular intervals holding the Clutter
+threads lock, with the given priority. The function is called repeatedly
+until it returns %FALSE, at which point the timeout is automatically
+removed and the function will not be called again. The @notify function
+is called when the timeout is removed.
-Since: 1.2
+The first call to the function will be at the end of the first @interval.
+
+It is important to note that, due to how the Clutter main loop is
+implemented, the timing will not be accurate and it will not try to
+"keep up" with the interval.
+
+See also clutter_threads_add_idle_full().
+
+Since: 0.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="priority">
+<parameter_description> the priority of the timeout source. Typically this will be in the
+range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH.
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @layout
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in milliseconds
</parameter_description>
</parameter>
-<parameter name="x_align">
-<parameter_description> return location for the horizontal alignment policy
+<parameter name="func">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="y_align">
-<parameter_description> return location for the vertical alignment policy
+<parameter name="data">
+<parameter_description> data to pass to the function
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the timeout source is removed
</parameter_description>
</parameter>
</parameters>
+<return> the ID (greater than 0) of the event source.
+
+</return>
+</function>
+
+<function name="clutter_threads_enter">
+<description>
+Locks the Clutter thread lock.
+
+Since: 0.4
+
+Deprecated: 1.12: This function should not be used by application
+code; marking critical sections is not portable on various
+platforms. Instead of acquiring the Clutter lock, schedule UI
+updates from the main loop using clutter_threads_add_idle() or
+clutter_threads_add_timeout().
+
+</description>
+<parameters>
+</parameters>
<return></return>
</function>
-<function name="clutter_model_iter_is_last">
+<function name="clutter_threads_init">
<description>
-Gets whether the iterator is at the end of the model to which it
-belongs.
+Initialises the Clutter threading mechanism, so that Clutter API can be
+called by multiple threads, using clutter_threads_enter() and
+clutter_threads_leave() to mark the critical sections.
-Since: 0.6
+You must call g_thread_init() before this function.
+
+This function must be called before clutter_init().
+
+It is safe to call this function multiple times.
+
+Since: 0.4
+
+Deprecated: 1.10: This function does not do anything. Threading support
+is initialized when Clutter is initialized.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #ClutterModelIter
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_threads_leave">
+<description>
+Unlocks the Clutter thread lock.
+
+Since: 0.4
+
+Deprecated: 1.12: This function should not be used by application
+code; marking critical sections is not portable on various
+platforms. Instead of acquiring the Clutter lock, schedule UI
+updates from the main loop using clutter_threads_add_idle() or
+clutter_threads_add_timeout().
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_threads_remove_repaint_func">
+<description>
+Removes the repaint function with @handle_id as its id
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="handle_id">
+<parameter_description> an unsigned integer greater than zero
</parameter_description>
</parameter>
</parameters>
-<return> #TRUE if @iter is the last iter in the filtered model.
-
-</return>
+<return></return>
</function>
-<function name="clutter_score_start">
+<function name="clutter_threads_set_lock_functions">
<description>
-Starts the score.
+Allows the application to replace the standard method that
+Clutter uses to protect its data structures. Normally, Clutter
+creates a single #GMutex that is locked by clutter_threads_enter(),
+and released by clutter_threads_leave(); using this function an
+application provides, instead, a function @enter_fn that is
+called by clutter_threads_enter() and a function @leave_fn that is
+called by clutter_threads_leave().
-Since: 0.6
+The functions must provide at least same locking functionality
+as the default implementation, but can also do extra application
+specific processing.
+
+As an example, consider an application that has its own recursive
+lock that when held, holds the Clutter lock as well. When Clutter
+unlocks the Clutter lock when entering a recursive main loop, the
+application must temporarily release its lock as well.
+
+Most threaded Clutter apps won't need to use this method.
+
+This method must be called before clutter_init(), and cannot
+be called multiple times.
+
+Since: 0.4
</description>
<parameters>
-<parameter name="score">
-<parameter_description> A #ClutterScore
+<parameter name="enter_fn">
+<parameter_description> function called when aquiring the Clutter main lock
+</parameter_description>
+</parameter>
+<parameter name="leave_fn">
+<parameter_description> function called when releasing the Clutter main lock
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_set_playing">
+<function name="clutter_timeline_add_marker">
<description>
-Starts or stops playing of @media.
+Adds a named marker that will be hit when the timeline has reached
+the specified @progress.
-Since: 0.2
+Markers are unique string identifiers for a given position on the
+timeline. Once @timeline reaches the given @progress of its duration,
+if will emit a ::marker-reached signal for each marker attached to
+that particular point.
+
+A marker can be removed with clutter_timeline_remove_marker(). The
+timeline can be advanced to a marker using
+clutter_timeline_advance_to_marker().
+
+See also: clutter_timeline_add_marker_at_time()
+
+Since: 1.14
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="playing">
-<parameter_description> %TRUE to start playing
+<parameter name="marker_name">
+<parameter_description> the unique name for this marker
+</parameter_description>
+</parameter>
+<parameter name="progress">
+<parameter_description> the normalized value of the position of the martke
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_alpha_set_closure">
+<function name="clutter_timeline_add_marker_at_time">
<description>
-Sets the #GClosure used to compute the alpha value at each
-frame of the #ClutterTimeline bound to @alpha.
+Adds a named marker that will be hit when the timeline has been
+running for @msecs milliseconds.
+
+Markers are unique string identifiers for a given position on the
+timeline. Once @timeline reaches the given @msecs, it will emit
+a ::marker-reached signal for each marker attached to that position.
+
+A marker can be removed with clutter_timeline_remove_marker(). The
+timeline can be advanced to a marker using
+clutter_timeline_advance_to_marker().
+
+See also: clutter_timeline_add_marker()
Since: 0.8
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> A #ClutterAlpha
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="closure">
-<parameter_description> A #GClosure
+<parameter name="marker_name">
+<parameter_description> the unique name for this marker
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> position of the marker in milliseconds
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_read_pixels">
+<function name="clutter_timeline_advance">
<description>
-Makes a screenshot of the stage in RGBA 8bit data, returns a
-linear buffer with @width * 4 as rowstride.
-
-The alpha data contained in the returned buffer is driver-dependent,
-and not guaranteed to hold any sensible value.
+Advance timeline to the requested point. The point is given as a
+time in milliseconds since the timeline started.
+<note><para>The @timeline will not emit the #ClutterTimeline::new-frame
+signal for the given time. The first ::new-frame signal after the call to
+clutter_timeline_advance() will be emit the skipped markers.
+</para></note>
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> A #ClutterStage
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of the first pixel that is read from stage
+<parameter name="msecs">
+<parameter_description> Time to advance to
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of the first pixel that is read from stage
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_timeline_advance_to_marker">
+<description>
+Advances @timeline to the time of the given @marker_name.
+
+<note><para>Like clutter_timeline_advance(), this function will not
+emit the #ClutterTimeline::new-frame for the time where @marker_name
+is set, nor it will emit #ClutterTimeline::marker-reached for
+ marker_name </para></note>
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width dimention of pixels to be read, or -1 for the
-entire stage width
+<parameter name="marker_name">
+<parameter_description> the name of the marker
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height dimention of pixels to be read, or -1 for the
-entire stage height
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_timeline_clone">
+<description>
+Create a new #ClutterTimeline instance which has property values
+matching that of supplied timeline. The cloned timeline will not
+be started and will not be positioned to the current position of
+the original @timeline: you will have to start it with clutter_timeline_start().
+
+<note><para>The only cloned properties are:</para>
+<itemizedlist>
+<listitem><simpara>#ClutterTimeline:duration</simpara></listitem>
+<listitem><simpara>#ClutterTimeline:loop</simpara></listitem>
+<listitem><simpara>#ClutterTimeline:delay</simpara></listitem>
+<listitem><simpara>#ClutterTimeline:direction</simpara></listitem>
+</itemizedlist></note>
+
+Since: 0.4
+
+Deprecated: 1.10: Use clutter_timeline_new() or g_object_new()
+instead
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> #ClutterTimeline to duplicate.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to newly allocated memory with the buffer
-or %NULL if the read failed. Use g_free() on the returned data
-to release the resources it has allocated.
+<return> a new #ClutterTimeline, cloned
+from @timeline
+
</return>
</function>
-<function name="clutter_value_set_shader_float">
+<function name="clutter_timeline_get_auto_reverse">
<description>
-Sets @floats as the contents of @value. The passed #GValue
-must have been initialized using %CLUTTER_TYPE_SHADER_FLOAT.
+Retrieves the value set by clutter_timeline_set_auto_reverse().
-Since: 0.8
+Since: 1.6
</description>
<parameters>
-<parameter name="value">
-<parameter_description> a #GValue
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> number of floating point values in @floats
+</parameters>
+<return> %TRUE if the timeline should automatically reverse, and
+%FALSE otherwise
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_cubic_bezier_progress">
+<description>
+Retrieves the control points for the cubic bezier progress mode.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="floats">
-<parameter_description> an array of floating point values
+<parameter name="c_1">
+<parameter_description> return location for the first control
+point of the cubic bezier, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="c_2">
+<parameter_description> return location for the second control
+point of the cubic bezier, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the @timeline is using a cubic bezier progress
+more, and %FALSE otherwise
+
+</return>
</function>
-<function name="clutter_color_add">
+<function name="clutter_timeline_get_current_repeat">
<description>
-Adds @a to @b and saves the resulting color inside @result.
+Retrieves the current repeat for a timeline.
-The alpha channel of @result is set as as the maximum value
-between the alpha channels of @a and @b.
+Repeats start at 0.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="a">
-<parameter_description> a #ClutterColor
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> a #ClutterColor
+</parameters>
+<return> the current repeat
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_delay">
+<description>
+Retrieves the delay set using clutter_timeline_set_delay().
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the result
+</parameters>
+<return> the delay in milliseconds.
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_delta">
+<description>
+Retrieves the amount of time elapsed since the last
+ClutterTimeline::new-frame signal.
+
+This function is only useful inside handlers for the ::new-frame
+signal, and its behaviour is undefined if the timeline is not
+playing.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the amount of time in milliseconds elapsed since the
+last frame
+
+</return>
</function>
-<function name="clutter_actor_set_reactive">
+<function name="clutter_timeline_get_direction">
<description>
-Sets @actor as reactive. Reactive actors will receive events.
+Retrieves the direction of the timeline set with
+clutter_timeline_set_direction().
Since: 0.6
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="reactive">
-<parameter_description> whether the actor should be reactive to events
+</parameters>
+<return> the direction of the timeline
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_duration">
+<description>
+Retrieves the duration of a #ClutterTimeline in milliseconds.
+See clutter_timeline_set_duration().
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the duration of the timeline, in milliseconds.
+
+</return>
</function>
-<function name="clutter_actor_box_clamp_to_pixel">
+<function name="clutter_timeline_get_duration_hint">
<description>
-Clamps the components of @box to the nearest integer
+Retrieves the full duration of the @timeline, taking into account the
+current value of the #ClutterTimeline:repeat-count property.
-Since: 1.2
+If the #ClutterTimeline:repeat-count property is set to -1, this function
+will return %G_MAXINT64.
+
+The returned value is to be considered a hint, and it's only valid
+as long as the @timeline hasn't been changed.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="box">
-<parameter_description> the #ClutterActorBox to clamp
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the full duration of the #ClutterTimeline
+
+</return>
</function>
-<function name="clutter_x11_set_display">
+<function name="clutter_timeline_get_elapsed_time">
<description>
-Sets the display connection Clutter should use; must be called
-before clutter_init(), clutter_init_with_args() or other functions
-pertaining Clutter's initialization process.
+Request the current time position of the timeline.
-If you are parsing the command line arguments by retrieving Clutter's
-#GOptionGroup with clutter_get_option_group() and calling
-g_option_context_parse() yourself, you should also call
-clutter_x11_set_display() before g_option_context_parse().
-Since: 0.8
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
+</parameter_description>
+</parameter>
+</parameters>
+<return> current elapsed time in milliseconds.
+</return>
+</function>
+
+<function name="clutter_timeline_get_loop">
+<description>
+Gets whether @timeline is looping
+
+Deprecated: 1.10: Use clutter_timeline_get_repeat_count() instead.
</description>
<parameters>
-<parameter name="xdpy">
-<parameter_description> pointer to a X display connection.
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the timeline is looping
+
+</return>
</function>
-<function name="clutter_alpha_new_full">
+<function name="clutter_timeline_get_progress">
<description>
-Creates a new #ClutterAlpha instance and sets the timeline
-and animation mode.
+The position of the timeline in a normalized [-1, 2] interval.
-See also clutter_alpha_set_timeline() and clutter_alpha_set_mode().
+The return value of this function is determined by the progress
+mode set using clutter_timeline_set_progress_mode(), or by the
+progress function set using clutter_timeline_set_progress_func().
-Since: 1.0
+Since: 0.6
</description>
<parameters>
<parameter name="timeline">
-<parameter_description> #ClutterTimeline timeline
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> animation mode
+</parameters>
+<return> the normalized current position in the timeline.
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_progress_mode">
+<description>
+Retrieves the progress mode set using clutter_timeline_set_progress_mode()
+or clutter_timeline_set_progress_func().
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterAlpha
+<return> a #ClutterAnimationMode
</return>
</function>
-<function name="clutter_text_get_chars">
+<function name="clutter_timeline_get_repeat_count">
<description>
-Retrieves the contents of the #ClutterText actor between
- start_pos and @end_pos.
+Retrieves the number set using clutter_timeline_set_repeat_count().
-The positions are specified in characters, not in bytes.
+Since: 1.10
-Since: 1.0
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of repeats
+
+</return>
+</function>
+
+<function name="clutter_timeline_get_step_progress">
+<description>
+Retrieves the parameters of the step progress mode used by @timeline.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="start_pos">
-<parameter_description> start of text, in characters
+<parameter name="n_steps">
+<parameter_description> return location for the number of steps, or %NULL
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> end of text, in characters
+<parameter name="step_mode">
+<parameter_description> return location for the value change policy,
+or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string with the contents of
-the text actor between the specified positions. Use g_free()
-to free the resources when done
+<return> %TRUE if the @timeline is using a step progress
+mode, and %FALSE otherwise
</return>
</function>
-<function name="clutter_set_default_frame_rate">
+<function name="clutter_timeline_has_marker">
<description>
-Sets the default frame rate. This frame rate will be used to limit
-the number of frames drawn if Clutter is not able to synchronize
-with the vertical refresh rate of the display. When synchronization
-is possible, this value is ignored.
+Checks whether @timeline has a marker set with the given name.
-Since: 0.6
+Since: 0.8
</description>
<parameters>
-<parameter name="frames_per_sec">
-<parameter_description> the new default frame rate
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="marker_name">
+<parameter_description> the name of the marker
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the marker was found
+
+</return>
</function>
-<function name="json_node_set_boolean">
+<function name="clutter_timeline_is_playing">
<description>
-Sets @value as the boolean content of the @node, replacing any existing
-content.
+Queries state of a #ClutterTimeline.
+
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a boolean value
+</parameters>
+<return> %TRUE if timeline is currently playing
+</return>
+</function>
+
+<function name="clutter_timeline_list_markers">
+<description>
+Retrieves the list of markers at time @msecs. If @msecs is a
+negative integer, all the markers attached to @timeline will be
+returned.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> the time to check, or -1
+</parameter_description>
+</parameter>
+<parameter name="n_markers">
+<parameter_description> the number of markers returned
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return>
+a newly allocated, %NULL terminated string array containing the names
+of the markers. Use g_strfreev() when done.
+
+</return>
</function>
-<function name="clutter_texture_get_repeat">
+<function name="clutter_timeline_new">
<description>
-Retrieves the horizontal and vertical repeat values set
-using clutter_texture_set_repeat()
+Creates a new #ClutterTimeline with a duration of @msecs.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="texture">
-<parameter_description> a #ClutterTexture
+<parameter name="msecs">
+<parameter_description> Duration of the timeline in milliseconds
</parameter_description>
</parameter>
-<parameter name="repeat_x">
-<parameter_description> return location for the horizontal repeat
+</parameters>
+<return> the newly created #ClutterTimeline instance. Use
+g_object_unref() when done using it
+
+</return>
+</function>
+
+<function name="clutter_timeline_pause">
+<description>
+Pauses the #ClutterTimeline on current frame
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="repeat_y">
-<parameter_description> return location for the vertical repeat
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_timeline_remove_marker">
+<description>
+Removes @marker_name, if found, from @timeline.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="marker_name">
+<parameter_description> the name of the marker to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_main">
+<function name="clutter_timeline_rewind">
<description>
-Starts the Clutter mainloop.
+Rewinds #ClutterTimeline to the first frame if its direction is
+%CLUTTER_TIMELINE_FORWARD and the last frame if it is
+%CLUTTER_TIMELINE_BACKWARD.
</description>
<parameters>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_units_from_string">
+<function name="clutter_timeline_set_auto_reverse">
<description>
-Parses a value and updates @units with it
+Sets whether @timeline should reverse the direction after the
+emission of the #ClutterTimeline::completed signal.
-A #ClutterUnits expressed in string should match:
+Setting the #ClutterTimeline:auto-reverse property to %TRUE is the
+equivalent of connecting a callback to the #ClutterTimeline::completed
+signal and changing the direction of the timeline from that callback;
+for instance, this code:
|[
-units: wsp* unit-value wsp* unit-name? wsp*
-unit-value: number
-unit-name: 'px' | 'pt' | 'mm' | 'em' | 'cm'
-number: digit+
-| digit* sep digit+
-sep: '.' | ','
-digit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
-wsp: (#0x20 | #0x9 | #0xA | #0xB | #0xC | #0xD)+
-]|
+static void
+reverse_timeline (ClutterTimeline *timeline)
+{
+ClutterTimelineDirection dir = clutter_timeline_get_direction (timeline);
-For instance, these are valid strings:
+if (dir == CLUTTER_TIMELINE_FORWARD)
+dir = CLUTTER_TIMELINE_BACKWARD;
+else
+dir = CLUTTER_TIMELINE_FORWARD;
-|[
-10 px
-5.1 em
-24 pt
-12.6 mm
-.3 cm
+clutter_timeline_set_direction (timeline, dir);
+}
+...
+timeline = clutter_timeline_new (1000);
+clutter_timeline_set_repeat_count (timeline, -1);
+g_signal_connect (timeline, "completed",
+G_CALLBACK (reverse_timeline),
+NULL);
]|
-While these are not:
+can be effectively replaced by:
|[
-42 cats
-omg!1!ponies
+timeline = clutter_timeline_new (1000);
+clutter_timeline_set_repeat_count (timeline, -1);
+clutter_timeline_set_auto_reverse (timeline);
]|
-<note>If no unit is specified, pixels are assumed.</note>
-
-Since: 1.0
+Since: 1.6
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> the string to convert
+<parameter name="reverse">
+<parameter_description> %TRUE if the @timeline should reverse the direction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the string was successfully parsed,
-and %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="clutter_device_manager_list_devices">
+<function name="clutter_timeline_set_cubic_bezier_progress">
<description>
-Lists all currently registered input devices
+Sets the #ClutterTimeline:progress-mode of @timeline
+to %CLUTTER_CUBIC_BEZIER, and sets the two control
+points for the cubic bezier.
-Since: 1.2
+The cubic bezier curve is between (0, 0) and (1, 1). The X coordinate
+of the two control points must be in the [ 0, 1 ] range, while the
+Y coordinate of the two control points can exceed this range.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="device_manager">
-<parameter_description> a #ClutterDeviceManager
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="c_1">
+<parameter_description> the first control point for the cubic bezier
+</parameter_description>
+</parameter>
+<parameter name="c_2">
+<parameter_description> the second control point for the cubic bezier
</parameter_description>
</parameter>
</parameters>
-<return>
-a newly allocated list of #ClutterInputDevice objects. Use
-g_slist_free() to deallocate it when done
-
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_get_alpha">
+<function name="clutter_timeline_set_delay">
<description>
-Retrieves the #ClutterAlpha object bound to @behave.
+Sets the delay, in milliseconds, before @timeline should start.
-Since: 0.2
+Since: 0.4
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> delay in milliseconds
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterAlpha object, or %NULL if no alpha
-object has been bound to this behaviour.
+<return></return>
+</function>
-</return>
+<function name="clutter_timeline_set_direction">
+<description>
+Sets the direction of @timeline, either %CLUTTER_TIMELINE_FORWARD or
+%CLUTTER_TIMELINE_BACKWARD.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> the direction of the timeline
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="cogl_util_next_p2">
+<function name="clutter_timeline_set_duration">
<description>
-Calculates the next power greater than @a.
+Sets the duration of the timeline, in milliseconds. The speed
+of the timeline depends on the ClutterTimeline:fps setting.
+Since: 0.6
</description>
<parameters>
-<parameter name="a">
-<parameter_description> Value to get the next power
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> duration of the timeline in milliseconds
</parameter_description>
</parameter>
</parameters>
-<return> The next power after @a.
-</return>
+<return></return>
</function>
-<function name="clutter_text_get_cursor_size">
+<function name="clutter_timeline_set_loop">
<description>
-Retrieves the size of the cursor of a #ClutterText actor.
+Sets whether @timeline should loop.
-Since: 1.0
+This function is equivalent to calling clutter_timeline_set_repeat_count()
+with -1 if @loop is %TRUE, and with 0 if @loop is %FALSE.
+
+Deprecated: 1.10: Use clutter_timeline_set_repeat_count() instead.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="loop">
+<parameter_description> %TRUE for enable looping
</parameter_description>
</parameter>
</parameters>
-<return> the size of the cursor, in pixels
+<return></return>
+</function>
-</return>
+<function name="clutter_timeline_set_progress_func">
+<description>
+Sets a custom progress function for @timeline. The progress function will
+be called by clutter_timeline_get_progress() and will be used to compute
+the progress value based on the elapsed time and the total duration of the
+timeline.
+
+If @func is not %NULL, the #ClutterTimeline:progress-mode property will
+be set to %CLUTTER_CUSTOM_MODE.
+
+If @func is %NULL, any previously set progress function will be unset, and
+the #ClutterTimeline:progress-mode property will be set to %CLUTTER_LINEAR.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a progress function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @func
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a function to be called when the progress function is removed
+or the timeline is disposed
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_color_lighten">
+<function name="clutter_timeline_set_progress_mode">
<description>
-Lightens @color by a fixed amount, and saves the changed color
-in @result.
+Sets the progress function using a value from the #ClutterAnimationMode
+enumeration. The @mode cannot be %CLUTTER_CUSTOM_MODE or bigger than
+%CLUTTER_ANIMATION_LAST.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #ClutterColor
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the lighter color
+<parameter name="mode">
+<parameter_description> the progress mode, as a #ClutterAnimationMode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_animation_completed">
+<function name="clutter_timeline_set_repeat_count">
<description>
-Emits the ::completed signal on @animation
+Sets the number of times the @timeline should repeat.
-When using this function with a #ClutterAnimation created
-by the clutter_actor_animate() family of functions, @animation
-will be unreferenced and it will not be valid anymore,
-unless g_object_ref() was called before calling this function
-or unless a reference was taken inside a handler for the
-#ClutterAnimation::completed signal
+If @count is 0, the timeline never repeats.
-Since: 1.0
+If @count is -1, the timeline will always repeat until
+it's stopped.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> the number of times the timeline should repeat
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_node_get_double">
+<function name="clutter_timeline_set_step_progress">
<description>
-Gets the double value stored inside a #JsonNode
+Sets the #ClutterTimeline:progress-mode of the @timeline to %CLUTTER_STEPS
+and provides the parameters of the step function.
+Since: 1.12
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="timeline">
+<parameter_description> a #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="n_steps">
+<parameter_description> the number of steps
+</parameter_description>
+</parameter>
+<parameter name="step_mode">
+<parameter_description> whether the change should happen at the start
+or at the end of the step
</parameter_description>
</parameter>
</parameters>
-<return> a double value.
-</return>
+<return></return>
</function>
-<function name="clutter_event_get_scroll_direction">
+<function name="clutter_timeline_skip">
<description>
-Retrieves the direction of the scrolling of @event
+Advance timeline by the requested time in milliseconds
-Since: 1.0
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
+</parameter_description>
+</parameter>
+<parameter name="msecs">
+<parameter_description> Amount of time to skip
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_timeline_start">
+<description>
+Starts the #ClutterTimeline playing.
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_SCROLL
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
</parameter_description>
</parameter>
</parameters>
-<return> the scrolling direction
+<return></return>
+</function>
-</return>
+<function name="clutter_timeline_stop">
+<description>
+Stops the #ClutterTimeline and moves to frame 0
+
+</description>
+<parameters>
+<parameter name="timeline">
+<parameter_description> A #ClutterTimeline
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_event_get_time">
+<function name="clutter_timeout_pool_add">
<description>
-Retrieves the time of the event.
+Sets a function to be called at regular intervals, and puts it inside
+the @pool. The function is repeatedly called until it returns %FALSE,
+at which point the timeout is automatically destroyed and the function
+won't be called again. If @notify is not %NULL, the @notify function
+will be called. The first call to @func will be at the end of @interval.
+
+Since Clutter 0.8 this will try to compensate for delays. For
+example, if @func takes half the interval time to execute then the
+function will be called again half the interval time after it
+finished. Before version 0.8 it would not fire until a full
+interval after the function completes so the delay between calls
+would be @interval * 1.5. This function does not however try to
+invoke the function multiple times to catch up missing frames if
+ func takes more than @interval ms to execute.
Since: 0.4
+Deprecated: 1.6
+
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="pool">
+<parameter_description> a #ClutterTimeoutPool
+</parameter_description>
+</parameter>
+<parameter name="fps">
+<parameter_description> the time between calls to the function, in frames per second
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> function to call
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to the function, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the time of the event, or %CLUTTER_CURRENT_TIME
+<return> the ID (greater than 0) of the timeout inside the pool.
+Use clutter_timeout_pool_remove() to stop the timeout.
</return>
</function>
-<function name="json_array_add_boolean_element">
+<function name="clutter_timeout_pool_new">
<description>
-Conveniently adds a boolean @value into @array
+Creates a new timeout pool source. A timeout pool should be used when
+multiple timeout functions, running at the same priority, are needed and
+the g_timeout_add() API might lead to starvation of the time slice of
+the main loop. A timeout pool allocates a single time slice of the main
+loop and runs every timeout function inside it. The timeout pool is
+always sorted, so that the extraction of the next timeout function is
+a constant time operation.
-See also: json_array_add_element(), json_node_set_boolean()
+Since: 0.4
-Since: 0.8
+Deprecated: 1.6
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> a boolean value
+<parameter name="priority">
+<parameter_description> the priority of the timeout pool. Typically this will
+be #G_PRIORITY_DEFAULT
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly created #ClutterTimeoutPool. The created pool
+is owned by the GLib default context and will be automatically
+destroyed when the context is destroyed. It is possible to force
+the destruction of the timeout pool using g_source_destroy()
+
+</return>
</function>
-<function name="clutter_binding_pool_unblock_action">
+<function name="clutter_timeout_pool_remove">
<description>
-Unblockes all the actions with name @action_name inside @pool.
+Removes a timeout function with @id_ from the timeout pool. The id
+is the same returned when adding a function to the timeout pool with
+clutter_timeout_pool_add().
-Unblocking an action does not cause the callback bound to it to
-be invoked in case clutter_binding_pool_activate() was called on
-an action previously blocked with clutter_binding_pool_block_action().
+Since: 0.4
-Since: 1.0
+Deprecated: 1.6
</description>
<parameters>
<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter_description> a #ClutterTimeoutPool
</parameter_description>
</parameter>
-<parameter name="action_name">
-<parameter_description> an action name
+<parameter name="id_">
+<parameter_description> the id of the timeout to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_group_new">
+<function name="clutter_transition_get_animatable">
<description>
-Create a new #ClutterGroup.
+Retrieves the #ClutterAnimatable set using clutter_transition_set_animatable().
+Since: 1.10
</description>
<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #ClutterGroup actor
+<return> a #ClutterAnimatable, or %NULL; the returned
+animatable is owned by the #ClutterTransition, and it should not be freed
+directly.
+
</return>
</function>
-<function name="clutter_text_get_cursor_visible">
+<function name="clutter_transition_get_interval">
<description>
-Retrieves whether the cursor of a #ClutterText actor is visible.
+Retrieves the interval set using clutter_transition_set_interval()
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cursor is visible
+<return> a #ClutterInterval, or %NULL; the returned
+interval is owned by the #ClutterTransition and it should not be freed
+directly
</return>
</function>
-<function name="json_node_dup_string">
+<function name="clutter_transition_get_remove_on_complete">
<description>
-Gets a copy of the string value stored inside a #JsonNode
+Retrieves the value of the #ClutterTransition:remove-on-complete property.
+Since: 1.10
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode of type %JSON_NODE_VALUE
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string containing a copy of
-the #JsonNode contents
+<return> %TRUE if the @transition should be detached when complete,
+and %FALSE otherwise
+
</return>
</function>
-<function name="clutter_behaviour_ellipse_get_width">
+<function name="clutter_transition_group_add_transition">
<description>
-Gets the width of the elliptical path.
+Adds @transition to @group.
-Since: 0.4
+This function acquires a reference on @transition that will be released
+when calling clutter_transition_group_remove_transition().
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="group">
+<parameter_description> a #ClutterTransitionGroup
+</parameter_description>
+</parameter>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
</parameters>
-<return> the width of the path
+<return></return>
+</function>
+
+<function name="clutter_transition_group_new">
+<description>
+Creates a new #ClutterTransitionGroup instance.
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterTransitionGroup. Use
+g_object_unref() when done to deallocate the resources it
+uses
</return>
</function>
-<function name="clutter_units_get_unit_value">
+<function name="clutter_transition_group_remove_all">
<description>
-Retrieves the value stored inside @units
+Removes all transitions from @group.
-Since: 1.0
+This function releases the reference acquired when calling
+clutter_transition_group_add_transition().
+
+Since: 1.12
</description>
<parameters>
-<parameter name="units">
-<parameter_description> a #ClutterUnits
+<parameter name="group">
+<parameter_description> a #ClutterTransitionGroup
</parameter_description>
</parameter>
</parameters>
-<return> the value stored inside a #ClutterUnits
+<return></return>
+</function>
-</return>
+<function name="clutter_transition_group_remove_transition">
+<description>
+Removes @transition from @group.
+
+This function releases the reference acquired on @transition when
+calling clutter_transition_group_add_transition().
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> a #ClutterTransitionGroup
+</parameter_description>
+</parameter>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_get_show_fps">
+<function name="clutter_transition_set_animatable">
<description>
-Returns whether Clutter should print out the frames per second on the
-console. You can enable this setting either using the
-<literal>CLUTTER_SHOW_FPS</literal> environment variable or passing
-the <literal>--clutter-show-fps</literal> command line argument. *
+Sets the #ClutterTransition:animatable property.
-Since: 0.4
+The @transition will acquire a reference to the @animatable instance,
+and will call the #ClutterTransitionClass.attached() virtual function.
+
+If an existing #ClutterAnimatable is attached to @transition, the
+reference will be released, and the #ClutterTransitionClass.detached()
+virtual function will be called.
+
+Since: 1.10
</description>
<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
+<parameter name="animatable">
+<parameter_description> a #ClutterAnimatable, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if Clutter should show the FPS.
+<return></return>
+</function>
-</return>
+<function name="clutter_transition_set_from">
+<description>
+Sets the initial value of the transition.
+
+This is a convenience function that will either create the
+#ClutterInterval used by @transition, or will update it if
+the #ClutterTransition:interval is already set.
+
+If @transition already has a #ClutterTransition:interval set,
+then @value must hold the same type, or a transformable type,
+as the interval's #ClutterInterval:value-type property.
+
+This is a convenience function for the C API; language bindings
+should use clutter_transition_set_from_value() instead.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
+<parameter name="value_type">
+<parameter_description> the type of the value to set
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> the initial value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_box_set_layout_manager">
+<function name="clutter_transition_set_from_value">
<description>
-Sets the #ClutterLayoutManager for @box
+Sets the initial value of the transition.
-A #ClutterLayoutManager is a delegate object that controls the
-layout of the children of @box
+This is a convenience function that will either create the
+#ClutterInterval used by @transition, or will update it if
+the #ClutterTransition:interval is already set.
-Since: 1.2
+This function will copy the contents of @value, so it is
+safe to call g_value_unset() after it returns.
+
+If @transition already has a #ClutterTransition:interval set,
+then @value must hold the same type, or a transformable type,
+as the interval's #ClutterInterval:value-type property.
+
+This function is meant to be used by language bindings.
+
+Since: 1.12
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
-<parameter name="manager">
-<parameter_description> a #ClutterLayoutManager
+<parameter name="value">
+<parameter_description> a #GValue with the initial value of the transition
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="json_object_get_string_member">
+<function name="clutter_transition_set_interval">
<description>
-Convenience function that retrieves the string value
-stored in @member_name of @object
+Sets the #ClutterTransition:interval property using @interval.
-See also: json_object_get_member()
+The @transition will acquire a reference on the @interval, sinking
+the floating flag on it if necessary.
-Since: 0.8
+Since: 1.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #JsonObject
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
-<parameter name="member_name">
-<parameter_description> the name of the member
+<parameter name="interval">
+<parameter_description> a #ClutterInterval, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the string value of the object's member
+<return></return>
+</function>
-</return>
+<function name="clutter_transition_set_remove_on_complete">
+<description>
+Sets whether @transition should be detached from the #ClutterAnimatable
+set using clutter_transition_set_animatable() when the
+#ClutterTimeline::completed signal is emitted.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
+<parameter name="remove_complete">
+<parameter_description> whether to detach @transition when complete
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_binding_pool_override_closure">
+<function name="clutter_transition_set_to">
<description>
-A #GClosure variant of clutter_binding_pool_override_action().
+Sets the final value of the transition.
-Allows overriding the action for @key_val and @modifiers inside a
-#ClutterBindingPool. See clutter_binding_pool_install_closure().
+This is a convenience function that will either create the
+#ClutterInterval used by @transition, or will update it if
+the #ClutterTransition:interval is already set.
-When an action has been activated using clutter_binding_pool_activate()
-the passed @callback will be invoked (with @data).
+If @transition already has a #ClutterTransition:interval set,
+then @value must hold the same type, or a transformable type,
+as the interval's #ClutterInterval:value-type property.
-Actions can be blocked with clutter_binding_pool_block_action()
-and then unblocked using clutter_binding_pool_unblock_action().
+This is a convenience function for the C API; language bindings
+should use clutter_transition_set_to_value() instead.
-Since: 1.0
+Since: 1.12
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> key symbol
+<parameter name="value_type">
+<parameter_description> the type of the value to set
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> bitmask of modifiers
+<parameter name="Varargs">
+<parameter_description> the final value
</parameter_description>
</parameter>
-<parameter name="closure">
-<parameter_description> a #GClosure
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_transition_set_to_value">
+<description>
+Sets the final value of the transition.
+
+This is a convenience function that will either create the
+#ClutterInterval used by @transition, or will update it if
+the #ClutterTransition:interval is already set.
+
+This function will copy the contents of @value, so it is
+safe to call g_value_unset() after it returns.
+
+If @transition already has a #ClutterTransition:interval set,
+then @value must hold the same type, or a transformable type,
+as the interval's #ClutterInterval:value-type property.
+
+This function is meant to be used by language bindings.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="transition">
+<parameter_description> a #ClutterTransition
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue with the final value of the transition
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_threads_enter">
+<function name="clutter_ungrab_keyboard">
<description>
-Locks the Clutter thread lock.
+Removes an existing grab of the keyboard.
-Since: 0.4
+Since: 0.6
</description>
<parameters>
@@ -21326,330 +39588,477 @@ Since: 0.4
<return></return>
</function>
-<function name="clutter_box_pack">
+<function name="clutter_ungrab_pointer">
<description>
-Adds @actor to @box and sets layout properties at the same time,
-if the #ClutterLayoutManager used by @box has them
+Removes an existing grab of the pointer.
-This function is a wrapper around clutter_container_add_actor()
-and clutter_layout_manager_child_set()
+Since: 0.6
-Language bindings should use the vector-based clutter_box_addv()
-variant instead
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
-Since: 1.2
+<function name="clutter_ungrab_pointer_for_device">
+<description>
+Removes an existing grab of the pointer events for device @id_.
+
+Since: 0.8
+
+Deprecated: 1.10: Use clutter_input_device_ungrab() instead.
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterBox
+<parameter name="id_">
+<parameter_description> a device id
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_unicode_to_keysym">
+<description>
+Convert from a ISO10646 character to a key symbol.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="wc">
+<parameter_description> a ISO10646 encoded character
</parameter_description>
</parameter>
-<parameter name="first_property">
-<parameter_description> the name of the first property to set, or %NULL
+</parameters>
+<return> the corresponding Clutter key symbol, if one exists.
+or, if there is no corresponding symbol, wc | 0x01000000
+
+</return>
+</function>
+
+<function name="clutter_units_copy">
+<description>
+Copies @units
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="units">
+<parameter_description> the #ClutterUnits to copy
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of property name and value pairs, terminated by %NULL
+</parameters>
+<return> the newly created copy of a
+#ClutterUnits structure. Use clutter_units_free() to free
+the allocated resources
+
+</return>
+</function>
+
+<function name="clutter_units_free">
+<description>
+Frees the resources allocated by @units
+
+You should only call this function on a #ClutterUnits
+created using clutter_units_copy()
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="units">
+<parameter_description> the #ClutterUnits to free
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_remove_action">
+<function name="clutter_units_from_cm">
<description>
-Removes the action matching the given @key_val, @modifiers pair,
-if any exists.
+Stores a value in centimeters inside @units
-Since: 1.0
+Since: 1.2
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> a key symbol
+<parameter name="cm">
+<parameter_description> centimeters
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> a bitmask for the modifiers
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_units_from_em">
+<description>
+Stores a value in em inside @units, using the default font
+name as returned by clutter_backend_get_font_name()
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="units">
+<parameter_description> a #ClutterUnits
+</parameter_description>
+</parameter>
+<parameter name="em">
+<parameter_description> em
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_container_remove_valist">
+<function name="clutter_units_from_em_for_font">
<description>
-Alternative va_list version of clutter_container_remove().
+Stores a value in em inside @units using @font_name
-Since: 0.4
+Since: 1.0
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #ClutterContainer
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="first_actor">
-<parameter_description> the first #ClutterActor to add
+<parameter name="font_name">
+<parameter_description> the font name and size
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> list of actors to remove, followed by %NULL
+<parameter name="em">
+<parameter_description> em
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_set_size">
+<function name="clutter_units_from_mm">
<description>
-Sets the actor's size request in pixels. This overrides any
-"normal" size request the actor would have. For example
-a text actor might normally request the size of the text;
-this function would force a specific size instead.
-
-If @width and/or @height are -1 the actor will use its
-"normal" size request instead of overriding it, i.e.
-you can "unset" the size with -1.
+Stores a value in millimiters inside @units
-This function sets or unsets both the minimum and natural size.
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> New width of actor in pixels, or -1
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> New height of actor in pixels, or -1
+<parameter name="mm">
+<parameter_description> millimeters
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_box_layout_set_expand">
+<function name="clutter_units_from_pixels">
<description>
-Sets whether @actor should expand inside @layout
+Stores a value in pixels inside @units
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterBoxLayout
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="actor">
-<parameter_description> a #ClutterActor child of @layout
+<parameter name="px">
+<parameter_description> pixels
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> whether @actor should expand
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_units_from_pt">
+<description>
+Stores a value in typographic points inside @units
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="units">
+<parameter_description> a #ClutterUnits
+</parameter_description>
+</parameter>
+<parameter name="pt">
+<parameter_description> typographic points
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_behaviour_get_nth_actor">
+<function name="clutter_units_from_string">
<description>
-Gets an actor the behaviour was applied to referenced by index num.
+Parses a value and updates @units with it
-Since: 0.2
+A #ClutterUnits expressed in string should match:
+
+|[
+units: wsp* unit-value wsp* unit-name? wsp*
+unit-value: number
+unit-name: 'px' | 'pt' | 'mm' | 'em' | 'cm'
+number: digit+
+| digit* sep digit+
+sep: '.' | ','
+digit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
+wsp: (#0x20 | #0x9 | #0xA | #0xB | #0xC | #0xD)+
+]|
+
+For instance, these are valid strings:
+
+|[
+10 px
+5.1 em
+24 pt
+12.6 mm
+.3 cm
+]|
+
+While these are not:
+
+|[
+42 cats
+omg!1!ponies
+]|
+
+<note><para>If no unit is specified, pixels are assumed.</para></note>
+
+Since: 1.0
</description>
<parameters>
-<parameter name="behave">
-<parameter_description> a #ClutterBehaviour
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> the index of an actor this behaviour is applied too.
+<parameter name="str">
+<parameter_description> the string to convert
</parameter_description>
</parameter>
</parameters>
-<return> A Clutter actor or NULL if @index_ is invalid.
+<return> %TRUE if the string was successfully parsed,
+and %FALSE otherwise
</return>
</function>
-<function name="clutter_behaviour_opacity_new">
+<function name="clutter_units_get_unit_type">
<description>
-Creates a new #ClutterBehaviourOpacity object, driven by @alpha
-which controls the opacity property of every actor, making it
-change in the interval between @opacity_start and @opacity_end.
+Retrieves the unit type of the value stored inside @units
-Since: 0.2
+Since: 1.0
</description>
<parameters>
-<parameter name="alpha">
-<parameter_description> a #ClutterAlpha instance, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="opacity_start">
-<parameter_description> minimum level of opacity
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="opacity_end">
-<parameter_description> maximum level of opacity
+</parameters>
+<return> a unit type
+
+</return>
+</function>
+
+<function name="clutter_units_get_unit_value">
+<description>
+Retrieves the value stored inside @units
+
+Since: 1.0
+
+</description>
+<parameters>
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #ClutterBehaviourOpacity
+<return> the value stored inside a #ClutterUnits
</return>
</function>
-<function name="clutter_shader_get_is_enabled">
+<function name="clutter_units_to_pixels">
<description>
-Checks whether @shader is enabled.
+Converts a value in #ClutterUnits to pixels
-Since: 0.6
+Since: 1.0
</description>
<parameters>
-<parameter name="shader">
-<parameter_description> a #ClutterShader
+<parameter name="units">
+<parameter_description> units to convert
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the shader is enabled.
+<return> the value in pixels
</return>
</function>
-<function name="clutter_actor_get_abs_allocation_vertices">
+<function name="clutter_units_to_string">
<description>
-Calculates the transformed screen coordinates of the four corners of
-the actor; the returned vertices relate to the #ClutterActorBox
-coordinates as follows:
-<itemizedlist>
-<listitem><para>v[0] contains (x1, y1)</para></listitem>
-<listitem><para>v[1] contains (x2, y1)</para></listitem>
-<listitem><para>v[2] contains (x1, y2)</para></listitem>
-<listitem><para>v[3] contains (x2, y2)</para></listitem>
-</itemizedlist>
+Converts @units into a string
-Since: 0.4
+See clutter_units_from_string() for the units syntax and for
+examples of output
+
+<note>Fractional values are truncated to the second decimal
+position for em, mm and cm, and to the first decimal position for
+typographic points. Pixels are integers.</note>
+
+Since: 1.0
</description>
<parameters>
-<parameter name="self">
-<parameter_description> A #ClutterActor
+<parameter name="units">
+<parameter_description> a #ClutterUnits
</parameter_description>
</parameter>
-<parameter name="verts">
-<parameter_description> Pointer to a location of an array
-of 4 #ClutterVertex where to store the result.
+</parameters>
+<return> a newly allocated string containing the encoded
+#ClutterUnits value. Use g_free() to free the string
+
+</return>
+</function>
+
+<function name="clutter_util_next_p2">
+<description>
+Calculates the nearest power of two, greater than or equal to @a.
+
+Deprecated: 1.2
+
+</description>
+<parameters>
+<parameter name="a">
+<parameter_description> Value to get the next power
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The nearest power of two, greater or equal to @a.
+
+</return>
</function>
-<function name="json_node_copy">
+<function name="clutter_value_dup_paint_node">
<description>
-Copies @node. If the node contains complex data types then the reference
-count of the objects is increased.
+Retrieves a pointer to the #ClutterPaintNode contained inside
+the passed #GValue, and if not %NULL it will increase the
+reference count.
+Since: 1.10
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="value">
+<parameter_description> a #GValue initialized with %CLUTTER_TYPE_PAINT_NODE
</parameter_description>
</parameter>
</parameters>
-<return> the copied #JsonNode
+<return> a pointer
+to the #ClutterPaintNode, with its reference count increased,
+or %NULL
+
</return>
</function>
-<function name="clutter_event_get_button">
+<function name="clutter_value_get_color">
<description>
-Retrieves the button number of @event
+Gets the #ClutterColor contained in @value.
-Since: 1.0
+Since: 0.8.4
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent of type %CLUTTER_BUTTON_PRESS or
-of type %CLUTTER_BUTTON_RELEASE
+<parameter name="value">
+<parameter_description> a #GValue initialized to #CLUTTER_TYPE_COLOR
</parameter_description>
</parameter>
</parameters>
-<return> the button number
+<return> the color inside the passed #GValue
</return>
</function>
-<function name="clutter_stage_hide_cursor">
+<function name="clutter_value_get_fixed">
<description>
-Makes the cursor invisible on the stage window
+Gets the fixed point value stored inside @value.
-Since: 0.4
+Since: 0.8
+
+Deprecated: 1.10: Use g_value_get_int() instead.
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="value">
+<parameter_description> a #GValue initialized to %COGL_TYPE_FIXED
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the value inside the passed #GValue
+
+</return>
</function>
-<function name="clutter_actor_box_get_y">
+<function name="clutter_value_get_paint_node">
<description>
-Retrieves the Y coordinate of the origin of @box
+Retrieves a pointer to the #ClutterPaintNode contained inside
+the passed #GValue.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #ClutterActorBox
+<parameter name="value">
+<parameter_description> a #GValue initialized with %CLUTTER_TYPE_PAINT_NODE
</parameter_description>
</parameter>
</parameters>
-<return> the Y coordinate of the origin
+<return> a pointer to
+a #ClutterPaintNode, or %NULL
</return>
</function>
-<function name="clutter_value_set_units">
+<function name="clutter_value_get_shader_float">
<description>
-Sets @value to @units
+Retrieves the list of floating point values stored inside
+the passed #GValue. @value must have been initialized with
+%CLUTTER_TYPE_SHADER_FLOAT.
Since: 0.8
</description>
<parameters>
<parameter name="value">
-<parameter_description> a #GValue initialized to #CLUTTER_TYPE_UNIT
+<parameter_description> a #GValue
</parameter_description>
</parameter>
-<parameter name="units">
-<parameter_description> the units to set
+<parameter name="length">
+<parameter_description> return location for the number of returned floating
+point values, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the pointer to a list of
+floating point values. The returned value is owned by the
+#GValue and should never be modified or freed.
+
+</return>
</function>
<function name="clutter_value_get_shader_int">
@@ -21672,880 +40081,1514 @@ values, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the pointer to a list of integer values.
-The returned value is owned by the #GValue and should never
-be modified or freed.
+<return> the pointer to a list of
+integer values. The returned value is owned by the #GValue and
+should never be modified or freed.
</return>
</function>
-<function name="clutter_texture_new_from_actor">
+<function name="clutter_value_get_shader_matrix">
<description>
-Creates a new #ClutterTexture object with its source a prexisting
-actor (and associated children). The textures content will contain
-'live' redirected output of the actors scene.
+Retrieves a matrix of floating point values stored inside
+the passed #GValue. @value must have been initialized with
+%CLUTTER_TYPE_SHADER_MATRIX.
-Note this function is intented as a utility call for uniformly applying
-shaders to groups and other potential visual effects. It requires that
-the %CLUTTER_FEATURE_OFFSCREEN feature is supported by the current backend
-and the target system.
+Since: 0.8
-Some tips on usage:
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a #GValue
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the number of returned floating
+point values, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pointer to a matrix
+of floating point values. The returned value is owned by the #GValue and
+should never be modified or freed.
-<itemizedlist>
-<listitem>
-<para>The source actor must be made visible (i.e by calling
-#clutter_actor_show).</para>
-</listitem>
-<listitem>
-<para>The source actor must have a parent in order for it to be
-allocated a size from the layouting mechanism. If the source
-actor does not have a parent when this function is called then
-the ClutterTexture will adopt it and allocate it at its
-preferred size. Using this you can clone an actor that is
-otherwise not displayed. Because of this feature if you do
-intend to display the source actor then you must make sure that
-the actor is parented before calling
-clutter_texture_new_from_actor() or that you unparent it before
-adding it to a container.</para>
-</listitem>
-<listitem>
-<para>When getting the image for the clone texture, Clutter
-will attempt to render the source actor exactly as it would
-appear if it was rendered on screen. The source actor's parent
-transformations are taken into account. Therefore if your
-source actor is rotated along the X or Y axes so that it has
-some depth, the texture will appear differently depending on
-the on-screen location of the source actor. While painting the
-source actor, Clutter will set up a temporary asymmetric
-perspective matrix as the projection matrix so that the source
-actor will be projected as if a small section of the screen was
-being viewed. Before version 0.8.2, an orthogonal identity
-projection was used which meant that the source actor would be
-clipped if any part of it was not on the zero Z-plane.</para>
-</listitem>
-<listitem>
-<para>Avoid reparenting the source with the created texture.</para>
-</listitem>
-<listitem>
-<para>A group can be padded with a transparent rectangle as to
-provide a border to contents for shader output (blurring text
-for example).</para>
-</listitem>
-<listitem>
-<para>The texture will automatically resize to contain a further
-transformed source. However, this involves overhead and can be
-avoided by placing the source actor in a bounding group
-sized large enough to contain any child tranformations.</para>
-</listitem>
-<listitem>
-<para>Uploading pixel data to the texture (e.g by using
-clutter_actor_set_from_file()) will destroy the offscreen texture data
-and end redirection.</para>
-</listitem>
-<listitem>
-<para>cogl_texture_get_data() with the handle returned by
-clutter_texture_get_cogl_texture() can be used to read the
-offscreen texture pixels into a pixbuf.</para>
-</listitem>
-</itemizedlist>
+</return>
+</function>
-Since: 0.6
+<function name="clutter_value_get_units">
+<description>
+Gets the #ClutterUnits contained in @value.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="actor">
-<parameter_description> A source #ClutterActor
+<parameter name="value">
+<parameter_description> a #GValue initialized to %CLUTTER_TYPE_UNITS
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #ClutterTexture object, or %NULL on failure.
+<return> the units inside the passed #GValue
</return>
</function>
-<function name="clutter_device_manager_get_core_device">
+<function name="clutter_value_set_color">
<description>
-Retrieves the core #ClutterInputDevice of type @device_type
-
-Core devices are devices created automatically by the default
-Clutter backend
+Sets @value to @color.
-Since: 1.2
+Since: 0.8.4
</description>
<parameters>
-<parameter name="device_manager">
-<parameter_description> a #ClutterDeviceManager
+<parameter name="value">
+<parameter_description> a #GValue initialized to #CLUTTER_TYPE_COLOR
</parameter_description>
</parameter>
-<parameter name="device_type">
-<parameter_description> the type of the core device
+<parameter name="color">
+<parameter_description> the color to set
</parameter_description>
</parameter>
</parameters>
-<return> a #ClutterInputDevice or %NULL. The
-returned device is owned by the #ClutterDeviceManager and should
-not be modified or freed
-
-</return>
+<return></return>
</function>
-<function name="clutter_backend_set_double_click_time">
+<function name="clutter_value_set_fixed">
<description>
-Sets the maximum time between two button press events, used to
-verify whether it's a double click event or not.
+Sets @value to @fixed_.
-Since: 0.4
+Since: 0.8
+
+Deprecated: 1.10: Use g_value_set_int() instead.
</description>
<parameters>
-<parameter name="backend">
-<parameter_description> a #ClutterBackend
+<parameter name="value">
+<parameter_description> a #GValue initialized to %COGL_TYPE_FIXED
</parameter_description>
</parameter>
-<parameter name="msec">
-<parameter_description> milliseconds between two button press events
+<parameter name="fixed_">
+<parameter_description> the fixed point value to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_stage_get_fullscreen">
+<function name="clutter_value_set_paint_node">
<description>
-Retrieves whether the stage is full screen or not
+Sets the contents of a #GValue initialized with %CLUTTER_TYPE_PAINT_NODE.
-Since: 1.0
+This function increased the reference count of @node; if you do not wish
+to increase the reference count, use clutter_value_take_paint_node()
+instead. The reference count will be released by g_value_unset().
+
+Since: 1.10
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> a #ClutterStage
+<parameter name="value">
+<parameter_description> a #GValue initialized with %CLUTTER_TYPE_PAINT_NODE
+</parameter_description>
+</parameter>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the stage is full screen
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_get_text_direction">
+<function name="clutter_value_set_shader_float">
<description>
-Retrieves the value set using clutter_actor_set_text_direction()
-
-If no text direction has been previously set, the default text
-direction, as returned by clutter_get_default_text_direction(), will
-be returned instead
+Sets @floats as the contents of @value. The passed #GValue
+must have been initialized using %CLUTTER_TYPE_SHADER_FLOAT.
-Since: 1.2
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="value">
+<parameter_description> a #GValue
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> number of floating point values in @floats
+</parameter_description>
+</parameter>
+<parameter name="floats">
+<parameter_description> an array of floating point values
</parameter_description>
</parameter>
</parameters>
-<return> the #ClutterTextDirection for the actor
-
-</return>
+<return></return>
</function>
-<function name="clutter_actor_set_shader">
+<function name="clutter_value_set_shader_int">
<description>
-Sets the #ClutterShader to be used when rendering @self.
-
-If @shader is %NULL it will unset any currently set shader
-for the actor.
+Sets @ints as the contents of @value. The passed #GValue
+must have been initialized using %CLUTTER_TYPE_SHADER_INT.
-Since: 0.6
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
-<parameter name="shader">
-<parameter_description> a #ClutterShader or %NULL to unset the shader.
+<parameter name="size">
+<parameter_description> number of integer values in @ints
+</parameter_description>
+</parameter>
+<parameter name="ints">
+<parameter_description> an array of integer values
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the shader was successfully applied
-
-</return>
+<return></return>
</function>
-<function name="clutter_behaviour_ellipse_set_angle_tilt">
+<function name="clutter_value_set_shader_matrix">
<description>
-Sets the angle at which the ellipse should be tilted around it's center.
+Sets @matrix as the contents of @value. The passed #GValue
+must have been initialized using %CLUTTER_TYPE_SHADER_MATRIX.
-Since: 0.4
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterBehaviourEllipse
+<parameter name="value">
+<parameter_description> a #GValue
</parameter_description>
</parameter>
-<parameter name="axis">
-<parameter_description> a #ClutterRotateAxis
+<parameter name="size">
+<parameter_description> number of floating point values in @floats
</parameter_description>
</parameter>
-<parameter name="angle_tilt">
-<parameter_description> tilt of the elipse around the center in the given axis in
-degrees.
+<parameter name="matrix">
+<parameter_description> a matrix of floating point values
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_media_get_buffer_fill">
+<function name="clutter_value_set_units">
<description>
-Retrieves the amount of the stream that is buffered.
+Sets @value to @units
-Since: 1.0
+Since: 0.8
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="value">
+<parameter_description> a #GValue initialized to %CLUTTER_TYPE_UNITS
+</parameter_description>
+</parameter>
+<parameter name="units">
+<parameter_description> the units to set
</parameter_description>
</parameter>
</parameters>
-<return> the fill level, between 0.0 and 1.0
+<return></return>
+</function>
+
+<function name="clutter_value_take_paint_node">
+<description>
+Sets the contents of a #GValue initialized with %CLUTTER_TYPE_PAINT_NODE.
+
+Unlike clutter_value_set_paint_node(), this function will not take a
+reference on the passed @node: instead, it will take ownership of the
+current reference count.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="value">
+<parameter_description> a #GValue, initialized with %CLUTTER_TYPE_PAINT_NODE
+</parameter_description>
+</parameter>
+<parameter name="node">
+<parameter_description> a #ClutterPaintNode, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_vertex_alloc">
+<description>
+Allocates a new, empty #ClutterVertex.
+
+Since: 1.12
+
+</description>
+<parameters>
+</parameters>
+<return> the newly allocated #ClutterVertex.
+Use clutter_vertex_free() to free its resources
</return>
</function>
-<function name="clutter_animator_key_get_progress">
+<function name="clutter_vertex_copy">
<description>
-Retrieves the progress of an clutter_animator_key
+Copies @vertex
-Since: 1.2
+Since: 1.0
</description>
<parameters>
-<parameter name="key">
-<parameter_description> a #ClutterAnimatorKey
+<parameter name="vertex">
+<parameter_description> a #ClutterVertex
</parameter_description>
</parameter>
</parameters>
-<return> the progress defined for a #ClutterAnimator key.
+<return> a newly allocated copy of #ClutterVertex.
+Use clutter_vertex_free() to free the allocated resources
</return>
</function>
-<function name="clutter_animation_get_mode">
+<function name="clutter_vertex_equal">
<description>
-Retrieves the animation mode of @animation, as set by
-clutter_animation_set_mode().
+Compares @vertex_a and @vertex_b for equality
Since: 1.0
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> a #ClutterAnimation
+<parameter name="vertex_a">
+<parameter_description> a #ClutterVertex
+</parameter_description>
+</parameter>
+<parameter name="vertex_b">
+<parameter_description> a #ClutterVertex
</parameter_description>
</parameter>
</parameters>
-<return> the mode for the animation
+<return> %TRUE if the passed #ClutterVertex are equal
</return>
</function>
-<function name="json_node_dup_array">
+<function name="clutter_vertex_free">
<description>
-Retrieves the #JsonArray stored inside a #JsonNode and returns it
-with its reference count increased by one.
+Frees a #ClutterVertex allocated using clutter_vertex_alloc() or
+clutter_vertex_copy().
+Since: 1.0
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="vertex">
+<parameter_description> a #ClutterVertex
</parameter_description>
</parameter>
</parameters>
-<return> the #JsonArray with its reference count increased.
-</return>
+<return></return>
</function>
-<function name="clutter_event_get_state">
+<function name="clutter_vertex_init">
<description>
-Retrieves the modifier state of the event.
+Initializes @vertex with the given coordinates.
-Since: 0.4
+Since: 1.10
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #ClutterEvent
+<parameter name="vertex">
+<parameter_description> a #ClutterVertex
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate
+</parameter_description>
+</parameter>
+<parameter name="z">
+<parameter_description> Z coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the modifier state parameter, or 0
+<return> the initialized #ClutterVertex
</return>
</function>
-<function name="clutter_path_add_rel_line_to">
+<function name="clutter_vertex_new">
<description>
-Same as clutter_path_add_line_to() except the coordinates are
-relative to the previous node.
+Creates a new #ClutterVertex for the point in 3D space
+identified by the 3 coordinates @x, @y, @z.
+
+This function is the logical equivalent of:
+
+|[
+clutter_vertex_init (clutter_vertex_alloc (), x, y, z);
+]|
Since: 1.0
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
-</parameter_description>
-</parameter>
<parameter name="x">
-<parameter_description> the x coordinate
+<parameter_description> X coordinate
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the y coordinate
+<parameter_description> Y coordinate
</parameter_description>
</parameter>
+<parameter name="z">
+<parameter_description> Z coordinate
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly allocated #ClutterVertex.
+Use clutter_vertex_free() to free the resources
+
+</return>
+</function>
+
+<function name="clutter_wayland_disable_event_retrieval">
+<description>
+Disables the dispatch of the events in the main loop.
+
+This is useful for integrating Clutter with another library that will do the
+event dispatch; in general only a single source should be acting on changes
+on the Wayland file descriptor.
+
+<warning>This function can only be called before calling
+clutter_init().</warning>
+
+This function should not be normally used by applications.
+
+Since: 1.16
+
+</description>
+<parameters>
</parameters>
<return></return>
</function>
-<function name="clutter_model_get_column_name">
+<function name="clutter_wayland_input_device_get_wl_seat">
<description>
-Retrieves the name of the @column
+Access the underlying data structure representing the Wayland device that is
+backing this #ClutterInputDevice.
-Since: 0.6
+Note: this function can only be called when running on the Wayland platform.
+Calling this function at any other time will return %NULL.
+
+Since: 1.10
</description>
<parameters>
-<parameter name="model">
-<parameter_description> #ClutterModel
+<parameter name="device">
+<parameter_description> a #ClutterInputDevice
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> the column number
+</parameters>
+<return> the Wayland input device associated with the
+ device
+
+</return>
+</function>
+
+<function name="clutter_wayland_set_compositor_display">
+<description>
+This informs Clutter of your compositor side Wayland display
+object. This must be called before calling clutter_init().
+
+Since: 1.8
+Stability: unstable
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> A compositor side struct wl_display pointer
</parameter_description>
</parameter>
</parameters>
-<return> the name of the column. The model holds the returned
-string, and it should not be modified or freed
+<return></return>
+</function>
+
+<function name="clutter_wayland_set_display">
+<description>
+Sets the display connection Clutter should use; must be called
+before clutter_init(), clutter_init_with_args() or other functions
+pertaining Clutter's initialization process.
+
+If you are parsing the command line arguments by retrieving Clutter's
+#GOptionGroup with clutter_get_option_group() and calling
+g_option_context_parse() yourself, you should also call
+clutter_wayland_set_display() before g_option_context_parse().
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> pointer to a wayland display
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_wayland_stage_get_wl_shell_surface">
+<description>
+Access the underlying data structure representing the shell surface that is
+backing the #ClutterStage
+
+Note: this function can only be called when running on the Wayland
+platform. Calling this function at any other time will return %NULL.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+</parameters>
+<return> the Wayland shell surface associated with
+ stage
</return>
</function>
-<function name="clutter_text_set_text">
+<function name="clutter_wayland_stage_get_wl_surface">
<description>
-Sets the contents of a #ClutterText actor.
+Access the underlying data structure representing the surface that is
+backing the #ClutterStage
-If the #ClutterText:use-markup property was set to %TRUE it
-will be reset to %FALSE as a side effect. If you want to
-maintain the #ClutterText:use-markup you should use the
-clutter_text_set_markup() function instead
+Note: this function can only be called when running on the Wayland
+platform. Calling this function at any other time will return %NULL.
-Since: 1.0
+Since: 1.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to set. Passing %NULL is the same as passing "" (the
-empty string)
+</parameters>
+<return> the Wayland surface associated with @stage
+
+</return>
+</function>
+
+<function name="clutter_wayland_stage_set_wl_surface">
+<description>
+Allows you to explicitly provide an existing Wayland surface to associate
+with @stage, preventing Cogl from allocating a surface and shell surface for
+the stage automatically.
+
+This function must be called before @stage is shown.
+
+Note: this function can only be called when running on the Wayland
+platform. Calling this function at any other time has no effect.
+
+Since: 1.16
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="surface">
+<parameter_description> A Wayland surface to associate with the @stage.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_interval_get_value_type">
+<function name="clutter_wayland_surface_attach_buffer">
<description>
-Retrieves the #GType of the values inside @interval.
+This associates a client's buffer with the #ClutterWaylandSurface
+actor @self. This will automatically result in @self being re-drawn
+with the new buffer contents.
-Since: 1.0
+Since: 1.8
+Stability: unstable
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> a #ClutterInterval
+<parameter name="self">
+<parameter_description> A #ClutterWaylandSurface actor
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> A compositor side resource representing a wl_buffer
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> A #GError
</parameter_description>
</parameter>
</parameters>
-<return> the type of the value, or G_TYPE_INVALID
-
-</return>
+<return></return>
</function>
-<function name="clutter_cairo_texture_create_region">
+<function name="clutter_wayland_surface_damage_buffer">
<description>
-Creates a new Cairo context that will updat the region defined
-by @x_offset, @y_offset, @width and @height.
+This marks a region of the given @buffer has having been changed by
+the client. This will automatically result in the corresponding damaged
+region of the actor @self being redrawn.
-<warning><para>Do not call this function within the paint virtual
-function or from a callback to the #ClutterActor::paint
-signal.</para></warning>
+If multiple regions are changed then this should be called multiple
+times with different damage rectangles.
-Since: 1.0
+Since: 1.8
+Stability: unstable
</description>
<parameters>
<parameter name="self">
-<parameter_description> a #ClutterCairoTexture
+<parameter_description> A #ClutterWaylandSurface actor
</parameter_description>
</parameter>
-<parameter name="x_offset">
-<parameter_description> offset of the region on the X axis
+<parameter name="buffer">
+<parameter_description> A wayland resource for a buffer
</parameter_description>
</parameter>
-<parameter name="y_offset">
-<parameter_description> offset of the region on the Y axis
+<parameter name="x">
+<parameter_description> The x coordinate of the damaged rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The y coordinate of the damaged rectangle
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> width of the region, or -1 for the full surface width
+<parameter_description> The width of the damaged rectangle
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> height of the region, or -1 for the full surface height
+<parameter_description> The height of the damaged rectangle
</parameter_description>
</parameter>
</parameters>
-<return> a newly created Cairo context. Use cairo_destroy()
-to upload the contents of the context when done drawing
+<return></return>
+</function>
+
+<function name="clutter_wayland_surface_get_cogl_texture">
+<description>
+Retrieves the Cogl texture with the contents of the Wayland surface.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterWaylandSurface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a Cogl texture, or %NULL
</return>
</function>
-<function name="clutter_color_subtract">
+<function name="clutter_wayland_surface_get_surface">
<description>
-Subtracts @b from @a and saves the resulting color inside @result.
+Retrieves a point to the Wayland surface used by the actor.
-This function assumes that the components of @a are greater than the
-components of @b; the result is, otherwise, undefined.
+Since: 1.10
-The alpha channel of @result is set as the minimum value
-between the alpha channels of @a and @b.
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterWaylandSurface
+</parameter_description>
+</parameter>
+</parameters>
+<return> a wl_surface pointer, or %NULL
+
+</return>
+</function>
+
+<function name="clutter_wayland_surface_new">
+<description>
+Creates a new #ClutterWaylandSurface for @surface
+
+Since: 1.8
+Stability: unstable
</description>
<parameters>
-<parameter name="a">
-<parameter_description> a #ClutterColor
+<parameter name="surface">
+<parameter_description> the Wayland surface this actor should represent
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> a #ClutterColor
+</parameters>
+<return> A new #ClutterWaylandSurface representing @surface
+
+</return>
+</function>
+
+<function name="clutter_wayland_surface_set_surface">
+<description>
+Sets the Wayland surface to be used by the actor.
+
+Since: 1.10
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #ClutterWaylandSurface
</parameter_description>
</parameter>
-<parameter name="result">
-<parameter_description> return location for the result
+<parameter name="surface">
+<parameter_description> a Wayland wl_surface pointer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_color_new">
+<function name="clutter_win32_disable_event_retrieval">
<description>
-Creates a new #ClutterColor with the given values.
+Disables retrieval of Windows messages in the main loop. Use to
+create event-less canvas.
-Since: 0.8.4
+This function can only be called before calling clutter_init().
+
+Since: 0.8
</description>
<parameters>
-<parameter name="red">
-<parameter_description> red component of the color, between 0 and 255
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_win32_get_stage_from_window">
+<description>
+Gets the stage for a particular window.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="hwnd">
+<parameter_description> a window handle
</parameter_description>
</parameter>
-<parameter name="green">
-<parameter_description> green component of the color, between 0 and 255
+</parameters>
+<return> The stage or NULL if a stage does not exist for the
+window.
+
+</return>
+</function>
+
+<function name="clutter_win32_get_stage_window">
+<description>
+Gets the stage's window handle
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="blue">
-<parameter_description> blue component of the color, between 0 and 255
+</parameters>
+<return> An HWND for the stage window.
+
+</return>
+</function>
+
+<function name="clutter_win32_handle_event">
+<description>
+This function processes a single Win32 message. It can be used to
+hook into external windows message processing (for example, a GDK
+filter function).
+
+If clutter_win32_disable_event_retrieval() has been called, you must
+let this function process events to update Clutter's internal state.
+
+Since: 1.6
+
+</description>
+<parameters>
+<parameter name="msg">
+<parameter_description> A pointer to a structure describing a Win32 message.
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> alpha component of the color, between 0 and 255
+</parameters>
+<return> %TRUE if the message was handled entirely by Clutter
+and no further processing (such as calling the default window
+procedure) should take place. %FALSE is returned if is the message
+was not handled at all or if Clutter expects processing to take
+place.
+
+</return>
+</function>
+
+<function name="clutter_win32_set_stage_foreign">
+<description>
+Target the #ClutterStage to use an existing external window handle.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
+</parameter_description>
+</parameter>
+<parameter name="hwnd">
+<parameter_description> an existing window handle
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocated color. Use clutter_color_free()
-when done
+<return> %TRUE if foreign window is valid
</return>
</function>
-<function name="clutter_text_set_selectable">
+<function name="clutter_x11_add_filter">
<description>
-Sets whether a #ClutterText actor should be selectable.
-
-A selectable #ClutterText will allow selecting its contents using
-the pointer or the keyboard.
+Adds an event filter function.
-Since: 1.0
+Since: 0.6
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+<parameter name="func">
+<parameter_description> a filter function
</parameter_description>
</parameter>
-<parameter name="selectable">
-<parameter_description> whether the #ClutterText actor should be selectable
+<parameter name="data">
+<parameter_description> user data to be passed to the filter function, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_binding_pool_install_closure">
+<function name="clutter_x11_disable_event_retrieval">
<description>
-A #GClosure variant of clutter_binding_pool_install_action().
+Disables the internal polling of X11 events in the main loop.
-Installs a new action inside a #ClutterBindingPool. The action
-is bound to @key_val and @modifiers.
+Libraries or applications calling this function will be responsible of
+polling all X11 events.
-The same action name can be used for multiple @key_val, @modifiers
-pairs.
+You also must call clutter_x11_handle_event() to let Clutter process
+events and maintain its internal state.
-When an action has been activated using clutter_binding_pool_activate()
-the passed @closure will be invoked.
+<warning>This function can only be called before calling
+clutter_init().</warning>
-Actions can be blocked with clutter_binding_pool_block_action()
-and then unblocked using clutter_binding_pool_unblock_action().
+<note>Even with event handling disabled, Clutter will still select
+all the events required to maintain its internal state on the stage
+Window; compositors using Clutter and input regions to pass events
+through to application windows should not rely on an empty input
+region, and should instead clear it themselves explicitly using the
+XFixes extension.</note>
-Since: 1.0
+This function should not be normally used by applications.
+
+Since: 0.8
</description>
<parameters>
-<parameter name="pool">
-<parameter_description> a #ClutterBindingPool
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_x11_enable_xinput">
+<description>
+Enables the use of the XInput extension if present on connected
+XServer and support built into Clutter. XInput allows for multiple
+pointing devices to be used.
+
+This function must be called before clutter_init().
+
+Since XInput might not be supported by the X server, you might
+want to use clutter_x11_has_xinput() to see if support was enabled.
+
+Since: 0.8
+
+Deprecated: 1.14: This function does not do anything; XInput support
+is enabled by default in Clutter. Use the CLUTTER_DISABLE_XINPUT
+environment variable to disable XInput support and use Xlib core
+events instead.
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+
+<function name="clutter_x11_event_get_key_group">
+<description>
+Retrieves the group for the modifiers set in @event
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #ClutterEvent of type %CLUTTER_KEY_PRESS or %CLUTTER_KEY_RELEASE
</parameter_description>
</parameter>
-<parameter name="action_name">
-<parameter_description> the name of the action
+</parameters>
+<return> the group id
+
+</return>
+</function>
+
+<function name="clutter_x11_event_sequence_get_touch_detail">
+<description>
+Retrieves the touch detail froma #ClutterEventSequence.
+
+Since: 1.12
+
+</description>
+<parameters>
+<parameter name="sequence">
+<parameter_description> a #ClutterEventSequence
</parameter_description>
</parameter>
-<parameter name="key_val">
-<parameter_description> key symbol
+</parameters>
+<return> the touch detail
+
+</return>
+</function>
+
+<function name="clutter_x11_get_current_event_time">
+<description>
+Retrieves the timestamp of the last X11 event processed by
+Clutter. This might be different from the timestamp returned
+by clutter_get_current_event_time(), as Clutter may synthesize
+or throttle events.
+
+Since: 1.0
+
+</description>
+<parameters>
+</parameters>
+<return> a timestamp, in milliseconds
+
+</return>
+</function>
+
+<function name="clutter_x11_get_default_display">
+<description>
+Retrieves the pointer to the default display.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the default display
+
+</return>
+</function>
+
+<function name="clutter_x11_get_default_screen">
+<description>
+Gets the number of the default X Screen object.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the number of the default screen
+
+</return>
+</function>
+
+<function name="clutter_x11_get_input_devices">
+<description>
+Retrieves a pointer to the list of input devices
+
+Deprecated: 1.2: Use clutter_device_manager_peek_devices() instead
+
+Since: 0.8
+
+
+</description>
+<parameters>
+</parameters>
+<return> a
+pointer to the internal list of input devices; the returned list is
+owned by Clutter and should not be modified or freed
+</return>
+</function>
+
+<function name="clutter_x11_get_root_window">
+<description>
+Retrieves the root window.
+
+Since: 0.6
+
+</description>
+<parameters>
+</parameters>
+<return> the id of the root window
+
+</return>
+</function>
+
+<function name="clutter_x11_get_stage_from_window">
+<description>
+Gets the stage for a particular X window.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="win">
+<parameter_description> an X Window ID
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> bitmask of modifiers
+</parameters>
+<return> A #ClutterStage, or% NULL if a stage
+does not exist for the window
+
+</return>
+</function>
+
+<function name="clutter_x11_get_stage_visual">
+<description>
+Returns an XVisualInfo suitable for creating a foreign window for the given
+stage. NOTE: It doesn't do as the name may suggest, which is return the
+XVisualInfo that was used to create an existing window for the given stage.
+
+XXX: It might be best to deprecate this function and replace with something
+along the lines of clutter_backend_x11_get_foreign_visual () or perhaps
+clutter_stage_x11_get_foreign_visual ()
+
+Deprecated: 1.2: Use clutter_x11_get_visual_info() instead
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="closure">
-<parameter_description> a #GClosure
+</parameters>
+<return> An XVisualInfo suitable for creating a
+foreign stage. Use XFree() to free the returned value instead
+
+</return>
+</function>
+
+<function name="clutter_x11_get_stage_window">
+<description>
+Gets the stages X Window.
+
+Since: 0.4
+
+</description>
+<parameters>
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> An XID for the stage window.
+
+</return>
</function>
-<function name="json_array_get_null_element">
+<function name="clutter_x11_get_use_argb_visual">
<description>
-Conveniently retrieves whether the element at @index_ is set to null
+Retrieves whether the Clutter X11 backend is using ARGB visuals by default
+
+Since: 1.2
-See also: json_array_get_element(), JSON_NODE_TYPE(), %JSON_NODE_NULL
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if ARGB visuals are queried by default
+
+</return>
+</function>
+
+<function name="clutter_x11_get_visual_info">
+<description>
+Retrieves the <structname>XVisualInfo</structname> used by the Clutter X11
+backend.
+
+Since: 1.2
+
+</description>
+<parameters>
+</parameters>
+<return> a <structname>XVisualInfo</structname>, or
+<varname>None</varname>. The returned value should be freed using XFree()
+when done
+
+</return>
+</function>
+
+<function name="clutter_x11_handle_event">
+<description>
+This function processes a single X event; it can be used to hook
+into external X11 event processing (for example, a GDK filter
+function).
+
+If clutter_x11_disable_event_retrieval() has been called, you must
+let this function process events to update Clutter's internal state.
Since: 0.8
</description>
<parameters>
-<parameter name="array">
-<parameter_description> a #JsonArray
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> the index of the element to retrieve
+<parameter name="xevent">
+<parameter_description> pointer to XEvent structure
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the element is null
+<return> #ClutterX11FilterReturn. %CLUTTER_X11_FILTER_REMOVE
+indicates that Clutter has internally handled the event and the
+caller should do no further processing. %CLUTTER_X11_FILTER_CONTINUE
+indicates that Clutter is either not interested in the event,
+or has used the event to update internal state without taking
+any exclusive action. %CLUTTER_X11_FILTER_TRANSLATE will not
+occur.
</return>
</function>
-<function name="clutter_text_set_cursor_visible">
+<function name="clutter_x11_has_composite_extension">
<description>
-Sets whether the cursor of a #ClutterText actor should be
-visible or not.
+Retrieves whether Clutter is running on an X11 server with the
+XComposite extension
-The color of the cursor will be the same as the text color
-unless clutter_text_set_cursor_color() has been called.
-The size of the cursor can be set using clutter_text_set_cursor_size().
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if the XComposite extension is available
+</return>
+</function>
-The position of the cursor can be changed programmatically using
-clutter_text_set_cursor_position().
+<function name="clutter_x11_has_event_retrieval">
+<description>
+Queries the X11 backend to check if event collection has been disabled.
-Since: 1.0
+Since: 0.8
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterText
+</parameters>
+<return> TRUE if event retrival has been disabled. FALSE otherwise.
+
+</return>
+</function>
+
+<function name="clutter_x11_has_xinput">
+<description>
+Gets whether Clutter has XInput support.
+
+Since: 0.8
+
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if Clutter was compiled with XInput support
+and XInput support is available at run time.
+
+</return>
+</function>
+
+<function name="clutter_x11_remove_filter">
+<description>
+Removes the given filter function.
+
+Since: 0.6
+
+</description>
+<parameters>
+<parameter name="func">
+<parameter_description> a filter function
</parameter_description>
</parameter>
-<parameter name="cursor_visible">
-<parameter_description> whether the cursor should be visible
+<parameter name="data">
+<parameter_description> user data to be passed to the filter function, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_group_remove_all">
+<function name="clutter_x11_set_display">
<description>
-Removes all children actors from the #ClutterGroup.
+Sets the display connection Clutter should use; must be called
+before clutter_init(), clutter_init_with_args() or other functions
+pertaining Clutter's initialization process.
+
+If you are parsing the command line arguments by retrieving Clutter's
+#GOptionGroup with clutter_get_option_group() and calling
+g_option_context_parse() yourself, you should also call
+clutter_x11_set_display() before g_option_context_parse().
+
+Since: 0.8
</description>
<parameters>
-<parameter name="group">
-<parameter_description> A #ClutterGroup
+<parameter name="xdpy">
+<parameter_description> pointer to a X display connection.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_actor_get_transformation_matrix">
+<function name="clutter_x11_set_stage_foreign">
<description>
-Retrieves the transformations applied to @self
+Target the #ClutterStage to use an existing external X Window
-Since: 1.0
+Since: 0.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="stage">
+<parameter_description> a #ClutterStage
</parameter_description>
</parameter>
-<parameter name="matrix">
-<parameter_description> the return location for a #CoglMatrix
+<parameter name="xwindow">
+<parameter_description> an existing X Window id
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if foreign window is valid
+
+</return>
+</function>
+
+<function name="clutter_x11_set_use_argb_visual">
+<description>
+Sets whether the Clutter X11 backend should request ARGB visuals by default
+or not.
+
+By default, Clutter requests RGB visuals.
+
+<note>If no ARGB visuals are found, the X11 backend will fall back to
+requesting a RGB visual instead.</note>
+
+ARGB visuals are required for the #ClutterStage:use-alpha property to work.
+
+<note>This function can only be called once, and before clutter_init() is
+called.</note>
+
+Since: 1.2
+
+</description>
+<parameters>
+<parameter name="use_argb">
+<parameter_description> %TRUE if ARGB visuals should be requested by default
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_script_get_object">
+<function name="clutter_x11_texture_pixmap_new">
<description>
-Retrieves the object bound to @name. This function does not increment
-the reference count of the returned object.
+Creates a new #ClutterX11TexturePixmap which can be used to display the
+contents of an X11 Pixmap inside a Clutter scene graph
-Since: 0.6
+Since: 0.8
</description>
<parameters>
-<parameter name="script">
-<parameter_description> a #ClutterScript
+</parameters>
+<return> A new #ClutterX11TexturePixmap
+
+</return>
+</function>
+
+<function name="clutter_x11_texture_pixmap_new_with_pixmap">
+<description>
+Creates a new #ClutterX11TexturePixmap for @pixmap
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="pixmap">
+<parameter_description> the X Pixmap to which this texture should be bound
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name of the object to retrieve
+</parameters>
+<return> A new #ClutterX11TexturePixmap bound to the given X Pixmap
+
+</return>
+</function>
+
+<function name="clutter_x11_texture_pixmap_new_with_window">
+<description>
+Creates a new #ClutterX11TexturePixmap for @window
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> the X window to which this texture should be bound
</parameter_description>
</parameter>
</parameters>
-<return> : (transfer none): the named object, or %NULL if no object
-with the given name was available
+<return> A new #ClutterX11TexturePixmap bound to the given X window.
</return>
</function>
-<function name="json_node_get_value">
+<function name="clutter_x11_texture_pixmap_set_automatic">
<description>
-Retrieves a value from a #JsonNode and copies into @value. When done
-using it, call g_value_unset() on the #GValue.
+Enables or disables the automatic updates ot @texture in case the backing
+pixmap or window is damaged
+
+Since: 0.8
</description>
<parameters>
-<parameter name="node">
-<parameter_description> a #JsonNode
+<parameter name="texture">
+<parameter_description> a #ClutterX11TexturePixmap
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> return location for an uninitialized value
+<parameter name="setting">
+<parameter_description> %TRUE to enable automatic updates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_timeline_get_delta">
+<function name="clutter_x11_texture_pixmap_set_pixmap">
<description>
-Retrieves the amount of time elapsed since the last
-ClutterTimeline::new-frame signal.
-
-This function is only useful inside handlers for the ::new-frame
-signal, and its behaviour is undefined if the timeline is not
-playing.
+Sets the X Pixmap to which the texture should be bound.
-Since: 0.6
+Since: 0.8
</description>
<parameters>
-<parameter name="timeline">
-<parameter_description> a #ClutterTimeline
+<parameter name="texture">
+<parameter_description> the texture to bind
+</parameter_description>
+</parameter>
+<parameter name="pixmap">
+<parameter_description> the X Pixmap to which the texture should be bound
</parameter_description>
</parameter>
</parameters>
-<return> the amount of time in milliseconds elapsed since the
-last frame
+<return></return>
+</function>
-</return>
+<function name="clutter_x11_texture_pixmap_set_window">
+<description>
+Sets up a suitable pixmap for the window, using the composite and damage
+extensions if possible, and then calls
+clutter_x11_texture_pixmap_set_pixmap().
+
+If you want to display a window in a #ClutterTexture, you probably want
+this function, or its older sister, clutter_glx_texture_pixmap_set_window().
+
+This function has no effect unless the XComposite extension is available.
+
+Since: 0.8
+
+</description>
+<parameters>
+<parameter name="texture">
+<parameter_description> the texture to bind
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> the X window to which the texture should be bound
+</parameter_description>
+</parameter>
+<parameter name="automatic">
+<parameter_description> %TRUE for automatic window updates, %FALSE for manual.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="clutter_stage_ensure_current">
+<function name="clutter_x11_texture_pixmap_sync_window">
<description>
-This function essentially makes sure the right GL context is
-current for the passed stage. It is not intended to
-be used by applications.
+Resets the texture's pixmap from its window, perhaps in response to the
+pixmap's invalidation as the window changed size.
Since: 0.8
</description>
<parameters>
-<parameter name="stage">
-<parameter_description> the #ClutterStage
+<parameter name="texture">
+<parameter_description> the texture to bind
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_path_insert_node">
+<function name="clutter_x11_texture_pixmap_update_area">
<description>
-Inserts @node into the path before the node at the given offset. If
- index_ is negative it will append the node to the end of the path.
+Performs the actual binding of texture to the current content of
+the pixmap. Can be called to update the texture if the pixmap
+content has changed.
-Since: 1.0
+Since: 0.8
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #ClutterPath
+<parameter name="texture">
+<parameter_description> The texture whose content shall be updated.
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> offset of where to insert the node
+<parameter name="x">
+<parameter_description> the X coordinate of the area to update
</parameter_description>
</parameter>
-<parameter name="node">
-<parameter_description> the node to insert
+<parameter name="y">
+<parameter_description> the Y coordinate of the area to update
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the area to update
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the area to update
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_flow_layout_set_row_spacing">
+<function name="clutter_x11_trap_x_errors">
<description>
-Sets the spacing between rows, in pixels
+Traps every X error until clutter_x11_untrap_x_errors() is called.
-Since: 1.2
+Since: 0.6
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #ClutterFlowLayout
-</parameter_description>
-</parameter>
-<parameter name="spacing">
-<parameter_description> the space between rows
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="clutter_rectangle_new">
+<function name="clutter_x11_untrap_x_errors">
<description>
-Creates a new #ClutterActor with a rectangular shape.
+Removes the X error trap and returns the current status.
+Since: 0.4
</description>
<parameters>
</parameters>
-<return> a new #ClutterActor
+<return> the trapped error code, or 0 for success
+
</return>
</function>
-<function name="clutter_actor_get_pango_context">
+<function name="clutter_zoom_action_get_focal_point">
<description>
-Retrieves the #PangoContext for @self. The actor's #PangoContext
-is already configured using the appropriate font map, resolution
-and font options.
+Retrieves the focal point of the current zoom
-Unlike clutter_actor_create_pango_context(), this context is owend
-by the #ClutterActor and it will be updated each time the options
-stored by the #ClutterBackend change.
+Since: 1.12
-You can use the returned #PangoContext to create a #PangoLayout
-and render text using cogl_pango_render_layout() to reuse the
-glyphs cache also used by Clutter.
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #ClutterZoomAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> a #ClutterPoint
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 1.0
+<function name="clutter_zoom_action_get_transformed_focal_point">
+<description>
+Retrieves the focal point relative to the actor's coordinates of
+the current zoom
+
+Since: 1.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #ClutterActor
+<parameter name="action">
+<parameter_description> a #ClutterZoomAction
+</parameter_description>
+</parameter>
+<parameter name="point">
+<parameter_description> a #ClutterPoint
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoContext for a #ClutterActor.
-The returned #PangoContext is owned by the actor and should not be
-unreferenced by the application code
-
-</return>
+<return></return>
</function>
-<function name="clutter_score_rewind">
+<function name="clutter_zoom_action_get_zoom_axis">
<description>
-Rewinds a #ClutterScore to its initial state.
+Retrieves the axis constraint set by clutter_zoom_action_set_zoom_axis()
-Since: 0.6
+Since: 1.12
</description>
<parameters>
-<parameter name="score">
-<parameter_description> A #ClutterScore
+<parameter name="action">
+<parameter_description> a #ClutterZoomAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the axis constraint
+
+</return>
</function>
-<function name="clutter_media_set_subtitle_font_name">
+<function name="clutter_zoom_action_new">
<description>
-Sets the font used by the subtitle renderer. The @font_name string must be
-either %NULL, which means that the default font name of the underlying
-implementation will be used; or must follow the grammar recognized by
-pango_font_description_from_string() like:
+Creates a new #ClutterZoomAction instance
-|[
-clutter_media_set_subtitle_font_name (media, "Sans 24pt");
-]|
+Since: 1.12
-Since: 1.2
+</description>
+<parameters>
+</parameters>
+<return> the newly created #ClutterZoomAction
+
+</return>
+</function>
+
+<function name="clutter_zoom_action_set_zoom_axis">
+<description>
+Restricts the zooming action to a specific axis
+
+Since: 1.12
</description>
<parameters>
-<parameter name="media">
-<parameter_description> a #ClutterMedia
+<parameter name="action">
+<parameter_description> a #ClutterZoomAction
</parameter_description>
</parameter>
-<parameter name="font_name">
-<parameter_description> a font name, or %NULL to set the default font name
+<parameter name="axis">
+<parameter_description> the axis to constraint the zooming to
</parameter_description>
</parameter>
</parameters>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]