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