mutter/doc
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
..
common cookbook: Remove bold on emphasis inside programlisting 2010-12-09 13:39:48 +00:00
cookbook docs: Remove checks for whether an effect is disabled 2011-03-17 15:56:55 +00:00
manual build: Distcheck fixes 2010-06-30 12:26:10 +01:00
reference clutter-actor: Add an 'offscreen-redirect' property 2011-05-13 01:46:32 +01:00
clutter-actor-invariants.txt Try to clean up how we handle actor transformations 2010-09-13 18:18:34 +01:00
CODING_STYLE docs: Update the coding style 2010-10-03 11:02:56 +01:00
HACKING docs: Use "Cogl" not "COGL" in Cogl API reference 2010-09-23 15:53:29 +01:00
HACKING.backends docs: Update the HACKING.backends documentation 2011-02-09 13:29:30 +00:00
Makefile.am docs: Disable manual 2010-06-30 11:56:13 +01:00
RELEASING docs: Update RELEASING 2011-03-16 13:09:41 +00:00