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