96525a47c77b307416cc3718e1c4e555f3536bb7
[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 #include "DNA_world_types.h"
48
49 #include "GPU_framebuffer.h"
50 #include "GPU_texture.h"
51 #include "GPU_shader.h"
52
53 #include "draw_common.h"
54 #include "draw_cache.h"
55 #include "draw_view.h"
56
57 #include "draw_manager_profiling.h"
58 #include "draw_debug.h"
59
60 #include "MEM_guardedalloc.h"
61
62 #include "RE_engine.h"
63
64 #include "DEG_depsgraph.h"
65
66 struct rcti;
67 struct bContext;
68 struct GPUFrameBuffer;
69 struct GPUShader;
70 struct GPUMaterial;
71 struct GPUTexture;
72 struct GPUUniformBuffer;
73 struct Object;
74 struct GPUBatch;
75 struct DefaultFramebufferList;
76 struct DefaultTextureList;
77 struct DRWTextStore;
78 struct LampEngineData;
79 struct ParticleSystem;
80 struct RenderEngineType;
81 struct ViewportEngineData;
82 struct ViewportEngineData_Info;
83
84 typedef struct DRWUniform DRWUniform;
85 typedef struct DRWInterface DRWInterface;
86 typedef struct DRWPass DRWPass;
87 typedef struct DRWShadingGroup DRWShadingGroup;
88
89 /* TODO Put it somewhere else? */
90 typedef struct BoundSphere {
91         float center[3], radius;
92 } BoundSphere;
93
94 /* declare members as empty (unused) */
95 typedef char DRWViewportEmptyList;
96
97 #define DRW_VIEWPORT_LIST_SIZE(list) \
98         (sizeof(list) == sizeof(DRWViewportEmptyList) ? 0 : ((sizeof(list)) / sizeof(void *)))
99
100 /* Unused members must be either pass list or 'char *' when not usd. */
101 #define DRW_VIEWPORT_DATA_SIZE(ty) { \
102         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->fbl)), \
103         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->txl)), \
104         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->psl)), \
105         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->stl)) \
106 }
107
108 /* Use of multisample framebuffers. */
109 #define MULTISAMPLE_SYNC_ENABLE(dfbl, dtxl) { \
110         if (dfbl->multisample_fb != NULL) { \
111                 DRW_stats_query_start("Multisample Blit"); \
112                 GPU_framebuffer_bind(dfbl->multisample_fb); \
113                 /* TODO clear only depth but need to do alpha to coverage for transparencies. */ \
114                 GPU_framebuffer_clear_color_depth(dfbl->multisample_fb, (const float[4]){0.0f}, 1.0f); \
115                 DRW_stats_query_end(); \
116         } \
117 } ((void)0)
118
119 #define MULTISAMPLE_SYNC_DISABLE(dfbl, dtxl) { \
120         if (dfbl->multisample_fb != NULL) { \
121                 DRW_stats_query_start("Multisample Resolve"); \
122                 GPU_framebuffer_bind(dfbl->default_fb); \
123                 DRW_multisamples_resolve(dtxl->multisample_depth, dtxl->multisample_color, true); \
124                 DRW_stats_query_end(); \
125         } \
126 }
127
128 #define MULTISAMPLE_SYNC_DISABLE_NO_DEPTH(dfbl, dtxl) { \
129         if (dfbl->multisample_fb != NULL) { \
130                 DRW_stats_query_start("Multisample Resolve"); \
131                 GPU_framebuffer_bind(dfbl->default_fb); \
132                 DRW_multisamples_resolve(dtxl->multisample_depth, dtxl->multisample_color, false); \
133                 DRW_stats_query_end(); \
134         } \
135 }
136
137
138
139
140 typedef struct DrawEngineDataSize {
141         int fbl_len;
142         int txl_len;
143         int psl_len;
144         int stl_len;
145 } DrawEngineDataSize;
146
147 typedef struct DrawEngineType {
148         struct DrawEngineType *next, *prev;
149
150         char idname[32];
151
152         const DrawEngineDataSize *vedata_size;
153
154         void (*engine_init)(void *vedata);
155         void (*engine_free)(void);
156
157         void (*cache_init)(void *vedata);
158         void (*cache_populate)(void *vedata, struct Object *ob);
159         void (*cache_finish)(void *vedata);
160
161         void (*draw_background)(void *vedata);
162         void (*draw_scene)(void *vedata);
163
164         void (*view_update)(void *vedata);
165         void (*id_update)(void *vedata, struct ID *id);
166
167         void (*render_to_image)(
168                 void *vedata, struct RenderEngine *engine,
169                 struct RenderLayer *layer, const struct rcti *rect);
170 } DrawEngineType;
171
172 #ifndef __DRW_ENGINE_H__
173 /* Buffer and textures used by the viewport by default */
174 typedef struct DefaultFramebufferList {
175         struct GPUFrameBuffer *default_fb;
176         struct GPUFrameBuffer *color_only_fb;
177         struct GPUFrameBuffer *depth_only_fb;
178         struct GPUFrameBuffer *multisample_fb;
179 } DefaultFramebufferList;
180
181 typedef struct DefaultTextureList {
182         struct GPUTexture *color;
183         struct GPUTexture *depth;
184         struct GPUTexture *multisample_color;
185         struct GPUTexture *multisample_depth;
186 } DefaultTextureList;
187 #endif
188
189 /* Textures */
190 typedef enum {
191         DRW_TEX_FILTER = (1 << 0),
192         DRW_TEX_WRAP = (1 << 1),
193         DRW_TEX_COMPARE = (1 << 2),
194         DRW_TEX_MIPMAP = (1 << 3),
195 } DRWTextureFlag;
196
197 /* Textures from DRW_texture_pool_query_* have the options
198  * DRW_TEX_FILTER for color float textures, and no options
199  * for depth textures and integer textures. */
200 struct GPUTexture *DRW_texture_pool_query_2D(int w, int h, GPUTextureFormat format, DrawEngineType *engine_type);
201
202 struct GPUTexture *DRW_texture_create_1D(
203         int w, GPUTextureFormat format, DRWTextureFlag flags, const float *fpixels);
204 struct GPUTexture *DRW_texture_create_2D(
205         int w, int h, GPUTextureFormat format, DRWTextureFlag flags, const float *fpixels);
206 struct GPUTexture *DRW_texture_create_2D_array(
207         int w, int h, int d, GPUTextureFormat format, DRWTextureFlag flags, const float *fpixels);
208 struct GPUTexture *DRW_texture_create_3D(
209         int w, int h, int d, GPUTextureFormat format, DRWTextureFlag flags, const float *fpixels);
210 struct GPUTexture *DRW_texture_create_cube(
211         int w, GPUTextureFormat format, DRWTextureFlag flags, const float *fpixels);
212
213 void DRW_texture_ensure_fullscreen_2D(
214         struct GPUTexture **tex, GPUTextureFormat format, DRWTextureFlag flags);
215 void DRW_texture_ensure_2D(
216         struct GPUTexture **tex, int w, int h, GPUTextureFormat format, DRWTextureFlag flags);
217
218 void DRW_texture_generate_mipmaps(struct GPUTexture *tex);
219 void DRW_texture_free(struct GPUTexture *tex);
220 #define DRW_TEXTURE_FREE_SAFE(tex) do { \
221         if (tex != NULL) { \
222                 DRW_texture_free(tex); \
223                 tex = NULL; \
224         } \
225 } while (0)
226
227 /* UBOs */
228 struct GPUUniformBuffer *DRW_uniformbuffer_create(int size, const void *data);
229 void DRW_uniformbuffer_update(struct GPUUniformBuffer *ubo, const void *data);
230 void DRW_uniformbuffer_free(struct GPUUniformBuffer *ubo);
231 #define DRW_UBO_FREE_SAFE(ubo) do { \
232         if (ubo != NULL) { \
233                 DRW_uniformbuffer_free(ubo); \
234                 ubo = NULL; \
235         } \
236 } while (0)
237
238 void DRW_transform_to_display(struct GPUTexture *tex, bool use_view_settings);
239 void DRW_transform_none(struct GPUTexture *tex);
240 void DRW_multisamples_resolve(
241         struct GPUTexture *src_depth, struct GPUTexture *src_color, bool use_depth);
242
243 /* Shaders */
244 struct GPUShader *DRW_shader_create(
245         const char *vert, const char *geom, const char *frag, const char *defines);
246 struct GPUShader *DRW_shader_create_with_lib(
247         const char *vert, const char *geom, const char *frag, const char *lib, const char *defines);
248 struct GPUShader *DRW_shader_create_with_transform_feedback(
249         const char *vert, const char *geom, const char *defines,
250         const GPUShaderTFBType prim_type, const char **varying_names, const int varying_count);
251 struct GPUShader *DRW_shader_create_2D(const char *frag, const char *defines);
252 struct GPUShader *DRW_shader_create_3D(const char *frag, const char *defines);
253 struct GPUShader *DRW_shader_create_fullscreen(const char *frag, const char *defines);
254 struct GPUShader *DRW_shader_create_3D_depth_only(void);
255 struct GPUMaterial *DRW_shader_find_from_world(struct World *wo, const void *engine_type, int options, bool deferred);
256 struct GPUMaterial *DRW_shader_find_from_material(struct Material *ma, const void *engine_type, int options, bool deferred);
257 struct GPUMaterial *DRW_shader_create_from_world(
258         struct Scene *scene, struct World *wo, const void *engine_type, int options,
259         const char *vert, const char *geom, const char *frag_lib, const char *defines, bool deferred);
260 struct GPUMaterial *DRW_shader_create_from_material(
261         struct Scene *scene, struct Material *ma, const void *engine_type, int options,
262         const char *vert, const char *geom, const char *frag_lib, const char *defines, bool deferred);
263 void DRW_shader_free(struct GPUShader *shader);
264 #define DRW_SHADER_FREE_SAFE(shader) do { \
265         if (shader != NULL) { \
266                 DRW_shader_free(shader); \
267                 shader = NULL; \
268         } \
269 } while (0)
270
271 /* Batches */
272
273 typedef enum {
274         DRW_STATE_WRITE_DEPTH   = (1 << 0),
275         DRW_STATE_WRITE_COLOR   = (1 << 1),
276         DRW_STATE_DEPTH_ALWAYS  = (1 << 2),
277         DRW_STATE_DEPTH_LESS    = (1 << 3),
278         DRW_STATE_DEPTH_LESS_EQUAL = (1 << 4),
279         DRW_STATE_DEPTH_EQUAL   = (1 << 5),
280         DRW_STATE_DEPTH_GREATER = (1 << 6),
281         DRW_STATE_DEPTH_GREATER_EQUAL = (1 << 7),
282         DRW_STATE_CULL_BACK     = (1 << 8),
283         DRW_STATE_CULL_FRONT    = (1 << 9),
284         DRW_STATE_WIRE          = (1 << 10),
285         DRW_STATE_POINT         = (1 << 11),
286         DRW_STATE_OFFSET_POSITIVE = (1 << 12), /* Polygon offset. Does not work with lines and points. */
287         DRW_STATE_OFFSET_NEGATIVE = (1 << 13), /* Polygon offset. Does not work with lines and points. */
288         /* DRW_STATE_STIPPLE_4     = (1 << 14), */ /* Not used */
289         DRW_STATE_BLEND         = (1 << 15),
290         DRW_STATE_ADDITIVE      = (1 << 16),
291         DRW_STATE_MULTIPLY      = (1 << 17),
292         /* DRW_STATE_TRANSMISSION  = (1 << 18), */ /* Not used */
293         DRW_STATE_CLIP_PLANES   = (1 << 19),
294         DRW_STATE_ADDITIVE_FULL = (1 << 20), /* Same as DRW_STATE_ADDITIVE but let alpha accumulate without premult. */
295         DRW_STATE_BLEND_PREMUL  = (1 << 21), /* Use that if color is already premult by alpha. */
296         DRW_STATE_WIRE_SMOOTH   = (1 << 22),
297         DRW_STATE_TRANS_FEEDBACK = (1 << 23),
298         DRW_STATE_BLEND_OIT     = (1 << 24),
299         DRW_STATE_FIRST_VERTEX_CONVENTION = (1 << 25),
300
301         DRW_STATE_WRITE_STENCIL          = (1 << 27),
302         DRW_STATE_WRITE_STENCIL_SHADOW_PASS   = (1 << 28),
303         DRW_STATE_WRITE_STENCIL_SHADOW_FAIL   = (1 << 29),
304         DRW_STATE_STENCIL_EQUAL          = (1 << 30),
305         DRW_STATE_STENCIL_NEQUAL         = (1 << 31),
306 } DRWState;
307 #define DRW_STATE_DEFAULT (DRW_STATE_WRITE_DEPTH | DRW_STATE_WRITE_COLOR | DRW_STATE_DEPTH_LESS_EQUAL)
308
309 typedef enum {
310         DRW_ATTRIB_INT,
311         DRW_ATTRIB_FLOAT,
312 } DRWAttribType;
313
314 typedef struct DRWInstanceAttribFormat {
315         char name[32];
316         DRWAttribType type;
317         int components;
318 } DRWInstanceAttribFormat;
319
320 struct GPUVertFormat *DRW_shgroup_instance_format_array(const DRWInstanceAttribFormat attribs[], int arraysize);
321 #define DRW_shgroup_instance_format(format, ...) do { \
322         if (format == NULL) { \
323                 DRWInstanceAttribFormat drw_format[] = __VA_ARGS__;\
324                 format = DRW_shgroup_instance_format_array(drw_format, (sizeof(drw_format) / sizeof(DRWInstanceAttribFormat))); \
325         } \
326 } while (0)
327
328 DRWShadingGroup *DRW_shgroup_create(struct GPUShader *shader, DRWPass *pass);
329 DRWShadingGroup *DRW_shgroup_create_sub(DRWShadingGroup *shgroup);
330 DRWShadingGroup *DRW_shgroup_material_create(struct GPUMaterial *material, DRWPass *pass);
331 DRWShadingGroup *DRW_shgroup_material_instance_create(
332         struct GPUMaterial *material, DRWPass *pass, struct GPUBatch *geom, struct Object *ob,
333         struct GPUVertFormat *format);
334 DRWShadingGroup *DRW_shgroup_material_empty_tri_batch_create(struct GPUMaterial *material, DRWPass *pass, int size);
335 DRWShadingGroup *DRW_shgroup_instance_create(
336         struct GPUShader *shader, DRWPass *pass, struct GPUBatch *geom, struct GPUVertFormat *format);
337 DRWShadingGroup *DRW_shgroup_point_batch_create(struct GPUShader *shader, DRWPass *pass);
338 DRWShadingGroup *DRW_shgroup_line_batch_create_with_format(
339         struct GPUShader *shader, DRWPass *pass, struct GPUVertFormat *format);
340 DRWShadingGroup *DRW_shgroup_line_batch_create(
341         struct GPUShader *shader, DRWPass *pass);
342 DRWShadingGroup *DRW_shgroup_empty_tri_batch_create(
343         struct GPUShader *shader, DRWPass *pass, int size);
344 DRWShadingGroup *DRW_shgroup_transform_feedback_create(
345         struct GPUShader *shader, DRWPass *pass, struct GPUVertBuf *tf_target);
346
347
348 typedef void (DRWCallGenerateFn)(
349         DRWShadingGroup *shgroup,
350         void (*draw_fn)(DRWShadingGroup *shgroup, struct GPUBatch *geom),
351         void *user_data);
352
353 /* return final visibility */
354 typedef bool (DRWCallVisibilityFn)(
355         bool vis_in,
356         void *user_data);
357
358 void DRW_shgroup_instance_batch(DRWShadingGroup *shgroup, struct GPUBatch *batch);
359
360 void DRW_shgroup_call_add(DRWShadingGroup *shgroup, struct GPUBatch *geom, float (*obmat)[4]);
361 void DRW_shgroup_call_range_add(
362         DRWShadingGroup *shgroup, struct GPUBatch *geom, float (*obmat)[4], uint v_sta, uint v_count);
363 void DRW_shgroup_call_procedural_points_add(DRWShadingGroup *shgroup, uint point_len, float (*obmat)[4]);
364 void DRW_shgroup_call_procedural_lines_add(DRWShadingGroup *shgroup, uint line_count, float (*obmat)[4]);
365 void DRW_shgroup_call_procedural_triangles_add(DRWShadingGroup *shgroup, uint tria_count, float (*obmat)[4]);
366 void DRW_shgroup_call_object_procedural_triangles_culled_add(DRWShadingGroup *shgroup, uint tria_count, struct Object *ob);
367 void DRW_shgroup_call_object_add_ex(
368         DRWShadingGroup *shgroup, struct GPUBatch *geom, struct Object *ob, struct Material *ma, bool bypass_culling);
369 #define DRW_shgroup_call_object_add(shgroup, geom, ob) DRW_shgroup_call_object_add_ex(shgroup, geom, ob, NULL, false)
370 #define DRW_shgroup_call_object_add_no_cull(shgroup, geom, ob) DRW_shgroup_call_object_add_ex(shgroup, geom, ob, NULL, true)
371 void DRW_shgroup_call_object_add_with_callback(
372         DRWShadingGroup *shgroup, struct GPUBatch *geom, struct Object *ob, struct Material *ma,
373         DRWCallVisibilityFn *callback, void *user_data);
374 /* Used for drawing a batch with instancing without instance attribs. */
375 void DRW_shgroup_call_instances_add(
376         DRWShadingGroup *shgroup, struct GPUBatch *geom, float (*obmat)[4], uint *count);
377 void DRW_shgroup_call_object_instances_add(
378         DRWShadingGroup *shgroup, struct GPUBatch *geom, struct Object *ob, uint *count);
379 void DRW_shgroup_call_sculpt_add(DRWShadingGroup *shgroup, struct Object *ob, float (*obmat)[4]);
380 void DRW_shgroup_call_generate_add(
381         DRWShadingGroup *shgroup, DRWCallGenerateFn *geometry_fn, void *user_data, float (*obmat)[4]);
382 void DRW_shgroup_call_dynamic_add_array(DRWShadingGroup *shgroup, const void *attr[], uint attr_len);
383 #define DRW_shgroup_call_dynamic_add(shgroup, ...) do { \
384         const void *array[] = {__VA_ARGS__}; \
385         DRW_shgroup_call_dynamic_add_array(shgroup, array, (sizeof(array) / sizeof(*array))); \
386 } while (0)
387
388 uint DRW_shgroup_get_instance_count(const DRWShadingGroup *shgroup);
389
390 void DRW_shgroup_state_enable(DRWShadingGroup *shgroup, DRWState state);
391 void DRW_shgroup_state_disable(DRWShadingGroup *shgroup, DRWState state);
392 void DRW_shgroup_stencil_mask(DRWShadingGroup *shgroup, uint mask);
393
394 void DRW_shgroup_uniform_texture(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex);
395 void DRW_shgroup_uniform_texture_persistent(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex);
396 void DRW_shgroup_uniform_block(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo);
397 void DRW_shgroup_uniform_block_persistent(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo);
398 void DRW_shgroup_uniform_texture_ref(DRWShadingGroup *shgroup, const char *name, struct GPUTexture **tex);
399 void DRW_shgroup_uniform_float(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
400 void DRW_shgroup_uniform_vec2(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
401 void DRW_shgroup_uniform_vec3(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
402 void DRW_shgroup_uniform_vec4(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
403 void DRW_shgroup_uniform_short_to_int(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
404 void DRW_shgroup_uniform_short_to_float(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
405 /* Boolean are expected to be 4bytes longs for opengl! */
406 void DRW_shgroup_uniform_bool(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
407 void DRW_shgroup_uniform_int(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
408 void DRW_shgroup_uniform_ivec2(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
409 void DRW_shgroup_uniform_ivec3(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
410 void DRW_shgroup_uniform_ivec4(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
411 void DRW_shgroup_uniform_mat3(DRWShadingGroup *shgroup, const char *name, const float (*value)[3]);
412 void DRW_shgroup_uniform_mat4(DRWShadingGroup *shgroup, const char *name, const float (*value)[4]);
413 /* Store value instead of referencing it. */
414 void DRW_shgroup_uniform_int_copy(DRWShadingGroup *shgroup, const char *name, const int value);
415 void DRW_shgroup_uniform_bool_copy(DRWShadingGroup *shgroup, const char *name, const bool value);
416 void DRW_shgroup_uniform_float_copy(DRWShadingGroup *shgroup, const char *name, const float value);
417
418 bool DRW_shgroup_is_empty(DRWShadingGroup *shgroup);
419
420 /* Passes */
421 DRWPass *DRW_pass_create(const char *name, DRWState state);
422 void DRW_pass_state_set(DRWPass *pass, DRWState state);
423 void DRW_pass_state_add(DRWPass *pass, DRWState state);
424 void DRW_pass_state_remove(DRWPass *pass, DRWState state);
425 void DRW_pass_foreach_shgroup(DRWPass *pass, void (*callback)(void *userData, DRWShadingGroup *shgrp), void *userData);
426 void DRW_pass_sort_shgroup_z(DRWPass *pass);
427
428 bool DRW_pass_is_empty(DRWPass *pass);
429
430 /* Viewport */
431 typedef enum {
432         /* keep in sync with the union struct DRWMatrixState. */
433         DRW_MAT_PERS = 0,
434         DRW_MAT_PERSINV,
435         DRW_MAT_VIEW,
436         DRW_MAT_VIEWINV,
437         DRW_MAT_WIN,
438         DRW_MAT_WININV,
439
440         DRW_MAT_COUNT, // Don't use this.
441 } DRWViewportMatrixType;
442
443 typedef struct DRWMatrixState {
444         union {
445                 float mat[DRW_MAT_COUNT][4][4];
446                 struct {
447                         /* keep in sync with the enum DRWViewportMatrixType. */
448                         float persmat[4][4];
449                         float persinv[4][4];
450                         float viewmat[4][4];
451                         float viewinv[4][4];
452                         float winmat[4][4];
453                         float wininv[4][4];
454                 };
455         };
456 } DRWMatrixState;
457
458 void DRW_viewport_matrix_get(float mat[4][4], DRWViewportMatrixType type);
459 void DRW_viewport_matrix_get_all(DRWMatrixState *state);
460 void DRW_viewport_matrix_override_set(const float mat[4][4], DRWViewportMatrixType type);
461 void DRW_viewport_matrix_override_set_all(DRWMatrixState *state);
462 void DRW_viewport_matrix_override_unset(DRWViewportMatrixType type);
463 void DRW_viewport_matrix_override_unset_all(void);
464
465 /* These are in view-space so negative if in perspective.
466  * Extract near and far clip distance from the projection matrix. */
467 float DRW_viewport_near_distance_get(void);
468 float DRW_viewport_far_distance_get(void);
469
470 const float *DRW_viewport_size_get(void);
471 const float *DRW_viewport_invert_size_get(void);
472 const float *DRW_viewport_screenvecs_get(void);
473 const float *DRW_viewport_pixelsize_get(void);
474 bool DRW_viewport_is_persp_get(void);
475
476 struct DefaultFramebufferList *DRW_viewport_framebuffer_list_get(void);
477 struct DefaultTextureList     *DRW_viewport_texture_list_get(void);
478
479 void DRW_viewport_request_redraw(void);
480
481 void DRW_render_to_image(struct RenderEngine *engine, struct Depsgraph *depsgraph);
482 void DRW_render_object_iter(
483         void *vedata, struct RenderEngine *engine, struct Depsgraph *depsgraph,
484         void (*callback)(void *vedata, struct Object *ob, struct RenderEngine *engine, struct Depsgraph *depsgraph));
485 void DRW_render_instance_buffer_finish(void);
486 void DRW_render_viewport_size_set(int size[2]);
487
488 void DRW_custom_pipeline(
489         DrawEngineType *draw_engine_type,
490         struct Depsgraph *depsgraph,
491         void (*callback)(void *vedata, void *user_data),
492         void *user_data);
493
494 /* ViewLayers */
495 void *DRW_view_layer_engine_data_get(DrawEngineType *engine_type);
496 void **DRW_view_layer_engine_data_ensure_ex(
497         struct ViewLayer *view_layer, DrawEngineType *engine_type, void (*callback)(void *storage));
498 void **DRW_view_layer_engine_data_ensure(
499         DrawEngineType *engine_type, void (*callback)(void *storage));
500
501 /* DrawData */
502 DrawData *DRW_drawdata_get(ID *ib, DrawEngineType *engine_type);
503 DrawData *DRW_drawdata_ensure(
504         ID *id,
505         DrawEngineType *engine_type,
506         size_t size,
507         DrawDataInitCb init_cb,
508         DrawDataFreeCb free_cb);
509
510 /* Settings */
511 bool DRW_object_is_renderable(const struct Object *ob);
512 int DRW_object_visibility_in_active_context(const struct Object *ob);
513 bool DRW_object_is_flat_normal(const struct Object *ob);
514 bool DRW_object_use_hide_faces(const struct Object *ob);
515
516 bool DRW_object_is_visible_psys_in_active_context(const struct Object *object, const struct ParticleSystem *psys);
517
518 struct Object *DRW_object_get_dupli_parent(const struct Object *ob);
519 struct DupliObject *DRW_object_get_dupli(const struct Object *ob);
520
521 /* Draw commands */
522 void DRW_draw_pass(DRWPass *pass);
523 void DRW_draw_pass_subset(DRWPass *pass, DRWShadingGroup *start_group, DRWShadingGroup *end_group);
524
525 void DRW_draw_callbacks_pre_scene(void);
526 void DRW_draw_callbacks_post_scene(void);
527
528 void DRW_state_reset_ex(DRWState state);
529 void DRW_state_reset(void);
530 void DRW_state_lock(DRWState state);
531
532 void DRW_state_invert_facing(void);
533
534 void DRW_state_clip_planes_len_set(uint plane_len);
535 void DRW_state_clip_planes_reset(void);
536
537 /* Culling, return true if object is inside view frustum. */
538 bool DRW_culling_sphere_test(BoundSphere *bsphere);
539 bool DRW_culling_box_test(BoundBox *bbox);
540 bool DRW_culling_plane_test(float plane[4]);
541
542 void DRW_culling_frustum_corners_get(BoundBox *corners);
543 void DRW_culling_frustum_planes_get(float planes[6][4]);
544
545 /* Selection */
546 void DRW_select_load_id(uint id);
547
548 /* Draw State */
549 void DRW_state_dfdy_factors_get(float dfdyfac[2]);
550 bool DRW_state_is_fbo(void);
551 bool DRW_state_is_select(void);
552 bool DRW_state_is_depth(void);
553 bool DRW_state_is_image_render(void);
554 bool DRW_state_is_scene_render(void);
555 bool DRW_state_is_opengl_render(void);
556 bool DRW_state_is_playback(void);
557 bool DRW_state_show_text(void);
558 bool DRW_state_draw_support(void);
559 bool DRW_state_draw_background(void);
560
561 /* Avoid too many lookups while drawing */
562 typedef struct DRWContextState {
563
564         struct ARegion *ar;         /* 'CTX_wm_region(C)' */
565         struct RegionView3D *rv3d;  /* 'CTX_wm_region_view3d(C)' */
566         struct View3D *v3d;     /* 'CTX_wm_view3d(C)' */
567
568         struct Scene *scene;    /* 'CTX_data_scene(C)' */
569         struct ViewLayer *view_layer;  /* 'CTX_data_view_layer(C)' */
570
571         /* Use 'object_edit' for edit-mode */
572         struct Object *obact;   /* 'OBACT' */
573
574         struct RenderEngineType *engine_type;
575
576         struct Depsgraph *depsgraph;
577
578         eObjectMode object_mode;
579
580         /* Last resort (some functions take this as an arg so we can't easily avoid).
581          * May be NULL when used for selection or depth buffer. */
582         const struct bContext *evil_C;
583
584         /* ---- */
585
586         /* Cache: initialized by 'drw_context_state_init'. */
587         struct Object *object_pose;
588         struct Object *object_edit;
589
590 } DRWContextState;
591
592 const DRWContextState *DRW_context_state_get(void);
593
594 #define XRAY_ALPHA(v3d)   (((v3d)->shading.type == OB_WIRE) ? (v3d)->shading.xray_alpha_wire : (v3d)->shading.xray_alpha)
595 #define XRAY_FLAG(v3d)    (((v3d)->shading.type == OB_WIRE) ? V3D_SHADING_XRAY_BONE : V3D_SHADING_XRAY)
596 #define XRAY_ENABLED(v3d) ((((v3d)->shading.flag & XRAY_FLAG(v3d)) != 0) && (XRAY_ALPHA(v3d) < 1.0f))
597
598 #endif /* __DRW_RENDER_H__ */