Add PaintNode, an element on the render object tree

Now that we have a proper scene graph API, we should split out the
rendering part from the logical and event handling part.

ClutterPaintNode is a lightweight fundamental type that encodes only the
paint operations: pipeline state and geometry. At its most simple, is a
way to structure setting up the programmable pipeline using a
CoglPipeline, and submitting Cogl primitives. The important take away
from this API is that you are not allowed to call Cogl API like
cogl_set_source() or cogl_primitive_draw() directly.

The interesting approach to this is that, in the future, we should be
able to move to a purely retained mode: we will decide which actors need
to be painted, they will update their own branch of the render graph,
and we'll take the render graph and build all the rendering commands
from that.

For the 1.x API, we will have to maintain invariants and the existing
behaviour, but as soon as we can break API, the old paint signal will
just go away, and Actors will only be allowed to manipulate the render
tree.

1 files changed, 95 insertions, 0 deletions

diff --git a/clutter/clutter-paint-node.h b/clutter/clutter-paint-node.h
new file mode 100644
index 000000000..46cc7d30a
--- /dev/null
+++ b/clutter/clutter-paint-node.h
@@ -0,0 +1,95 @@
+/*
+ * Clutter.
+ *
+ * An OpenGL based 'interactive canvas' library.
+ *
+ * Copyright (C) 2011  Intel Corporation.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author:
+ *   Emmanuele Bassi <ebassi@linux.intel.com>
+ */
+
+#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
+#error "Only <clutter/clutter.h> can be included directly."
+#endif
+
+#ifndef __CLUTTER_PAINT_NODE_H__
+#define __CLUTTER_PAINT_NODE_H__
+
+#include <cogl/cogl.h>
+#include <clutter/clutter-types.h>
+
+G_BEGIN_DECLS
+
+#define CLUTTER_TYPE_PAINT_NODE                 (clutter_paint_node_get_type ())
+#define CLUTTER_PAINT_NODE(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PAINT_NODE, ClutterPaintNode))
+#define CLUTTER_IS_PAINT_NODE(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PAINT_NODE))
+
+typedef struct _ClutterPaintNodePrivate ClutterPaintNodePrivate;
+typedef struct _ClutterPaintNodeClass   ClutterPaintNodeClass;
+
+GType clutter_paint_node_get_type (void) G_GNUC_CONST;
+
+ClutterPaintNode *      clutter_paint_node_ref                          (ClutterPaintNode      *node);
+void                    clutter_paint_node_unref                        (ClutterPaintNode      *node);
+
+void                    clutter_paint_node_set_name                     (ClutterPaintNode      *node,
+                                                                         const char            *name);
+
+void                    clutter_paint_node_add_child                    (ClutterPaintNode      *node,
+                                                                         ClutterPaintNode      *child);
+void                    clutter_paint_node_remove_child                 (ClutterPaintNode      *node,
+                                                                         ClutterPaintNode      *child);
+void                    clutter_paint_node_replace_child                (ClutterPaintNode      *node,
+                                                                         ClutterPaintNode      *old_child,
+                                                                         ClutterPaintNode      *new_child);
+void                    clutter_paint_node_remove_all                   (ClutterPaintNode      *node);
+
+guint                   clutter_paint_node_get_n_children               (ClutterPaintNode      *node);
+
+ClutterPaintNode *      clutter_paint_node_get_first_child              (ClutterPaintNode      *node);
+ClutterPaintNode *      clutter_paint_node_get_previous_sibling         (ClutterPaintNode      *node);
+ClutterPaintNode *      clutter_paint_node_get_next_sibling             (ClutterPaintNode      *node);
+ClutterPaintNode *      clutter_paint_node_get_last_child               (ClutterPaintNode      *node);
+ClutterPaintNode *      clutter_paint_node_get_parent                   (ClutterPaintNode      *node);
+
+void                    clutter_paint_node_add_rectangle                (ClutterPaintNode      *node,
+                                                                         const ClutterActorBox *rect);
+void                    clutter_paint_node_add_texture_rectangle        (ClutterPaintNode      *node,
+                                                                         const ClutterActorBox *rect,
+                                                                         float                  x_1,
+                                                                         float                  y_1,
+                                                                         float                  x_2,
+                                                                         float                  y_2);
+#if defined(COGL_ENABLE_EXPERIMENTAL_2_0_API) && defined(CLUTTER_ENABLE_EXPERIMENTAL_API)
+void                    clutter_paint_node_add_path                     (ClutterPaintNode      *node,
+                                                                         CoglPath              *path);
+void                    clutter_paint_node_add_primitive                (ClutterPaintNode      *node,
+                                                                         CoglPrimitive         *primitive);
+#endif /* COGL_ENABLE_EXPERIMENTAL_2_0_API && CLUTTER_ENABLE_EXPERIMENTAL_API */
+
+#define CLUTTER_VALUE_HOLDS_PAINT_NODE(value)   (G_VALUE_HOLDS (value, CLUTTER_TYPE_PAINT_NODE))
+
+void                    clutter_value_set_paint_node                    (GValue                *value,
+                                                                         gpointer               node);
+void                    clutter_value_take_paint_node                   (GValue                *value,
+                                                                         gpointer               node);
+gpointer                clutter_value_get_paint_node                    (const GValue          *value);
+gpointer                clutter_value_dup_paint_node                    (const GValue          *value);
+
+G_END_DECLS
+
+#endif /* __CLUTTER_PAINT_NODE_H__ */