Cleanup: use bool for mipmap args
[blender.git] / source / blender / gpu / GPU_draw.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program 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.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_draw.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_DRAW_H__
33 #define __GPU_DRAW_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct ImBuf;
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 /* Material drawing
62  * - first the state is initialized by a particular object and
63  *   it's materials
64  * - after this, materials can be quickly enabled by their number,
65  *   GPU_enable_material returns 0 if drawing should be skipped
66  * - after drawing, the material must be disabled again */
67
68 void GPU_begin_object_materials(struct View3D *v3d, struct RegionView3D *rv3d, 
69                                 struct Scene *scene, struct Object *ob, bool glsl, bool *do_alpha_after);
70 void GPU_end_object_materials(void);
71
72 int GPU_enable_material(int nr, void *attribs);
73 void GPU_disable_material(void);
74
75 void GPU_material_diffuse_get(int nr, float diff[4]);
76 bool GPU_material_use_matcaps_get(void);
77
78 void GPU_set_material_alpha_blend(int alphablend);
79 int GPU_get_material_alpha_blend(void);
80
81 /* TexFace drawing
82  * - this is mutually exclusive with material drawing, a mesh should
83  *   be drawn using one or the other
84  * - passing NULL clears the state again */
85
86 int GPU_set_tpage(struct MTFace *tface, int mipmap, int transp);
87 void GPU_clear_tpage(bool force);
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][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(bool mipmap);
108 bool GPU_get_mipmap(void);
109 void GPU_set_linear_mipmap(bool linear);
110 bool GPU_get_linear_mipmap(void);
111 void GPU_paint_set_mipmap(bool 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 /* enable gpu mipmapping */
119 void GPU_set_gpu_mipmapping(int gpu_mipmap);
120
121 /* Image updates and free
122  * - these deal with images bound as opengl textures */
123
124 void GPU_paint_update_image(struct Image *ima, ImageUser *iuser, int x, int y, int w, int h);
125 void GPU_update_images_framechange(void);
126 int GPU_update_image_time(struct Image *ima, double time);
127 int GPU_verify_image(struct Image *ima, struct ImageUser *iuser, int tftile, bool compare, bool mipmap, bool is_data);
128 void GPU_create_gl_tex(unsigned int *bind, unsigned int *rect, float *frect, int rectw, int recth,
129                        bool mipmap, bool use_hight_bit_depth, struct Image *ima);
130 void GPU_create_gl_tex_compressed(unsigned int *bind, unsigned int *pix, int x, int y, int mipmap, struct Image *ima, struct ImBuf *ibuf);
131 bool GPU_upload_dxt_texture(struct ImBuf *ibuf);
132 void GPU_free_image(struct Image *ima);
133 void GPU_free_images(void);
134 void GPU_free_images_anim(void);
135 void GPU_free_images_old(void);
136
137 /* smoke drawing functions */
138 void GPU_free_smoke(struct SmokeModifierData *smd);
139 void GPU_create_smoke(struct SmokeModifierData *smd, int highres);
140
141 /* Delayed free of OpenGL buffers by main thread */
142 void GPU_free_unused_buffers(void);
143
144 #ifdef __cplusplus
145 }
146 #endif
147
148 #endif
149