Debian Codegraph @

clutter/deprecated/clutter-shader.h

raw
1 /*
2 * Clutter.
3 *
4 * An OpenGL based 'interactive canvas' library.
5 *
6 * Authored By Matthew Allum <[email protected]>
7 * Øyvind Kolås <[email protected]>
8 *
9 * Copyright (C) 2007 OpenedHand
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2 of the License, or (at your option) any later version.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
23 */
24
25 #if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
26 #error "Only <clutter/clutter.h> can be included directly."
27 #endif
28
29 #ifndef __CLUTTER_SHADER_H__
30 #define __CLUTTER_SHADER_H__
31
32 #include <clutter/clutter-types.h>
33 #include <clutter/clutter-shader-types.h>
34
35 G_BEGIN_DECLS
36
37 #define CLUTTER_TYPE_SHADER (clutter_shader_get_type ())
38 #define CLUTTER_SHADER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), CLUTTER_TYPE_SHADER, ClutterShader))
39 #define CLUTTER_SHADER_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), CLUTTER_TYPE_SHADER, ClutterShaderClass))
40 #define CLUTTER_IS_SHADER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), CLUTTER_TYPE_SHADER))
41 #define CLUTTER_IS_SHADER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), CLUTTER_TYPE_SHADER))
42 #define CLUTTER_SHADER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), CLUTTER_TYPE_SHADER, ClutterShaderClass))
43
44 /**
45 * CLUTTER_SHADER_ERROR:
46 *
47 * Error domain for #ClutterShader errors
48 *
49 * Since: 0.6
50 *
51 * Deprecated: 1.8
52 */
53 #define CLUTTER_SHADER_ERROR (clutter_shader_error_quark ())
54
55 /**
56 * ClutterShaderError:
57 * @CLUTTER_SHADER_ERROR_NO_ASM: No ASM shaders support
58 * @CLUTTER_SHADER_ERROR_NO_GLSL: No GLSL shaders support
59 * @CLUTTER_SHADER_ERROR_COMPILE: Compilation error
60 *
61 * #ClutterShader error enumeration
62 *
63 * Since: 0.6
64 *
65 * Deprecated: 1.8
66 */
67 typedef enum {
68 CLUTTER_SHADER_ERROR_NO_ASM,
69 CLUTTER_SHADER_ERROR_NO_GLSL,
70 CLUTTER_SHADER_ERROR_COMPILE
71 } ClutterShaderError;
72
73 typedef struct _ClutterShaderPrivate ClutterShaderPrivate;
74 typedef struct _ClutterShaderClass ClutterShaderClass;
75
76 /**
77 * ClutterShader:
78 *
79 * The #ClutterShader structure contains only private data
80 * and should be accessed using the provided API
81 *
82 * Since: 0.6
83 *
84 * Deprecated: 1.8: Use #ClutterShaderEffect instead
85 */
86 struct _ClutterShader
87 {
88 /*< private >*/
89 GObject parent;
90 ClutterShaderPrivate *priv;
91 };
92
93 /**
94 * ClutterShaderClass:
95 *
96 * The #ClutterShaderClass structure contains only private data
97 *
98 * Since: 0.6
99 *
100 * Deprecated: 1.8: Use #ClutterShaderEffectClass instead
101 */
102 struct _ClutterShaderClass
103 {
104 /*< private >*/
105 GObjectClass parent_class;
106 };
107
108 CLUTTER_DEPRECATED_IN_1_8
109 GQuark clutter_shader_error_quark (void);
110
111 CLUTTER_DEPRECATED_IN_1_8
112 GType clutter_shader_get_type (void) G_GNUC_CONST;
113
114 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
115 ClutterShader * clutter_shader_new (void);
116
117 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
118 void clutter_shader_set_is_enabled (ClutterShader *shader,
119 gboolean enabled);
120 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
121 gboolean clutter_shader_get_is_enabled (ClutterShader *shader);
122
123 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
124 gboolean clutter_shader_compile (ClutterShader *shader,
125 GError **error);
126 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
127 void clutter_shader_release (ClutterShader *shader);
128 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
129 gboolean clutter_shader_is_compiled (ClutterShader *shader);
130
131 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
132 void clutter_shader_set_vertex_source (ClutterShader *shader,
133 const gchar *data,
134 gssize length);
135 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
136 void clutter_shader_set_fragment_source (ClutterShader *shader,
137 const gchar *data,
138 gssize length);
139 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
140 const gchar * clutter_shader_get_vertex_source (ClutterShader *shader);
141 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
142 const gchar * clutter_shader_get_fragment_source (ClutterShader *shader);
143
144 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
145 void clutter_shader_set_uniform (ClutterShader *shader,
146 const gchar *name,
147 const GValue *value);
148
149 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
150 CoglHandle clutter_shader_get_cogl_program (ClutterShader *shader);
151 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
152 CoglHandle clutter_shader_get_cogl_fragment_shader (ClutterShader *shader);
153 CLUTTER_DEPRECATED_IN_1_8_FOR(ClutterShaderEffect)
154 CoglHandle clutter_shader_get_cogl_vertex_shader (ClutterShader *shader);
155
156 /* ClutterActor methods */
157
158 CLUTTER_DEPRECATED_IN_1_8_FOR(clutter_actor_add_effect)
159 gboolean clutter_actor_set_shader (ClutterActor *self,
160 ClutterShader *shader);
161
162 CLUTTER_DEPRECATED_IN_1_8_FOR(clutter_actor_get_effect)
163 ClutterShader * clutter_actor_get_shader (ClutterActor *self);
164
165 CLUTTER_DEPRECATED_IN_1_8_FOR(clutter_shader_effect_set_uniform_value)
166 void clutter_actor_set_shader_param (ClutterActor *self,
167 const gchar *param,
168 const GValue *value);
169
170 CLUTTER_DEPRECATED_IN_1_8_FOR(clutter_shader_effect_set_uniform)
171 void clutter_actor_set_shader_param_int (ClutterActor *self,
172 const gchar *param,
173 gint value);
174
175 CLUTTER_DEPRECATED_IN_1_8_FOR(clutter_shader_effect_set_uniform)
176 void clutter_actor_set_shader_param_float (ClutterActor *self,
177 const gchar *param,
178 gfloat value);
179
180 G_END_DECLS
181
182 #endif /* __CLUTTER_SHADER_H__ */