Draw Manager: replace varargs with a pointer array
[blender.git] / source / blender / draw / intern / DRW_render.h
1 /*
2  * Copyright 2016, Blender Foundation.
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  * Contributor(s): Blender Institute
19  *
20  */
21
22 /** \file DRW_render.h
23  *  \ingroup draw
24  */
25
26 /* This is the Render Functions used by Realtime engines to draw with OpenGL */
27
28 #ifndef __DRW_RENDER_H__
29 #define __DRW_RENDER_H__
30
31 #include "BKE_context.h"
32 #include "BKE_layer.h"
33 #include "BKE_scene.h"
34
35 #include "BLI_listbase.h"
36 #include "BLI_math_matrix.h"
37 #include "BLI_math_vector.h"
38 #include "BLI_string.h"
39
40 #include "BLT_translation.h"
41
42 #include "DNA_object_types.h"
43 #include "DNA_lamp_types.h"
44 #include "DNA_material_types.h"
45 #include "DNA_scene_types.h"
46
47 #include "draw_common.h"
48 #include "draw_cache.h"
49 #include "draw_view.h"
50
51 #include "MEM_guardedalloc.h"
52
53 #include "RE_engine.h"
54
55 struct bContext;
56 struct GPUFrameBuffer;
57 struct GPUShader;
58 struct GPUTexture;
59 struct GPUUniformBuffer;
60 struct Object;
61 struct Batch;
62 struct DefaultFramebufferList;
63 struct DefaultTextureList;
64 struct LampEngineData;
65 struct RenderEngineType;
66
67 typedef struct DRWUniform DRWUniform;
68 typedef struct DRWInterface DRWInterface;
69 typedef struct DRWPass DRWPass;
70 typedef struct DRWShadingGroup DRWShadingGroup;
71
72 typedef struct DrawEngineType {
73         struct DrawEngineType *next, *prev;
74
75         char idname[32];
76
77         void (*engine_init)(void *vedata);
78         void (*engine_free)(void);
79
80         void (*cache_init)(void *vedata);
81         void (*cache_populate)(void *vedata, struct Object *ob);
82         void (*cache_finish)(void *vedata);
83
84         void (*draw_background)(void *vedata);
85         void (*draw_scene)(void *vedata);
86 } DrawEngineType;
87
88 #ifndef __DRW_ENGINE_H__
89 /* Buffer and textures used by the viewport by default */
90 typedef struct DefaultFramebufferList {
91         struct GPUFrameBuffer *default_fb;
92 } DefaultFramebufferList;
93
94 typedef struct DefaultTextureList {
95         struct GPUTexture *color;
96         struct GPUTexture *depth;
97 } DefaultTextureList;
98 #endif
99
100 /* Textures */
101
102 typedef enum {
103         DRW_TEX_RGBA_8,
104         DRW_TEX_RGBA_16,
105         DRW_TEX_RGBA_32,
106         DRW_TEX_RGB_8,
107         DRW_TEX_RGB_16,
108         DRW_TEX_RGB_32,
109         DRW_TEX_RG_8,
110         DRW_TEX_RG_16,
111         DRW_TEX_RG_32,
112         DRW_TEX_R_8,
113         DRW_TEX_R_16,
114         DRW_TEX_R_32,
115         DRW_TEX_DEPTH_16,
116         DRW_TEX_DEPTH_24,
117         DRW_TEX_DEPTH_32,
118 } DRWTextureFormat;
119
120 typedef enum {
121         DRW_TEX_FILTER = (1 << 0),
122         DRW_TEX_WRAP = (1 << 1),
123         DRW_TEX_COMPARE = (1 << 2),
124 } DRWTextureFlag;
125
126 struct GPUTexture *DRW_texture_create_1D(
127         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
128 struct GPUTexture *DRW_texture_create_2D(
129         int w, int h, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
130 struct GPUTexture *DRW_texture_create_2D_array(
131         int w, int h, int d, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
132 struct GPUTexture *DRW_texture_create_cube(
133         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
134 void DRW_texture_free(struct GPUTexture *tex);
135
136 /* UBOs */
137 struct GPUUniformBuffer *DRW_uniformbuffer_create(int size, const void *data);
138 void DRW_uniformbuffer_update(struct GPUUniformBuffer *ubo, const void *data);
139 void DRW_uniformbuffer_free(struct GPUUniformBuffer *ubo);
140
141 /* Buffers */
142
143 /* DRWFboTexture->format */
144 #define DRW_BUF_DEPTH_16                1
145 #define DRW_BUF_DEPTH_24                2
146 #define DRW_BUF_R_8                             3
147 #define DRW_BUF_R_16                    4
148 #define DRW_BUF_R_32                    5
149 #define DRW_BUF_RG_8                    6
150 #define DRW_BUF_RG_16                   7
151 #define DRW_BUF_RG_32                   8
152 #define DRW_BUF_RGB_8                   9
153 #define DRW_BUF_RGB_16                  10
154 #define DRW_BUF_RGB_32                  11
155 #define DRW_BUF_RGBA_8                  12
156 #define DRW_BUF_RGBA_16                 13
157 #define DRW_BUF_RGBA_32                 14
158
159 #define MAX_FBO_TEX                     5
160
161 typedef struct DRWFboTexture {
162         struct GPUTexture **tex;
163         int format;
164         DRWTextureFlag flag;
165 } DRWFboTexture;
166
167 void DRW_framebuffer_init(struct GPUFrameBuffer **fb, int width, int height, DRWFboTexture textures[MAX_FBO_TEX], int texnbr);
168 void DRW_framebuffer_bind(struct GPUFrameBuffer *fb);
169 void DRW_framebuffer_clear(bool color, bool depth, bool stencil, float clear_col[4], float clear_depth);
170 void DRW_framebuffer_texture_attach(struct GPUFrameBuffer *fb, struct GPUTexture *tex, int slot);
171 void DRW_framebuffer_texture_detach(struct GPUTexture *tex);
172 void DRW_framebuffer_blit(struct GPUFrameBuffer *fb_read, struct GPUFrameBuffer *fb_write, bool depth);
173
174 /* Shaders */
175 struct GPUShader *DRW_shader_create(const char *vert, const char *geom, const char *frag, const char *defines);
176 struct GPUShader *DRW_shader_create_with_lib(const char *vert, const char *geom, const char *frag, const char *lib, const char *defines);
177 struct GPUShader *DRW_shader_create_2D(const char *frag, const char *defines);
178 struct GPUShader *DRW_shader_create_3D(const char *frag, const char *defines);
179 struct GPUShader *DRW_shader_create_fullscreen(const char *frag, const char *defines);
180 struct GPUShader *DRW_shader_create_3D_depth_only(void);
181 void DRW_shader_free(struct GPUShader *shader);
182
183 /* Batches */
184
185 typedef enum {
186         DRW_STATE_WRITE_DEPTH   = (1 << 0),
187         DRW_STATE_WRITE_COLOR   = (1 << 1),
188         DRW_STATE_DEPTH_LESS    = (1 << 2),
189         DRW_STATE_DEPTH_EQUAL   = (1 << 3),
190         DRW_STATE_DEPTH_GREATER = (1 << 4),
191         DRW_STATE_CULL_BACK     = (1 << 5),
192         DRW_STATE_CULL_FRONT    = (1 << 6),
193         DRW_STATE_WIRE          = (1 << 7),
194         DRW_STATE_WIRE_LARGE    = (1 << 8),
195         DRW_STATE_POINT         = (1 << 9),
196         DRW_STATE_STIPPLE_2     = (1 << 10),
197         DRW_STATE_STIPPLE_3     = (1 << 11),
198         DRW_STATE_STIPPLE_4     = (1 << 12),
199         DRW_STATE_BLEND         = (1 << 13),
200
201         DRW_STATE_WRITE_STENCIL_SELECT = (1 << 14),
202         DRW_STATE_WRITE_STENCIL_ACTIVE = (1 << 15),
203         DRW_STATE_TEST_STENCIL_SELECT  = (1 << 16),
204         DRW_STATE_TEST_STENCIL_ACTIVE  = (1 << 17),
205 } DRWState;
206
207 DRWShadingGroup *DRW_shgroup_create(struct GPUShader *shader, DRWPass *pass);
208 DRWShadingGroup *DRW_shgroup_instance_create(struct GPUShader *shader, DRWPass *pass, struct Batch *geom);
209 DRWShadingGroup *DRW_shgroup_point_batch_create(struct GPUShader *shader, DRWPass *pass);
210 DRWShadingGroup *DRW_shgroup_line_batch_create(struct GPUShader *shader, DRWPass *pass);
211
212 void DRW_shgroup_free(struct DRWShadingGroup *shgroup);
213 void DRW_shgroup_call_add(DRWShadingGroup *shgroup, struct Batch *geom, float (*obmat)[4]);
214 void DRW_shgroup_dynamic_call_add_array(DRWShadingGroup *shgroup, const void **attr, unsigned int attr_len);
215 #define DRW_shgroup_dynamic_call_add(shgroup, ...) do { \
216         const void *array[] = {__VA_ARGS__}; \
217         DRW_shgroup_dynamic_call_add_array(shgroup, array, (sizeof(array) / sizeof(*array))); \
218 } while (0)
219
220 void DRW_shgroup_state_set(DRWShadingGroup *shgroup, DRWState state);
221 void DRW_shgroup_attrib_int(DRWShadingGroup *shgroup, const char *name, int size);
222 void DRW_shgroup_attrib_float(DRWShadingGroup *shgroup, const char *name, int size);
223
224 void DRW_shgroup_uniform_texture(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex, int loc);
225 void DRW_shgroup_uniform_block(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo, int loc);
226 void DRW_shgroup_uniform_buffer(DRWShadingGroup *shgroup, const char *name, struct GPUTexture **tex, int loc);
227 void DRW_shgroup_uniform_bool(DRWShadingGroup *shgroup, const char *name, const bool *value, int arraysize);
228 void DRW_shgroup_uniform_float(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
229 void DRW_shgroup_uniform_vec2(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
230 void DRW_shgroup_uniform_vec3(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
231 void DRW_shgroup_uniform_vec4(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
232 void DRW_shgroup_uniform_int(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
233 void DRW_shgroup_uniform_ivec2(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
234 void DRW_shgroup_uniform_ivec3(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
235 void DRW_shgroup_uniform_mat3(DRWShadingGroup *shgroup, const char *name, const float *value);
236 void DRW_shgroup_uniform_mat4(DRWShadingGroup *shgroup, const char *name, const float *value);
237
238 /* Passes */
239 DRWPass *DRW_pass_create(const char *name, DRWState state);
240
241 /* Viewport */
242 typedef enum {
243         DRW_MAT_PERS,
244         DRW_MAT_VIEW,
245         DRW_MAT_VIEWINV,
246         DRW_MAT_WIN,
247 } DRWViewportMatrixType;
248
249 void DRW_viewport_init(const bContext *C);
250 void DRW_viewport_matrix_get(float mat[4][4], DRWViewportMatrixType type);
251 float *DRW_viewport_size_get(void);
252 float *DRW_viewport_screenvecs_get(void);
253 float *DRW_viewport_pixelsize_get(void);
254 bool DRW_viewport_is_persp_get(void);
255 bool DRW_viewport_cache_is_dirty(void);
256
257 struct DefaultFramebufferList *DRW_viewport_framebuffer_list_get(void);
258 struct DefaultTextureList     *DRW_viewport_texture_list_get(void);
259
260 /* Objects */
261 void **DRW_object_engine_data_get(Object *ob, DrawEngineType *det);
262 struct LampEngineData *DRW_lamp_engine_data_get(Object *ob, struct RenderEngineType *engine_type);
263 void DRW_lamp_engine_data_free(struct LampEngineData *led);
264
265 /* Settings */
266 bool DRW_is_object_renderable(struct Object *ob);
267
268 /* Draw commands */
269 void DRW_draw_pass(DRWPass *pass);
270
271 void DRW_draw_callbacks_pre_scene(void);
272 void DRW_draw_callbacks_post_scene(void);
273
274 void DRW_state_reset(void);
275
276 /* Other */
277 void DRW_get_dfdy_factors(float dfdyfac[2]);
278 const struct bContext *DRW_get_context(void);
279 #endif /* __DRW_RENDER_H__ */