2008-02-15 Matthew Allum <mallum@openedhand.com>

        * clutter-docs.sgml:
        Overhaul the overview.

diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog
index cbc1a36..8c6280b 100644 (file)
--- a/doc/reference/ChangeLog
+++ b/doc/reference/ChangeLog
@@ -1,3 +1,8 @@
+2008-02-15  Matthew Allum  <mallum@openedhand.com>
+
+       * clutter-docs.sgml:
+        Overhaul the overview.
+
 2008-02-15  Emmanuele Bassi  <ebassi@openedhand.com>
 
        * clutter-animation.sgml: Fix some of the grammar; add a timeout-based

diff --git a/doc/reference/clutter-docs.sgml b/doc/reference/clutter-docs.sgml
index c934d43..f004192 100644 (file)
--- a/doc/reference/clutter-docs.sgml
+++ b/doc/reference/clutter-docs.sgml
@@ -13,7 +13,7 @@
     <releaseinfo>Version &version;</releaseinfo>
 
     <copyright>
-      <year>2007</year>
+      <year>2008</year>
       <holder>OpenedHand LTD</holder>
     </copyright>
 
@@ -51,24 +51,65 @@
     rich graphical user interfaces.
 
     </para>
+
+    <para>
+
+    Clutter essentially works by manipulating a scene graph of 2D
+    surfaces (actors) in 3D space.
+
+    </para>
+    <para>
+
+    #ClutterActor is the base class for such surfaces. All
+    #ClutterActors can we positioned and rotated in 3D space, scaled,
+    clipped, have children, have there opacity and origin set.
+    Tranforms applied to a parent actor also apply to any children.
+    Actors are also able to receive events.
+
+    </para>
+    <para>    
+
+    Sub classes of #ClutterActor include #ClutterStage, #ClutterTexture,
+    #ClutterLabel, #ClutterRectangle, #ClutterStage, #ClutterEntry and
+    #ClutterGroup. #ClutterActors are added to a parent, transformed
+    and the made visible.
+
+    </para>
+    <para>
+    
+    #ClutterStage is the top level #ClutterActor - its essentially a
+    window or framebuffer. It is created automatically when Clutter is
+    initialised. #ClutterStage is a #ClutterGroup, a class
+    implementing the #ClutterCointainer interface. Clutter currently
+    only supports a single stage.
+    
+    </para>
     <para>
 
-    Clutter semantics work by having a stage (a window) and then
-    adding actors (widgets) to the stage and manipulating via the
-    actor api. Actors can contain child actors (ClutterGroup for
-    example) and be manipulated as a whole.
+    #ClutterTimeline's provide the basis for Clutters animation
+    utilitys. Building on this include the #ClutterScore, for
+    syncronising multiple timelines and the #ClutterBehaviour's and
+    #ClutterEffect's for creating animation effects such as transitions.
 
     </para>
     <para>
 
-    Animations and visual effects can be created via the use of
-    timelines and behaviours. Timelines provide accurate frame based
-    animations. Behaviours further extend this by taking a timeline, a
-    control function (ClutterAlpha) and then applying to actors as to
-    modify a property as a function of time.
+    Clutter further contains a number of utilities including;
+    #ClutterScript - for loading 'UI definition' files formatted in
+    JSON, #ClutterShader - a class for applying GPU shaders to actors,
+    #ClutterModel - a utility class for MVC list type implementations
+    and #ClutterFixed - fixed point math utilitys
 
     </para>
 
+    </partintro>
+  </part>
+
+  <part id="clutterbuilding">
+    <title>Building Clutter</title>
+
+    <partintro>
+
     <para>
 
     Clutter depends on the following libraries:
@@ -105,19 +146,19 @@
             <para>GDK-Pixbuf is a library for loading and manipulating
             various image file formats.</para>
           </listitem>
+          <term>Backend Windowing System Library</term>
+          <listitem>
+            <para>GLX, EGL (1.1), SDL and Cocoa (OS X)</para>
+          </listitem>
+          <term>Graphics Rendering </term>
+          <listitem>
+            <para>Open GL (1.2+) ir Open GL ES (1.1) </para>
+          </listitem>
         </varlistentry>
       </variablelist>
 
     </para>
 
-    </partintro>
-  </part>
-
-  <part id="clutterbuilding">
-    <title>Building Clutter</title>
-
-    <partintro>
-
     <para>
     FIXME: Linux, Windows, OSX. Embedded?
     </para>