From 8668a019a0bde8a078f999cd5b960a1f63f700ec Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Thu, 5 Aug 2010 11:41:25 +0100
Subject: [PATCH] cookbook: Fix the text-shadow recipe

Fill out the recipe and add more comments to the example code.
---
 doc/cookbook/examples/text-shadow.c | 10 ++--
 doc/cookbook/text.xml               | 71 +++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+), 3 deletions(-)

diff --git a/doc/cookbook/examples/text-shadow.c b/doc/cookbook/examples/text-shadow.c
index 4afe62c4a..ced68b7b3 100644
--- a/doc/cookbook/examples/text-shadow.c
+++ b/doc/cookbook/examples/text-shadow.c
@@ -11,22 +11,26 @@ _text_paint_cb (ClutterActor *actor)
 {
   ClutterText *text = CLUTTER_TEXT (actor);
 
-  ClutterActorBox alloc = { 0, };
-  clutter_actor_get_allocation_box (actor, &alloc);
-
+  /* Get the PangoLayout that the Text actor is going to paint */
   PangoLayout *layout;
   layout = clutter_text_get_layout (text);
 
+  /* Get the color of the text, to extract the alpha component */
   ClutterColor text_color = { 0, };
   clutter_text_get_color (text, &text_color);
 
+  /* Composite the opacity so that the shadow is correctly blended */
   guint8 real_opacity;
   real_opacity = clutter_actor_get_paint_opacity (actor)
                * text_color.alpha
                / 255;
 
+  /* Create a #ccc color and premultiply it */
   CoglColor color;
   cogl_color_set_from_4ub (&color, 0xcc, 0xcc, 0xcc, real_opacity);
+  cogl_color_premultiply (&color);
+
+  /* Finally, render the Text layout at a given offset using the color */
   cogl_pango_render_layout (layout, SHADOW_X_OFFSET, SHADOW_Y_OFFSET, &color, 0);
 }
 
diff --git a/doc/cookbook/text.xml b/doc/cookbook/text.xml
index a278bb980..01ba040c1 100644
--- a/doc/cookbook/text.xml
+++ b/doc/cookbook/text.xml
@@ -29,6 +29,11 @@
     <section>
       <title>Solution</title>
 
+      <para>Override the <function>paint</function> signal of
+      <type>ClutterText</type> and use the CoglPango API to paint the
+      <type>PangoLayout</type> of the actor with the color of the
+      shadow at a given offset.</para>
+
       <screenshot>
         <mediaobject>
           <imageobject>
@@ -46,6 +51,72 @@
     <section>
       <title>Discussion</title>
 
+      <para>The <type>ClutterText</type> class provides an actor that
+      transforms the <type>PangoLayout</type> object into an element of
+      the Clutter scene graph. The underlying layout is painted, though,
+      through a subset of the Cogl API, called
+      <emphasis>CoglPango</emphasis>.</para>
+
+      <para>It is possible to paint <type>PangoLayout</type> created by a
+      <type>ClutterText</type> by invoking
+      <function>cogl_pango_render_layout()</function>:</para>
+
+      <informalexample><programlisting>
+<![CDATA[
+void
+cogl_pango_render_layout (PangoLayout *layout,
+                          int          x_offset,
+                          int          y_offset,
+                          CoglColor   *text_color,
+                          int          flags);
+]]>
+      </programlisting></informalexample>
+
+      <para>This function will paint the layout at the given offsets using the
+      provided color.</para>
+
+      <warning><para>The <function>cogl_pango_render_layout()<function>
+      function will only work with <type>PangoLayout</type>s created by
+      Clutter.</para></warning>
+
+      <para>Since the shadow of the text is literally the same text but painted
+      with a different color and at an offset, we can use the
+      <function>paint</function> signal of <type>ClutterText</type> to paint
+      the shadow, and then let <type>ClutterText</type> paint its contents on
+      top:</para>
+
+      <informalexample><programlisting>
+<![CDATA[
+static void
+_text_paint_cb (ClutterActor *actor)
+{
+  ClutterText *text = CLUTTER_TEXT (actor);
+
+  /* Get the PangoLayout that the Text actor is going to paint... */
+  PangoLayout *layout;
+  layout = clutter_text_get_layout (text);
+
+  /* ... Create the color of the shadow... */
+
+  /* ... Finally, render the Text layout at a given
+   * offset using the color of the shadow
+   */
+  cogl_pango_render_layout (layout,
+                            SHADOW_X_OFFSET, SHADOW_Y_OFFSET,
+                            &color, 0);
+}
+]]>
+      </programlisting></informalexample>
+
+      <para>Note that we are using the <type>PangoLayout</type> of the
+      <type>ClutterText</type> because the <type>ClutterText</type> actor
+      always keeps an updated layout internally. It is, however, possible for
+      any <type>ClutterActor</type> to create a <type>PangoLayout</type> using
+      <function>clutter_actor_create_pango_layout()</function>, and then paint
+      that layout using <function>cogl_pango_render_layout()</function> in
+      their implementation of the <function>paint</function> virtual
+      function.</para>
+
     </section>
 
     <section>