correct fsf address
[blender-staging.git] / source / blender / gpu / GPU_extensions.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 #ifndef GPU_EXTENSIONS_H
34 #define GPU_EXTENSIONS_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct Image;
41 struct ImageUser;
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 void GPU_extensions_init(void); /* call this before running any of the functions below */
59 void GPU_extensions_exit(void);
60 int GPU_glsl_support(void);
61 int GPU_non_power_of_two_support(void);
62 int GPU_print_error(char *str);
63
64 /* GPU Types */
65
66 typedef enum GPUDeviceType {
67         GPU_DEVICE_NVIDIA =             (1<<0),
68         GPU_DEVICE_ATI =                (1<<1),
69         GPU_DEVICE_INTEL =              (1<<2),
70         GPU_DEVICE_SOFTWARE =   (1<<3),
71         GPU_DEVICE_UNKNOWN =    (1<<4),
72         GPU_DEVICE_ANY =                (0xff)
73 } GPUDeviceType;
74
75 typedef enum GPUOSType {
76         GPU_OS_WIN =                    (1<<16),
77         GPU_OS_MAC =                    (1<<17),
78         GPU_OS_UNIX =                   (1<<18),
79         GPU_OS_ANY =                    (0xff00)
80 } GPUOSType;
81
82 typedef enum GPUDriverType {
83         GPU_DRIVER_OFFICIAL =   (1<<24),
84         GPU_DRIVER_OPENSOURCE = (1<<25),
85         GPU_DRIVER_SOFTWARE =   (1<<26),
86         GPU_DRIVER_UNKNOWN =    (0xff0000)
87 } GPUDriverType;
88
89 int GPU_type_matches(GPUDeviceType device, GPUOSType os, GPUDriverType driver);
90
91 /* GPU Texture
92    - always returns unsigned char RGBA textures
93    - if texture with non square dimensions is created, depending on the
94      graphics card capabilities the texture may actually be stored in a
95          larger texture with power of two dimensions. the actual dimensions
96          may be queried with GPU_texture_opengl_width/height. GPU_texture_coord_2f
97          calls glTexCoord2f with the coordinates adjusted for this.
98    - can use reference counting:
99        - reference counter after GPU_texture_create is 1
100        - GPU_texture_ref increases by one
101        - GPU_texture_free decreases by one, and frees if 0
102         - if created with from_blender, will not free the texture
103 */
104
105 GPUTexture *GPU_texture_create_1D(int w, float *pixels);
106 GPUTexture *GPU_texture_create_2D(int w, int h, float *pixels);
107 GPUTexture *GPU_texture_create_3D(int w, int h, int depth, float *fpixels);
108 GPUTexture *GPU_texture_create_depth(int w, int h);
109 GPUTexture *GPU_texture_from_blender(struct Image *ima,
110         struct ImageUser *iuser, double time, int mipmap);
111 void GPU_texture_free(GPUTexture *tex);
112
113 void GPU_texture_ref(GPUTexture *tex);
114
115 void GPU_texture_bind(GPUTexture *tex, int number);
116 void GPU_texture_unbind(GPUTexture *tex);
117
118 GPUFrameBuffer *GPU_texture_framebuffer(GPUTexture *tex);
119
120 int GPU_texture_target(GPUTexture *tex);
121 int GPU_texture_opengl_width(GPUTexture *tex);
122 int GPU_texture_opengl_height(GPUTexture *tex);
123
124 /* GPU Framebuffer
125    - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
126      multiple FBO's may be created, to get around limitations on the number
127          of attached textures and the dimension requirements.
128    - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
129      be called before rendering to the window framebuffer again */
130
131 GPUFrameBuffer *GPU_framebuffer_create();
132 int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex);
133 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, GPUTexture *tex);
134 void GPU_framebuffer_texture_bind(GPUFrameBuffer *fb, GPUTexture *tex);
135 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, GPUTexture *tex);
136 void GPU_framebuffer_free(GPUFrameBuffer *fb);
137
138 void GPU_framebuffer_restore();
139
140 /* GPU OffScreen
141    - wrapper around framebuffer and texture for simple offscreen drawing */
142
143 GPUOffScreen *GPU_offscreen_create(int width, int height);
144 void GPU_offscreen_free(GPUOffScreen *ofs);
145 void GPU_offscreen_bind(GPUOffScreen *ofs);
146 void GPU_offscreen_unbind(GPUOffScreen *ofs);
147
148 /* GPU Shader
149    - only for fragment shaders now
150    - must call texture bind before setting a texture as uniform! */
151
152 GPUShader *GPU_shader_create(const char *vertexcode, const char *fragcode, const char *libcode); /*GPUShader *lib);*/
153 /*GPUShader *GPU_shader_create_lib(const char *code);*/
154 void GPU_shader_free(GPUShader *shader);
155
156 void GPU_shader_bind(GPUShader *shader);
157 void GPU_shader_unbind();
158
159 int GPU_shader_get_uniform(GPUShader *shader, char *name);
160 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
161         int arraysize, float *value);
162 void GPU_shader_uniform_texture(GPUShader *shader, int location, GPUTexture *tex);
163
164 int GPU_shader_get_attribute(GPUShader *shader, char *name);
165
166 /* Vertex attributes for shaders */
167
168 #define GPU_MAX_ATTRIB          32
169
170 typedef struct GPUVertexAttribs {
171         struct {
172                 int type;
173                 int glindex;
174                 char name[32];
175         } layer[GPU_MAX_ATTRIB];
176
177         int totlayer;
178 } GPUVertexAttribs;
179
180 #ifdef __cplusplus
181 }
182 #endif
183
184 #endif
185