summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2016-07-12 14:48:58 +0100
committerPhilip Withnall <philip.withnall@collabora.co.uk>2016-07-12 14:49:58 +0100
commitd7372cc45347b92effd1bf2c0f60185a1e35ab27 (patch)
treec7029167b7e7112f00ccb23e627d035a02d64b3b
parent9285a8522fbe1a4651c729a52de97dfff73dcf9b (diff)
downloadclutter-d7372cc45347b92effd1bf2c0f60185a1e35ab27.tar.gz
actor: Clarify that add_effect() sinks floating references on the effect
So if you want to reuse a ClutterEffect, make sure to g_object_ref_sink() it yourself first. https://bugzilla.gnome.org/show_bug.cgi?id=768734
-rw-r--r--clutter/clutter-actor.c9
1 files changed, 8 insertions, 1 deletions
diff --git a/clutter/clutter-actor.c b/clutter/clutter-actor.c
index fedcbfe09..f7cbc93a4 100644
--- a/clutter/clutter-actor.c
+++ b/clutter/clutter-actor.c
@@ -17162,6 +17162,9 @@ clutter_actor_get_clip_to_allocation (ClutterActor *self)
* clutter_actor_remove_effect() or clutter_actor_clear_effects() is
* called.
*
+ * Note that as #ClutterEffect is initially unowned,
+ * clutter_actor_add_effect() will sink any floating reference on @effect.
+ *
* Since: 1.4
*/
void
@@ -17185,7 +17188,11 @@ clutter_actor_add_effect (ClutterActor *self,
* @effect: a #ClutterEffect
*
* A convenience function for setting the name of a #ClutterEffect
- * while adding it to the list of effectss applied to @self
+ * while adding it to the list of effects applied to @self.
+ *
+ * Note that as #ClutterEffect is initially unowned,
+ * clutter_actor_add_effect_with_name() will sink any floating
+ * reference on @effect.
*
* This function is the logical equivalent of:
*