[clutter/wip/neil/master-next] offscreen-effect: Update the documentation for get_texture()

[Neil Roberts <nroberts src gnome org>]

commit a293c69253639631e9a8ee56efe7f074049dda82
Author: Neil Roberts <neil linux intel com>
Date:   Tue Feb 14 11:30:24 2012 +0000

    offscreen-effect: Update the documentation for get_texture()
    
    This changes the documentation for
    clutter_offscreen_effect_get_texture to make it clear that the texture
    will only change after pre_paint is called so that an implementation
    is free to cache the texture handle between pre_paint calls.

 clutter/clutter-offscreen-effect.c |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/clutter/clutter-offscreen-effect.c b/clutter/clutter-offscreen-effect.c
index 6805ec0..0b28fa4 100644
--- a/clutter/clutter-offscreen-effect.c
+++ b/clutter/clutter-offscreen-effect.c
@@ -486,8 +486,10 @@ clutter_offscreen_effect_init (ClutterOffscreenEffect *self)
  * Retrieves the texture used as a render target for the offscreen
  * buffer created by @effect
  *
- * You should only use the returned texture when painting. The
- * returned texture might change between different frames. This can be
+ * 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.
  *