diff options
| author | Georges Basile Stavracas Neto <georges.stavracas@gmail.com> | 2020-07-05 18:55:04 -0300 |
|---|---|---|
| committer | Georges Basile Stavracas Neto <georges.stavracas@gmail.com> | 2020-12-08 18:08:27 -0300 |
| commit | 0ad9da8b7490aa6d29f9b9e8ed7874afb4528e69 (patch) | |
| tree | 380b649b9e88a7adeb0de89e39640733d527a457 /clutter | |
| parent | 010fd22a0f45e66a8e4ed264e7815553fe0f1e33 (diff) | |
| download | mutter-0ad9da8b7490aa6d29f9b9e8ed7874afb4528e69.tar.gz | |
clutter/offscreen-effect: Document paint nodes
Diffstat (limited to 'clutter')
| -rw-r--r-- | clutter/clutter/clutter-offscreen-effect.c | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/clutter/clutter/clutter-offscreen-effect.c b/clutter/clutter/clutter-offscreen-effect.c index 6a17f1004..62404c4e4 100644 --- a/clutter/clutter/clutter-offscreen-effect.c +++ b/clutter/clutter/clutter-offscreen-effect.c @@ -60,6 +60,30 @@ * #ClutterOffscreenEffectClass.create_texture() virtual function; no chain up * to the #ClutterOffscreenEffect implementation is required in this * case. + * + * ## Paint nodes + * + * #ClutterOffscreenEffect is generates the following paint node tree: + * + * |[<!-- language="plain" --> + * Effect + * ├─────────┐ + * Layer Pipeline + * │ + * Actor + * ]| + * + * When the actor contents are cached, the generated paint node tree + * looks like this: + * + * |[<!-- language="plain" --> + * Effect + * │ + * Pipeline + * ]| + * + * In both cases, the "Pipeline" node is created with the return value + * of #ClutterOffscreenEffectClass.create_pipeline(). */ #include "clutter-build-config.h" |