mutter/doc/reference/clutter
Neil Roberts 7f78237ee5 clutter-actor: Add an 'offscreen-redirect' property
This adds a property which can be used to redirect the actor through
an FBO before painting so that it becomes flattened in an image. The
image can be used as a cache to avoid having to repaint the actor if
something unrelated in the scene changes. It can also be used to
implement correct opacity even if the actor has overlapping
primitives. The property is an enum that takes three values:

CLUTTER_OFFSCREEN_REDIRECT_NEVER: The default behaviour which is to
  never flatten the actor.

CLUTTER_OFFSCREEN_REDIRECT_ALWAYS: The actor is always redirected
  through an FBO.

CLUTTER_OFFSCREEN_REDIRECT_ONLY_FOR_OPACITY: The actor is only
  redirected through an FBO if the paint opacity is not 255. This
  value would be used if the actor wants correct opacity. It will
  avoid the overhead of using an FBO whenever the actor is fully
  opaque.

The property is implemented by installing a ClutterFlattenEffect.
ClutterFlattenEffect is a new internal class which subclasses
ClutterOffscreen to redirect the painting to an FBO. When
ClutterOffscreen paints, the effect sets an opacity override on the
actor so that the image will always contain the actor at full
opacity. The opacity is then applied to the resulting image before
painting it to the stage. This means the actor does not need to be
redrawn while the opacity is being animated.

The effect has a high internal priority so that it will always occur
before any other effects and it gets hidden from the application.
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 an 'offscreen-redirect' property 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