synched with trunk at revision 36569
[blender-staging.git] / source / blender / gpu / GPU_extensions.h
index eba585e8838b2144a107eb67f68c868b127e09ae..8bf923a567956263329348cc413c42e8d4cf0f59 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -18,7 +18,7 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this shader; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2005 Blender Foundation.
  * All rights reserved.
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file GPU_extensions.h
+ *  \ingroup gpu
+ */
+
 #ifndef GPU_EXTENSIONS_H
 #define GPU_EXTENSIONS_H
 
@@ -37,8 +41,6 @@
 extern "C" {
 #endif
 
-/* GPU extensions support */
-
 struct Image;
 struct ImageUser;
 
@@ -48,32 +50,68 @@ typedef struct GPUTexture GPUTexture;
 struct GPUFrameBuffer;
 typedef struct GPUFrameBuffer GPUFrameBuffer;
 
+struct GPUOffScreen;
+typedef struct GPUOffScreen GPUOffScreen;
+
 struct GPUShader;
 typedef struct GPUShader GPUShader;
 
+/* GPU extensions support */
+
 void GPU_extensions_disable(void);
 void GPU_extensions_init(void); /* call this before running any of the functions below */
 void GPU_extensions_exit(void);
-int GPU_extensions_minimum_support(void);
-int GPU_print_error(char *str);
+int GPU_print_error(const char *str);
+
+int GPU_glsl_support(void);
+int GPU_non_power_of_two_support(void);
+int GPU_color_depth(void);
+
+/* GPU Types */
+
+typedef enum GPUDeviceType {
+       GPU_DEVICE_NVIDIA =             (1<<0),
+       GPU_DEVICE_ATI =                (1<<1),
+       GPU_DEVICE_INTEL =              (1<<2),
+       GPU_DEVICE_SOFTWARE =   (1<<3),
+       GPU_DEVICE_UNKNOWN =    (1<<4),
+       GPU_DEVICE_ANY =                (0xff)
+} GPUDeviceType;
+
+typedef enum GPUOSType {
+       GPU_OS_WIN =                    (1<<8),
+       GPU_OS_MAC =                    (1<<9),
+       GPU_OS_UNIX =                   (1<<10),
+       GPU_OS_ANY =                    (0xff00)
+} GPUOSType;
+
+typedef enum GPUDriverType {
+       GPU_DRIVER_OFFICIAL =   (1<<16),
+       GPU_DRIVER_OPENSOURCE = (1<<17),
+       GPU_DRIVER_SOFTWARE =   (1<<18),
+       GPU_DRIVER_ANY =                (0xff0000)
+} GPUDriverType;
+
+int GPU_type_matches(GPUDeviceType device, GPUOSType os, GPUDriverType driver);
 
 /* GPU Texture
    - always returns unsigned char RGBA textures
    - if texture with non square dimensions is created, depending on the
-     graphics card capabilities the texture may actually be stored in a
+        graphics card capabilities the texture may actually be stored in a
         larger texture with power of two dimensions. the actual dimensions
         may be queried with GPU_texture_opengl_width/height. GPU_texture_coord_2f
         calls glTexCoord2f with the coordinates adjusted for this.
    - can use reference counting:
-       - reference counter after GPU_texture_create is 1
-       - GPU_texture_ref increases by one
-       - GPU_texture_free decreases by one, and frees if 0
+          - reference counter after GPU_texture_create is 1
+          - GPU_texture_ref increases by one
+          - GPU_texture_free decreases by one, and frees if 0
        - if created with from_blender, will not free the texture
 */
 
-GPUTexture *GPU_texture_create_1D(int w, float *pixels);
-GPUTexture *GPU_texture_create_2D(int w, int h, float *pixels);
-GPUTexture *GPU_texture_create_depth(int w, int h);
+GPUTexture *GPU_texture_create_1D(int w, float *pixels, char err_out[256]);
+GPUTexture *GPU_texture_create_2D(int w, int h, float *pixels, char err_out[256]);
+GPUTexture *GPU_texture_create_3D(int w, int h, int depth, float *fpixels);
+GPUTexture *GPU_texture_create_depth(int w, int h, char err_out[256]);
 GPUTexture *GPU_texture_from_blender(struct Image *ima,
        struct ImageUser *iuser, double time, int mipmap);
 void GPU_texture_free(GPUTexture *tex);
@@ -91,19 +129,28 @@ int GPU_texture_opengl_height(GPUTexture *tex);
 
 /* GPU Framebuffer
    - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
-     multiple FBO's may be created, to get around limitations on the number
+        multiple FBO's may be created, to get around limitations on the number
         of attached textures and the dimension requirements.
    - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
-     be called before rendering to the window framebuffer again */
+        be called before rendering to the window framebuffer again */
 
-GPUFrameBuffer *GPU_framebuffer_create();
-int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex);
+GPUFrameBuffer *GPU_framebuffer_create(void);
+int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, GPUTexture *tex, char err_out[256]);
 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, GPUTexture *tex);
 void GPU_framebuffer_texture_bind(GPUFrameBuffer *fb, GPUTexture *tex);
 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, GPUTexture *tex);
 void GPU_framebuffer_free(GPUFrameBuffer *fb);
 
-void GPU_framebuffer_restore();
+void GPU_framebuffer_restore(void);
+
+/* GPU OffScreen
+   - wrapper around framebuffer and texture for simple offscreen drawing 
+   - changes size if graphics card can't support it */
+
+GPUOffScreen *GPU_offscreen_create(int *width, int *height, char err_out[256]);
+void GPU_offscreen_free(GPUOffScreen *ofs);
+void GPU_offscreen_bind(GPUOffScreen *ofs);
+void GPU_offscreen_unbind(GPUOffScreen *ofs);
 
 /* GPU Shader
    - only for fragment shaders now
@@ -114,9 +161,9 @@ GPUShader *GPU_shader_create(const char *vertexcode, const char *fragcode, const
 void GPU_shader_free(GPUShader *shader);
 
 void GPU_shader_bind(GPUShader *shader);
-void GPU_shader_unbind();
+void GPU_shader_unbind(GPUShader *shader);
 
-int GPU_shader_get_uniform(GPUShader *shader, char *name);
+int GPU_shader_get_uniform(GPUShader *shader, const char *name);
 void GPU_shader_uniform_vector(GPUShader *shader, int location, int length,
        int arraysize, float *value);
 void GPU_shader_uniform_texture(GPUShader *shader, int location, GPUTexture *tex);