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