SCons / epydoc support
[blender.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 MTFace;
41 struct Image;
42 struct Scene;
43 struct Object;
44
45 /* OpenGL drawing functions related to shading. These are also
46  * shared with the game engine, where there were previously
47  * duplicates of some of these functions. */
48
49 /* Initialize
50  * - sets the default Blender opengl state, if in doubt, check
51  *   the contents of this function
52  * - this is called when starting Blender, for opengl rendering,
53  *   and for switching back from the game engine for example. */
54
55 void GPU_state_init(void);
56
57 /* Material drawing
58  * - first the state is initialized by a particular object and
59  *   it's materials
60  * - after this, materials can be quickly enabled by their number,
61  *   GPU_enable_material returns 0 if drawing should be skipped
62  * - after drawing, the material must be disabled again */
63
64 void GPU_set_object_materials(struct Scene *scene, struct Object *ob,
65         int glsl, int *do_alpha_pass);
66 int GPU_enable_material(int nr, void *attribs);
67 void GPU_disable_material(void);
68
69 void GPU_set_material_blend_mode(int blendmode);
70 int GPU_get_material_blend_mode(void);
71
72 /* TexFace drawing
73  * - this is mutually exclusive with material drawing, a mesh should
74  *   be drawn using one or the other
75  * - passing NULL clears the state again */
76
77 int GPU_set_tpage(struct MTFace *tface);
78
79 /* Lights
80  * - returns how many lights were enabled
81  * - this affects fixed functions materials and texface, not glsl */
82
83 int GPU_default_lights(void);
84 int GPU_scene_object_lights(struct Scene *scene, struct Object *ob,
85         int lay, float viewmat[][4], int ortho);
86
87 /* Text render
88  * - based on moving uv coordinates */
89
90 void GPU_render_text(struct MTFace *tface, int mode,
91         const char *textstr, int textlen, unsigned int *col,
92         float *v1, float *v2, float *v3, float *v4, int glattrib);
93
94 /* Mipmap settings
95  * - these will free textures on changes */
96
97 void GPU_set_mipmap(int mipmap);
98 void GPU_set_linear_mipmap(int linear);
99 void GPU_paint_set_mipmap(int mipmap);
100
101 /* Image updates and free
102  * - these deal with images bound as opengl textures */
103
104 void GPU_paint_update_image(struct Image *ima, int x, int y, int w, int h);
105 void GPU_update_images_framechange(void);
106 int GPU_update_image_time(struct Image *ima, double time);
107 int GPU_verify_image(struct Image *ima, int tftile, int tfmode, int compare);
108 void GPU_free_image(struct Image *ima);
109 void GPU_free_images(void);
110
111 #ifdef __cplusplus
112 }
113 #endif
114
115 #endif
116