python api for ID property access by Joseph Eager, copied from blender 2.4x.
[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 GPUOffScreen;
52 typedef struct GPUOffScreen GPUOffScreen;
53
54 struct GPUShader;
55 typedef struct GPUShader GPUShader;
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 Texture
65    - always returns unsigned char RGBA textures
66    - if texture with non square dimensions is created, depending on the
67      graphics card capabilities the texture may actually be stored in a
68          larger texture with power of two dimensions. the actual dimensions
69          may be queried with GPU_texture_opengl_width/height. GPU_texture_coord_2f
70          calls glTexCoord2f with the coordinates adjusted for this.
71    - can use reference counting:
72        - reference counter after GPU_texture_create is 1
73        - GPU_texture_ref increases by one
74        - GPU_texture_free decreases by one, and frees if 0
75         - if created with from_blender, will not free the texture
76 */
77
78 GPUTexture *GPU_texture_create_1D(int w, float *pixels);
79 GPUTexture *GPU_texture_create_2D(int w, int h, float *pixels);
80 GPUTexture *GPU_texture_create_3D(int w, int h, int depth, float *fpixels);
81 GPUTexture *GPU_texture_create_depth(int w, int h);
82 GPUTexture *GPU_texture_from_blender(struct Image *ima,
83         struct ImageUser *iuser, double time, int mipmap);
84 void GPU_texture_free(GPUTexture *tex);
85
86 void GPU_texture_ref(GPUTexture *tex);
87
88 void GPU_texture_bind(GPUTexture *tex, int number);
89 void GPU_texture_unbind(GPUTexture *tex);
90
91 GPUFrameBuffer *GPU_texture_framebuffer(GPUTexture *tex);
92
93 int GPU_texture_target(GPUTexture *tex);
94 int GPU_texture_opengl_width(GPUTexture *tex);
95 int GPU_texture_opengl_height(GPUTexture *tex);
96
97 /* GPU Framebuffer
98    - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
99      multiple FBO's may be created, to get around limitations on the number
100          of attached textures and the dimension requirements.
101    - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
102      be called before rendering to the window framebuffer again */
103
104 GPUFrameBuffer *GPU_framebuffer_create();
105 int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex);
106 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, GPUTexture *tex);
107 void GPU_framebuffer_texture_bind(GPUFrameBuffer *fb, GPUTexture *tex);
108 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, GPUTexture *tex);
109 void GPU_framebuffer_free(GPUFrameBuffer *fb);
110
111 void GPU_framebuffer_restore();
112
113 /* GPU OffScreen
114    - wrapper around framebuffer and texture for simple offscreen drawing */
115
116 GPUOffScreen *GPU_offscreen_create(int width, int height);
117 void GPU_offscreen_free(GPUOffScreen *ofs);
118 void GPU_offscreen_bind(GPUOffScreen *ofs);
119 void GPU_offscreen_unbind(GPUOffScreen *ofs);
120
121 /* GPU Shader
122    - only for fragment shaders now
123    - must call texture bind before setting a texture as uniform! */
124
125 GPUShader *GPU_shader_create(const char *vertexcode, const char *fragcode, const char *libcode); /*GPUShader *lib);*/
126 /*GPUShader *GPU_shader_create_lib(const char *code);*/
127 void GPU_shader_free(GPUShader *shader);
128
129 void GPU_shader_bind(GPUShader *shader);
130 void GPU_shader_unbind();
131
132 int GPU_shader_get_uniform(GPUShader *shader, char *name);
133 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
134         int arraysize, float *value);
135 void GPU_shader_uniform_texture(GPUShader *shader, int location, GPUTexture *tex);
136
137 int GPU_shader_get_attribute(GPUShader *shader, char *name);
138
139 /* Vertex attributes for shaders */
140
141 #define GPU_MAX_ATTRIB          32
142
143 typedef struct GPUVertexAttribs {
144         struct {
145                 int type;
146                 int glindex;
147                 char name[32];
148         } layer[GPU_MAX_ATTRIB];
149
150         int totlayer;
151 } GPUVertexAttribs;
152
153 #ifdef __cplusplus
154 }
155 #endif
156
157 #endif
158