[cogl] docs: make cogl.h clip stack docs consistent



commit de04a58f305276b3f9d6a33d4dacfd9d71f80619
Author: Robert Bragg <robert linux intel com>
Date:   Sun Nov 20 19:00:38 2011 +0000

    docs: make cogl.h clip stack docs consistent
    
    This updates some of the cogl.h cogl_clip_ API documentation to make it
    consistent with the documentation for corresponding framebuffer clip
    stack API in cogl-framebuffer.h
    
    Reviewed-by: Neil Roberts <neil linux intel com>

 cogl/cogl.h |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/cogl/cogl.h b/cogl/cogl.h
index bef39d4..772886b 100644
--- a/cogl/cogl.h
+++ b/cogl/cogl.h
@@ -1032,8 +1032,10 @@ cogl_clip_push_from_path_preserve (void);
  * to be larger than the true bounds but behaviour is undefined if the
  * bounds are smaller than the true bounds.
  *
- * The clipping area is intersected with the previous clipping area.
- * To restore the previous clipping area, call cogl_clip_pop().
+ * The primitive is transformed by the current model-view matrix and
+ * the silhouette is intersected with the previous clipping area.  To
+ * restore the previous clipping area, call
+ * cogl_clip_pop().
  *
  * Since: 1.10
  * Stability: unstable



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]