Merge branch 'master' into blender2.8
[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 ListBase;
47 struct Material;
48 struct Object;
49 struct Scene;
50 struct GPUVertexAttribs;
51 struct GPUNode;
52 struct GPUNodeLink;
53 struct GPUNodeStack;
54 struct GPUMaterial;
55 struct GPUTexture;
56 struct GPUUniformBuffer;
57 struct GPULamp;
58 struct PreviewImage;
59 struct World;
60 struct bNode;
61 struct bNodeTree;
62
63 typedef struct GPUNode GPUNode;
64 typedef struct GPUNodeLink GPUNodeLink;
65 typedef struct GPUMaterial GPUMaterial;
66
67 typedef struct GPUParticleInfo GPUParticleInfo;
68
69 /* Functions to create GPU Materials nodes */
70
71 typedef enum GPUType {
72         /* Keep in sync with GPU_DATATYPE_STR */
73         /* The value indicates the number of elements in each type */
74         GPU_NONE = 0,
75         GPU_FLOAT = 1,
76         GPU_VEC2 = 2,
77         GPU_VEC3 = 3,
78         GPU_VEC4 = 4,
79         GPU_MAT3 = 9,
80         GPU_MAT4 = 16,
81
82         /* Values not in GPU_DATATYPE_STR */
83         GPU_TEX2D = 1002,
84         GPU_TEX3D = 1003,
85         GPU_SHADOW2D = 1004,
86         GPU_TEXCUBE = 1005,
87
88         /* GLSL Struct types */
89         GPU_CLOSURE = 1006,
90
91         /* Opengl Attributes */
92         GPU_ATTRIB = 3001
93 } GPUType;
94
95 typedef enum GPUBuiltin {
96         GPU_VIEW_MATRIX =           (1 << 0),
97         GPU_OBJECT_MATRIX =         (1 << 1),
98         GPU_INVERSE_VIEW_MATRIX =   (1 << 2),
99         GPU_INVERSE_OBJECT_MATRIX = (1 << 3),
100         GPU_VIEW_POSITION =         (1 << 4),
101         GPU_VIEW_NORMAL =           (1 << 5),
102         GPU_OBCOLOR =               (1 << 6),
103         GPU_AUTO_BUMPSCALE =        (1 << 7),
104         GPU_CAMERA_TEXCO_FACTORS =  (1 << 8),
105         GPU_PARTICLE_SCALAR_PROPS = (1 << 9),
106         GPU_PARTICLE_LOCATION =     (1 << 10),
107         GPU_PARTICLE_VELOCITY =     (1 << 11),
108         GPU_PARTICLE_ANG_VELOCITY = (1 << 12),
109         GPU_LOC_TO_VIEW_MATRIX =    (1 << 13),
110         GPU_INVERSE_LOC_TO_VIEW_MATRIX = (1 << 14),
111         GPU_OBJECT_INFO =           (1 << 15),
112         GPU_VOLUME_DENSITY =        (1 << 16),
113         GPU_VOLUME_FLAME =          (1 << 17)
114 } GPUBuiltin;
115
116 typedef enum GPUOpenGLBuiltin {
117         GPU_MATCAP_NORMAL = 1,
118         GPU_COLOR = 2,
119 } GPUOpenGLBuiltin;
120
121 typedef enum GPUMatType {
122         GPU_MATERIAL_TYPE_MESH  = 1,
123         GPU_MATERIAL_TYPE_WORLD = 2,
124 } GPUMatType;
125
126
127 typedef enum GPUBlendMode {
128         GPU_BLEND_SOLID = 0,
129         GPU_BLEND_ADD = 1,
130         GPU_BLEND_ALPHA = 2,
131         GPU_BLEND_CLIP = 4,
132         GPU_BLEND_ALPHA_SORT = 8,
133         GPU_BLEND_ALPHA_TO_COVERAGE = 16
134 } GPUBlendMode;
135
136 typedef struct GPUNodeStack {
137         GPUType type;
138         const char *name;
139         float vec[4];
140         struct GPUNodeLink *link;
141         bool hasinput;
142         bool hasoutput;
143         short sockettype;
144 } GPUNodeStack;
145
146
147 #define GPU_DYNAMIC_GROUP_FROM_TYPE(f) ((f) & 0xFFFF0000)
148
149 #define GPU_DYNAMIC_GROUP_MISC     0x00010000
150 #define GPU_DYNAMIC_GROUP_LAMP     0x00020000
151 #define GPU_DYNAMIC_GROUP_OBJECT   0x00030000
152 #define GPU_DYNAMIC_GROUP_SAMPLER  0x00040000
153 #define GPU_DYNAMIC_GROUP_MIST     0x00050000
154 #define GPU_DYNAMIC_GROUP_WORLD    0x00060000
155 #define GPU_DYNAMIC_GROUP_MAT      0x00070000
156 #define GPU_DYNAMIC_UBO            0x00080000
157
158 typedef enum GPUDynamicType {
159
160         GPU_DYNAMIC_NONE                 = 0,
161
162         GPU_DYNAMIC_OBJECT_VIEWMAT       = 1  | GPU_DYNAMIC_GROUP_OBJECT,
163         GPU_DYNAMIC_OBJECT_MAT           = 2  | GPU_DYNAMIC_GROUP_OBJECT,
164         GPU_DYNAMIC_OBJECT_VIEWIMAT      = 3  | GPU_DYNAMIC_GROUP_OBJECT,
165         GPU_DYNAMIC_OBJECT_IMAT          = 4  | GPU_DYNAMIC_GROUP_OBJECT,
166         GPU_DYNAMIC_OBJECT_COLOR         = 5  | GPU_DYNAMIC_GROUP_OBJECT,
167         GPU_DYNAMIC_OBJECT_AUTOBUMPSCALE = 6  | GPU_DYNAMIC_GROUP_OBJECT,
168         GPU_DYNAMIC_OBJECT_LOCTOVIEWMAT  = 7  | GPU_DYNAMIC_GROUP_OBJECT,
169         GPU_DYNAMIC_OBJECT_LOCTOVIEWIMAT = 8  | GPU_DYNAMIC_GROUP_OBJECT,
170
171         GPU_DYNAMIC_LAMP_DYNVEC          = 1  | GPU_DYNAMIC_GROUP_LAMP,
172         GPU_DYNAMIC_LAMP_DYNCO           = 2  | GPU_DYNAMIC_GROUP_LAMP,
173         GPU_DYNAMIC_LAMP_DYNIMAT         = 3  | GPU_DYNAMIC_GROUP_LAMP,
174         GPU_DYNAMIC_LAMP_DYNPERSMAT      = 4  | GPU_DYNAMIC_GROUP_LAMP,
175         GPU_DYNAMIC_LAMP_DYNENERGY       = 5  | GPU_DYNAMIC_GROUP_LAMP,
176         GPU_DYNAMIC_LAMP_DYNCOL          = 6  | GPU_DYNAMIC_GROUP_LAMP,
177         GPU_DYNAMIC_LAMP_DISTANCE        = 7  | GPU_DYNAMIC_GROUP_LAMP,
178         GPU_DYNAMIC_LAMP_ATT1            = 8  | GPU_DYNAMIC_GROUP_LAMP,
179         GPU_DYNAMIC_LAMP_ATT2            = 9  | GPU_DYNAMIC_GROUP_LAMP,
180         GPU_DYNAMIC_LAMP_SPOTSIZE        = 10 | GPU_DYNAMIC_GROUP_LAMP,
181         GPU_DYNAMIC_LAMP_SPOTBLEND       = 11 | GPU_DYNAMIC_GROUP_LAMP,
182         GPU_DYNAMIC_LAMP_SPOTSCALE       = 12 | GPU_DYNAMIC_GROUP_LAMP,
183         GPU_DYNAMIC_LAMP_COEFFCONST      = 13 | GPU_DYNAMIC_GROUP_LAMP,
184         GPU_DYNAMIC_LAMP_COEFFLIN        = 14 | GPU_DYNAMIC_GROUP_LAMP,
185         GPU_DYNAMIC_LAMP_COEFFQUAD       = 15 | GPU_DYNAMIC_GROUP_LAMP,
186
187         GPU_DYNAMIC_SAMPLER_2DBUFFER     = 1  | GPU_DYNAMIC_GROUP_SAMPLER,
188         GPU_DYNAMIC_SAMPLER_2DIMAGE      = 2  | GPU_DYNAMIC_GROUP_SAMPLER,
189         GPU_DYNAMIC_SAMPLER_2DSHADOW     = 3  | GPU_DYNAMIC_GROUP_SAMPLER,
190
191         GPU_DYNAMIC_MIST_ENABLE          = 1  | GPU_DYNAMIC_GROUP_MIST,
192         GPU_DYNAMIC_MIST_START           = 2  | GPU_DYNAMIC_GROUP_MIST,
193         GPU_DYNAMIC_MIST_DISTANCE        = 3  | GPU_DYNAMIC_GROUP_MIST,
194         GPU_DYNAMIC_MIST_INTENSITY       = 4  | GPU_DYNAMIC_GROUP_MIST,
195         GPU_DYNAMIC_MIST_TYPE            = 5  | GPU_DYNAMIC_GROUP_MIST,
196         GPU_DYNAMIC_MIST_COLOR           = 6  | GPU_DYNAMIC_GROUP_MIST,
197
198         GPU_DYNAMIC_HORIZON_COLOR        = 1  | GPU_DYNAMIC_GROUP_WORLD,
199         GPU_DYNAMIC_AMBIENT_COLOR        = 2  | GPU_DYNAMIC_GROUP_WORLD,
200         GPU_DYNAMIC_ZENITH_COLOR         = 3  | GPU_DYNAMIC_GROUP_WORLD,
201
202         GPU_DYNAMIC_MAT_DIFFRGB          = 1  | GPU_DYNAMIC_GROUP_MAT,
203         GPU_DYNAMIC_MAT_REF              = 2  | GPU_DYNAMIC_GROUP_MAT,
204         GPU_DYNAMIC_MAT_SPECRGB          = 3  | GPU_DYNAMIC_GROUP_MAT,
205         GPU_DYNAMIC_MAT_SPEC             = 4  | GPU_DYNAMIC_GROUP_MAT,
206         GPU_DYNAMIC_MAT_HARD             = 5  | GPU_DYNAMIC_GROUP_MAT,
207         GPU_DYNAMIC_MAT_EMIT             = 6  | GPU_DYNAMIC_GROUP_MAT,
208         GPU_DYNAMIC_MAT_AMB              = 7  | GPU_DYNAMIC_GROUP_MAT,
209         GPU_DYNAMIC_MAT_ALPHA            = 8  | GPU_DYNAMIC_GROUP_MAT,
210         GPU_DYNAMIC_MAT_MIR              = 9  | GPU_DYNAMIC_GROUP_MAT
211 } GPUDynamicType;
212
213 GPUNodeLink *GPU_attribute(CustomDataType type, const char *name);
214 GPUNodeLink *GPU_uniform(float *num);
215 GPUNodeLink *GPU_dynamic_uniform(float *num, GPUDynamicType dynamictype, void *data);
216 GPUNodeLink *GPU_uniform_buffer(float *num, GPUType gputype);
217 GPUNodeLink *GPU_image(struct Image *ima, struct ImageUser *iuser, bool is_data);
218 GPUNodeLink *GPU_cube_map(struct Image *ima, struct ImageUser *iuser, bool is_data);
219 GPUNodeLink *GPU_image_preview(struct PreviewImage *prv);
220 GPUNodeLink *GPU_texture(int size, float *pixels);
221 GPUNodeLink *GPU_dynamic_texture(struct GPUTexture *tex, GPUDynamicType dynamictype, void *data);
222 GPUNodeLink *GPU_builtin(GPUBuiltin builtin);
223 GPUNodeLink *GPU_opengl_builtin(GPUOpenGLBuiltin builtin);
224 void GPU_node_link_set_type(GPUNodeLink *link, GPUType type);
225
226 bool GPU_link(GPUMaterial *mat, const char *name, ...);
227 bool GPU_stack_link(GPUMaterial *mat, struct bNode *node, const char *name, GPUNodeStack *in, GPUNodeStack *out, ...);
228 GPUNodeLink *GPU_uniformbuffer_link_out(
229         struct GPUMaterial *mat, struct bNode *node,
230         struct GPUNodeStack *stack, const int index);
231
232 void GPU_material_output_link(GPUMaterial *material, GPUNodeLink *link);
233 void GPU_material_enable_alpha(GPUMaterial *material);
234 GPUBuiltin GPU_get_material_builtins(GPUMaterial *material);
235 GPUBlendMode GPU_material_alpha_blend(GPUMaterial *material, float obcol[4]);
236
237 void GPU_material_sss_profile_create(GPUMaterial *material, float *radii, short *falloff_type, float *sharpness);
238 struct GPUUniformBuffer *GPU_material_sss_profile_get(
239         GPUMaterial *material, int sample_ct, struct GPUTexture **tex_profile);
240
241 /* High level functions to create and use GPU materials */
242 GPUMaterial *GPU_material_world(struct Scene *scene, struct World *wo);
243 GPUMaterial *GPU_material_from_nodetree_find(
244         struct ListBase *gpumaterials, const void *engine_type, int options);
245 GPUMaterial *GPU_material_from_nodetree(
246         struct Scene *scene, struct bNodeTree *ntree, struct ListBase *gpumaterials, const void *engine_type, int options,
247         const char *vert_code, const char *geom_code, const char *frag_lib, const char *defines);
248 GPUMaterial *GPU_material_from_blender(struct Scene *scene, struct Material *ma, bool use_opensubdiv);
249 GPUMaterial *GPU_material_matcap(struct Scene *scene, struct Material *ma, bool use_opensubdiv);
250 void GPU_material_free(struct ListBase *gpumaterial);
251
252 void GPU_materials_free(void);
253
254 void GPU_material_bind(
255         GPUMaterial *material, int oblay, int viewlay, double time, int mipmap,
256         float viewmat[4][4], float viewinv[4][4], float cameraborder[4]);
257 void GPU_material_bind_uniforms(
258         GPUMaterial *material, float obmat[4][4], float viewmat[4][4], float obcol[4],
259         float autobumpscale, GPUParticleInfo *pi, float object_info[3]);
260 void GPU_material_unbind(GPUMaterial *material);
261 bool GPU_material_bound(GPUMaterial *material);
262 struct Scene *GPU_material_scene(GPUMaterial *material);
263 GPUMatType GPU_Material_get_type(GPUMaterial *material);
264 struct GPUPass *GPU_material_get_pass(GPUMaterial *material);
265
266 struct GPUUniformBuffer *GPU_material_get_uniform_buffer(GPUMaterial *material);
267 void GPU_material_create_uniform_buffer(GPUMaterial *material, struct ListBase *inputs);
268 void GPU_material_uniform_buffer_tag_dirty(struct ListBase *gpumaterials);
269
270 void GPU_material_vertex_attributes(GPUMaterial *material,
271         struct GPUVertexAttribs *attrib);
272
273 bool GPU_material_do_color_management(GPUMaterial *mat);
274 bool GPU_material_use_new_shading_nodes(GPUMaterial *mat);
275 bool GPU_material_use_world_space_shading(GPUMaterial *mat);
276 bool GPU_material_use_domain_surface(GPUMaterial *mat);
277 bool GPU_material_use_domain_volume(GPUMaterial *mat);
278
279 /* Exported shading */
280
281 typedef struct GPUShadeInput {
282         GPUMaterial *gpumat;
283         struct Material *mat;
284
285         GPUNodeLink *rgb, *specrgb, *vn, *view, *vcol, *ref;
286         GPUNodeLink *alpha, *refl, *spec, *emit, *har, *amb;
287         GPUNodeLink *spectra, *mir, *refcol;
288 } GPUShadeInput;
289
290 typedef struct GPUShadeResult {
291         GPUNodeLink *diff, *spec, *combined, *alpha;
292 } GPUShadeResult;
293
294 void GPU_shadeinput_set(GPUMaterial *mat, struct Material *ma, GPUShadeInput *shi);
295 void GPU_shaderesult_set(GPUShadeInput *shi, GPUShadeResult *shr);
296
297 /* Export GLSL shader */
298
299 typedef enum GPUDataType {
300         GPU_DATA_NONE = 0,
301         GPU_DATA_1I = 1,   /* 1 integer */
302         GPU_DATA_1F = 2,
303         GPU_DATA_2F = 3,
304         GPU_DATA_3F = 4,
305         GPU_DATA_4F = 5,
306         GPU_DATA_9F = 6,
307         GPU_DATA_16F = 7,
308         GPU_DATA_4UB = 8,
309 } GPUDataType;
310
311 /* this structure gives information of each uniform found in the shader */
312 typedef struct GPUInputUniform {
313         struct GPUInputUniform *next, *prev;
314         char varname[32];         /* name of uniform in shader */
315         GPUDynamicType type;      /* type of uniform, data format and calculation derive from it */
316         GPUDataType datatype;     /* type of uniform data */
317         struct Object *lamp;      /* when type=GPU_DYNAMIC_LAMP_... or GPU_DYNAMIC_SAMPLER_2DSHADOW */
318         struct Image *image;      /* when type=GPU_DYNAMIC_SAMPLER_2DIMAGE */
319         struct Material *material;/* when type=GPU_DYNAMIC_MAT_... */
320         int texnumber;            /* when type=GPU_DYNAMIC_SAMPLER, texture number: 0.. */
321         unsigned char *texpixels; /* for internally generated texture, pixel data in RGBA format */
322         int texsize;              /* size in pixel of the texture in texpixels buffer:
323                                    * for 2D textures, this is S and T size (square texture) */
324 } GPUInputUniform;
325
326 typedef struct GPUInputAttribute {
327         struct GPUInputAttribute *next, *prev;
328         char varname[32];     /* name of attribute in shader */
329         int type;             /* from CustomData.type, data type derives from it */
330         GPUDataType datatype; /* type of attribute data */
331         const char *name;     /* layer name */
332         int number;           /* generic attribute number */
333 } GPUInputAttribute;
334
335 typedef struct GPUShaderExport {
336         ListBase uniforms;
337         ListBase attributes;
338         char *vertex;
339         char *fragment;
340 } GPUShaderExport;
341
342 GPUShaderExport *GPU_shader_export(struct Scene *scene, struct Material *ma);
343 void GPU_free_shader_export(GPUShaderExport *shader);
344
345 /* Lamps */
346 GPUNodeLink *GPU_lamp_get_data(
347         GPUMaterial *mat, struct GPULamp *lamp,
348         GPUNodeLink **r_col, GPUNodeLink **r_lv, GPUNodeLink **r_dist, GPUNodeLink **r_shadow, GPUNodeLink **r_energy);
349
350 /* World */
351 void GPU_mist_update_enable(short enable);
352 void GPU_mist_update_values(int type, float start, float dist, float inten, float color[3]);
353 void GPU_horizon_update_color(float color[3]);
354 void GPU_ambient_update_color(float color[3]);
355 void GPU_zenith_update_color(float color[3]);
356
357 struct GPUParticleInfo
358 {
359         float scalprops[4];
360         float location[4];
361         float velocity[3];
362         float angular_velocity[3];
363 };
364
365 #ifdef WITH_OPENSUBDIV
366 struct DerivedMesh;
367 void GPU_material_update_fvar_offset(GPUMaterial *gpu_material,
368                                      struct DerivedMesh *dm);
369 #endif
370
371 #ifdef __cplusplus
372 }
373 #endif
374
375 #endif /*__GPU_MATERIAL_H__*/