Merge branch 'master' into blender2.8
[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 /* Mipmap settings
69  * - these will free textures on changes */
70
71 void GPU_set_mipmap(bool mipmap);
72 bool GPU_get_mipmap(void);
73 void GPU_set_linear_mipmap(bool linear);
74 bool GPU_get_linear_mipmap(void);
75 void GPU_paint_set_mipmap(bool mipmap);
76
77 /* Anisotropic filtering settings
78  * - these will free textures on changes */
79 void GPU_set_anisotropic(float value);
80 float GPU_get_anisotropic(void);
81
82 /* enable gpu mipmapping */
83 void GPU_set_gpu_mipmapping(int gpu_mipmap);
84
85 /* Image updates and free
86  * - these deal with images bound as opengl textures */
87
88 void GPU_paint_update_image(struct Image *ima, struct ImageUser *iuser, int x, int y, int w, int h);
89 int GPU_verify_image(
90         struct Image *ima, struct ImageUser *iuser,
91         int textarget, bool compare, bool mipmap, bool is_data);
92 void GPU_create_gl_tex(
93         unsigned int *bind, unsigned int *rect, float *frect, int rectw, int recth,
94         int textarget, bool mipmap, bool use_hight_bit_depth, struct Image *ima);
95 void GPU_create_gl_tex_compressed(
96         unsigned int *bind, unsigned int *pix, int x, int y, int mipmap,
97         int textarget, struct Image *ima, struct ImBuf *ibuf);
98 bool GPU_upload_dxt_texture(struct ImBuf *ibuf);
99 void GPU_free_image(struct Image *ima);
100 void GPU_free_images(void);
101 void GPU_free_images_anim(void);
102 void GPU_free_images_old(void);
103
104 /* smoke drawing functions */
105 void GPU_free_smoke(struct SmokeModifierData *smd);
106 void GPU_create_smoke(struct SmokeModifierData *smd, int highres);
107
108 /* Delayed free of OpenGL buffers by main thread */
109 void GPU_free_unused_buffers(void);
110
111 /* utilities */
112 void    GPU_select_index_set(int index);
113 void    GPU_select_index_get(int index, int *r_col);
114 int             GPU_select_to_index(unsigned int col);
115 void    GPU_select_to_index_array(unsigned int *col, const unsigned int size);
116
117 typedef enum eGPUAttribMask {
118         GPU_DEPTH_BUFFER_BIT = (1 << 0),
119         GPU_ENABLE_BIT = (1 << 1),
120         GPU_SCISSOR_BIT = (1 << 2),
121         GPU_VIEWPORT_BIT = (1 << 3),
122         GPU_BLEND_BIT = (1 << 4),
123 } eGPUAttribMask;
124
125 void gpuPushAttrib(eGPUAttribMask mask);
126 void gpuPopAttrib(void);
127
128 #ifdef __cplusplus
129 }
130 #endif
131
132 #endif
133