95a08e6d5b30a8db7b7ff980738c7097240f9a33
[blender.git] / source / blender / gpu / GPU_material.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This shader is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This shader is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this shader; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2005 Blender Foundation.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): Brecht Van Lommel.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 /** \file GPU_material.h
34  *  \ingroup gpu
35  */
36
37 #ifndef __GPU_MATERIAL__
38 #define __GPU_MATERIAL__
39
40 #include "DNA_listBase.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 struct Image;
47 struct ImageUser;
48 struct Material;
49 struct Object;
50 struct Lamp;
51 struct Image;
52 struct bNode;
53 struct LinkNode;
54 struct Scene;
55 struct GPUVertexAttribs;
56 struct GPUNode;
57 struct GPUNodeLink;
58 struct GPUNodeStack;
59 struct GPUMaterial;
60 struct GPUTexture;
61 struct GPULamp;
62
63 typedef struct GPUNode GPUNode;
64 typedef struct GPUNodeLink GPUNodeLink;
65 typedef struct GPUMaterial GPUMaterial;
66 typedef struct GPULamp GPULamp;
67
68 /* Functions to create GPU Materials nodes */
69
70 typedef enum GPUType {
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         GPU_TEX2D = 1002,
79         GPU_SHADOW2D = 1003,
80         GPU_ATTRIB = 3001
81 } GPUType;
82
83 typedef enum GPUBuiltin {
84         GPU_VIEW_MATRIX = 1,
85         GPU_OBJECT_MATRIX = 2,
86         GPU_INVERSE_VIEW_MATRIX = 4,
87         GPU_INVERSE_OBJECT_MATRIX = 8,
88         GPU_VIEW_POSITION = 16,
89         GPU_VIEW_NORMAL = 32,
90         GPU_OBCOLOR = 64
91 } GPUBuiltin;
92
93 typedef enum GPUBlendMode {
94         GPU_BLEND_SOLID = 0,
95         GPU_BLEND_ADD = 1,
96         GPU_BLEND_ALPHA = 2,
97         GPU_BLEND_CLIP = 4
98 } GPUBlendMode;
99
100 typedef struct GPUNodeStack {
101         GPUType type;
102         const char *name;
103         float vec[4];
104         struct GPUNodeLink *link;
105         short hasinput;
106         short hasoutput;
107         short sockettype;
108 } GPUNodeStack;
109
110 GPUNodeLink *GPU_attribute(int type, const char *name);
111 GPUNodeLink *GPU_uniform(float *num);
112 GPUNodeLink *GPU_dynamic_uniform(float *num, int dynamictype, void *data);
113 GPUNodeLink *GPU_image(struct Image *ima, struct ImageUser *iuser);
114 GPUNodeLink *GPU_texture(int size, float *pixels);
115 GPUNodeLink *GPU_dynamic_texture(struct GPUTexture *tex, int dynamictype, void *data);
116 GPUNodeLink *GPU_socket(GPUNodeStack *sock);
117 GPUNodeLink *GPU_builtin(GPUBuiltin builtin);
118
119 int GPU_link(GPUMaterial *mat, const char *name, ...);
120 int GPU_stack_link(GPUMaterial *mat, const char *name, GPUNodeStack *in, GPUNodeStack *out, ...);
121
122 void GPU_material_output_link(GPUMaterial *material, GPUNodeLink *link);
123 void GPU_material_enable_alpha(GPUMaterial *material);
124 GPUBlendMode GPU_material_blend_mode(GPUMaterial *material, float obcol[4]);
125
126 /* High level functions to create and use GPU materials */
127
128 GPUMaterial *GPU_material_from_blender(struct Scene *scene, struct Material *ma);
129 void GPU_material_free(struct Material *ma);
130
131 void GPU_materials_free(void);
132
133 void GPU_material_bind(GPUMaterial *material, int oblay, int viewlay, double time, int mipmap);
134 void GPU_material_bind_uniforms(GPUMaterial *material, float obmat[][4], float viewmat[][4], float viewinv[][4], float obcol[4]);
135 void GPU_material_unbind(GPUMaterial *material);
136 int GPU_material_bound(GPUMaterial *material);
137
138 void GPU_material_vertex_attributes(GPUMaterial *material,
139         struct GPUVertexAttribs *attrib);
140
141 /* Exported shading */
142
143 typedef struct GPUShadeInput {
144         GPUMaterial *gpumat;
145         struct Material *mat;
146
147         GPUNodeLink *rgb, *specrgb, *vn, *view, *vcol, *ref;
148         GPUNodeLink *alpha, *refl, *spec, *emit, *har, *amb;
149 } GPUShadeInput;
150
151 typedef struct GPUShadeResult {
152         GPUNodeLink *diff, *spec, *combined, *alpha;
153 } GPUShadeResult;
154
155 void GPU_shadeinput_set(GPUMaterial *mat, struct Material *ma, GPUShadeInput *shi);
156 void GPU_shaderesult_set(GPUShadeInput *shi, GPUShadeResult *shr);
157
158 /* Export GLSL shader */
159
160 typedef enum GPUDynamicType {
161         GPU_DYNAMIC_NONE = 0,
162         GPU_DYNAMIC_OBJECT_VIEWMAT = 1,
163         GPU_DYNAMIC_OBJECT_MAT = 2,
164         GPU_DYNAMIC_OBJECT_VIEWIMAT = 3,
165         GPU_DYNAMIC_OBJECT_IMAT = 4,
166         GPU_DYNAMIC_OBJECT_COLOR = 5,
167         GPU_DYNAMIC_LAMP_FIRST = 6,
168         GPU_DYNAMIC_LAMP_DYNVEC = 6,
169         GPU_DYNAMIC_LAMP_DYNCO = 7,
170         GPU_DYNAMIC_LAMP_DYNIMAT = 8,
171         GPU_DYNAMIC_LAMP_DYNPERSMAT = 9,
172         GPU_DYNAMIC_LAMP_DYNENERGY = 10,
173         GPU_DYNAMIC_LAMP_DYNCOL = 11,
174         GPU_DYNAMIC_LAMP_LAST = 11,
175         GPU_DYNAMIC_SAMPLER_2DBUFFER = 12,
176         GPU_DYNAMIC_SAMPLER_2DIMAGE = 13,
177         GPU_DYNAMIC_SAMPLER_2DSHADOW = 14,
178 } GPUDynamicType;
179
180 typedef enum GPUDataType {
181         GPU_DATA_NONE = 0,
182         GPU_DATA_1I = 1,        // 1 integer
183         GPU_DATA_1F = 2,
184         GPU_DATA_2F = 3,
185         GPU_DATA_3F = 4,
186         GPU_DATA_4F = 5,
187         GPU_DATA_9F = 6,
188         GPU_DATA_16F = 7,
189         GPU_DATA_4UB = 8,
190 } GPUDataType;
191
192 /* this structure gives information of each uniform found in the shader */
193 typedef struct GPUInputUniform {
194         struct GPUInputUniform *next, *prev;
195         char varname[32];               /* name of uniform in shader */
196         GPUDynamicType type;    /* type of uniform, data format and calculation derive from it */
197         GPUDataType datatype;   /* type of uniform data */
198         struct Object *lamp;    /* when type=GPU_DYNAMIC_LAMP_... or GPU_DYNAMIC_SAMPLER_2DSHADOW */
199         struct Image *image;    /* when type=GPU_DYNAMIC_SAMPLER_2DIMAGE */
200         int texnumber;                  /* when type=GPU_DYNAMIC_SAMPLER, texture number: 0.. */
201         unsigned char *texpixels;       /* for internally generated texture, pixel data in RGBA format */
202         int texsize;                    /* size in pixel of the texture in texpixels buffer: for 2D textures, this is S and T size (square texture) */
203 } GPUInputUniform;
204
205 typedef struct GPUInputAttribute {
206         struct GPUInputAttribute *next, *prev;
207         char varname[32];       /* name of attribute in shader */
208         int type;                       /* from CustomData.type, data type derives from it */
209         GPUDataType datatype;   /* type of attribute data */
210         const char *name;       /* layer name */
211         int number;                     /* generic attribute number */
212 } GPUInputAttribute;
213
214 typedef struct GPUShaderExport {
215         ListBase uniforms;
216         ListBase attributes;
217         char *vertex;
218         char *fragment;
219 } GPUShaderExport;
220
221 GPUShaderExport *GPU_shader_export(struct Scene *scene, struct Material *ma);
222 void GPU_free_shader_export(GPUShaderExport *shader);
223
224 /* Lamps */
225
226 GPULamp *GPU_lamp_from_blender(struct Scene *scene, struct Object *ob, struct Object *par);
227 void GPU_lamp_free(struct Object *ob);
228
229 int GPU_lamp_has_shadow_buffer(GPULamp *lamp);
230 void GPU_lamp_shadow_buffer_bind(GPULamp *lamp, float viewmat[][4], int *winsize, float winmat[][4]);
231 void GPU_lamp_shadow_buffer_unbind(GPULamp *lamp);
232
233 void GPU_lamp_update(GPULamp *lamp, int lay, int hide, float obmat[][4]);
234 void GPU_lamp_update_colors(GPULamp *lamp, float r, float g, float b, float energy);
235 int GPU_lamp_shadow_layer(GPULamp *lamp);
236
237 #ifdef __cplusplus
238 }
239 #endif
240
241 #endif /*__GPU_MATERIAL__*/
242