06378b088de33458837c0c1aa9876dce0dab37a9
[blender.git] / source / blender / gpu / intern / gpu_codegen.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. The Blender
8  * Foundation also sells licenses for use in proprietary software under
9  * the Blender License.  See http://www.blender.org/BL/ for information
10  * about this.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2005 Blender Foundation.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): Brecht Van Lommel.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file blender/gpu/intern/gpu_codegen.h
32  *  \ingroup gpu
33  */
34
35
36 #ifndef __GPU_CODEGEN_H__
37 #define __GPU_CODEGEN_H__
38
39 #include "DNA_listBase.h"
40 #include "GPU_material.h"
41 #include "GL/glew.h"
42
43 struct ListBase;
44 struct GPUShader;
45 struct GPUOutput;
46 struct GPUNode;
47 struct GPUVertexAttribs;
48 struct GPUFrameBuffer;
49
50 #define MAX_FUNCTION_NAME       64
51 #define MAX_PARAMETER           32
52
53 #define FUNCTION_QUAL_IN        0
54 #define FUNCTION_QUAL_OUT       1
55 #define FUNCTION_QUAL_INOUT     2
56
57 typedef struct GPUFunction {
58         char name[MAX_FUNCTION_NAME];
59         int paramtype[MAX_PARAMETER];
60         int paramqual[MAX_PARAMETER];
61         int totparam;
62 } GPUFunction;
63
64 GPUFunction *GPU_lookup_function(const char *name);
65
66 /* Pass Generation
67    - Takes a list of nodes and a desired output, and makes a pass. This
68          will take ownership of the nodes and free them early if unused or
69          at the end if used.
70 */
71
72 typedef enum GPUDataSource {
73         GPU_SOURCE_VEC_UNIFORM,
74         GPU_SOURCE_BUILTIN,
75         GPU_SOURCE_TEX_PIXEL,
76         GPU_SOURCE_TEX,
77         GPU_SOURCE_ATTRIB
78 } GPUDataSource;
79
80 struct GPUNode {
81         struct GPUNode *next, *prev;
82
83         const char *name;
84         int tag;
85
86         ListBase inputs;
87         ListBase outputs;
88 };
89
90 struct GPUNodeLink {
91         GPUNodeStack *socket;
92
93         int attribtype;
94         const char *attribname;
95
96         int image;
97
98         int texture;
99         int texturesize;
100
101         void *ptr1, *ptr2;
102
103         int dynamic;
104         int dynamictype;        
105
106         int type;
107         int users;
108
109         GPUTexture *dynamictex;
110
111         GPUBuiltin builtin;
112
113         struct GPUOutput *output;
114 };
115
116 typedef struct GPUOutput {
117         struct GPUOutput *next, *prev;
118
119         GPUNode *node;
120         int type;                               /* data type = length of vector/matrix */
121         GPUNodeLink *link;              /* output link */
122         int id;                                 /* unique id as created by code generator */
123 } GPUOutput;
124
125 typedef struct GPUInput {
126         struct GPUInput *next, *prev;
127
128         GPUNode *node;
129
130         int type;                               /* datatype */
131         int source;                             /* data source */
132
133         int id;                                 /* unique id as created by code generator */
134         int texid;                              /* number for multitexture */
135         int attribid;                   /* id for vertex attributes */
136         int bindtex;                    /* input is responsible for binding the texture? */
137         int definetex;                  /* input is responsible for defining the pixel? */
138         int textarget;                  /* GL_TEXTURE_* */
139         int textype;                    /* datatype */
140
141         struct Image *ima;              /* image */
142         struct ImageUser *iuser;/* image user */
143         float *dynamicvec;              /* vector data in case it is dynamic */
144         int dynamictype;                /* origin of the dynamic uniform (GPUDynamicType) */
145         void *dynamicdata;              /* data source of the dynamic uniform */
146         GPUTexture *tex;                /* input texture, only set at runtime */
147         int shaderloc;                  /* id from opengl */
148         char shadername[32];    /* name in shader */
149
150         float vec[16];                  /* vector data */
151         GPUNodeLink *link;
152         int dynamictex;                 /* dynamic? */
153         int attribtype;                 /* attribute type */
154         char attribname[32];    /* attribute name */
155         int attribfirst;                /* this is the first one that is bound */
156         GPUBuiltin builtin;             /* builtin uniform */
157 } GPUInput;
158
159 struct GPUPass {
160         struct GPUPass *next, *prev;
161
162         ListBase inputs;
163         struct GPUOutput *output;
164         struct GPUShader *shader;
165         char *fragmentcode;
166         char *vertexcode;
167         const char *libcode;
168 };
169
170
171 typedef struct GPUPass GPUPass;
172
173 GPUPass *GPU_generate_pass(ListBase *nodes, struct GPUNodeLink *outlink,
174         struct GPUVertexAttribs *attribs, int *builtin, const char *name);
175
176 struct GPUShader *GPU_pass_shader(GPUPass *pass);
177
178 void GPU_pass_bind(GPUPass *pass, double time, int mipmap);
179 void GPU_pass_update_uniforms(GPUPass *pass);
180 void GPU_pass_unbind(GPUPass *pass);
181
182 void GPU_pass_free(GPUPass *pass);
183
184 /* Material calls */
185
186 const char *GPU_builtin_name(GPUBuiltin builtin);
187 void gpu_material_add_node(struct GPUMaterial *material, struct GPUNode *node);
188 int GPU_link_changed(struct GPUNodeLink *link);
189
190 #endif
191