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