Remove game properties in image editor
[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 Object;
43 struct Scene;
44 struct ViewLayer;
45 struct View3D;
46 struct RegionView3D;
47 struct SmokeModifierData;
48 struct DupliObject;
49
50 #include "DNA_object_enums.h"
51
52 /* OpenGL drawing functions related to shading. */
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
59 void GPU_state_init(void);
60
61 /* Programmable point size
62  * - shaders set their own point size when enabled
63  * - use glPointSize when disabled */
64
65 void GPU_enable_program_point_size(void);
66 void GPU_disable_program_point_size(void);
67
68 /* Material drawing
69  * - first the state is initialized by a particular object and
70  *   it's materials
71  * - after this, materials can be quickly enabled by their number,
72  *   GPU_object_material_bind returns 0 if drawing should be skipped
73  * - after drawing, the material must be disabled again */
74
75 void GPU_begin_object_materials(
76         struct View3D *v3d, struct RegionView3D *rv3d,
77         struct Scene *scene, struct ViewLayer *view_layer,
78         struct Object *ob, bool glsl, bool *do_alpha_after);
79 void GPU_end_object_materials(void);
80 bool GPU_object_materials_check(void);
81
82 int GPU_object_material_bind(int nr, void *attribs);
83 void GPU_object_material_unbind(void);
84 int GPU_object_material_visible(int nr, void *attribs);
85
86 void GPU_begin_dupli_object(struct DupliObject *dob);
87 void GPU_end_dupli_object(void);
88
89 void GPU_material_diffuse_get(int nr, float diff[4]);
90 bool GPU_material_use_matcaps_get(void);
91
92 void GPU_set_material_alpha_blend(int alphablend);
93 int GPU_get_material_alpha_blend(void);
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 ViewLayer *view_layer, float viewmat[4][4], int ortho);
102
103 /* Mipmap settings
104  * - these will free textures on changes */
105
106 void GPU_set_mipmap(bool mipmap);
107 bool GPU_get_mipmap(void);
108 void GPU_set_linear_mipmap(bool linear);
109 bool GPU_get_linear_mipmap(void);
110 void GPU_paint_set_mipmap(bool mipmap);
111
112 /* Anisotropic filtering settings
113  * - these will free textures on changes */
114 void GPU_set_anisotropic(float value);
115 float GPU_get_anisotropic(void);
116
117 /* enable gpu mipmapping */
118 void GPU_set_gpu_mipmapping(int gpu_mipmap);
119
120 /* Image updates and free
121  * - these deal with images bound as opengl textures */
122
123 void GPU_paint_update_image(struct Image *ima, struct ImageUser *iuser, int x, int y, int w, int h);
124 int GPU_verify_image(
125         struct Image *ima, struct ImageUser *iuser,
126         int textarget, bool compare, bool mipmap, bool is_data);
127 void GPU_create_gl_tex(
128         unsigned int *bind, unsigned int *rect, float *frect, int rectw, int recth,
129         int textarget, bool mipmap, bool use_hight_bit_depth, struct Image *ima);
130 void GPU_create_gl_tex_compressed(
131         unsigned int *bind, unsigned int *pix, int x, int y, int mipmap,
132         int textarget, struct Image *ima, struct ImBuf *ibuf);
133 bool GPU_upload_dxt_texture(struct ImBuf *ibuf);
134 void GPU_free_image(struct Image *ima);
135 void GPU_free_images(void);
136 void GPU_free_images_anim(void);
137 void GPU_free_images_old(void);
138
139 /* smoke drawing functions */
140 void GPU_free_smoke(struct SmokeModifierData *smd);
141 void GPU_create_smoke(struct SmokeModifierData *smd, int highres);
142
143 /* Delayed free of OpenGL buffers by main thread */
144 void GPU_free_unused_buffers(void);
145
146 #ifdef WITH_OPENSUBDIV
147 struct DerivedMesh;
148 void GPU_draw_update_fvar_offset(struct DerivedMesh *dm);
149 #endif
150
151 /* utilities */
152 void    GPU_select_index_set(int index);
153 void    GPU_select_index_get(int index, int *r_col);
154 int             GPU_select_to_index(unsigned int col);
155 void    GPU_select_to_index_array(unsigned int *col, const unsigned int size);
156
157 typedef enum eGPUAttribMask {
158         GPU_DEPTH_BUFFER_BIT = (1 << 0),
159         GPU_ENABLE_BIT = (1 << 1),
160         GPU_SCISSOR_BIT = (1 << 2),
161         GPU_VIEWPORT_BIT = (1 << 3),
162         GPU_BLEND_BIT = (1 << 4),
163 } eGPUAttribMask;
164
165 void gpuPushAttrib(eGPUAttribMask mask);
166 void gpuPopAttrib(void);
167
168 #ifdef __cplusplus
169 }
170 #endif
171
172 #endif
173