Draw manager: Cleanup, use full name for depsgraph variable
[blender.git] / source / blender / draw / DRW_engine.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_engine.h
23  *  \ingroup draw
24  */
25
26 #ifndef __DRW_ENGINE_H__
27 #define __DRW_ENGINE_H__
28
29 struct ARegion;
30 struct CollectionEngineSettings;
31 struct Depsgraph;
32 struct DRWPass;
33 struct DRWInstanceDataList;
34 struct Main;
35 struct Material;
36 struct Scene;
37 struct DrawEngineType;
38 struct ID;
39 struct IDProperty;
40 struct bContext;
41 struct Object;
42 struct ViewLayer;
43 struct ViewContext;
44 struct ViewportEngineData;
45 struct View3D;
46 struct rcti;
47 struct GPUOffScreen;
48 struct GPUViewport;
49 struct RenderEngineType;
50 struct WorkSpace;
51
52 #include "BLI_sys_types.h"  /* for bool */
53
54 /* Buffer and textures used by the viewport by default */
55 typedef struct DefaultFramebufferList {
56         struct GPUFrameBuffer *default_fb;
57         struct GPUFrameBuffer *multisample_fb;
58 } DefaultFramebufferList;
59
60 typedef struct DefaultTextureList {
61         struct GPUTexture *color;
62         struct GPUTexture *depth;
63         struct GPUTexture *multisample_color;
64         struct GPUTexture *multisample_depth;
65 } DefaultTextureList;
66
67 void DRW_engines_register(void);
68 void DRW_engines_free(void);
69
70 void DRW_engine_register(struct DrawEngineType *draw_engine_type);
71 void DRW_engine_viewport_data_size_get(
72         const void *engine_type,
73         int *r_fbl_len, int *r_txl_len, int *r_psl_len, int *r_stl_len);
74
75 typedef struct DRWUpdateContext {
76         struct Main *bmain;
77         struct Depsgraph *depsgraph;
78         struct Scene *scene;
79         struct ViewLayer *view_layer;
80         struct ARegion *ar;
81         struct View3D *v3d;
82         struct RenderEngineType *engine_type;
83 } DRWUpdateContext;
84 void DRW_notify_view_update(const DRWUpdateContext *update_ctx);
85 void DRW_notify_id_update(const DRWUpdateContext *update_ctx, struct ID *id);
86
87 void DRW_draw_view(const struct bContext *C);
88
89 void DRW_draw_render_loop_ex(
90         struct Depsgraph *depsgraph,
91         struct RenderEngineType *engine_type,
92         struct ARegion *ar, struct View3D *v3d,
93         const struct bContext *evil_C);
94 void DRW_draw_render_loop(
95         struct Depsgraph *depsgraph,
96         struct ARegion *ar, struct View3D *v3d);
97 void DRW_draw_render_loop_offscreen(
98         struct Depsgraph *depsgraph,
99         struct RenderEngineType *engine_type,
100         struct ARegion *ar, struct View3D *v3d,
101         const bool draw_background,
102         struct GPUOffScreen *ofs,
103         struct GPUViewport *viewport);
104 void DRW_draw_select_loop(
105         struct Depsgraph *depsgraph,
106         struct ARegion *ar, struct View3D *v3d,
107         bool use_obedit_skip, bool use_nearest, const struct rcti *rect);
108 void DRW_draw_depth_loop(
109         struct Depsgraph *depsgraph,
110         struct ARegion *ar, struct View3D *v3d);
111
112 /* This is here because GPUViewport needs it */
113 void DRW_pass_free(struct DRWPass *pass);
114 struct DRWInstanceDataList *DRW_instance_data_list_create(void);
115 void DRW_instance_data_list_free(struct DRWInstanceDataList *idatalist);
116
117 /* Mode engines initialization */
118 void OBJECT_collection_settings_create(struct IDProperty *properties);
119 void EDIT_MESH_collection_settings_create(struct IDProperty *properties);
120 void EDIT_ARMATURE_collection_settings_create(struct IDProperty *properties);
121 void PAINT_WEIGHT_collection_settings_create(struct IDProperty *properties);
122 void PAINT_VERTEX_collection_settings_create(struct IDProperty *properties);
123
124 #endif /* __DRW_ENGINE_H__ */