[mutter/gbsneto/offscreen-paint-node: 21/22] clutter/offscreen-effect: Document paint nodes
- From: Georges Basile Stavracas Neto <gbsneto src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [mutter/gbsneto/offscreen-paint-node: 21/22] clutter/offscreen-effect: Document paint nodes
- Date: Tue, 8 Dec 2020 20:52:11 +0000 (UTC)
commit 7afa07112dddf7a6217f3bb321b62a573fb2d286
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date: Sun Jul 5 18:55:04 2020 -0300
clutter/offscreen-effect: Document paint nodes
clutter/clutter/clutter-offscreen-effect.c | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
---
diff --git a/clutter/clutter/clutter-offscreen-effect.c b/clutter/clutter/clutter-offscreen-effect.c
index 6a17f10040..62404c4e43 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"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]