Fix #35337: sculpt performance regression, partial redraw was not working anymore
[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_listBase.h"
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct Image;
42 struct ImageUser;
43 struct Material;
44 struct Object;
45 struct Lamp;
46 struct Image;
47 struct bNode;
48 struct LinkNode;
49 struct Scene;
50 struct GPUVertexAttribs;
51 struct GPUNode;
52 struct GPUNodeLink;
53 struct GPUNodeStack;
54 struct GPUMaterial;
55 struct GPUTexture;
56 struct GPULamp;
57 struct PreviewImage;
58
59 typedef struct GPUNode GPUNode;
60 typedef struct GPUNodeLink GPUNodeLink;
61 typedef struct GPUMaterial GPUMaterial;
62 typedef struct GPULamp GPULamp;
63
64 /* Functions to create GPU Materials nodes */
65
66 typedef enum GPUType {
67         GPU_NONE = 0,
68         GPU_FLOAT = 1,
69         GPU_VEC2 = 2,
70         GPU_VEC3 = 3,
71         GPU_VEC4 = 4,
72         GPU_MAT3 = 9,
73         GPU_MAT4 = 16,
74         GPU_TEX2D = 1002,
75         GPU_SHADOW2D = 1003,
76         GPU_ATTRIB = 3001
77 } GPUType;
78
79 typedef enum GPUBuiltin {
80         GPU_VIEW_MATRIX = 1,
81         GPU_OBJECT_MATRIX = 2,
82         GPU_INVERSE_VIEW_MATRIX = 4,
83         GPU_INVERSE_OBJECT_MATRIX = 8,
84         GPU_VIEW_POSITION = 16,
85         GPU_VIEW_NORMAL = 32,
86         GPU_OBCOLOR = 64,
87         GPU_AUTO_BUMPSCALE = 128
88 } GPUBuiltin;
89
90 typedef enum GPUBlendMode {
91         GPU_BLEND_SOLID = 0,
92         GPU_BLEND_ADD = 1,
93         GPU_BLEND_ALPHA = 2,
94         GPU_BLEND_CLIP = 4,
95         GPU_BLEND_ALPHA_SORT = 8
96 } GPUBlendMode;
97
98 typedef struct GPUNodeStack {
99         GPUType type;
100         const char *name;
101         float vec[4];
102         struct GPUNodeLink *link;
103         short hasinput;
104         short hasoutput;
105         short sockettype;
106 } GPUNodeStack;
107
108 GPUNodeLink *GPU_attribute(int type, const char *name);
109 GPUNodeLink *GPU_uniform(float *num);
110 GPUNodeLink *GPU_dynamic_uniform(float *num, int dynamictype, void *data);
111 GPUNodeLink *GPU_image(struct Image *ima, struct ImageUser *iuser, int isdata);
112 GPUNodeLink *GPU_image_preview(struct PreviewImage *prv);
113 GPUNodeLink *GPU_texture(int size, float *pixels);
114 GPUNodeLink *GPU_dynamic_texture(struct GPUTexture *tex, int dynamictype, void *data);
115 GPUNodeLink *GPU_builtin(GPUBuiltin builtin);
116
117 int GPU_link(GPUMaterial *mat, const char *name, ...);
118 int GPU_stack_link(GPUMaterial *mat, const char *name, GPUNodeStack *in, GPUNodeStack *out, ...);
119
120 void GPU_material_output_link(GPUMaterial *material, GPUNodeLink *link);
121 void GPU_material_enable_alpha(GPUMaterial *material);
122 GPUBlendMode GPU_material_alpha_blend(GPUMaterial *material, float obcol[4]);
123
124 /* High level functions to create and use GPU materials */
125
126 GPUMaterial *GPU_material_from_blender(struct Scene *scene, struct Material *ma);
127 GPUMaterial *GPU_material_matcap(struct Scene *scene, struct Material *ma);
128 void GPU_material_free(struct Material *ma);
129
130 void GPU_materials_free(void);
131
132 void GPU_material_bind(GPUMaterial *material, int oblay, int viewlay, double time, int mipmap, float viewmat[4][4], float viewinv[4][4]);
133 void GPU_material_bind_uniforms(GPUMaterial *material, float obmat[4][4], float obcol[4], float autobumpscale);
134 void GPU_material_unbind(GPUMaterial *material);
135 int GPU_material_bound(GPUMaterial *material);
136
137 void GPU_material_vertex_attributes(GPUMaterial *material,
138         struct GPUVertexAttribs *attrib);
139
140 int GPU_material_do_color_management(GPUMaterial *mat);
141
142 /* Exported shading */
143
144 typedef struct GPUShadeInput {
145         GPUMaterial *gpumat;
146         struct Material *mat;
147
148         GPUNodeLink *rgb, *specrgb, *vn, *view, *vcol, *ref;
149         GPUNodeLink *alpha, *refl, *spec, *emit, *har, *amb;
150 } GPUShadeInput;
151
152 typedef struct GPUShadeResult {
153         GPUNodeLink *diff, *spec, *combined, *alpha;
154 } GPUShadeResult;
155
156 void GPU_shadeinput_set(GPUMaterial *mat, struct Material *ma, GPUShadeInput *shi);
157 void GPU_shaderesult_set(GPUShadeInput *shi, GPUShadeResult *shr);
158
159 /* Export GLSL shader */
160
161 typedef enum GPUDynamicType {
162         GPU_DYNAMIC_NONE = 0,
163         GPU_DYNAMIC_OBJECT_VIEWMAT = 1,
164         GPU_DYNAMIC_OBJECT_MAT = 2,
165         GPU_DYNAMIC_OBJECT_VIEWIMAT = 3,
166         GPU_DYNAMIC_OBJECT_IMAT = 4,
167         GPU_DYNAMIC_OBJECT_COLOR = 5,
168         GPU_DYNAMIC_OBJECT_AUTOBUMPSCALE = 15,
169         GPU_DYNAMIC_LAMP_FIRST = 6,
170         GPU_DYNAMIC_LAMP_DYNVEC = 6,
171         GPU_DYNAMIC_LAMP_DYNCO = 7,
172         GPU_DYNAMIC_LAMP_DYNIMAT = 8,
173         GPU_DYNAMIC_LAMP_DYNPERSMAT = 9,
174         GPU_DYNAMIC_LAMP_DYNENERGY = 10,
175         GPU_DYNAMIC_LAMP_DYNCOL = 11,
176         GPU_DYNAMIC_LAMP_LAST = 11,
177         GPU_DYNAMIC_SAMPLER_2DBUFFER = 12,
178         GPU_DYNAMIC_SAMPLER_2DIMAGE = 13,
179         GPU_DYNAMIC_SAMPLER_2DSHADOW = 14,
180         GPU_DYNAMIC_LAMP_DISTANCE = 15,
181         GPU_DYNAMIC_LAMP_ATT1 = 16,
182         GPU_DYNAMIC_LAMP_ATT2 = 17,
183         GPU_DYNAMIC_LAMP_SPOTSIZE = 18,
184         GPU_DYNAMIC_LAMP_SPOTBLEND = 19,
185 } GPUDynamicType;
186
187 typedef enum GPUDataType {
188         GPU_DATA_NONE = 0,
189         GPU_DATA_1I = 1,        // 1 integer
190         GPU_DATA_1F = 2,
191         GPU_DATA_2F = 3,
192         GPU_DATA_3F = 4,
193         GPU_DATA_4F = 5,
194         GPU_DATA_9F = 6,
195         GPU_DATA_16F = 7,
196         GPU_DATA_4UB = 8,
197 } GPUDataType;
198
199 /* this structure gives information of each uniform found in the shader */
200 typedef struct GPUInputUniform {
201         struct GPUInputUniform *next, *prev;
202         char varname[32];               /* name of uniform in shader */
203         GPUDynamicType type;    /* type of uniform, data format and calculation derive from it */
204         GPUDataType datatype;   /* type of uniform data */
205         struct Object *lamp;    /* when type=GPU_DYNAMIC_LAMP_... or GPU_DYNAMIC_SAMPLER_2DSHADOW */
206         struct Image *image;    /* when type=GPU_DYNAMIC_SAMPLER_2DIMAGE */
207         int texnumber;                  /* when type=GPU_DYNAMIC_SAMPLER, texture number: 0.. */
208         unsigned char *texpixels;       /* for internally generated texture, pixel data in RGBA format */
209         int texsize;                    /* size in pixel of the texture in texpixels buffer: for 2D textures, this is S and T size (square texture) */
210 } GPUInputUniform;
211
212 typedef struct GPUInputAttribute {
213         struct GPUInputAttribute *next, *prev;
214         char varname[32];       /* name of attribute in shader */
215         int type;                       /* from CustomData.type, data type derives from it */
216         GPUDataType datatype;   /* type of attribute data */
217         const char *name;       /* layer name */
218         int number;                     /* generic attribute number */
219 } GPUInputAttribute;
220
221 typedef struct GPUShaderExport {
222         ListBase uniforms;
223         ListBase attributes;
224         char *vertex;
225         char *fragment;
226 } GPUShaderExport;
227
228 GPUShaderExport *GPU_shader_export(struct Scene *scene, struct Material *ma);
229 void GPU_free_shader_export(GPUShaderExport *shader);
230
231 /* Lamps */
232
233 GPULamp *GPU_lamp_from_blender(struct Scene *scene, struct Object *ob, struct Object *par);
234 void GPU_lamp_free(struct Object *ob);
235
236 int GPU_lamp_has_shadow_buffer(GPULamp *lamp);
237 void GPU_lamp_update_buffer_mats(GPULamp *lamp);
238 void GPU_lamp_shadow_buffer_bind(GPULamp *lamp, float viewmat[4][4], int *winsize, float winmat[4][4]);
239 void GPU_lamp_shadow_buffer_unbind(GPULamp *lamp);
240 int GPU_lamp_shadow_buffer_type(GPULamp *lamp);
241
242 void GPU_lamp_update(GPULamp *lamp, int lay, int hide, float obmat[4][4]);
243 void GPU_lamp_update_colors(GPULamp *lamp, float r, float g, float b, float energy);
244 void GPU_lamp_update_distance(GPULamp *lamp, float distance, float att1, float att2);
245 void GPU_lamp_update_spot(GPULamp *lamp, float spotsize, float spotblend);
246 int GPU_lamp_shadow_layer(GPULamp *lamp);
247
248 #ifdef __cplusplus
249 }
250 #endif
251
252 #endif /*__GPU_MATERIAL_H__*/
253