remove $Id: tags after discussion on the mailign list: http://markmail.org/message...
[blender.git] / source / blender / gpu / GPU_draw.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This shader is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. The Blender
8  * Foundation also sells licenses for use in proprietary software under
9  * the Blender License.  See http://www.blender.org/BL/ for information
10  * about this.
11  *
12  * This shader is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this shader; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2005 Blender Foundation.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): Brecht Van Lommel.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 /** \file GPU_draw.h
32  *  \ingroup gpu
33  */
34
35 #ifndef GPU_GAME_H
36 #define GPU_GAME_H
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Image;
43 struct ImageUser;
44 struct MTFace;
45 struct Object;
46 struct Scene;
47 struct View3D;
48 struct RegionView3D;
49 struct SmokeModifierData;
50
51 /* OpenGL drawing functions related to shading. These are also
52  * shared with the game engine, where there were previously
53  * duplicates of some of these functions. */
54
55 /* Initialize
56  * - sets the default Blender opengl state, if in doubt, check
57  *   the contents of this function
58  * - this is called when starting Blender, for opengl rendering,
59  *   and for switching back from the game engine for example. */
60
61 void GPU_state_init(void);
62
63 /* Debugging */
64
65 void GPU_state_print(void);
66
67 /* Material drawing
68  * - first the state is initialized by a particular object and
69  *   it's materials
70  * - after this, materials can be quickly enabled by their number,
71  *   GPU_enable_material returns 0 if drawing should be skipped
72  * - after drawing, the material must be disabled again */
73
74 void GPU_begin_object_materials(struct View3D *v3d, struct RegionView3D *rv3d, 
75         struct Scene *scene, struct Object *ob, int glsl, int *do_alpha_pass);
76 void GPU_end_object_materials(void);
77
78 int GPU_enable_material(int nr, void *attribs);
79 void GPU_disable_material(void);
80
81 void GPU_set_material_alpha_blend(int alphablend);
82 int GPU_get_material_alpha_blend(void);
83
84 /* TexFace drawing
85  * - this is mutually exclusive with material drawing, a mesh should
86  *   be drawn using one or the other
87  * - passing NULL clears the state again */
88
89 int GPU_set_tpage(struct MTFace *tface, int mipmap, int transp);
90
91 /* Lights
92  * - returns how many lights were enabled
93  * - this affects fixed functions materials and texface, not glsl */
94
95 int GPU_default_lights(void);
96 int GPU_scene_object_lights(struct Scene *scene, struct Object *ob,
97         int lay, float viewmat[][4], int ortho);
98
99 /* Text render
100  * - based on moving uv coordinates */
101
102 void GPU_render_text(struct MTFace *tface, int mode,
103         const char *textstr, int textlen, unsigned int *col,
104         float *v1, float *v2, float *v3, float *v4, int glattrib);
105
106 /* Mipmap settings
107  * - these will free textures on changes */
108
109 void GPU_set_mipmap(int mipmap);
110 void GPU_set_linear_mipmap(int linear);
111 void GPU_paint_set_mipmap(int mipmap);
112
113 /* Anisotropic filtering settings
114  * - these will free textures on changes */
115 void GPU_set_anisotropic(float value);
116 float GPU_get_anisotropic(void);
117
118 /* Image updates and free
119  * - these deal with images bound as opengl textures */
120
121 void GPU_paint_update_image(struct Image *ima, int x, int y, int w, int h, int mipmap);
122 void GPU_update_images_framechange(void);
123 int GPU_update_image_time(struct Image *ima, double time);
124 int GPU_verify_image(struct Image *ima, struct ImageUser *iuser, int tftile, int compare, int mipmap);
125 void GPU_free_image(struct Image *ima);
126 void GPU_free_images(void);
127 void GPU_free_images_anim(void);
128
129 /* smoke drawing functions */
130 void GPU_free_smoke(struct SmokeModifierData *smd);
131 void GPU_create_smoke(struct SmokeModifierData *smd, int highres);
132
133 /* Delayed free of OpenGL buffers by main thread */
134 void GPU_free_unused_buffers(void);
135
136 #ifdef __cplusplus
137 }
138 #endif
139
140 #endif
141