Cleanup: comment line length (editors)
[blender.git] / source / blender / gpu / GPU_material.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_material.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_MATERIAL_H__
33 #define __GPU_MATERIAL_H__
34
35 #include "DNA_customdata_types.h" /* for CustomDataType */
36 #include "DNA_listBase.h"
37
38 #include "BLI_sys_types.h" /* for bool */
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 struct Image;
45 struct ImageUser;
46 struct Main;
47 struct Material;
48 struct Object;
49 struct Image;
50 struct Scene;
51 struct SceneRenderLayer;
52 struct GPUVertexAttribs;
53 struct GPUNode;
54 struct GPUNodeLink;
55 struct GPUNodeStack;
56 struct GPUMaterial;
57 struct GPUTexture;
58 struct GPULamp;
59 struct PreviewImage;
60 struct World;
61
62 typedef struct GPUNode GPUNode;
63 typedef struct GPUNodeLink GPUNodeLink;
64 typedef struct GPUMaterial GPUMaterial;
65 typedef struct GPULamp GPULamp;
66 typedef struct GPUParticleInfo GPUParticleInfo;
67
68 /* Functions to create GPU Materials nodes */
69
70 typedef enum GPUType {
71         /* The value indicates the number of elements in each type */
72         GPU_NONE = 0,
73         GPU_FLOAT = 1,
74         GPU_VEC2 = 2,
75         GPU_VEC3 = 3,
76         GPU_VEC4 = 4,
77         GPU_MAT3 = 9,
78         GPU_MAT4 = 16,
79
80         GPU_TEX2D = 1002,
81         GPU_SHADOW2D = 1003,
82         GPU_TEXCUBE = 1004,
83         GPU_ATTRIB = 3001
84 } GPUType;
85
86 typedef enum GPUBuiltin {
87         GPU_VIEW_MATRIX =           (1 << 0),
88         GPU_OBJECT_MATRIX =         (1 << 1),
89         GPU_INVERSE_VIEW_MATRIX =   (1 << 2),
90         GPU_INVERSE_OBJECT_MATRIX = (1 << 3),
91         GPU_VIEW_POSITION =         (1 << 4),
92         GPU_VIEW_NORMAL =           (1 << 5),
93         GPU_OBCOLOR =               (1 << 6),
94         GPU_AUTO_BUMPSCALE =        (1 << 7),
95         GPU_CAMERA_TEXCO_FACTORS =  (1 << 8),
96         GPU_PARTICLE_SCALAR_PROPS = (1 << 9),
97         GPU_PARTICLE_LOCATION =     (1 << 10),
98         GPU_PARTICLE_VELOCITY =     (1 << 11),
99         GPU_PARTICLE_ANG_VELOCITY = (1 << 12),
100         GPU_LOC_TO_VIEW_MATRIX =    (1 << 13),
101         GPU_INVERSE_LOC_TO_VIEW_MATRIX = (1 << 14),
102         GPU_OBJECT_INFO =           (1 << 15)
103 } GPUBuiltin;
104
105 typedef enum GPUOpenGLBuiltin {
106         GPU_MATCAP_NORMAL = 1,
107         GPU_COLOR = 2,
108 } GPUOpenGLBuiltin;
109
110 typedef enum GPUMatType {
111         GPU_MATERIAL_TYPE_MESH  = 1,
112         GPU_MATERIAL_TYPE_WORLD = 2,
113 } GPUMatType;
114
115
116 typedef enum GPUBlendMode {
117         GPU_BLEND_SOLID = 0,
118         GPU_BLEND_ADD = 1,
119         GPU_BLEND_ALPHA = 2,
120         GPU_BLEND_CLIP = 4,
121         GPU_BLEND_ALPHA_SORT = 8,
122         GPU_BLEND_ALPHA_TO_COVERAGE = 16
123 } GPUBlendMode;
124
125 typedef struct GPUNodeStack {
126         GPUType type;
127         const char *name;
128         float vec[4];
129         struct GPUNodeLink *link;
130         bool hasinput;
131         bool hasoutput;
132         short sockettype;
133 } GPUNodeStack;
134
135
136 #define GPU_DYNAMIC_GROUP_FROM_TYPE(f) ((f) & 0xFFFF0000)
137
138 #define GPU_DYNAMIC_GROUP_MISC     0x00010000
139 #define GPU_DYNAMIC_GROUP_LAMP     0x00020000
140 #define GPU_DYNAMIC_GROUP_OBJECT   0x00030000
141 #define GPU_DYNAMIC_GROUP_SAMPLER  0x00040000
142 #define GPU_DYNAMIC_GROUP_MIST     0x00050000
143 #define GPU_DYNAMIC_GROUP_WORLD    0x00060000
144 #define GPU_DYNAMIC_GROUP_MAT      0x00070000
145
146 typedef enum GPUDynamicType {
147
148         GPU_DYNAMIC_NONE                 = 0,
149
150         GPU_DYNAMIC_OBJECT_VIEWMAT       = 1  | GPU_DYNAMIC_GROUP_OBJECT,
151         GPU_DYNAMIC_OBJECT_MAT           = 2  | GPU_DYNAMIC_GROUP_OBJECT,
152         GPU_DYNAMIC_OBJECT_VIEWIMAT      = 3  | GPU_DYNAMIC_GROUP_OBJECT,
153         GPU_DYNAMIC_OBJECT_IMAT          = 4  | GPU_DYNAMIC_GROUP_OBJECT,
154         GPU_DYNAMIC_OBJECT_COLOR         = 5  | GPU_DYNAMIC_GROUP_OBJECT,
155         GPU_DYNAMIC_OBJECT_AUTOBUMPSCALE = 6  | GPU_DYNAMIC_GROUP_OBJECT,
156         GPU_DYNAMIC_OBJECT_LOCTOVIEWMAT  = 7  | GPU_DYNAMIC_GROUP_OBJECT,
157         GPU_DYNAMIC_OBJECT_LOCTOVIEWIMAT = 8  | GPU_DYNAMIC_GROUP_OBJECT,
158
159         GPU_DYNAMIC_LAMP_DYNVEC          = 1  | GPU_DYNAMIC_GROUP_LAMP,
160         GPU_DYNAMIC_LAMP_DYNCO           = 2  | GPU_DYNAMIC_GROUP_LAMP,
161         GPU_DYNAMIC_LAMP_DYNIMAT         = 3  | GPU_DYNAMIC_GROUP_LAMP,
162         GPU_DYNAMIC_LAMP_DYNPERSMAT      = 4  | GPU_DYNAMIC_GROUP_LAMP,
163         GPU_DYNAMIC_LAMP_DYNENERGY       = 5  | GPU_DYNAMIC_GROUP_LAMP,
164         GPU_DYNAMIC_LAMP_DYNCOL          = 6  | GPU_DYNAMIC_GROUP_LAMP,
165         GPU_DYNAMIC_LAMP_DISTANCE        = 7  | GPU_DYNAMIC_GROUP_LAMP,
166         GPU_DYNAMIC_LAMP_ATT1            = 8  | GPU_DYNAMIC_GROUP_LAMP,
167         GPU_DYNAMIC_LAMP_ATT2            = 9  | GPU_DYNAMIC_GROUP_LAMP,
168         GPU_DYNAMIC_LAMP_SPOTSIZE        = 10 | GPU_DYNAMIC_GROUP_LAMP,
169         GPU_DYNAMIC_LAMP_SPOTBLEND       = 11 | GPU_DYNAMIC_GROUP_LAMP,
170         GPU_DYNAMIC_LAMP_SPOTSCALE       = 12 | GPU_DYNAMIC_GROUP_LAMP,
171         GPU_DYNAMIC_LAMP_COEFFCONST      = 13 | GPU_DYNAMIC_GROUP_LAMP,
172         GPU_DYNAMIC_LAMP_COEFFLIN        = 14 | GPU_DYNAMIC_GROUP_LAMP,
173         GPU_DYNAMIC_LAMP_COEFFQUAD       = 15 | GPU_DYNAMIC_GROUP_LAMP,
174
175         GPU_DYNAMIC_SAMPLER_2DBUFFER     = 1  | GPU_DYNAMIC_GROUP_SAMPLER,
176         GPU_DYNAMIC_SAMPLER_2DIMAGE      = 2  | GPU_DYNAMIC_GROUP_SAMPLER,
177         GPU_DYNAMIC_SAMPLER_2DSHADOW     = 3  | GPU_DYNAMIC_GROUP_SAMPLER,
178
179         GPU_DYNAMIC_MIST_ENABLE          = 1  | GPU_DYNAMIC_GROUP_MIST,
180         GPU_DYNAMIC_MIST_START           = 2  | GPU_DYNAMIC_GROUP_MIST,
181         GPU_DYNAMIC_MIST_DISTANCE        = 3  | GPU_DYNAMIC_GROUP_MIST,
182         GPU_DYNAMIC_MIST_INTENSITY       = 4  | GPU_DYNAMIC_GROUP_MIST,
183         GPU_DYNAMIC_MIST_TYPE            = 5  | GPU_DYNAMIC_GROUP_MIST,
184         GPU_DYNAMIC_MIST_COLOR           = 6  | GPU_DYNAMIC_GROUP_MIST,
185
186         GPU_DYNAMIC_HORIZON_COLOR        = 1  | GPU_DYNAMIC_GROUP_WORLD,
187         GPU_DYNAMIC_AMBIENT_COLOR        = 2  | GPU_DYNAMIC_GROUP_WORLD,
188         GPU_DYNAMIC_ZENITH_COLOR         = 3  | GPU_DYNAMIC_GROUP_WORLD,
189
190         GPU_DYNAMIC_MAT_DIFFRGB          = 1  | GPU_DYNAMIC_GROUP_MAT,
191         GPU_DYNAMIC_MAT_REF              = 2  | GPU_DYNAMIC_GROUP_MAT,
192         GPU_DYNAMIC_MAT_SPECRGB          = 3  | GPU_DYNAMIC_GROUP_MAT,
193         GPU_DYNAMIC_MAT_SPEC             = 4  | GPU_DYNAMIC_GROUP_MAT,
194         GPU_DYNAMIC_MAT_HARD             = 5  | GPU_DYNAMIC_GROUP_MAT,
195         GPU_DYNAMIC_MAT_EMIT             = 6  | GPU_DYNAMIC_GROUP_MAT,
196         GPU_DYNAMIC_MAT_AMB              = 7  | GPU_DYNAMIC_GROUP_MAT,
197         GPU_DYNAMIC_MAT_ALPHA            = 8  | GPU_DYNAMIC_GROUP_MAT,
198         GPU_DYNAMIC_MAT_MIR              = 9  | GPU_DYNAMIC_GROUP_MAT
199 } GPUDynamicType;
200
201 GPUNodeLink *GPU_attribute(CustomDataType type, const char *name);
202 GPUNodeLink *GPU_uniform(float *num);
203 GPUNodeLink *GPU_dynamic_uniform(float *num, GPUDynamicType dynamictype, void *data);
204 GPUNodeLink *GPU_image(struct Image *ima, struct ImageUser *iuser, bool is_data);
205 GPUNodeLink *GPU_cube_map(struct Image *ima, struct ImageUser *iuser, bool is_data);
206 GPUNodeLink *GPU_image_preview(struct PreviewImage *prv);
207 GPUNodeLink *GPU_texture(int size, float *pixels);
208 GPUNodeLink *GPU_dynamic_texture(struct GPUTexture *tex, GPUDynamicType dynamictype, void *data);
209 GPUNodeLink *GPU_builtin(GPUBuiltin builtin);
210 GPUNodeLink *GPU_opengl_builtin(GPUOpenGLBuiltin builtin);
211 void GPU_node_link_set_type(GPUNodeLink *link, GPUType type);
212
213 bool GPU_link(GPUMaterial *mat, const char *name, ...);
214 bool GPU_stack_link(GPUMaterial *mat, const char *name, GPUNodeStack *in, GPUNodeStack *out, ...);
215
216 void GPU_material_output_link(GPUMaterial *material, GPUNodeLink *link);
217 void GPU_material_enable_alpha(GPUMaterial *material);
218 GPUBuiltin GPU_get_material_builtins(GPUMaterial *material);
219 GPUBlendMode GPU_material_alpha_blend(GPUMaterial *material, float obcol[4]);
220
221 /* High level functions to create and use GPU materials */
222 GPUMaterial *GPU_material_world(struct Scene *scene, struct World *wo);
223
224 GPUMaterial *GPU_material_from_blender(struct Scene *scene, struct Material *ma, bool use_opensubdiv);
225 GPUMaterial *GPU_material_matcap(struct Scene *scene, struct Material *ma, bool use_opensubdiv);
226 void GPU_material_free(struct ListBase *gpumaterial);
227
228 void GPU_materials_free(struct Main *bmain);
229
230 bool GPU_lamp_visible(GPULamp *lamp, struct SceneRenderLayer *srl, struct Material *ma);
231 void GPU_material_bind(
232         GPUMaterial *material, int oblay, int viewlay, double time, int mipmap,
233         float viewmat[4][4], float viewinv[4][4], float cameraborder[4], bool scenelock);
234 void GPU_material_bind_uniforms(
235         GPUMaterial *material, float obmat[4][4], float viewmat[4][4], float obcol[4],
236         float autobumpscale, GPUParticleInfo *pi, float object_info[3]);
237 void GPU_material_unbind(GPUMaterial *material);
238 bool GPU_material_bound(GPUMaterial *material);
239 struct Scene *GPU_material_scene(GPUMaterial *material);
240 GPUMatType GPU_Material_get_type(GPUMaterial *material);
241
242 void GPU_material_vertex_attributes(GPUMaterial *material,
243         struct GPUVertexAttribs *attrib);
244
245 bool GPU_material_do_color_management(GPUMaterial *mat);
246 bool GPU_material_use_new_shading_nodes(GPUMaterial *mat);
247 bool GPU_material_use_world_space_shading(GPUMaterial *mat);
248
249 /* Exported shading */
250
251 typedef struct GPUShadeInput {
252         GPUMaterial *gpumat;
253         struct Material *mat;
254
255         GPUNodeLink *rgb, *specrgb, *vn, *view, *vcol, *ref;
256         GPUNodeLink *alpha, *refl, *spec, *emit, *har, *amb;
257         GPUNodeLink *spectra, *mir, *refcol;
258 } GPUShadeInput;
259
260 typedef struct GPUShadeResult {
261         GPUNodeLink *diff, *spec, *combined, *alpha;
262 } GPUShadeResult;
263
264 void GPU_shadeinput_set(GPUMaterial *mat, struct Material *ma, GPUShadeInput *shi);
265 void GPU_shaderesult_set(GPUShadeInput *shi, GPUShadeResult *shr);
266
267 /* Export GLSL shader */
268
269 typedef enum GPUDataType {
270         GPU_DATA_NONE = 0,
271         GPU_DATA_1I = 1,   /* 1 integer */
272         GPU_DATA_1F = 2,
273         GPU_DATA_2F = 3,
274         GPU_DATA_3F = 4,
275         GPU_DATA_4F = 5,
276         GPU_DATA_9F = 6,
277         GPU_DATA_16F = 7,
278         GPU_DATA_4UB = 8,
279 } GPUDataType;
280
281 /* this structure gives information of each uniform found in the shader */
282 typedef struct GPUInputUniform {
283         struct GPUInputUniform *next, *prev;
284         char varname[32];         /* name of uniform in shader */
285         GPUDynamicType type;      /* type of uniform, data format and calculation derive from it */
286         GPUDataType datatype;     /* type of uniform data */
287         struct Object *lamp;      /* when type=GPU_DYNAMIC_LAMP_... or GPU_DYNAMIC_SAMPLER_2DSHADOW */
288         struct Image *image;      /* when type=GPU_DYNAMIC_SAMPLER_2DIMAGE */
289         struct Material *material;/* when type=GPU_DYNAMIC_MAT_... */
290         int texnumber;            /* when type=GPU_DYNAMIC_SAMPLER, texture number: 0.. */
291         unsigned char *texpixels; /* for internally generated texture, pixel data in RGBA format */
292         int texsize;              /* size in pixel of the texture in texpixels buffer:
293                                    * for 2D textures, this is S and T size (square texture) */
294 } GPUInputUniform;
295
296 typedef struct GPUInputAttribute {
297         struct GPUInputAttribute *next, *prev;
298         char varname[32];     /* name of attribute in shader */
299         int type;             /* from CustomData.type, data type derives from it */
300         GPUDataType datatype; /* type of attribute data */
301         const char *name;     /* layer name */
302         int number;           /* generic attribute number */
303 } GPUInputAttribute;
304
305 typedef struct GPUShaderExport {
306         ListBase uniforms;
307         ListBase attributes;
308         char *vertex;
309         char *fragment;
310 } GPUShaderExport;
311
312 GPUShaderExport *GPU_shader_export(struct Scene *scene, struct Material *ma);
313 void GPU_free_shader_export(GPUShaderExport *shader);
314
315 /* Lamps */
316
317 GPULamp *GPU_lamp_from_blender(struct Scene *scene, struct Object *ob, struct Object *par);
318 void GPU_lamp_free(struct Object *ob);
319
320 bool GPU_lamp_has_shadow_buffer(GPULamp *lamp);
321 void GPU_lamp_update_buffer_mats(GPULamp *lamp);
322 void GPU_lamp_shadow_buffer_bind(GPULamp *lamp, float viewmat[4][4], int *winsize, float winmat[4][4]);
323 void GPU_lamp_shadow_buffer_unbind(GPULamp *lamp);
324 int GPU_lamp_shadow_buffer_type(GPULamp *lamp);
325 int GPU_lamp_shadow_bind_code(GPULamp *lamp);
326 float *GPU_lamp_dynpersmat(GPULamp *lamp);
327
328 void GPU_lamp_update(GPULamp *lamp, int lay, int hide, float obmat[4][4]);
329 void GPU_lamp_update_colors(GPULamp *lamp, float r, float g, float b, float energy);
330 void GPU_lamp_update_distance(GPULamp *lamp, float distance, float att1, float att2,
331                               float coeff_const, float coeff_lin, float coeff_quad);
332 void GPU_lamp_update_spot(GPULamp *lamp, float spotsize, float spotblend);
333 int GPU_lamp_shadow_layer(GPULamp *lamp);
334 GPUNodeLink *GPU_lamp_get_data(
335         GPUMaterial *mat, GPULamp *lamp,
336         GPUNodeLink **r_col, GPUNodeLink **r_lv, GPUNodeLink **r_dist, GPUNodeLink **r_shadow, GPUNodeLink **r_energy);
337
338 /* World */
339 void GPU_mist_update_enable(short enable);
340 void GPU_mist_update_values(int type, float start, float dist, float inten, float color[3]);
341 void GPU_horizon_update_color(float color[3]);
342 void GPU_ambient_update_color(float color[3]);
343 void GPU_zenith_update_color(float color[3]);
344
345 struct GPUParticleInfo
346 {
347         float scalprops[4];
348         float location[4];
349         float velocity[3];
350         float angular_velocity[3];
351 };
352
353 #ifdef WITH_OPENSUBDIV
354 struct DerivedMesh;
355 void GPU_material_update_fvar_offset(GPUMaterial *gpu_material,
356                                      struct DerivedMesh *dm);
357 #endif
358
359 #ifdef __cplusplus
360 }
361 #endif
362
363 #endif /*__GPU_MATERIAL_H__*/