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-15 12:07:57 -0300 |
| commit | 46c68f368fff5af2fae203a938f9516a3554752f (patch) | |
| tree | a426cc3d33a96d155e13796687bbdc574c407b99 | |
| parent | 489840840468be15b73151ddb260430244e74329 (diff) | |
| download | mutter-46c68f368fff5af2fae203a938f9516a3554752f.tar.gz | |
clutter/offscreen-effect: Document paint nodes
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1355>
| -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 598adb316..6d4f095fb 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 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" |