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