diff options
author | Emmanuele Bassi <ebassi@openedhand.com> | 2008-06-26 09:02:58 +0000 |
---|---|---|
committer | Emmanuele Bassi <ebassi@openedhand.com> | 2008-06-26 09:02:58 +0000 |
commit | e7a7307b493ae07d0563ffbbc33ac836f410bcda (patch) | |
tree | 79b5a7c1096271b5bf292e3a4420d822acbaca95 /doc/reference/clutter/clutter-overview.xml | |
parent | 93fda926514c91139790d083dafff49a64f11b4e (diff) | |
download | clutter-e7a7307b493ae07d0563ffbbc33ac836f410bcda.tar.gz |
2008-06-26 Emmanuele Bassi <ebassi@openedhand.com>
* clutter/clutter-overview.xml: Split the overview into its own
file, so we gtk-doc can linkify all class names.
* clutter/building-clutter.xml: Split the building instructions
into its own file, for better maintainability.
* clutter/clutter-animation.xml:
* clutter/creating-behaviours.xml:
* clutter/subclassing-ClutterActor.xml: Rename from SGML to XML;
these were not SGML files anyway, but templates.
* clutter/clutter-docs.sgml: Use XInclude instead of the ugly
entities hack.
* clutter/Makefile.am: Update the build.
Diffstat (limited to 'doc/reference/clutter/clutter-overview.xml')
-rw-r--r-- | doc/reference/clutter/clutter-overview.xml | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/reference/clutter/clutter-overview.xml b/doc/reference/clutter/clutter-overview.xml new file mode 100644 index 000000000..a015fd22a --- /dev/null +++ b/doc/reference/clutter/clutter-overview.xml @@ -0,0 +1,53 @@ +<part id="clutter-overview"> + <partinfo> + <author> + <firstname>Emmanuele</firstname> + <surname>Bassi</surname> + <affiliation> + <address> + <email>ebassi@openedhand.com</email> + </address> + </affiliation> + </author> + </partinfo> + + <title>Overview</title> + + <partintro> + + <para>Clutter is a GObject based library for creating fast, visually + rich, graphical user interfaces.</para> + + <para>Clutter works by manipulating a scene-graph of 2D surfaces, or + 'actors', inside a 3D space.</para> + + <para>#ClutterActor is the base class for such surfaces. All + #ClutterActor<!-- -->s can be positioned, scaled and rotated in 3D space. + In addition, other properties can be set, such as 2D clipping, children and + opacity. Tranforms applied to a parent actor also apply to any children. + Actors are also able to receive events.</para> + + <para>Subclasses of #ClutterActor include #ClutterStage, #ClutterTexture, + #ClutterLabel, #ClutterRectangle, #ClutterEntry and + #ClutterGroup. #ClutterActor<!-- -->s are added to a parent, transformed + and then made visible.</para> + + <para>#ClutterStage is the top level #ClutterActor - it's the + representation of a window, or framebuffer. It is created automatically + when Clutter is initialised. #ClutterStage is a #ClutterGroup, a class + implementing the #ClutterCointainer interface.</para> + + <para>#ClutterTimeline<!-- -->s provide the basis for Clutter's animation + utilities. Multiple timelines can be synchronised using #ClutterScore, + and #ClutterBehaviour and #ClutterEffect allow for the creation of + animation effects such as transitions.</para> + + <para>Clutter further contains a number of utilities, including; + #ClutterScript - for loading 'UI definition' files formatted in + <ulink type="http" url="http://json.org">JSON</ulink>, #ClutterShader - a + class for applying GPU shaders to actors, #ClutterModel - a utility class + for MVC list type implementations, and fixed point math utilities.</para> + + </partintro> + +</part> |