2006-06-21 18:34:25 -04:00
|
|
|
<?xml version="1.0"?>
|
2008-02-15 11:17:31 -05:00
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
2006-06-21 18:34:25 -04:00
|
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
|
|
|
<!ENTITY version SYSTEM "version.xml">
|
|
|
|
|
]>
|
|
|
|
|
|
|
|
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
|
|
|
<bookinfo>
|
|
|
|
|
<title>Clutter &version; Reference Manual</title>
|
2006-06-22 05:06:24 -04:00
|
|
|
<releaseinfo>Version &version;</releaseinfo>
|
|
|
|
|
|
|
|
|
|
<copyright>
|
2009-01-27 10:18:45 -05:00
|
|
|
<year>2006,2007,2008</year>
|
2006-06-22 05:06:24 -04:00
|
|
|
<holder>OpenedHand LTD</holder>
|
|
|
|
|
</copyright>
|
|
|
|
|
|
2009-01-27 10:18:45 -05:00
|
|
|
<copyright>
|
|
|
|
|
<year>2009</year>
|
|
|
|
|
<holder>Intel Corporation</holder>
|
|
|
|
|
</copyright>
|
|
|
|
|
|
2006-06-22 05:06:24 -04:00
|
|
|
<legalnotice>
|
|
|
|
|
<para>
|
|
|
|
|
Permission is granted to copy, distribute and/or modify this
|
|
|
|
|
document under the terms of the <citetitle>GNU Free
|
|
|
|
|
Documentation License</citetitle>, Version 1.1 or any later
|
|
|
|
|
version published by the Free Software Foundation with no
|
|
|
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
|
|
|
Texts. You may obtain a copy of the <citetitle>GNU Free
|
|
|
|
|
Documentation License</citetitle> from the Free Software
|
|
|
|
|
Foundation by visiting <ulink type="http"
|
|
|
|
|
url="http://www.fsf.org">their Web site</ulink> or by writing
|
|
|
|
|
to:
|
|
|
|
|
|
|
|
|
|
<address>
|
|
|
|
|
The Free Software Foundation, Inc.,
|
|
|
|
|
<street>59 Temple Place</street> - Suite 330,
|
|
|
|
|
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
|
|
|
|
|
<country>USA</country>
|
|
|
|
|
</address>
|
|
|
|
|
</para>
|
|
|
|
|
</legalnotice>
|
2006-06-21 18:34:25 -04:00
|
|
|
</bookinfo>
|
|
|
|
|
|
2008-06-26 05:02:58 -04:00
|
|
|
<xi:include href="xml/clutter-overview.xml"/>
|
|
|
|
|
<xi:include href="xml/building-clutter.xml"/>
|
2009-02-23 08:44:03 -05:00
|
|
|
<xi:include href="xml/running-clutter.xml"/>
|
2008-02-13 11:46:07 -05:00
|
|
|
|
2007-06-14 11:29:52 -04:00
|
|
|
<part id="clutterbase">
|
|
|
|
|
<title>Clutter Core Reference</title>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>Abstract classes and interfaces</title>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-actor.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-container.xml"/>
|
2008-06-12 07:41:03 -04:00
|
|
|
<xi:include href="xml/clutter-child-meta.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-media.xml"/>
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>Base actors</title>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-rectangle.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-texture.xml"/>
|
2009-01-27 10:18:45 -05:00
|
|
|
<xi:include href="xml/clutter-clone.xml"/>
|
2008-12-11 10:01:28 -05:00
|
|
|
<xi:include href="xml/clutter-text.xml"/>
|
2009-01-09 09:26:35 -05:00
|
|
|
<xi:include href="xml/clutter-cairo-texture.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>Container actors</title>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-group.xml"/>
|
2008-02-15 11:20:28 -05:00
|
|
|
<xi:include href="xml/clutter-stage.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
</part>
|
|
|
|
|
|
|
|
|
|
<part id="clutteranimation">
|
2008-06-12 07:41:03 -04:00
|
|
|
<title>Clutter Animation Framework</title>
|
|
|
|
|
|
|
|
|
|
<partintro>
|
|
|
|
|
<para>Clutter has a fully extensible animation framework
|
|
|
|
|
providing support for explicit and implicit animations of
|
|
|
|
|
single actors as well as groups of actors.</para>
|
|
|
|
|
</partintro>
|
2007-07-26 10:00:20 -04:00
|
|
|
|
2007-06-14 11:29:52 -04:00
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>Base classes</title>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-timeline.xml"/>
|
2007-12-04 11:26:19 -05:00
|
|
|
<xi:include href="xml/clutter-score.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-alpha.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-behaviour.xml"/>
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>Behaviours</title>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
2007-07-09 17:38:54 -04:00
|
|
|
<xi:include href="xml/clutter-behaviour-depth.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-behaviour-ellipse.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-behaviour-opacity.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-behaviour-path.xml"/>
|
2008-12-05 08:13:37 -05:00
|
|
|
<xi:include href="xml/clutter-path.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
<xi:include href="xml/clutter-behaviour-rotate.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-behaviour-scale.xml"/>
|
|
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2008-11-17 Emmanuele Bassi <ebassi@linux.intel.com>
Bug 1014 - Clutter Animation API Improvements
* clutter/Makefile.am:
* clutter/clutter.h: Update the build
* clutter/clutter-types.h: Add AnimationMode, an enumeration
for easing functions.
* clutter/clutter-alpha.[ch]: Add the :mode property to
control the function bound to an Alpha instance using an
enumeration value. Also add six new alpha functions:
- ease-in, ease-out, ease-in-out
- sine-in, sine-out, sine-in-out
* clutter/clutter-deprecated.h: Deprecate the #defines for
the alpha functions. They will be replaced by entries in the
ClutterAnimationMode.
* clutter/clutter-interval.[ch]: Add ClutterInterval, an
object for defining, validating and computing an interval
between two values.
* clutter/clutter-animation.[ch]: Add ClutterAnimation, an
object responsible for animation the properties of a single
actor along an interval of values. ClutterAnimation memory
management is automatic. A simple wrapper method for
ClutterActor is provided:
clutter_actor_animate()
which will create, or update, an animation for the passed
actor.
* clutter/clutter-debug.h:
* clutter/clutter-main.c: Add a new 'animation' debug note.
* clutter/clutter-script.c: Clean up the alpha functions
whitelist, and add the new functions.
* doc/reference/clutter/Makefile.am:
* doc/reference/clutter/clutter-sections.txt: Update the
API reference.
* doc/reference/clutter/clutter-animation.xml: Renamed to
doc/reference/clutter/clutter-animation-tutorial.xml to
avoid clashes with the ClutterAnimation section.
* doc/reference/clutter/clutter-docs.sgml: Renamed to
doc/reference/clutter/clutter-docs.xml, as it was an XML
file and not a SGML file.
* tests/Makefile.am:
* tests/interactive/Makefile.am:
* tests/interactive/test-animation.c:
* tests/interactive/test-easing.c: Add two tests for the
new simple animation API and the easing functions.
* tests/interactive/test-actors.c:
* tests/interactive/test-behave.c:
* tests/interactive/test-depth.c:
* tests/interactive/test-effects.c:
* tests/interactive/test-layout.c:
* tests/interactive/test-multistage.c:
* tests/interactive/test-paint-wrapper.c:
* tests/interactive/test-rotate.c:
* tests/interactive/test-scale.c:
* tests/interactive/test-texture-quality.c:
* tests/interactive/test-threads.c:
* tests/interactive/test-viewport.c: Update interactive tests
to the deprecations and new alpha API.
2008-11-18 04:50:03 -05:00
|
|
|
<title>High Level API</title>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
2008-11-17 Emmanuele Bassi <ebassi@linux.intel.com>
Bug 1014 - Clutter Animation API Improvements
* clutter/Makefile.am:
* clutter/clutter.h: Update the build
* clutter/clutter-types.h: Add AnimationMode, an enumeration
for easing functions.
* clutter/clutter-alpha.[ch]: Add the :mode property to
control the function bound to an Alpha instance using an
enumeration value. Also add six new alpha functions:
- ease-in, ease-out, ease-in-out
- sine-in, sine-out, sine-in-out
* clutter/clutter-deprecated.h: Deprecate the #defines for
the alpha functions. They will be replaced by entries in the
ClutterAnimationMode.
* clutter/clutter-interval.[ch]: Add ClutterInterval, an
object for defining, validating and computing an interval
between two values.
* clutter/clutter-animation.[ch]: Add ClutterAnimation, an
object responsible for animation the properties of a single
actor along an interval of values. ClutterAnimation memory
management is automatic. A simple wrapper method for
ClutterActor is provided:
clutter_actor_animate()
which will create, or update, an animation for the passed
actor.
* clutter/clutter-debug.h:
* clutter/clutter-main.c: Add a new 'animation' debug note.
* clutter/clutter-script.c: Clean up the alpha functions
whitelist, and add the new functions.
* doc/reference/clutter/Makefile.am:
* doc/reference/clutter/clutter-sections.txt: Update the
API reference.
* doc/reference/clutter/clutter-animation.xml: Renamed to
doc/reference/clutter/clutter-animation-tutorial.xml to
avoid clashes with the ClutterAnimation section.
* doc/reference/clutter/clutter-docs.sgml: Renamed to
doc/reference/clutter/clutter-docs.xml, as it was an XML
file and not a SGML file.
* tests/Makefile.am:
* tests/interactive/Makefile.am:
* tests/interactive/test-animation.c:
* tests/interactive/test-easing.c: Add two tests for the
new simple animation API and the easing functions.
* tests/interactive/test-actors.c:
* tests/interactive/test-behave.c:
* tests/interactive/test-depth.c:
* tests/interactive/test-effects.c:
* tests/interactive/test-layout.c:
* tests/interactive/test-multistage.c:
* tests/interactive/test-paint-wrapper.c:
* tests/interactive/test-rotate.c:
* tests/interactive/test-scale.c:
* tests/interactive/test-texture-quality.c:
* tests/interactive/test-threads.c:
* tests/interactive/test-viewport.c: Update interactive tests
to the deprecations and new alpha API.
2008-11-18 04:50:03 -05:00
|
|
|
<xi:include href="xml/clutter-interval.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-animation.xml"/>
|
2009-01-08 08:31:27 -05:00
|
|
|
<xi:include href="xml/clutter-animatable.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
</part>
|
|
|
|
|
|
|
|
|
|
<part>
|
2006-06-21 18:34:25 -04:00
|
|
|
<title>Clutter Tools</title>
|
2007-06-14 11:29:52 -04:00
|
|
|
|
2007-10-25 10:46:59 -04:00
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>General purpose API</title>
|
2007-10-25 10:46:59 -04:00
|
|
|
|
|
|
|
|
<xi:include href="xml/clutter-color.xml"/>
|
2008-12-08 09:22:39 -05:00
|
|
|
<xi:include href="xml/clutter-binding-pool.xml"/>
|
2007-11-23 12:25:50 -05:00
|
|
|
<xi:include href="xml/clutter-event.xml"/>
|
2007-10-25 10:46:59 -04:00
|
|
|
<xi:include href="xml/clutter-fixed.xml"/>
|
2007-11-23 12:25:50 -05:00
|
|
|
<xi:include href="xml/clutter-main.xml"/>
|
2007-12-10 06:03:24 -05:00
|
|
|
<xi:include href="xml/clutter-shader.xml"/>
|
2007-10-25 10:46:59 -04:00
|
|
|
<xi:include href="xml/clutter-units.xml"/>
|
2007-11-23 12:25:50 -05:00
|
|
|
<xi:include href="xml/clutter-util.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-version.xml"/>
|
2007-10-25 10:46:59 -04:00
|
|
|
</chapter>
|
|
|
|
|
|
|
|
|
|
<chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
<title>User interface definition</title>
|
2007-10-25 10:46:59 -04:00
|
|
|
|
|
|
|
|
<xi:include href="xml/clutter-script.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-scriptable.xml"/>
|
|
|
|
|
</chapter>
|
2007-11-23 12:25:50 -05:00
|
|
|
|
|
|
|
|
<chapter>
|
|
|
|
|
<title>Generic list model</title>
|
|
|
|
|
|
|
|
|
|
<xi:include href="xml/clutter-model.xml"/>
|
|
|
|
|
<xi:include href="xml/clutter-model-iter.xml"/>
|
2008-01-09 09:34:24 -05:00
|
|
|
<xi:include href="xml/clutter-list-model.xml"/>
|
2007-11-23 12:25:50 -05:00
|
|
|
</chapter>
|
2007-06-14 11:29:52 -04:00
|
|
|
</part>
|
|
|
|
|
|
|
|
|
|
<part>
|
2007-03-22 16:31:53 -04:00
|
|
|
<title>Clutter Backends</title>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
|
|
|
|
<partintro>
|
|
|
|
|
<para>Clutter is usually compiled against a specific drawing backend.
|
|
|
|
|
All backends have a common API for querying the underlying platform,
|
|
|
|
|
and some of them might have specific API exposed by Clutter.</para>
|
|
|
|
|
</partintro>
|
2008-02-15 11:17:31 -05:00
|
|
|
|
2007-03-22 16:31:53 -04:00
|
|
|
<xi:include href="xml/clutter-backend.xml"/>
|
2007-11-15 12:35:47 -05:00
|
|
|
<xi:include href="xml/clutter-x11.xml"/>
|
2008-03-26 18:22:32 -04:00
|
|
|
<xi:include href="xml/clutter-win32.xml"/>
|
2007-06-14 11:29:52 -04:00
|
|
|
</part>
|
|
|
|
|
|
2007-06-16 16:56:40 -04:00
|
|
|
<part>
|
|
|
|
|
<title>Additional Documentation</title>
|
|
|
|
|
|
|
|
|
|
<partintro>
|
|
|
|
|
<para>This section contains additional useful documentation for
|
|
|
|
|
developing with Clutter.</para>
|
|
|
|
|
</partintro>
|
|
|
|
|
|
2008-06-26 05:02:58 -04:00
|
|
|
<xi:include href="subclassing-ClutterActor.xml"/>
|
2007-06-16 16:56:40 -04:00
|
|
|
|
2008-11-17 Emmanuele Bassi <ebassi@linux.intel.com>
Bug 1014 - Clutter Animation API Improvements
* clutter/Makefile.am:
* clutter/clutter.h: Update the build
* clutter/clutter-types.h: Add AnimationMode, an enumeration
for easing functions.
* clutter/clutter-alpha.[ch]: Add the :mode property to
control the function bound to an Alpha instance using an
enumeration value. Also add six new alpha functions:
- ease-in, ease-out, ease-in-out
- sine-in, sine-out, sine-in-out
* clutter/clutter-deprecated.h: Deprecate the #defines for
the alpha functions. They will be replaced by entries in the
ClutterAnimationMode.
* clutter/clutter-interval.[ch]: Add ClutterInterval, an
object for defining, validating and computing an interval
between two values.
* clutter/clutter-animation.[ch]: Add ClutterAnimation, an
object responsible for animation the properties of a single
actor along an interval of values. ClutterAnimation memory
management is automatic. A simple wrapper method for
ClutterActor is provided:
clutter_actor_animate()
which will create, or update, an animation for the passed
actor.
* clutter/clutter-debug.h:
* clutter/clutter-main.c: Add a new 'animation' debug note.
* clutter/clutter-script.c: Clean up the alpha functions
whitelist, and add the new functions.
* doc/reference/clutter/Makefile.am:
* doc/reference/clutter/clutter-sections.txt: Update the
API reference.
* doc/reference/clutter/clutter-animation.xml: Renamed to
doc/reference/clutter/clutter-animation-tutorial.xml to
avoid clashes with the ClutterAnimation section.
* doc/reference/clutter/clutter-docs.sgml: Renamed to
doc/reference/clutter/clutter-docs.xml, as it was an XML
file and not a SGML file.
* tests/Makefile.am:
* tests/interactive/Makefile.am:
* tests/interactive/test-animation.c:
* tests/interactive/test-easing.c: Add two tests for the
new simple animation API and the easing functions.
* tests/interactive/test-actors.c:
* tests/interactive/test-behave.c:
* tests/interactive/test-depth.c:
* tests/interactive/test-effects.c:
* tests/interactive/test-layout.c:
* tests/interactive/test-multistage.c:
* tests/interactive/test-paint-wrapper.c:
* tests/interactive/test-rotate.c:
* tests/interactive/test-scale.c:
* tests/interactive/test-texture-quality.c:
* tests/interactive/test-threads.c:
* tests/interactive/test-viewport.c: Update interactive tests
to the deprecations and new alpha API.
2008-11-18 04:50:03 -05:00
|
|
|
<xi:include href="clutter-animation-tutorial.xml"/>
|
2007-07-26 10:00:20 -04:00
|
|
|
|
2008-06-26 05:02:58 -04:00
|
|
|
<xi:include href="creating-behaviours.xml"/>
|
2008-02-13 11:46:07 -05:00
|
|
|
|
2007-06-16 16:56:40 -04:00
|
|
|
</part>
|
|
|
|
|
|
2007-06-14 11:29:52 -04:00
|
|
|
<index>
|
|
|
|
|
<title>Index</title>
|
|
|
|
|
</index>
|
2008-06-12 07:41:03 -04:00
|
|
|
|
2007-08-04 05:52:51 -04:00
|
|
|
<index role="deprecated">
|
|
|
|
|
<title>Index of deprecated symbols</title>
|
|
|
|
|
</index>
|
2008-06-12 07:41:03 -04:00
|
|
|
|
2007-08-04 05:52:51 -04:00
|
|
|
<index role="0.2">
|
|
|
|
|
<title>Index of new symbols in 0.2</title>
|
|
|
|
|
</index>
|
2008-06-12 07:41:03 -04:00
|
|
|
|
2007-08-04 05:52:51 -04:00
|
|
|
<index role="0.4">
|
|
|
|
|
<title>Index of new symbols in 0.4</title>
|
|
|
|
|
</index>
|
2008-06-12 07:41:03 -04:00
|
|
|
|
2007-08-13 13:01:35 -04:00
|
|
|
<index role="0.6">
|
|
|
|
|
<title>Index of new symbols in 0.6</title>
|
|
|
|
|
</index>
|
2008-06-12 07:41:03 -04:00
|
|
|
|
2008-04-28 11:22:54 -04:00
|
|
|
<index role="0.8">
|
|
|
|
|
<title>Index of new symbols in 0.8</title>
|
|
|
|
|
</index>
|
2007-01-18 03:53:50 -05:00
|
|
|
|
2009-02-20 07:00:41 -05:00
|
|
|
<index role="1.0">
|
|
|
|
|
<title>Index of new symbols in 1.0</title>
|
|
|
|
|
</index>
|
|
|
|
|
|
2006-06-22 04:40:37 -04:00
|
|
|
<appendix id="license">
|
|
|
|
|
<title>License</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
|
|
|
modify it under the terms of the <citetitle>GNU Library General
|
|
|
|
|
Public License</citetitle> as published by the Free Software
|
|
|
|
|
Foundation; either version 2 of the License, or (at your option)
|
|
|
|
|
any later version.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
<citetitle>GNU Library General Public License</citetitle> for
|
|
|
|
|
more details.
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
You may obtain a copy of the <citetitle>GNU Library General
|
|
|
|
|
Public License</citetitle> from the Free Software Foundation by
|
|
|
|
|
visiting <ulink type="http" url="http://www.fsf.org">their Web
|
|
|
|
|
site</ulink> or by writing to:
|
|
|
|
|
|
|
|
|
|
<address>
|
|
|
|
|
Free Software Foundation, Inc.
|
|
|
|
|
<street>59 Temple Place</street> - Suite 330
|
|
|
|
|
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
|
|
|
|
|
<country>USA</country>
|
|
|
|
|
</address>
|
|
|
|
|
</para>
|
|
|
|
|
</appendix>
|
|
|
|
|
|
2006-06-21 18:34:25 -04:00
|
|
|
</book>
|