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