Bugfix #20574: New 3D View regions were all had their 'type' set to 'RGN_TYPE_UI...
[blender-staging.git] / source / blender / gpu / GPU_draw.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_GAME_H
34 #define GPU_GAME_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct Image;
41 struct ImageUser;
42 struct MTFace;
43 struct Object;
44 struct Scene;
45 struct View3D;
46 struct RegionView3D;
47 struct SmokeModifierData;
48
49 /* OpenGL drawing functions related to shading. These are also
50  * shared with the game engine, where there were previously
51  * duplicates of some of these functions. */
52
53 /* Initialize
54  * - sets the default Blender opengl state, if in doubt, check
55  *   the contents of this function
56  * - this is called when starting Blender, for opengl rendering,
57  *   and for switching back from the game engine for example. */
58
59 void GPU_state_init(void);
60
61 /* Debugging */
62
63 void GPU_state_print(void);
64
65 /* Material drawing
66  * - first the state is initialized by a particular object and
67  *   it's materials
68  * - after this, materials can be quickly enabled by their number,
69  *   GPU_enable_material returns 0 if drawing should be skipped
70  * - after drawing, the material must be disabled again */
71
72 void GPU_begin_object_materials(struct View3D *v3d, struct RegionView3D *rv3d, 
73         struct Scene *scene, struct Object *ob, int glsl, int *do_alpha_pass);
74 void GPU_end_object_materials(void);
75
76 int GPU_enable_material(int nr, void *attribs);
77 void GPU_disable_material(void);
78
79 void GPU_set_material_blend_mode(int blendmode);
80 int GPU_get_material_blend_mode(void);
81
82 /* TexFace drawing
83  * - this is mutually exclusive with material drawing, a mesh should
84  *   be drawn using one or the other
85  * - passing NULL clears the state again */
86
87 int GPU_set_tpage(struct MTFace *tface, int mipmap);
88
89 /* Lights
90  * - returns how many lights were enabled
91  * - this affects fixed functions materials and texface, not glsl */
92
93 int GPU_default_lights(void);
94 int GPU_scene_object_lights(struct Scene *scene, struct Object *ob,
95         int lay, float viewmat[][4], int ortho);
96
97 /* Text render
98  * - based on moving uv coordinates */
99
100 void GPU_render_text(struct MTFace *tface, int mode,
101         const char *textstr, int textlen, unsigned int *col,
102         float *v1, float *v2, float *v3, float *v4, int glattrib);
103
104 /* Mipmap settings
105  * - these will free textures on changes */
106
107 void GPU_set_mipmap(int mipmap);
108 void GPU_set_linear_mipmap(int linear);
109 void GPU_paint_set_mipmap(int mipmap);
110
111 /* Image updates and free
112  * - these deal with images bound as opengl textures */
113
114 void GPU_paint_update_image(struct Image *ima, int x, int y, int w, int h, int mipmap);
115 void GPU_update_images_framechange(void);
116 int GPU_update_image_time(struct Image *ima, double time);
117 int GPU_verify_image(struct Image *ima, struct ImageUser *iuser, int tftile, int tfmode, int compare, int mipmap);
118 void GPU_free_image(struct Image *ima);
119 void GPU_free_images(void);
120
121 /* smoke drawing functions */
122 void GPU_free_smoke(struct SmokeModifierData *smd);
123 void GPU_create_smoke(struct SmokeModifierData *smd, int highres);
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif
130