merged from trunk 20741:20848
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* GPU extensions support */
41
42 struct Image;
43 struct ImageUser;
44
45 struct GPUTexture;
46 typedef struct GPUTexture GPUTexture;
47
48 struct GPUFrameBuffer;
49 typedef struct GPUFrameBuffer GPUFrameBuffer;
50
51 struct GPUShader;
52 typedef struct GPUShader GPUShader;
53
54 void GPU_extensions_disable(void);
55 void GPU_extensions_init(void); /* call this before running any of the functions below */
56 void GPU_extensions_exit(void);
57 int GPU_extensions_minimum_support(void);
58 int GPU_print_error(char *str);
59
60 /* GPU Texture
61    - always returns unsigned char RGBA textures
62    - if texture with non square dimensions is created, depending on the
63      graphics card capabilities the texture may actually be stored in a
64          larger texture with power of two dimensions. the actual dimensions
65          may be queried with GPU_texture_opengl_width/height. GPU_texture_coord_2f
66          calls glTexCoord2f with the coordinates adjusted for this.
67    - can use reference counting:
68        - reference counter after GPU_texture_create is 1
69        - GPU_texture_ref increases by one
70        - GPU_texture_free decreases by one, and frees if 0
71         - if created with from_blender, will not free the texture
72 */
73
74 GPUTexture *GPU_texture_create_1D(int w, float *pixels);
75 GPUTexture *GPU_texture_create_2D(int w, int h, float *pixels);
76 GPUTexture *GPU_texture_create_depth(int w, int h);
77 GPUTexture *GPU_texture_from_blender(struct Image *ima,
78         struct ImageUser *iuser, double time);
79 void GPU_texture_free(GPUTexture *tex);
80
81 void GPU_texture_ref(GPUTexture *tex);
82
83 void GPU_texture_bind(GPUTexture *tex, int number);
84 void GPU_texture_unbind(GPUTexture *tex);
85
86 GPUFrameBuffer *GPU_texture_framebuffer(GPUTexture *tex);
87
88 int GPU_texture_target(GPUTexture *tex);
89 int GPU_texture_opengl_width(GPUTexture *tex);
90 int GPU_texture_opengl_height(GPUTexture *tex);
91
92 /* GPU Framebuffer
93    - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
94      multiple FBO's may be created, to get around limitations on the number
95          of attached textures and the dimension requirements.
96    - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
97      be called before rendering to the window framebuffer again */
98
99 GPUFrameBuffer *GPU_framebuffer_create();
100 int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex);
101 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, GPUTexture *tex);
102 void GPU_framebuffer_texture_bind(GPUFrameBuffer *fb, GPUTexture *tex);
103 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, GPUTexture *tex);
104 void GPU_framebuffer_free(GPUFrameBuffer *fb);
105
106 void GPU_framebuffer_restore();
107
108 /* GPU Shader
109    - only for fragment shaders now
110    - must call texture bind before setting a texture as uniform! */
111
112 GPUShader *GPU_shader_create(const char *vertexcode, const char *fragcode, const char *libcode); /*GPUShader *lib);*/
113 /*GPUShader *GPU_shader_create_lib(const char *code);*/
114 void GPU_shader_free(GPUShader *shader);
115
116 void GPU_shader_bind(GPUShader *shader);
117 void GPU_shader_unbind();
118
119 int GPU_shader_get_uniform(GPUShader *shader, char *name);
120 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
121         int arraysize, float *value);
122 void GPU_shader_uniform_texture(GPUShader *shader, int location, GPUTexture *tex);
123
124 int GPU_shader_get_attribute(GPUShader *shader, char *name);
125
126 /* Vertex attributes for shaders */
127
128 #define GPU_MAX_ATTRIB          32
129
130 typedef struct GPUVertexAttribs {
131         struct {
132                 int type;
133                 int glindex;
134                 char name[32];
135         } layer[GPU_MAX_ATTRIB];
136
137         int totlayer;
138 } GPUVertexAttribs;
139
140 #ifdef __cplusplus
141 }
142 #endif
143
144 #endif
145