985cebc86875c34aa4eff4c9fb402ba556639c46
[blender.git] / source / blender / gpu / GPU_extensions.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_extensions.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_EXTENSIONS_H__
33 #define __GPU_EXTENSIONS_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct Image;
40 struct ImageUser;
41 struct PreviewImage;
42         
43 struct GPUTexture;
44 typedef struct GPUTexture GPUTexture;
45
46 struct GPUFrameBuffer;
47 typedef struct GPUFrameBuffer GPUFrameBuffer;
48
49 struct GPUOffScreen;
50 typedef struct GPUOffScreen GPUOffScreen;
51
52 struct GPUShader;
53 typedef struct GPUShader GPUShader;
54
55 /* GPU extensions support */
56
57 void GPU_extensions_disable(void);
58
59 bool GPU_glsl_support(void);
60 bool GPU_non_power_of_two_support(void);
61 bool GPU_vertex_buffer_support(void);
62 bool GPU_display_list_support(void);
63 bool GPU_bicubic_bump_support(void);
64
65 int GPU_max_texture_size(void);
66 int GPU_color_depth(void);
67
68 void GPU_code_generate_glsl_lib(void);
69
70
71 /* GPU Types */
72
73 typedef enum GPUDeviceType {
74         GPU_DEVICE_NVIDIA =             (1<<0),
75         GPU_DEVICE_ATI =                (1<<1),
76         GPU_DEVICE_INTEL =              (1<<2),
77         GPU_DEVICE_SOFTWARE =   (1<<3),
78         GPU_DEVICE_UNKNOWN =    (1<<4),
79         GPU_DEVICE_ANY =                (0xff)
80 } GPUDeviceType;
81
82 typedef enum GPUOSType {
83         GPU_OS_WIN =                    (1<<8),
84         GPU_OS_MAC =                    (1<<9),
85         GPU_OS_UNIX =                   (1<<10),
86         GPU_OS_ANY =                    (0xff00)
87 } GPUOSType;
88
89 typedef enum GPUDriverType {
90         GPU_DRIVER_OFFICIAL =   (1<<16),
91         GPU_DRIVER_OPENSOURCE = (1<<17),
92         GPU_DRIVER_SOFTWARE =   (1<<18),
93         GPU_DRIVER_ANY =                (0xff0000)
94 } GPUDriverType;
95
96 bool GPU_type_matches(GPUDeviceType device, GPUOSType os, GPUDriverType driver);
97
98 /* GPU Texture
99  * - always returns unsigned char RGBA textures
100  * - if texture with non square dimensions is created, depending on the
101  *   graphics card capabilities the texture may actually be stored in a
102  *   larger texture with power of two dimensions. the actual dimensions
103  *   may be queried with GPU_texture_opengl_width/height. GPU_texture_coord_2f
104  *   calls glTexCoord2f with the coordinates adjusted for this.
105  * - can use reference counting:
106  *     - reference counter after GPU_texture_create is 1
107  *     - GPU_texture_ref increases by one
108  *     - GPU_texture_free decreases by one, and frees if 0
109  *  - if created with from_blender, will not free the texture
110  */
111
112 typedef enum GPUHDRType {
113         GPU_HDR_NONE =       0,
114         GPU_HDR_HALF_FLOAT = 1,
115         GPU_HDR_FULL_FLOAT = (1 << 1),
116 } GPUHDRType;
117
118 GPUTexture *GPU_texture_create_1D(int w, const float *pixels, char err_out[256]);
119 GPUTexture *GPU_texture_create_2D(int w, int h, const float *pixels, GPUHDRType hdr, char err_out[256]);
120 GPUTexture *GPU_texture_create_3D(int w, int h, int depth, int channels, const float *fpixels);
121 GPUTexture *GPU_texture_create_depth(int w, int h, char err_out[256]);
122 GPUTexture *GPU_texture_create_vsm_shadow_map(int size, char err_out[256]);
123 GPUTexture *GPU_texture_create_2D_procedural(int w, int h, const float *pixels, char err_out[256]);
124 GPUTexture *GPU_texture_create_1D_procedural(int w, const float *pixels, char err_out[256]);
125 GPUTexture *GPU_texture_from_blender(struct Image *ima,
126         struct ImageUser *iuser, bool is_data, double time, int mipmap);
127 GPUTexture *GPU_texture_from_preview(struct PreviewImage *prv, int mipmap);
128 void GPU_invalid_tex_init(void);
129 void GPU_invalid_tex_bind(int mode);
130 void GPU_invalid_tex_free(void);
131
132 void GPU_texture_free(GPUTexture *tex);
133
134 void GPU_texture_ref(GPUTexture *tex);
135
136 void GPU_texture_bind(GPUTexture *tex, int number);
137 void GPU_texture_unbind(GPUTexture *tex);
138
139 void GPU_depth_texture_mode(GPUTexture *tex, bool compare, bool use_filter);
140
141 GPUFrameBuffer *GPU_texture_framebuffer(GPUTexture *tex);
142
143 int GPU_texture_target(const GPUTexture *tex);
144 int GPU_texture_opengl_width(const GPUTexture *tex);
145 int GPU_texture_opengl_height(const GPUTexture *tex);
146 int GPU_texture_opengl_bindcode(const GPUTexture *tex);
147
148 /* GPU Framebuffer
149  * - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
150  *   multiple FBO's may be created, to get around limitations on the number
151  *   of attached textures and the dimension requirements.
152  * - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
153  *   be called before rendering to the window framebuffer again */
154
155 void GPU_texture_bind_as_framebuffer(GPUTexture *tex);
156
157 GPUFrameBuffer *GPU_framebuffer_create(void);
158 int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex, int slot, char err_out[256]);
159 void GPU_framebuffer_texture_detach(GPUTexture *tex);
160 void GPU_framebuffer_slots_bind(GPUFrameBuffer *fb, int slot);
161 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, GPUTexture *tex);
162 void GPU_framebuffer_free(GPUFrameBuffer *fb);
163 bool GPU_framebuffer_check_valid(GPUFrameBuffer *fb, char err_out[256]);
164
165 void GPU_framebuffer_bind_no_save(GPUFrameBuffer *fb, int slot);
166
167 void GPU_framebuffer_restore(void);
168 void GPU_framebuffer_blur(GPUFrameBuffer *fb, GPUTexture *tex, GPUFrameBuffer *blurfb, GPUTexture *blurtex);
169
170 /* GPU OffScreen
171  * - wrapper around framebuffer and texture for simple offscreen drawing
172  * - changes size if graphics card can't support it */
173
174 GPUOffScreen *GPU_offscreen_create(int width, int height, char err_out[256]);
175 void GPU_offscreen_free(GPUOffScreen *ofs);
176 void GPU_offscreen_bind(GPUOffScreen *ofs, bool save);
177 void GPU_offscreen_unbind(GPUOffScreen *ofs, bool restore);
178 void GPU_offscreen_read_pixels(GPUOffScreen *ofs, int type, void *pixels);
179 int GPU_offscreen_width(const GPUOffScreen *ofs);
180 int GPU_offscreen_height(const GPUOffScreen *ofs);
181
182 /* GPU Shader
183  * - only for fragment shaders now
184  * - must call texture bind before setting a texture as uniform! */
185
186 GPUShader *GPU_shader_create(const char *vertexcode, const char *fragcode, const char *libcode, const char *defines);
187 void GPU_shader_free(GPUShader *shader);
188
189 void GPU_shader_bind(GPUShader *shader);
190 void GPU_shader_unbind(void);
191
192 int GPU_shader_get_uniform(GPUShader *shader, const char *name);
193 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
194         int arraysize, const float *value);
195 void GPU_shader_uniform_texture(GPUShader *shader, int location, GPUTexture *tex);
196 void GPU_shader_uniform_int(GPUShader *shader, int location, int value);
197
198 int GPU_shader_get_attribute(GPUShader *shader, const char *name);
199
200 /* Builtin/Non-generated shaders */
201 typedef enum GPUBuiltinShader {
202         GPU_SHADER_VSM_STORE =                  (1<<0),
203         GPU_SHADER_SEP_GAUSSIAN_BLUR =  (1<<1),
204 } GPUBuiltinShader;
205
206 GPUShader *GPU_shader_get_builtin_shader(GPUBuiltinShader shader);
207 GPUShader *GPU_shader_get_builtin_fx_shader(int effects, bool persp);
208
209 void GPU_shader_free_builtin_shaders(void);
210
211 /* Vertex attributes for shaders */
212
213 #define GPU_MAX_ATTRIB          32
214
215 typedef struct GPUVertexAttribs {
216         struct {
217                 int type;
218                 int glindex;
219                 int gltexco;
220                 int attribid;
221                 char name[64];  /* MAX_CUSTOMDATA_LAYER_NAME */
222         } layer[GPU_MAX_ATTRIB];
223
224         int totlayer;
225 } GPUVertexAttribs;
226
227 #ifdef __cplusplus
228 }
229 #endif
230
231 #endif  /* __GPU_EXTENSIONS_H__ */