mutter/doc/reference/clutter
Neil Roberts 701440efd8 clutter-actor: Add a 'has_overlaps' virtual
This adds a virtual to ClutterActor so that an actor subclass can
report whether it has overlapping primitives. ClutterActor uses this
to determine whether it needs to use ClutterFlattenEffect to implement
the opacity property. The default implementation of the virtual
returns TRUE which means that most actors will end up being redirected
offscreen when the opacity != 255. ClutterTexture and ClutterRectangle
override this to return FALSE because they should never need to be
redirected. ClutterClone overrides it to divert to the source.

The values for the ClutterOffscreenRedirect enum have changed to:

AUTOMATIC_FOR_OPACITY

 The actor will only be redirected if has_overlaps returns TRUE and
 the opacity is < 255

ALWAYS_FOR_OPACITY

 The actor will always be redirected if the opacity < 255 regardless
 of the return value of has_overlaps

ALWAYS

 The actor will always be redirected offscreen.

This means that the property can't be used to prevent the actor from
being redirected but only to increase the likelihood that it will be
redirected.

ClutterActor now adds and removes the flatten effect depending on
whether flattening is needed directly in clutter_actor_paint(). There
are new internal versions of add/remove_effect that don't queue a
redraw. This means that ClutterFlattenEffect is now just a no-op
subclass of ClutterOffscreen. It is only needed because
ClutterOffscreen is abstract. Removing the effect also makes it so
that the cached image will be freed as soon as an actor is repainted
without being flattened.
2011-05-13 01:46:32 +01:00
..
actor-box.png Merged clutter-ivan branch into trunk. 2008-04-25 13:37:36 +00:00
animator-key-frames.png docs: Add visual cue for Animator's key frames 2010-02-25 17:09:55 +00:00
animator-key-frames.svg docs: Add visual cue for Animator's key frames 2010-02-25 17:09:55 +00:00
bin-layout.png docs: Add images for layout managers 2009-10-23 17:32:18 +01:00
box-layout.png docs: Add images for layout managers 2009-10-23 17:32:18 +01:00
building-clutter.xml backend: remove untested fruity backend 2011-04-11 17:54:36 +01:00
clutter-animation-tutorial.xml doc: fix clutter_init() usage in examples 2011-02-28 14:10:05 +00:00
clutter-docs.xml.in docs: Add 1.6 index to the API references 2010-12-09 15:53:26 +00:00
clutter-overview.xml docs: Fix some wrong function/signal/property names 2010-11-18 15:21:16 +00:00
clutter-sections.txt clutter-actor: Add a 'has_overlaps' virtual 2011-05-13 01:46:32 +01:00
clutter.types Add SnapConstraint 2010-11-15 16:00:49 +00:00
constraints-example.png docs: Update the constraints example image 2010-11-16 11:01:20 +00:00
creating-behaviours.xml [docs] Fix wrong XML elements 2009-07-21 16:35:50 +01:00
easing-modes.png [docs] Update the easing modes documentation 2009-01-20 18:13:36 +00:00
easing-modes.svg [docs] Update the easing modes documentation 2009-01-20 18:13:36 +00:00
event-flow.dia * clutter/event-flow.png: fixed typo. 2008-06-13 10:37:33 +00:00
event-flow.png * clutter/event-flow.png: fixed typo. 2008-06-13 10:37:33 +00:00
flow-layout-horizontal.png docs: Add images for layout managers 2009-10-23 17:32:18 +01:00
flow-layout-vertical.png docs: Add images for layout managers 2009-10-23 17:32:18 +01:00
glossary.xml [docs] Add more collateral documentation 2009-09-03 16:51:14 +01:00
Makefile.am clutter-actor: Add an 'offscreen-redirect' property 2011-05-13 01:46:32 +01:00
migrating-ClutterBehaviour.xml timeline: Rename the reverse property to auto-reverse 2010-12-17 12:07:52 +00:00
migrating-ClutterEffect.xml [docs] Fix typo in the effects migration guide 2009-07-21 09:20:16 +01:00
migrating-ClutterPath.xml docs: Fix some wrong function/signal/property names 2010-11-18 15:21:16 +00:00
offscreen-redirect.png clutter-actor: Add an 'offscreen-redirect' property 2011-05-13 01:46:32 +01:00
path-alpha-func.png Merged clutter-ivan branch into trunk. 2008-04-25 13:37:36 +00:00
running-clutter.xml docs: Use "Cogl" not "COGL" in Cogl API reference 2010-09-23 15:53:29 +01:00
subclassing-ClutterActor.xml docs: Update documentation to reflect automatic map/unmap/etc. 2010-11-24 16:51:59 +00:00