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