Object Mode: Add to EvaluationContext & DRWContextState
[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 "BLI_listbase.h"
32 #include "BLI_math_matrix.h"
33 #include "BLI_math_vector.h"
34 #include "BLI_string.h"
35
36 #include "BKE_context.h"
37 #include "BKE_layer.h"
38 #include "BKE_material.h"
39 #include "BKE_scene.h"
40
41 #include "BLT_translation.h"
42
43 #include "DNA_object_types.h"
44 #include "DNA_lamp_types.h"
45 #include "DNA_material_types.h"
46 #include "DNA_scene_types.h"
47
48 #include "draw_common.h"
49 #include "draw_cache.h"
50 #include "draw_view.h"
51
52 #include "draw_manager_profiling.h"
53
54 #include "MEM_guardedalloc.h"
55
56 #include "RE_engine.h"
57
58 struct bContext;
59 struct GPUFrameBuffer;
60 struct GPUShader;
61 struct GPUMaterial;
62 struct GPUTexture;
63 struct GPUUniformBuffer;
64 struct Object;
65 struct Gwn_Batch;
66 struct DefaultFramebufferList;
67 struct DefaultTextureList;
68 struct DRWTextStore;
69 struct LampEngineData;
70 struct RenderEngineType;
71 struct ViewportEngineData;
72 struct ViewportEngineData_Info;
73
74 typedef struct DRWUniform DRWUniform;
75 typedef struct DRWInterface DRWInterface;
76 typedef struct DRWPass DRWPass;
77 typedef struct DRWShadingGroup DRWShadingGroup;
78
79 /* declare members as empty (unused) */
80 typedef char DRWViewportEmptyList;
81
82 #define DRW_VIEWPORT_LIST_SIZE(list) \
83         (sizeof(list) == sizeof(DRWViewportEmptyList) ? 0 : ((sizeof(list)) / sizeof(void *)))
84
85 /* Unused members must be either pass list or 'char *' when not usd. */
86 #define DRW_VIEWPORT_DATA_SIZE(ty) { \
87         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->fbl)), \
88         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->txl)), \
89         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->psl)), \
90         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->stl)) \
91 }
92
93 /* Use of multisample framebuffers. */
94 #define MULTISAMPLE_SYNC_ENABLE(dfbl) { \
95         if (dfbl->multisample_fb != NULL) { \
96                 DRW_stats_query_start("Multisample Blit"); \
97                 DRW_framebuffer_blit(dfbl->default_fb, dfbl->multisample_fb, false, false); \
98                 DRW_framebuffer_blit(dfbl->default_fb, dfbl->multisample_fb, true, false); \
99                 DRW_framebuffer_bind(dfbl->multisample_fb); \
100                 DRW_stats_query_end(); \
101         } \
102 }
103
104 #define MULTISAMPLE_SYNC_DISABLE(dfbl) { \
105         if (dfbl->multisample_fb != NULL) { \
106                 DRW_stats_query_start("Multisample Resolve"); \
107                 DRW_framebuffer_blit(dfbl->multisample_fb, dfbl->default_fb, false, false); \
108                 DRW_framebuffer_blit(dfbl->multisample_fb, dfbl->default_fb, true, false); \
109                 DRW_framebuffer_bind(dfbl->default_fb); \
110                 DRW_stats_query_end(); \
111         } \
112 }
113
114
115
116 typedef struct DrawEngineDataSize {
117         int fbl_len;
118         int txl_len;
119         int psl_len;
120         int stl_len;
121 } DrawEngineDataSize;
122
123 typedef struct DrawEngineType {
124         struct DrawEngineType *next, *prev;
125
126         char idname[32];
127
128         const DrawEngineDataSize *vedata_size;
129
130         void (*engine_init)(void *vedata);
131         void (*engine_free)(void);
132
133         void (*cache_init)(void *vedata);
134         void (*cache_populate)(void *vedata, struct Object *ob);
135         void (*cache_finish)(void *vedata);
136
137         void (*draw_background)(void *vedata);
138         void (*draw_scene)(void *vedata);
139
140         void (*view_update)(void *vedata);
141         void (*id_update)(void *vedata, struct ID *id);
142
143         void (*render_to_image)(void *vedata, struct RenderEngine *engine, struct Depsgraph *graph);
144 } DrawEngineType;
145
146 #ifndef __DRW_ENGINE_H__
147 /* Buffer and textures used by the viewport by default */
148 typedef struct DefaultFramebufferList {
149         struct GPUFrameBuffer *default_fb;
150         struct GPUFrameBuffer *multisample_fb;
151 } DefaultFramebufferList;
152
153 typedef struct DefaultTextureList {
154         struct GPUTexture *color;
155         struct GPUTexture *depth;
156         struct GPUTexture *multisample_color;
157         struct GPUTexture *multisample_depth;
158 } DefaultTextureList;
159 #endif
160
161 /* Textures */
162 /* NOTE naming in this struct is broken.
163  * There should either be suffixes for Normalized int formats or float formats.
164  * Right now every 8bit texture is Normalized int and others are Floating point. */
165 typedef enum {
166         DRW_TEX_RGBA_8,
167         DRW_TEX_RGBA_16,
168         DRW_TEX_RGBA_32,
169         DRW_TEX_RGB_11_11_10,
170         DRW_TEX_RGB_8,
171         DRW_TEX_RGB_16,
172         DRW_TEX_RGB_32,
173         DRW_TEX_RG_8,
174         DRW_TEX_RG_16,
175         DRW_TEX_RG_16I,
176         DRW_TEX_RG_32,
177         DRW_TEX_R_8,
178         DRW_TEX_R_16,
179         DRW_TEX_R_32,
180         DRW_TEX_DEPTH_16,
181         DRW_TEX_DEPTH_24,
182         DRW_TEX_DEPTH_24_STENCIL_8,
183         DRW_TEX_DEPTH_32,
184 } DRWTextureFormat;
185
186 typedef enum {
187         DRW_TEX_FILTER = (1 << 0),
188         DRW_TEX_WRAP = (1 << 1),
189         DRW_TEX_COMPARE = (1 << 2),
190         DRW_TEX_MIPMAP = (1 << 3),
191         DRW_TEX_TEMP = (1 << 4),
192 } DRWTextureFlag;
193
194 struct GPUTexture *DRW_texture_create_1D(
195         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
196 struct GPUTexture *DRW_texture_create_2D(
197         int w, int h, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
198 struct GPUTexture *DRW_texture_create_2D_array(
199         int w, int h, int d, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
200 struct GPUTexture *DRW_texture_create_3D(
201         int w, int h, int d, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
202 struct GPUTexture *DRW_texture_create_cube(
203         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
204 void DRW_texture_generate_mipmaps(struct GPUTexture *tex);
205 void DRW_texture_update(struct GPUTexture *tex, const float *pixels);
206 void DRW_texture_free(struct GPUTexture *tex);
207 #define DRW_TEXTURE_FREE_SAFE(tex) do { \
208         if (tex != NULL) { \
209                 DRW_texture_free(tex); \
210                 tex = NULL; \
211         } \
212 } while (0)
213
214 /* UBOs */
215 struct GPUUniformBuffer *DRW_uniformbuffer_create(int size, const void *data);
216 void DRW_uniformbuffer_update(struct GPUUniformBuffer *ubo, const void *data);
217 void DRW_uniformbuffer_free(struct GPUUniformBuffer *ubo);
218 #define DRW_UBO_FREE_SAFE(ubo) do { \
219         if (ubo != NULL) { \
220                 DRW_uniformbuffer_free(ubo); \
221                 ubo = NULL; \
222         } \
223 } while (0)
224
225 /* Buffers */
226 #define MAX_FBO_TEX                     5
227
228 typedef struct DRWFboTexture {
229         struct GPUTexture **tex;
230         int format;
231         DRWTextureFlag flag;
232 } DRWFboTexture;
233
234 struct GPUFrameBuffer *DRW_framebuffer_create(void);
235 void DRW_framebuffer_init(
236         struct GPUFrameBuffer **fb, void *engine_type, int width, int height,
237         DRWFboTexture textures[MAX_FBO_TEX], int textures_len);
238 void DRW_framebuffer_bind(struct GPUFrameBuffer *fb);
239 void DRW_framebuffer_clear(bool color, bool depth, bool stencil, float clear_col[4], float clear_depth);
240 void DRW_framebuffer_read_data(int x, int y, int w, int h, int channels, int slot, float *data);
241 void DRW_framebuffer_read_depth(int x, int y, int w, int h, float *data);
242 void DRW_framebuffer_texture_attach(struct GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int mip);
243 void DRW_framebuffer_texture_layer_attach(struct GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int layer, int mip);
244 void DRW_framebuffer_cubeface_attach(struct GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int face, int mip);
245 void DRW_framebuffer_texture_detach(struct GPUTexture *tex);
246 void DRW_framebuffer_blit(struct GPUFrameBuffer *fb_read, struct GPUFrameBuffer *fb_write, bool depth, bool stencil);
247 void DRW_framebuffer_recursive_downsample(
248         struct GPUFrameBuffer *fb, struct GPUTexture *tex, int num_iter,
249         void (*callback)(void *userData, int level), void *userData);
250 void DRW_framebuffer_viewport_size(struct GPUFrameBuffer *fb_read, int x, int y, int w, int h);
251 void DRW_framebuffer_free(struct GPUFrameBuffer *fb);
252 #define DRW_FRAMEBUFFER_FREE_SAFE(fb) do { \
253         if (fb != NULL) { \
254                 DRW_framebuffer_free(fb); \
255                 fb = NULL; \
256         } \
257 } while (0)
258
259 void DRW_transform_to_display(struct GPUTexture *tex);
260
261 /* Shaders */
262 struct GPUShader *DRW_shader_create(
263         const char *vert, const char *geom, const char *frag, const char *defines);
264 struct GPUShader *DRW_shader_create_with_lib(
265         const char *vert, const char *geom, const char *frag, const char *lib, const char *defines);
266 struct GPUShader *DRW_shader_create_2D(const char *frag, const char *defines);
267 struct GPUShader *DRW_shader_create_3D(const char *frag, const char *defines);
268 struct GPUShader *DRW_shader_create_fullscreen(const char *frag, const char *defines);
269 struct GPUShader *DRW_shader_create_3D_depth_only(void);
270 void DRW_shader_free(struct GPUShader *shader);
271 #define DRW_SHADER_FREE_SAFE(shader) do { \
272         if (shader != NULL) { \
273                 DRW_shader_free(shader); \
274                 shader = NULL; \
275         } \
276 } while (0)
277
278 /* Batches */
279
280 typedef enum {
281         DRW_STATE_WRITE_DEPTH   = (1 << 0),
282         DRW_STATE_WRITE_COLOR   = (1 << 1),
283         DRW_STATE_DEPTH_LESS    = (1 << 2),
284         DRW_STATE_DEPTH_EQUAL   = (1 << 3),
285         DRW_STATE_DEPTH_GREATER = (1 << 4),
286         DRW_STATE_DEPTH_ALWAYS  = (1 << 5),
287         DRW_STATE_CULL_BACK     = (1 << 6),
288         DRW_STATE_CULL_FRONT    = (1 << 7),
289         DRW_STATE_WIRE          = (1 << 8),
290         DRW_STATE_WIRE_LARGE    = (1 << 9),
291         DRW_STATE_POINT         = (1 << 10),
292         DRW_STATE_STIPPLE_2     = (1 << 11),
293         DRW_STATE_STIPPLE_3     = (1 << 12),
294         DRW_STATE_STIPPLE_4     = (1 << 13),
295         DRW_STATE_BLEND         = (1 << 14),
296         DRW_STATE_ADDITIVE      = (1 << 15),
297         DRW_STATE_MULTIPLY      = (1 << 16),
298         DRW_STATE_TRANSMISSION  = (1 << 17),
299         DRW_STATE_CLIP_PLANES   = (1 << 18),
300         DRW_STATE_ADDITIVE_FULL = (1 << 19), /* Same as DRW_STATE_ADDITIVE but let alpha accumulate without premult. */
301
302         DRW_STATE_WRITE_STENCIL    = (1 << 27),
303         DRW_STATE_STENCIL_EQUAL    = (1 << 28),
304 } DRWState;
305
306 #define DRW_STATE_DEFAULT (DRW_STATE_WRITE_DEPTH | DRW_STATE_WRITE_COLOR | DRW_STATE_DEPTH_LESS)
307
308
309 DRWShadingGroup *DRW_shgroup_create(struct GPUShader *shader, DRWPass *pass);
310 DRWShadingGroup *DRW_shgroup_material_create(struct GPUMaterial *material, DRWPass *pass);
311 DRWShadingGroup *DRW_shgroup_material_instance_create(
312         struct GPUMaterial *material, DRWPass *pass, struct Gwn_Batch *geom, struct Object *ob);
313 DRWShadingGroup *DRW_shgroup_material_empty_tri_batch_create(struct GPUMaterial *material, DRWPass *pass, int size);
314 DRWShadingGroup *DRW_shgroup_instance_create(struct GPUShader *shader, DRWPass *pass, struct Gwn_Batch *geom);
315 DRWShadingGroup *DRW_shgroup_point_batch_create(struct GPUShader *shader, DRWPass *pass);
316 DRWShadingGroup *DRW_shgroup_line_batch_create(struct GPUShader *shader, DRWPass *pass);
317 DRWShadingGroup *DRW_shgroup_empty_tri_batch_create(struct GPUShader *shader, DRWPass *pass, int size);
318
319 typedef void (DRWCallGenerateFn)(
320         DRWShadingGroup *shgroup,
321         void (*draw_fn)(DRWShadingGroup *shgroup, struct Gwn_Batch *geom),
322         void *user_data);
323
324 void DRW_shgroup_instance_batch(DRWShadingGroup *shgroup, struct Gwn_Batch *instances);
325
326 void DRW_shgroup_free(struct DRWShadingGroup *shgroup);
327 void DRW_shgroup_call_add(DRWShadingGroup *shgroup, struct Gwn_Batch *geom, float (*obmat)[4]);
328 void DRW_shgroup_call_object_add(DRWShadingGroup *shgroup, struct Gwn_Batch *geom, struct Object *ob);
329 void DRW_shgroup_call_sculpt_add(DRWShadingGroup *shgroup, struct Object *ob, float (*obmat)[4]);
330 void DRW_shgroup_call_generate_add(
331         DRWShadingGroup *shgroup, DRWCallGenerateFn *geometry_fn, void *user_data, float (*obmat)[4]);
332 void DRW_shgroup_call_dynamic_add_array(DRWShadingGroup *shgroup, const void *attr[], unsigned int attr_len);
333 #define DRW_shgroup_call_dynamic_add(shgroup, ...) do { \
334         const void *array[] = {__VA_ARGS__}; \
335         DRW_shgroup_call_dynamic_add_array(shgroup, array, (sizeof(array) / sizeof(*array))); \
336 } while (0)
337 /* Use this to set a high number of instances. */
338 void DRW_shgroup_set_instance_count(DRWShadingGroup *shgroup, int count);
339
340 void DRW_shgroup_state_enable(DRWShadingGroup *shgroup, DRWState state);
341 void DRW_shgroup_state_disable(DRWShadingGroup *shgroup, DRWState state);
342 void DRW_shgroup_stencil_mask(DRWShadingGroup *shgroup, unsigned int mask);
343 void DRW_shgroup_attrib_float(DRWShadingGroup *shgroup, const char *name, int size);
344
345 void DRW_shgroup_uniform_texture(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex);
346 void DRW_shgroup_uniform_block(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo);
347 void DRW_shgroup_uniform_buffer(DRWShadingGroup *shgroup, const char *name, struct GPUTexture **tex);
348 void DRW_shgroup_uniform_float(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
349 void DRW_shgroup_uniform_vec2(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
350 void DRW_shgroup_uniform_vec3(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
351 void DRW_shgroup_uniform_vec4(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
352 void DRW_shgroup_uniform_short_to_int(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
353 void DRW_shgroup_uniform_short_to_float(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
354 /* Boolean are expected to be 4bytes longs for opengl! */
355 void DRW_shgroup_uniform_bool(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
356 void DRW_shgroup_uniform_int(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
357 void DRW_shgroup_uniform_ivec2(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
358 void DRW_shgroup_uniform_ivec3(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
359 void DRW_shgroup_uniform_mat3(DRWShadingGroup *shgroup, const char *name, const float *value);
360 void DRW_shgroup_uniform_mat4(DRWShadingGroup *shgroup, const char *name, const float *value);
361
362 /* Passes */
363 DRWPass *DRW_pass_create(const char *name, DRWState state);
364 void DRW_pass_state_set(DRWPass *pass, DRWState state);
365 void DRW_pass_foreach_shgroup(DRWPass *pass, void (*callback)(void *userData, DRWShadingGroup *shgrp), void *userData);
366 void DRW_pass_sort_shgroup_z(DRWPass *pass);
367
368 /* Viewport */
369 typedef enum {
370         DRW_MAT_PERS = 0,
371         DRW_MAT_PERSINV,
372         DRW_MAT_VIEW,
373         DRW_MAT_VIEWINV,
374         DRW_MAT_WIN,
375         DRW_MAT_WININV,
376 } DRWViewportMatrixType;
377
378 void DRW_viewport_init(const bContext *C);
379 void DRW_viewport_matrix_get(float mat[4][4], DRWViewportMatrixType type);
380 void DRW_viewport_matrix_override_set(float mat[4][4], DRWViewportMatrixType type);
381 void DRW_viewport_matrix_override_unset(DRWViewportMatrixType type);
382 const float *DRW_viewport_size_get(void);
383 const float *DRW_viewport_screenvecs_get(void);
384 const float *DRW_viewport_pixelsize_get(void);
385 bool DRW_viewport_is_persp_get(void);
386
387 struct DefaultFramebufferList *DRW_viewport_framebuffer_list_get(void);
388 struct DefaultTextureList     *DRW_viewport_texture_list_get(void);
389
390 void DRW_viewport_request_redraw(void);
391
392 void DRW_render_to_image(struct RenderEngine *re, struct Depsgraph *depsgraph);
393 void DRW_render_object_iter(
394         void *vedata, struct RenderEngine *engine, struct Depsgraph *graph,
395         void (*callback)(void *vedata, struct Object *ob, struct RenderEngine *engine, struct Depsgraph *graph));
396
397 /* ViewLayers */
398 void *DRW_view_layer_engine_data_get(DrawEngineType *engine_type);
399 void **DRW_view_layer_engine_data_ensure(DrawEngineType *engine_type, void (*callback)(void *storage));
400
401 /* Objects */
402 ObjectEngineData *DRW_object_engine_data_get(Object *ob, DrawEngineType *engine_type);
403 ObjectEngineData *DRW_object_engine_data_ensure(
404         Object *ob,
405         DrawEngineType *engine_type,
406         size_t size,
407         ObjectEngineDataInitCb init_cb,
408         ObjectEngineDataFreeCb free_cb);
409 struct LampEngineData *DRW_lamp_engine_data_ensure(Object *ob, struct RenderEngineType *engine_type);
410 void DRW_lamp_engine_data_free(struct LampEngineData *led);
411
412 /* Settings */
413 bool DRW_object_is_renderable(struct Object *ob);
414 bool DRW_check_object_visible_within_active_context(struct Object *ob);
415 bool DRW_object_is_flat_normal(const struct Object *ob);
416 int  DRW_object_is_mode_shade(const struct Object *ob);
417
418 /* Draw commands */
419 void DRW_draw_pass(DRWPass *pass);
420 void DRW_draw_pass_subset(DRWPass *pass, DRWShadingGroup *start_group, DRWShadingGroup *end_group);
421
422 void DRW_draw_text_cache_queue(struct DRWTextStore *dt);
423
424 void DRW_draw_callbacks_pre_scene(void);
425 void DRW_draw_callbacks_post_scene(void);
426
427 int DRW_draw_region_engine_info_offset(void);
428 void DRW_draw_region_engine_info(void);
429
430 void DRW_state_reset_ex(DRWState state);
431 void DRW_state_reset(void);
432
433 void DRW_state_invert_facing(void);
434
435 void DRW_state_clip_planes_add(float plane_eq[4]);
436 void DRW_state_clip_planes_reset(void);
437
438 /* Selection */
439 void DRW_select_load_id(unsigned int id);
440
441 /* Draw State */
442 void DRW_state_dfdy_factors_get(float dfdyfac[2]);
443 bool DRW_state_is_fbo(void);
444 bool DRW_state_is_select(void);
445 bool DRW_state_is_depth(void);
446 bool DRW_state_is_image_render(void);
447 bool DRW_state_is_scene_render(void);
448 bool DRW_state_show_text(void);
449 bool DRW_state_draw_support(void);
450 bool DRW_state_draw_background(void);
451
452 enum eDepsObjectIteratorMode DRW_iterator_mode_get(void);
453
454 struct DRWTextStore *DRW_state_text_cache_get(void);
455
456 /* Avoid too many lookups while drawing */
457 typedef struct DRWContextState {
458
459         struct ARegion *ar;         /* 'CTX_wm_region(C)' */
460         struct RegionView3D *rv3d;  /* 'CTX_wm_region_view3d(C)' */
461         struct View3D *v3d;     /* 'CTX_wm_view3d(C)' */
462
463         struct Scene *scene;    /* 'CTX_data_scene(C)' */
464         struct ViewLayer *view_layer;  /* 'CTX_data_view_layer(C)' */
465
466         /* Use 'scene->obedit' for edit-mode */
467         struct Object *obact;   /* 'OBACT' */
468
469         struct RenderEngineType *engine_type;
470
471         struct Depsgraph *depsgraph;
472
473         short object_mode;
474
475         /* Last resort (some functions take this as an arg so we can't easily avoid).
476          * May be NULL when used for selection or depth buffer. */
477         const struct bContext *evil_C;
478
479 } DRWContextState;
480
481 const DRWContextState *DRW_context_state_get(void);
482
483 #endif /* __DRW_RENDER_H__ */