for Clutter 1.4.2

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, 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 GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to:


          The Free Software Foundation, Inc.,
          59 Temple Place - Suite 330,
          BostonMA 02111-1307,
          USA
        


I. Overview
II. Building Clutter
III. Running Clutter
IV. Clutter Core Reference
Abstract classes and interfaces
ClutterActor — Base abstract class for all visual stage actors.
ClutterContainer — An interface for implementing container actors
ClutterChildMeta — Wrapper for actors inside a container
ClutterMedia — An interface for controlling playback of media data
ClutterLayoutManager — Layout managers base class
ClutterLayoutMeta — Wrapper for actors inside a layout manager
ClutterActorMeta — Base class of actor modifiers
ClutterAction — Abstract class for event-related logic
ClutterConstraint — Abstract class for constraints on position or size
ClutterEffect — Base class for actor effects
Base actors
ClutterRectangle — An actor that displays a simple rectangle.
ClutterTexture — An actor for displaying and manipulating images.
ClutterClone — An actor that displays a clone of a source actor
ClutterText — An actor for displaying and editing text
ClutterCairoTexture — Texture with Cairo integration
Container actors
ClutterGroup — A fixed layout container
ClutterStage — Top level visual element to which actors are placed.
ClutterBox — A Generic layout container
Layout managers
ClutterFixedLayout — A fixed layout manager
ClutterBinLayout — A simple layout manager
ClutterFlowLayout — A reflowing layout manager
ClutterBoxLayout — A layout manager arranging children on a single line
ClutterTableLayout — A layout manager arranging children in rows and columns
Actions, Constraints and Effects
ClutterClickAction — Action for clickable actors
ClutterDragAction — Action enabling dragging on actors
ClutterBindConstraint — A constraint binding the position or size of an actor
ClutterAlignConstraint — A constraint aligning the position of an actor
ClutterOffscreenEffect — Base class for effects using offscreen buffers
ClutterShaderEffect — Base class for shader effects
ClutterBlurEffect — A blur effect
ClutterColorizeEffect — A colorization effect
ClutterDesaturateEffect — A desaturation effect
ClutterDeformEffect — A base class for effects deforming the geometry of an actor
ClutterPageTurnEffect — A page turning effect
V. Clutter Animation Framework
Base classes
ClutterTimeline — A class for time-based events
ClutterScore — Controller for multiple timelines
ClutterAlpha — A class for calculating a value as a function of time
ClutterBehaviour — Class for providing behaviours to actors
Behaviours
ClutterBehaviourDepth — A behaviour controlling the Z position
ClutterBehaviourEllipse — A behaviour interpolating position along an ellipse
ClutterBehaviourOpacity — Behaviour controlling the opacity
ClutterBehaviourPath — A behaviour for moving actors along a ClutterPath
ClutterPath — An object describing a path with straight lines and bezier curves.
ClutterBehaviourRotate — A behaviour controlling rotation
ClutterBehaviourScale — A behaviour controlling scale
High Level API
Value intervals — An object holding an interval of two values
Implicit Animations — Simple implicit animations
ClutterAnimatable — Interface for animatable classes
ClutterAnimator — Multi-actor tweener
ClutterState — State machine with animated transitions
VI. Clutter Tools
General purpose API
Colors — Color management and manipulation.
Key Bindings — Pool for key bindings
Events — User and window system events
General — Various 'global' clutter functions.
ClutterSettings — Settings configuration
Shaders — Programmable pipeline abstraction
Stage Manager — Maintains the list of stages
ClutterInputDevice — An input device managed by Clutter
ClutterDeviceManager — Maintains the list of input devices
Unit conversion — A logical distance unit
Utilities — Utility functions
Features — Run-time detection of Clutter features
Versioning Macros — Versioning utility macros
User interface definition
ClutterScript — Loads a scene from UI definition data
ClutterScriptable — Override the UI definition parsing
Generic list model
ClutterModel — A generic model implementation
ClutterModelIter — Iterates through a model
ClutterListModel — List model implementation
VII. Clutter Backends
ClutterBackend — Backend abstraction
X11 Specific Support — X11 specific API
ClutterX11TexturePixmap — A texture which displays the content of an X Pixmap.
GLX Specific Support — GLX specific API
Win32 Specific Support — Win32 specific API
EGL Specific Support — EGL specific API
Intel CE3100, CE4100 Specific Support — Intel CE3100, CE4100 Specific API
VIII. Additional Documentation
Implementing a new actor
Creating Animations with Clutter
Basic Animations
Timelines
Behaviours
Implicit Animations
Conclusion
Creating You Own Behaviours
IX. Migrating from previous version of Clutter
Migrating from ClutterEffect
Using clutter_actor_animate()
Migrating to ClutterPath
Creating a ClutterPath
Iterating over a ClutterPath
Integration with Cairo
X. Clutter Actors and Objects
Object Hierarchy
Object Index
XI. Glossaries
Glossary
Annotation Glossary
Index of all symbols
Index of deprecated symbols
Index of new symbols in 0.2
Index of new symbols in 0.4
Index of new symbols in 0.6
Index of new symbols in 0.8
Index of new symbols in 1.0
Index of new symbols in 1.2
Index of new symbols in 1.4
A. License