4 * An OpenGL based 'interactive canvas' library.
6 * Copyright (C) 2010 Intel Corporation.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
22 * Emmanuele Bassi <ebassi@linux.intel.com>
25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
26 #error "Only <clutter/clutter.h> can be included directly."
29 #ifndef __CLUTTER_EFFECT_H__
30 #define __CLUTTER_EFFECT_H__
32 #include <clutter/clutter-actor-meta.h>
36 #define CLUTTER_TYPE_EFFECT (clutter_effect_get_type ())
37 #define CLUTTER_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_EFFECT, ClutterEffect))
38 #define CLUTTER_IS_EFFECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_EFFECT))
39 #define CLUTTER_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_EFFECT, ClutterEffectClass))
40 #define CLUTTER_IS_EFFECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_EFFECT))
41 #define CLUTTER_EFFECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_EFFECT, ClutterEffectClass))
43 typedef struct _ClutterEffectClass ClutterEffectClass;
48 * The #ClutterEffect structure contains only private data and should
49 * be accessed using the provided API
56 ClutterActorMeta parent_instance;
61 * @pre_paint: virtual function
62 * @post_paint: virtual function
63 * @get_paint_volume: virtual function
64 * @paint: virtual function
65 * @pick: virtual function
67 * The #ClutterEffectClass structure contains only private data
71 struct _ClutterEffectClass
74 ClutterActorMetaClass parent_class;
77 gboolean (* pre_paint) (ClutterEffect *effect);
78 void (* post_paint) (ClutterEffect *effect);
80 gboolean (* get_paint_volume) (ClutterEffect *effect,
81 ClutterPaintVolume *volume);
83 void (* paint) (ClutterEffect *effect,
84 ClutterEffectPaintFlags flags);
85 void (* pick) (ClutterEffect *effect,
86 ClutterEffectPaintFlags flags);
89 void (* _clutter_effect4) (void);
90 void (* _clutter_effect5) (void);
91 void (* _clutter_effect6) (void);
94 GType clutter_effect_get_type (void) G_GNUC_CONST;
96 void clutter_effect_queue_repaint (ClutterEffect *effect);
102 void clutter_actor_add_effect (ClutterActor *self,
103 ClutterEffect *effect);
104 void clutter_actor_add_effect_with_name (ClutterActor *self,
106 ClutterEffect *effect);
107 void clutter_actor_remove_effect (ClutterActor *self,
108 ClutterEffect *effect);
109 void clutter_actor_remove_effect_by_name (ClutterActor *self,
111 GList * clutter_actor_get_effects (ClutterActor *self);
112 ClutterEffect *clutter_actor_get_effect (ClutterActor *self,
114 void clutter_actor_clear_effects (ClutterActor *self);
116 gboolean clutter_actor_has_effects (ClutterActor *self);
120 #endif /* __CLUTTER_EFFECT_H__ */