OpenGL: manage built-in shaders better
[blender.git] / source / blender / gpu / GPU_shader.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_shader.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_SHADER_H__
33 #define __GPU_SHADER_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 typedef struct GPUShader GPUShader;
40 struct GPUTexture;
41
42 /* GPU Shader
43  * - only for fragment shaders now
44  * - must call texture bind before setting a texture as uniform! */
45
46 enum {
47         GPU_SHADER_FLAGS_NONE = 0,
48         GPU_SHADER_FLAGS_SPECIAL_OPENSUBDIV = (1 << 0),
49         GPU_SHADER_FLAGS_NEW_SHADING        = (1 << 1),
50 };
51
52 GPUShader *GPU_shader_create(
53         const char *vertexcode,
54         const char *fragcode,
55         const char *geocode,
56         const char *libcode,
57         const char *defines,
58         int input, int output, int number);
59 GPUShader *GPU_shader_create_ex(
60         const char *vertexcode,
61         const char *fragcode,
62         const char *geocode,
63         const char *libcode,
64         const char *defines,
65         int input, int output, int number,
66         const int flags);
67 void GPU_shader_free(GPUShader *shader);
68
69 void GPU_shader_bind(GPUShader *shader);
70 void GPU_shader_unbind(void);
71
72 void *GPU_shader_get_interface(GPUShader *shader);
73 void GPU_shader_set_interface(GPUShader *shader, void *interface);
74 int GPU_shader_get_uniform(GPUShader *shader, const char *name);
75 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
76         int arraysize, const float *value);
77 void GPU_shader_uniform_vector_int(GPUShader *shader, int location, int length,
78         int arraysize, const int *value);
79
80 void GPU_shader_uniform_texture(GPUShader *shader, int location, struct GPUTexture *tex);
81 void GPU_shader_uniform_int(GPUShader *shader, int location, int value);
82 void GPU_shader_geometry_stage_primitive_io(GPUShader *shader, int input, int output, int number);
83
84 int GPU_shader_get_attribute(GPUShader *shader, const char *name);
85
86 /* Builtin/Non-generated shaders */
87 typedef enum GPUBuiltinShader {
88         GPU_SHADER_VSM_STORE,
89         GPU_SHADER_SEP_GAUSSIAN_BLUR,
90         GPU_SHADER_SMOKE,
91         GPU_SHADER_SMOKE_FIRE,
92         GPU_SHADER_SMOKE_COBA,
93
94         /* specialized drawing */
95         GPU_SHADER_TEXT,
96         GPU_SHADER_EDGES_FRONT_BACK_PERSP,
97         GPU_SHADER_EDGES_FRONT_BACK_ORTHO,
98         GPU_SHADER_EDGES_OVERLAY_SIMPLE,
99         GPU_SHADER_EDGES_OVERLAY,
100         /* for simple 2D drawing */
101         GPU_SHADER_2D_UNIFORM_COLOR,
102         GPU_SHADER_2D_FLAT_COLOR,
103         GPU_SHADER_2D_SMOOTH_COLOR,
104         /* for simple 3D drawing */
105         GPU_SHADER_3D_UNIFORM_COLOR,
106         GPU_SHADER_3D_FLAT_COLOR,
107         GPU_SHADER_3D_SMOOTH_COLOR,
108         GPU_SHADER_3D_DEPTH_ONLY,
109         /* basic image drawing */
110         GPU_SHADER_2D_IMAGE_MASK_UNIFORM_COLOR,
111         GPU_SHADER_3D_IMAGE_MODULATE_ALPHA,
112         GPU_SHADER_3D_IMAGE_RECT_MODULATE_ALPHA,
113         GPU_SHADER_3D_IMAGE_DEPTH,
114         /* points */
115         GPU_SHADER_2D_POINT_FIXED_SIZE_UNIFORM_COLOR,
116         GPU_SHADER_2D_POINT_UNIFORM_SIZE_UNIFORM_COLOR_SMOOTH,
117         GPU_SHADER_2D_POINT_UNIFORM_SIZE_UNIFORM_COLOR_OUTLINE_SMOOTH,
118         GPU_SHADER_2D_POINT_UNIFORM_SIZE_VARYING_COLOR_OUTLINE_SMOOTH,
119         GPU_SHADER_2D_POINT_VARYING_SIZE_VARYING_COLOR,
120         GPU_SHADER_3D_POINT_FIXED_SIZE_UNIFORM_COLOR,
121         GPU_SHADER_3D_POINT_FIXED_SIZE_VARYING_COLOR,
122         GPU_SHADER_3D_POINT_UNIFORM_SIZE_UNIFORM_COLOR_SMOOTH,
123         GPU_SHADER_3D_POINT_UNIFORM_SIZE_UNIFORM_COLOR_OUTLINE_SMOOTH,
124         GPU_SHADER_3D_POINT_VARYING_SIZE_UNIFORM_COLOR,
125         GPU_SHADER_3D_POINT_VARYING_SIZE_VARYING_COLOR,
126
127         GPU_NUM_BUILTIN_SHADERS /* (not an actual shader) */
128 } GPUBuiltinShader;
129
130 GPUShader *GPU_shader_get_builtin_shader(GPUBuiltinShader shader);
131 GPUShader *GPU_shader_get_builtin_fx_shader(int effects, bool persp);
132
133 void GPU_shader_free_builtin_shaders(void);
134
135 /* Vertex attributes for shaders */
136
137 #define GPU_MAX_ATTRIB 32
138
139 typedef struct GPUVertexAttribs {
140         struct {
141                 int type;
142                 int glindex;
143                 int glinfoindoex;
144                 int gltexco;
145                 int attribid;
146                 char name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
147         } layer[GPU_MAX_ATTRIB];
148
149         int totlayer;
150 } GPUVertexAttribs;
151
152 #ifdef __cplusplus
153 }
154 #endif
155
156 #endif  /* __GPU_SHADER_H__ */