brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8a06cfdd81
mutter/clutter/clutter/clutter-paint-node-private.h

171 lines
6.2 KiB
C
Raw Normal View History

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.
2012-02-01 15:51:27 +00:00
/*
* 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>
*/
#ifndef __CLUTTER_PAINT_NODE_PRIVATE_H__
#define __CLUTTER_PAINT_NODE_PRIVATE_H__
#include <glib-object.h>
paint-node: Use JSON-GLib for debug serialization Instead of our homegrown string building; this at least ensures that we're generating proper data, instead of random strings. Plus, using JsonNode and JsonBuilder, we can ask the PaintNode subclasses to serialize themselves in a sensible way.
2012-02-03 13:51:29 +00:00
#include <json-glib/json-glib.h>
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.
2012-02-01 15:51:27 +00:00
#include <clutter/clutter-paint-node.h>
G_BEGIN_DECLS
#define CLUTTER_PAINT_NODE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_PAINT_NODE, ClutterPaintNodeClass))
#define CLUTTER_IS_PAINT_NODE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_PAINT_NODE))
#define CLUTTER_PAINT_NODE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_PAINT_NODE, ClutterPaintNodeClass))
typedef struct _ClutterPaintOperation ClutterPaintOperation;
struct _ClutterPaintNode
{
GTypeInstance parent_instance;
ClutterPaintNode *parent;
ClutterPaintNode *first_child;
ClutterPaintNode *prev_sibling;
ClutterPaintNode *next_sibling;
ClutterPaintNode *last_child;
guint n_children;
GArray *operations;
gchar *name;
volatile int ref_count;
};
struct _ClutterPaintNodeClass
{
GTypeClass base_class;
void (* finalize) (ClutterPaintNode *node);
gboolean (* pre_draw) (ClutterPaintNode *node);
void (* draw) (ClutterPaintNode *node);
void (* post_draw) (ClutterPaintNode *node);
paint-node: Use JSON-GLib for debug serialization Instead of our homegrown string building; this at least ensures that we're generating proper data, instead of random strings. Plus, using JsonNode and JsonBuilder, we can ask the PaintNode subclasses to serialize themselves in a sensible way.
2012-02-03 13:51:29 +00:00
JsonNode*(* serialize) (ClutterPaintNode *node);
paint-node: Get the framebuffer from the root node The PaintNode hierarchy should have the ability to retrieve the current active framebuffer by itself, instead of asking Cogl using the global state API. In order to do this, we ask the root node of a PaintNode graph for the active framebuffer. In the current, 1.x-compatibility mode we have two potential root node types: ClutterRootNode, used by ClutterStage; and ClutterDummyNode, used a local root for each actor. The former takes a framebuffer as part of its construction; the latter takes the actor that acts as the local top-level during the actor's paint sequence, which means we can get the active framebuffer from the stage associated to the actor. By keeping track of the active framebuffer on the node themselves we can drop the usage of cogl_get_draw_framebuffer() in their implementation.
2013-12-03 12:50:39 +00:00
CoglFramebuffer *(* get_framebuffer) (ClutterPaintNode *node);
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.
2012-02-01 15:51:27 +00:00
};
paint-node: Initialize ClutterPaintOperation Don't leave it to the compiler.
2012-03-20 16:11:52 +00:00
#define PAINT_OP_INIT { PAINT_OP_INVALID }
Use a consistent style for enum braces https://gitlab.gnome.org/GNOME/mutter/merge_requests/361
2018-12-19 08:04:25 +00:00
typedef enum
{
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.
2012-02-01 15:51:27 +00:00
PAINT_OP_INVALID = 0,
PAINT_OP_TEX_RECT,
clutter/paint-node: Add multitexture API The multitexture API is not a shortcut for multiple calls to the single texture API. It is meant to wrap calls to cogl_framebuffer_draw_multitexture_rectangle(), which uses the passed texture coordinates at different layers of the pipeline. https://gitlab.gnome.org/GNOME/mutter/merge_requests/405
2018-12-27 01:09:17 +00:00
PAINT_OP_MULTITEX_RECT,
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.
2012-02-01 15:51:27 +00:00
PAINT_OP_PATH,
PAINT_OP_PRIMITIVE
} PaintOpCode;
struct _ClutterPaintOperation
{
PaintOpCode opcode;
clutter/paint-node: Add multitexture API The multitexture API is not a shortcut for multiple calls to the single texture API. It is meant to wrap calls to cogl_framebuffer_draw_multitexture_rectangle(), which uses the passed texture coordinates at different layers of the pipeline. https://gitlab.gnome.org/GNOME/mutter/merge_requests/405
2018-12-27 01:09:17 +00:00
GArray *multitex_coords;
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.
2012-02-01 15:51:27 +00:00
union {
float texrect[8];
CoglPath *path;
CoglPrimitive *primitive;
} op;
};
GType _clutter_transform_node_get_type (void) G_GNUC_CONST;
GType _clutter_dummy_node_get_type (void) G_GNUC_CONST;
void _clutter_paint_operation_paint_rectangle (const ClutterPaintOperation *op);
void _clutter_paint_operation_clip_rectangle (const ClutterPaintOperation *op);
void _clutter_paint_operation_paint_path (const ClutterPaintOperation *op);
void _clutter_paint_operation_clip_path (const ClutterPaintOperation *op);
void _clutter_paint_operation_paint_primitive (const ClutterPaintOperation *op);
void _clutter_paint_node_init_types (void);
paint-nodes: Make part of the API internal At least for the time being, we only expose the parts of the API that we want to use internally and for new, out-of-tree Content implementations. The full PaintNode tree API will be made public in 1.12 once we branch master.
2012-03-16 11:57:34 +00:00
gpointer _clutter_paint_node_create (GType gtype);
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.
2012-02-01 15:51:27 +00:00
ClutterPaintNode * _clutter_transform_node_new (const CoglMatrix *matrix);
Debugging cleanups Add some more debugging notes to the layout and paint node output.
2012-03-16 16:16:40 +00:00
ClutterPaintNode * _clutter_dummy_node_new (ClutterActor *actor);
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.
2012-02-01 15:51:27 +00:00
void _clutter_paint_node_dump_tree (ClutterPaintNode *root);
paint-nodes: Make part of the API internal At least for the time being, we only expose the parts of the API that we want to use internally and for new, out-of-tree Content implementations. The full PaintNode tree API will be made public in 1.12 once we branch master.
2012-03-16 11:57:34 +00:00
G_GNUC_INTERNAL
void clutter_paint_node_remove_child (ClutterPaintNode *node,
ClutterPaintNode *child);
G_GNUC_INTERNAL
void clutter_paint_node_replace_child (ClutterPaintNode *node,
ClutterPaintNode *old_child,
ClutterPaintNode *new_child);
G_GNUC_INTERNAL
void clutter_paint_node_remove_all (ClutterPaintNode *node);
G_GNUC_INTERNAL
guint clutter_paint_node_get_n_children (ClutterPaintNode *node);
G_GNUC_INTERNAL
ClutterPaintNode * clutter_paint_node_get_first_child (ClutterPaintNode *node);
G_GNUC_INTERNAL
ClutterPaintNode * clutter_paint_node_get_previous_sibling (ClutterPaintNode *node);
G_GNUC_INTERNAL
ClutterPaintNode * clutter_paint_node_get_next_sibling (ClutterPaintNode *node);
G_GNUC_INTERNAL
ClutterPaintNode * clutter_paint_node_get_last_child (ClutterPaintNode *node);
G_GNUC_INTERNAL
ClutterPaintNode * clutter_paint_node_get_parent (ClutterPaintNode *node);
paint-node: Get the framebuffer from the root node The PaintNode hierarchy should have the ability to retrieve the current active framebuffer by itself, instead of asking Cogl using the global state API. In order to do this, we ask the root node of a PaintNode graph for the active framebuffer. In the current, 1.x-compatibility mode we have two potential root node types: ClutterRootNode, used by ClutterStage; and ClutterDummyNode, used a local root for each actor. The former takes a framebuffer as part of its construction; the latter takes the actor that acts as the local top-level during the actor's paint sequence, which means we can get the active framebuffer from the stage associated to the actor. By keeping track of the active framebuffer on the node themselves we can drop the usage of cogl_get_draw_framebuffer() in their implementation.
2013-12-03 12:50:39 +00:00
G_GNUC_INTERNAL
CoglFramebuffer * clutter_paint_node_get_framebuffer (ClutterPaintNode *node);
paint-nodes: Make part of the API internal At least for the time being, we only expose the parts of the API that we want to use internally and for new, out-of-tree Content implementations. The full PaintNode tree API will be made public in 1.12 once we branch master.
2012-03-16 11:57:34 +00:00
#define CLUTTER_TYPE_LAYER_NODE (_clutter_layer_node_get_type ())
#define CLUTTER_LAYER_NODE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_LAYER_NODE, ClutterLayerNode))
#define CLUTTER_IS_LAYER_NODE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_LAYER_NODE))
/*
* ClutterLayerNode:
*
docs: Remove last stray DocBook tags
2014-03-18 14:14:22 +00:00
* The #ClutterLayerNode structure is an opaque
paint-nodes: Make part of the API internal At least for the time being, we only expose the parts of the API that we want to use internally and for new, out-of-tree Content implementations. The full PaintNode tree API will be made public in 1.12 once we branch master.
2012-03-16 11:57:34 +00:00
* type whose members cannot be directly accessed.
*
* Since: 1.10
*/
typedef struct _ClutterLayerNode ClutterLayerNode;
typedef struct _ClutterLayerNodeClass ClutterLayerNodeClass;
GType _clutter_layer_node_get_type (void) G_GNUC_CONST;
ClutterPaintNode * _clutter_layer_node_new (const CoglMatrix *projection,
const cairo_rectangle_t *viewport,
float width,
float height,
guint8 opacity);
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.
2012-02-01 15:51:27 +00:00
G_END_DECLS
#endif /* __CLUTTER_PAINT_NODE_PRIVATE_H__ */
Reference in New Issue Copy Permalink