DRW: Cleanup: Make DRW_shgroup_uniform_mat4 uniform expect float (*)[4]
[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 "GPU_framebuffer.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
56 #include "MEM_guardedalloc.h"
57
58 #include "RE_engine.h"
59
60 #include "DEG_depsgraph.h"
61
62 struct rcti;
63 struct bContext;
64 struct GPUFrameBuffer;
65 struct GPUShader;
66 struct GPUMaterial;
67 struct GPUTexture;
68 struct GPUUniformBuffer;
69 struct Object;
70 struct Gwn_Batch;
71 struct DefaultFramebufferList;
72 struct DefaultTextureList;
73 struct DRWTextStore;
74 struct LampEngineData;
75 struct RenderEngineType;
76 struct ViewportEngineData;
77 struct ViewportEngineData_Info;
78
79 typedef struct DRWUniform DRWUniform;
80 typedef struct DRWInterface DRWInterface;
81 typedef struct DRWPass DRWPass;
82 typedef struct DRWShadingGroup DRWShadingGroup;
83
84 /* TODO Put it somewhere else? */
85 typedef struct BoundSphere {
86         float center[3], radius;
87 } BoundSphere;
88
89 /* declare members as empty (unused) */
90 typedef char DRWViewportEmptyList;
91
92 #define DRW_VIEWPORT_LIST_SIZE(list) \
93         (sizeof(list) == sizeof(DRWViewportEmptyList) ? 0 : ((sizeof(list)) / sizeof(void *)))
94
95 /* Unused members must be either pass list or 'char *' when not usd. */
96 #define DRW_VIEWPORT_DATA_SIZE(ty) { \
97         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->fbl)), \
98         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->txl)), \
99         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->psl)), \
100         DRW_VIEWPORT_LIST_SIZE(*(((ty *)NULL)->stl)) \
101 }
102
103 /* Use of multisample framebuffers. */
104 #define MULTISAMPLE_SYNC_ENABLE(dfbl) { \
105         if (dfbl->multisample_fb != NULL) { \
106                 DRW_stats_query_start("Multisample Blit"); \
107                 GPU_framebuffer_blit(dfbl->default_fb, 0, dfbl->multisample_fb, 0, GPU_COLOR_BIT | GPU_DEPTH_BIT); \
108                 GPU_framebuffer_bind(dfbl->multisample_fb); \
109                 DRW_stats_query_end(); \
110         } \
111 }
112
113 #define MULTISAMPLE_SYNC_DISABLE(dfbl) { \
114         if (dfbl->multisample_fb != NULL) { \
115                 DRW_stats_query_start("Multisample Resolve"); \
116                 GPU_framebuffer_blit(dfbl->multisample_fb, 0, dfbl->default_fb, 0, GPU_COLOR_BIT | GPU_DEPTH_BIT); \
117                 GPU_framebuffer_bind(dfbl->default_fb); \
118                 DRW_stats_query_end(); \
119         } \
120 }
121
122
123
124 typedef struct DrawEngineDataSize {
125         int fbl_len;
126         int txl_len;
127         int psl_len;
128         int stl_len;
129 } DrawEngineDataSize;
130
131 typedef struct DrawEngineType {
132         struct DrawEngineType *next, *prev;
133
134         char idname[32];
135
136         const DrawEngineDataSize *vedata_size;
137
138         void (*engine_init)(void *vedata);
139         void (*engine_free)(void);
140
141         void (*cache_init)(void *vedata);
142         void (*cache_populate)(void *vedata, struct Object *ob);
143         void (*cache_finish)(void *vedata);
144
145         void (*draw_background)(void *vedata);
146         void (*draw_scene)(void *vedata);
147
148         void (*view_update)(void *vedata);
149         void (*id_update)(void *vedata, struct ID *id);
150
151         void (*render_to_image)(void *vedata, struct RenderEngine *engine, struct RenderLayer *layer, const struct rcti *rect);
152 } DrawEngineType;
153
154 #ifndef __DRW_ENGINE_H__
155 /* Buffer and textures used by the viewport by default */
156 typedef struct DefaultFramebufferList {
157         struct GPUFrameBuffer *default_fb;
158         struct GPUFrameBuffer *color_only_fb;
159         struct GPUFrameBuffer *depth_only_fb;
160         struct GPUFrameBuffer *multisample_fb;
161 } DefaultFramebufferList;
162
163 typedef struct DefaultTextureList {
164         struct GPUTexture *color;
165         struct GPUTexture *depth;
166         struct GPUTexture *multisample_color;
167         struct GPUTexture *multisample_depth;
168 } DefaultTextureList;
169 #endif
170
171 /* Textures */
172 /* NOTE naming in this struct is broken.
173  * There should either be suffixes for Normalized int formats or float formats.
174  * Right now every 8bit texture is Normalized int and others are Floating point. */
175 typedef enum {
176         DRW_TEX_RGBA_8,
177         DRW_TEX_RGBA_16,
178         DRW_TEX_RGBA_32,
179         DRW_TEX_RGB_11_11_10,
180         DRW_TEX_RGB_8,
181         DRW_TEX_RGB_16,
182         DRW_TEX_RGB_32,
183         DRW_TEX_RG_8,
184         DRW_TEX_RG_16,
185         DRW_TEX_RG_16I,
186         DRW_TEX_RG_32,
187         DRW_TEX_R_8,
188         DRW_TEX_R_16,
189         DRW_TEX_R_16I,
190         DRW_TEX_R_16U,
191         DRW_TEX_R_32,
192         DRW_TEX_DEPTH_16,
193         DRW_TEX_DEPTH_24,
194         DRW_TEX_DEPTH_24_STENCIL_8,
195         DRW_TEX_DEPTH_32,
196 } DRWTextureFormat;
197
198 typedef enum {
199         DRW_TEX_FILTER = (1 << 0),
200         DRW_TEX_WRAP = (1 << 1),
201         DRW_TEX_COMPARE = (1 << 2),
202         DRW_TEX_MIPMAP = (1 << 3),
203 } DRWTextureFlag;
204
205 /* Textures from DRW_texture_pool_query_* have the options
206  * DRW_TEX_FILTER for color float textures, and no options
207  * for depth textures and integer textures. */
208 struct GPUTexture *DRW_texture_pool_query_2D(int w, int h, DRWTextureFormat format, DrawEngineType *engine_type);
209
210 struct GPUTexture *DRW_texture_create_1D(
211         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
212 struct GPUTexture *DRW_texture_create_2D(
213         int w, int h, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
214 struct GPUTexture *DRW_texture_create_2D_array(
215         int w, int h, int d, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
216 struct GPUTexture *DRW_texture_create_3D(
217         int w, int h, int d, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
218 struct GPUTexture *DRW_texture_create_cube(
219         int w, DRWTextureFormat format, DRWTextureFlag flags, const float *fpixels);
220
221 void DRW_texture_ensure_fullscreen_2D(
222         struct GPUTexture **tex, DRWTextureFormat format, DRWTextureFlag flags);
223 void DRW_texture_ensure_2D(
224         struct GPUTexture **tex, int w, int h, DRWTextureFormat format, DRWTextureFlag flags);
225
226 void DRW_texture_generate_mipmaps(struct GPUTexture *tex);
227 void DRW_texture_free(struct GPUTexture *tex);
228 #define DRW_TEXTURE_FREE_SAFE(tex) do { \
229         if (tex != NULL) { \
230                 DRW_texture_free(tex); \
231                 tex = NULL; \
232         } \
233 } while (0)
234
235 /* UBOs */
236 struct GPUUniformBuffer *DRW_uniformbuffer_create(int size, const void *data);
237 void DRW_uniformbuffer_update(struct GPUUniformBuffer *ubo, const void *data);
238 void DRW_uniformbuffer_free(struct GPUUniformBuffer *ubo);
239 #define DRW_UBO_FREE_SAFE(ubo) do { \
240         if (ubo != NULL) { \
241                 DRW_uniformbuffer_free(ubo); \
242                 ubo = NULL; \
243         } \
244 } while (0)
245
246 void DRW_transform_to_display(struct GPUTexture *tex);
247
248 /* Shaders */
249 struct GPUShader *DRW_shader_create(
250         const char *vert, const char *geom, const char *frag, const char *defines);
251 struct GPUShader *DRW_shader_create_with_lib(
252         const char *vert, const char *geom, const char *frag, const char *lib, const char *defines);
253 struct GPUShader *DRW_shader_create_2D(const char *frag, const char *defines);
254 struct GPUShader *DRW_shader_create_3D(const char *frag, const char *defines);
255 struct GPUShader *DRW_shader_create_fullscreen(const char *frag, const char *defines);
256 struct GPUShader *DRW_shader_create_3D_depth_only(void);
257 struct GPUMaterial *DRW_shader_find_from_world(struct World *wo, const void *engine_type, int options);
258 struct GPUMaterial *DRW_shader_find_from_material(struct Material *ma, const void *engine_type, int options);
259 struct GPUMaterial *DRW_shader_create_from_world(
260         struct Scene *scene, struct World *wo, const void *engine_type, int options,
261         const char *vert, const char *geom, const char *frag_lib, const char *defines);
262 struct GPUMaterial *DRW_shader_create_from_material(
263         struct Scene *scene, struct Material *ma, const void *engine_type, int options,
264         const char *vert, const char *geom, const char *frag_lib, const char *defines);
265 void DRW_shader_free(struct GPUShader *shader);
266 #define DRW_SHADER_FREE_SAFE(shader) do { \
267         if (shader != NULL) { \
268                 DRW_shader_free(shader); \
269                 shader = NULL; \
270         } \
271 } while (0)
272
273 /* Batches */
274
275 typedef enum {
276         DRW_STATE_WRITE_DEPTH   = (1 << 0),
277         DRW_STATE_WRITE_COLOR   = (1 << 1),
278         DRW_STATE_DEPTH_LESS    = (1 << 2),
279         DRW_STATE_DEPTH_EQUAL   = (1 << 3),
280         DRW_STATE_DEPTH_GREATER = (1 << 4),
281         DRW_STATE_DEPTH_ALWAYS  = (1 << 5),
282         DRW_STATE_CULL_BACK     = (1 << 6),
283         DRW_STATE_CULL_FRONT    = (1 << 7),
284         DRW_STATE_WIRE          = (1 << 8),
285 //      DRW_STATE_WIRE_LARGE    = (1 << 9), /* Removed from ogl in 3.0 */
286         DRW_STATE_POINT         = (1 << 10),
287         DRW_STATE_STIPPLE_2     = (1 << 11),
288         DRW_STATE_STIPPLE_3     = (1 << 12),
289         DRW_STATE_STIPPLE_4     = (1 << 13),
290         DRW_STATE_BLEND         = (1 << 14),
291         DRW_STATE_ADDITIVE      = (1 << 15),
292         DRW_STATE_MULTIPLY      = (1 << 16),
293         DRW_STATE_TRANSMISSION  = (1 << 17),
294         DRW_STATE_CLIP_PLANES   = (1 << 18),
295         DRW_STATE_ADDITIVE_FULL = (1 << 19), /* Same as DRW_STATE_ADDITIVE but let alpha accumulate without premult. */
296
297         DRW_STATE_WRITE_STENCIL    = (1 << 27),
298         DRW_STATE_STENCIL_EQUAL    = (1 << 28),
299 } DRWState;
300
301 #define DRW_STATE_DEFAULT (DRW_STATE_WRITE_DEPTH | DRW_STATE_WRITE_COLOR | DRW_STATE_DEPTH_LESS)
302
303 typedef enum {
304         DRW_ATTRIB_INT,
305         DRW_ATTRIB_FLOAT,
306 } DRWAttribType;
307
308 typedef struct DRWInstanceAttribFormat {
309         char name[32];
310         DRWAttribType type;
311         int components;
312 } DRWInstanceAttribFormat;
313
314 struct Gwn_VertFormat *DRW_shgroup_instance_format_array(const DRWInstanceAttribFormat attribs[], int arraysize);
315 #define DRW_shgroup_instance_format(format, ...) do { \
316         if (format == NULL) { \
317                 DRWInstanceAttribFormat drw_format[] = __VA_ARGS__;\
318                 format = DRW_shgroup_instance_format_array(drw_format, (sizeof(drw_format) / sizeof(DRWInstanceAttribFormat))); \
319         } \
320 } while (0)
321
322 DRWShadingGroup *DRW_shgroup_create(struct GPUShader *shader, DRWPass *pass);
323 DRWShadingGroup *DRW_shgroup_material_create(struct GPUMaterial *material, DRWPass *pass);
324 DRWShadingGroup *DRW_shgroup_material_instance_create(
325         struct GPUMaterial *material, DRWPass *pass, struct Gwn_Batch *geom, struct Object *ob,
326         struct Gwn_VertFormat *format);
327 DRWShadingGroup *DRW_shgroup_material_empty_tri_batch_create(struct GPUMaterial *material, DRWPass *pass, int size);
328 DRWShadingGroup *DRW_shgroup_instance_create(
329         struct GPUShader *shader, DRWPass *pass, struct Gwn_Batch *geom, struct Gwn_VertFormat *format);
330 DRWShadingGroup *DRW_shgroup_point_batch_create(struct GPUShader *shader, DRWPass *pass);
331 DRWShadingGroup *DRW_shgroup_line_batch_create(struct GPUShader *shader, DRWPass *pass);
332 DRWShadingGroup *DRW_shgroup_empty_tri_batch_create(struct GPUShader *shader, DRWPass *pass, int size);
333
334 typedef void (DRWCallGenerateFn)(
335         DRWShadingGroup *shgroup,
336         void (*draw_fn)(DRWShadingGroup *shgroup, struct Gwn_Batch *geom),
337         void *user_data);
338
339 void DRW_shgroup_instance_batch(DRWShadingGroup *shgroup, struct Gwn_Batch *batch);
340
341 void DRW_shgroup_free(struct DRWShadingGroup *shgroup);
342 void DRW_shgroup_call_add(DRWShadingGroup *shgroup, struct Gwn_Batch *geom, float (*obmat)[4]);
343 void DRW_shgroup_call_object_add(DRWShadingGroup *shgroup, struct Gwn_Batch *geom, struct Object *ob);
344 /* Used for drawing a batch with instancing without instance attribs. */
345 void DRW_shgroup_call_instances_add(
346         DRWShadingGroup *shgroup, struct Gwn_Batch *geom, float (*obmat)[4], unsigned int *count);
347 void DRW_shgroup_call_object_instances_add(
348         DRWShadingGroup *shgroup, struct Gwn_Batch *geom, struct Object *ob, unsigned int *count);
349 void DRW_shgroup_call_sculpt_add(DRWShadingGroup *shgroup, struct Object *ob, float (*obmat)[4]);
350 void DRW_shgroup_call_generate_add(
351         DRWShadingGroup *shgroup, DRWCallGenerateFn *geometry_fn, void *user_data, float (*obmat)[4]);
352 void DRW_shgroup_call_dynamic_add_array(DRWShadingGroup *shgroup, const void *attr[], unsigned int attr_len);
353 #define DRW_shgroup_call_dynamic_add(shgroup, ...) do { \
354         const void *array[] = {__VA_ARGS__}; \
355         DRW_shgroup_call_dynamic_add_array(shgroup, array, (sizeof(array) / sizeof(*array))); \
356 } while (0)
357
358 unsigned int DRW_shgroup_get_instance_count(const DRWShadingGroup *shgroup);
359
360 void DRW_shgroup_state_enable(DRWShadingGroup *shgroup, DRWState state);
361 void DRW_shgroup_state_disable(DRWShadingGroup *shgroup, DRWState state);
362 void DRW_shgroup_stencil_mask(DRWShadingGroup *shgroup, unsigned int mask);
363
364 void DRW_shgroup_uniform_texture(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex);
365 void DRW_shgroup_uniform_texture_persistent(DRWShadingGroup *shgroup, const char *name, const struct GPUTexture *tex);
366 void DRW_shgroup_uniform_block(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo);
367 void DRW_shgroup_uniform_block_persistent(DRWShadingGroup *shgroup, const char *name, const struct GPUUniformBuffer *ubo);
368 void DRW_shgroup_uniform_texture_ref(DRWShadingGroup *shgroup, const char *name, struct GPUTexture **tex);
369 void DRW_shgroup_uniform_float(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
370 void DRW_shgroup_uniform_vec2(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
371 void DRW_shgroup_uniform_vec3(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
372 void DRW_shgroup_uniform_vec4(DRWShadingGroup *shgroup, const char *name, const float *value, int arraysize);
373 void DRW_shgroup_uniform_short_to_int(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
374 void DRW_shgroup_uniform_short_to_float(DRWShadingGroup *shgroup, const char *name, const short *value, int arraysize);
375 /* Boolean are expected to be 4bytes longs for opengl! */
376 void DRW_shgroup_uniform_bool(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
377 void DRW_shgroup_uniform_int(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
378 void DRW_shgroup_uniform_ivec2(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
379 void DRW_shgroup_uniform_ivec3(DRWShadingGroup *shgroup, const char *name, const int *value, int arraysize);
380 void DRW_shgroup_uniform_mat3(DRWShadingGroup *shgroup, const char *name, const float (*value)[3]);
381 void DRW_shgroup_uniform_mat4(DRWShadingGroup *shgroup, const char *name, const float (*value)[4]);
382 /* Store value instead of referencing it. */
383 void DRW_shgroup_uniform_int_copy(DRWShadingGroup *shgroup, const char *name, const int value);
384
385 /* Passes */
386 DRWPass *DRW_pass_create(const char *name, DRWState state);
387 void DRW_pass_state_set(DRWPass *pass, DRWState state);
388 void DRW_pass_foreach_shgroup(DRWPass *pass, void (*callback)(void *userData, DRWShadingGroup *shgrp), void *userData);
389 void DRW_pass_sort_shgroup_z(DRWPass *pass);
390
391 /* Viewport */
392 typedef enum {
393         DRW_MAT_PERS = 0,
394         DRW_MAT_PERSINV,
395         DRW_MAT_VIEW,
396         DRW_MAT_VIEWINV,
397         DRW_MAT_WIN,
398         DRW_MAT_WININV,
399
400         DRW_MAT_COUNT, // Don't use this.
401 } DRWViewportMatrixType;
402
403 typedef struct DRWMatrixState {
404         float mat[DRW_MAT_COUNT][4][4];
405 } DRWMatrixState;
406
407 void DRW_viewport_init(const bContext *C);
408 void DRW_viewport_matrix_get(float mat[4][4], DRWViewportMatrixType type);
409 void DRW_viewport_matrix_get_all(DRWMatrixState *state);
410 void DRW_viewport_matrix_override_set(const float mat[4][4], DRWViewportMatrixType type);
411 void DRW_viewport_matrix_override_set_all(DRWMatrixState *state);
412 void DRW_viewport_matrix_override_unset(DRWViewportMatrixType type);
413 void DRW_viewport_matrix_override_unset_all(void);
414
415 const float *DRW_viewport_size_get(void);
416 const float *DRW_viewport_invert_size_get(void);
417 const float *DRW_viewport_screenvecs_get(void);
418 const float *DRW_viewport_pixelsize_get(void);
419 bool DRW_viewport_is_persp_get(void);
420
421 struct DefaultFramebufferList *DRW_viewport_framebuffer_list_get(void);
422 struct DefaultTextureList     *DRW_viewport_texture_list_get(void);
423
424 void DRW_viewport_request_redraw(void);
425
426 void DRW_render_to_image(struct RenderEngine *engine, struct Depsgraph *graph);
427 void DRW_render_object_iter(
428         void *vedata, struct RenderEngine *engine, struct Depsgraph *graph,
429         void (*callback)(void *vedata, struct Object *ob, struct RenderEngine *engine, struct Depsgraph *graph));
430 void DRW_render_instance_buffer_finish(void);
431
432 /* ViewLayers */
433 void *DRW_view_layer_engine_data_get(DrawEngineType *engine_type);
434 void **DRW_view_layer_engine_data_ensure(DrawEngineType *engine_type, void (*callback)(void *storage));
435
436 /* Objects */
437 ObjectEngineData *DRW_object_engine_data_get(Object *ob, DrawEngineType *engine_type);
438 ObjectEngineData *DRW_object_engine_data_ensure(
439         Object *ob,
440         DrawEngineType *engine_type,
441         size_t size,
442         ObjectEngineDataInitCb init_cb,
443         ObjectEngineDataFreeCb free_cb);
444 struct LampEngineData *DRW_lamp_engine_data_ensure(Object *ob, struct RenderEngineType *engine_type);
445 void DRW_lamp_engine_data_free(struct LampEngineData *led);
446
447 /* Settings */
448 bool DRW_object_is_renderable(struct Object *ob);
449 bool DRW_check_object_visible_within_active_context(struct Object *ob);
450 bool DRW_object_is_flat_normal(const struct Object *ob);
451 int  DRW_object_is_mode_shade(const struct Object *ob);
452
453 /* Draw commands */
454 void DRW_draw_pass(DRWPass *pass);
455 void DRW_draw_pass_subset(DRWPass *pass, DRWShadingGroup *start_group, DRWShadingGroup *end_group);
456
457 void DRW_draw_text_cache_queue(struct DRWTextStore *dt);
458
459 void DRW_draw_callbacks_pre_scene(void);
460 void DRW_draw_callbacks_post_scene(void);
461
462 int DRW_draw_region_engine_info_offset(void);
463 void DRW_draw_region_engine_info(void);
464
465 void DRW_state_reset_ex(DRWState state);
466 void DRW_state_reset(void);
467 void DRW_state_lock(DRWState state);
468
469 void DRW_state_invert_facing(void);
470
471 void DRW_state_clip_planes_count_set(unsigned int plane_ct);
472 void DRW_state_clip_planes_reset(void);
473
474 /* Culling, return true if object is inside view frustum. */
475 bool DRW_culling_sphere_test(BoundSphere *bsphere);
476 bool DRW_culling_box_test(BoundBox *bbox);
477
478 /* Selection */
479 void DRW_select_load_id(unsigned int id);
480
481 /* Draw State */
482 void DRW_state_dfdy_factors_get(float dfdyfac[2]);
483 bool DRW_state_is_fbo(void);
484 bool DRW_state_is_select(void);
485 bool DRW_state_is_depth(void);
486 bool DRW_state_is_image_render(void);
487 bool DRW_state_is_scene_render(void);
488 bool DRW_state_is_opengl_render(void);
489 bool DRW_state_show_text(void);
490 bool DRW_state_draw_support(void);
491 bool DRW_state_draw_background(void);
492
493 enum eDepsObjectIteratorMode DRW_iterator_mode_get(void);
494
495 struct DRWTextStore *DRW_state_text_cache_get(void);
496
497 /* Avoid too many lookups while drawing */
498 typedef struct DRWContextState {
499
500         struct ARegion *ar;         /* 'CTX_wm_region(C)' */
501         struct RegionView3D *rv3d;  /* 'CTX_wm_region_view3d(C)' */
502         struct View3D *v3d;     /* 'CTX_wm_view3d(C)' */
503
504         struct Scene *scene;    /* 'CTX_data_scene(C)' */
505         struct ViewLayer *view_layer;  /* 'CTX_data_view_layer(C)' */
506
507         /* Use 'object_edit' for edit-mode */
508         struct Object *obact;   /* 'OBACT' */
509
510         struct RenderEngineType *engine_type;
511
512         struct Depsgraph *depsgraph;
513
514         eObjectMode object_mode;
515
516         /* Last resort (some functions take this as an arg so we can't easily avoid).
517          * May be NULL when used for selection or depth buffer. */
518         const struct bContext *evil_C;
519
520         /* ---- */
521
522         /* Cache: initialized by 'drw_context_state_init'. */
523         struct Object *object_pose;
524         struct Object *object_edit;
525
526 } DRWContextState;
527
528 const DRWContextState *DRW_context_state_get(void);
529
530 #endif /* __DRW_RENDER_H__ */