Merge remote-tracking branch 'origin/master' into blender2.8
[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 #include "BLI_sys_types.h"  /* for bool */
30
31 struct ARegion;
32 struct CollectionEngineSettings;
33 struct Depsgraph;
34 struct DRWPass;
35 struct DRWInstanceDataList;
36 struct Main;
37 struct Material;
38 struct Scene;
39 struct DrawEngineType;
40 struct ID;
41 struct IDProperty;
42 struct bContext;
43 struct Object;
44 struct ViewLayer;
45 struct ViewContext;
46 struct ViewportEngineData;
47 struct View3D;
48 struct rcti;
49 struct GPUMaterial;
50 struct GPUOffScreen;
51 struct GPUViewport;
52 struct RenderEngine;
53 struct RenderEngineType;
54 struct WorkSpace;
55
56 #include "DNA_object_enums.h"
57
58 /* Buffer and textures used by the viewport by default */
59 typedef struct DefaultFramebufferList {
60         struct GPUFrameBuffer *default_fb;
61         struct GPUFrameBuffer *color_only_fb;
62         struct GPUFrameBuffer *depth_only_fb;
63         struct GPUFrameBuffer *multisample_fb;
64 } DefaultFramebufferList;
65
66 typedef struct DefaultTextureList {
67         struct GPUTexture *color;
68         struct GPUTexture *depth;
69         struct GPUTexture *multisample_color;
70         struct GPUTexture *multisample_depth;
71 } DefaultTextureList;
72
73 void DRW_engines_register(void);
74 void DRW_engines_free(void);
75
76 bool DRW_engine_render_support(struct DrawEngineType *draw_engine_type);
77 void DRW_engine_register(struct DrawEngineType *draw_engine_type);
78 void DRW_engine_viewport_data_size_get(
79         const void *engine_type,
80         int *r_fbl_len, int *r_txl_len, int *r_psl_len, int *r_stl_len);
81
82 typedef struct DRWUpdateContext {
83         struct Main *bmain;
84         struct Depsgraph *depsgraph;
85         struct Scene *scene;
86         struct ViewLayer *view_layer;
87         struct ARegion *ar;
88         struct View3D *v3d;
89         struct RenderEngineType *engine_type;
90 } DRWUpdateContext;
91 void DRW_notify_view_update(const DRWUpdateContext *update_ctx);
92
93
94 typedef enum eDRWSelectStage { DRW_SELECT_PASS_PRE = 1, DRW_SELECT_PASS_POST, } eDRWSelectStage;
95 typedef bool (*DRW_SelectPassFn)(
96         eDRWSelectStage stage, void *user_data);
97 typedef bool (*DRW_ObjectFilterFn)(
98         struct Object *ob, void *user_data);
99
100 void DRW_draw_view(const struct bContext *C);
101 void DRW_draw_region_engine_info(int xoffset, int yoffset);
102
103 void DRW_draw_render_loop_ex(
104         struct Depsgraph *depsgraph,
105         struct RenderEngineType *engine_type,
106         struct ARegion *ar, struct View3D *v3d,
107         struct GPUViewport *viewport,
108         const struct bContext *evil_C);
109 void DRW_draw_render_loop(
110         struct Depsgraph *depsgraph,
111         struct ARegion *ar, struct View3D *v3d,
112         struct GPUViewport *viewport);
113 void DRW_draw_render_loop_offscreen(
114         struct Depsgraph *depsgraph,
115         struct RenderEngineType *engine_type,
116         struct ARegion *ar, struct View3D *v3d,
117         const bool draw_background,
118         struct GPUOffScreen *ofs,
119         struct GPUViewport *viewport);
120 void DRW_draw_select_loop(
121         struct Depsgraph *depsgraph,
122         struct ARegion *ar, struct View3D *v3d,
123         bool use_obedit_skip, bool draw_surface, bool use_nearest, const struct rcti *rect,
124         DRW_SelectPassFn select_pass_fn, void *select_pass_user_data,
125         DRW_ObjectFilterFn object_filter_fn, void *object_filter_user_data);
126 void DRW_draw_depth_loop(
127         struct Depsgraph *depsgraph,
128         struct ARegion *ar, struct View3D *v3d);
129
130 /* grease pencil render */
131 bool DRW_render_check_grease_pencil(struct Depsgraph *depsgraph);
132 void DRW_render_gpencil(struct RenderEngine *engine, struct Depsgraph *depsgraph);
133 void DRW_gpencil_freecache(struct Object *ob);
134
135 /* This is here because GPUViewport needs it */
136 void DRW_pass_free(struct DRWPass *pass);
137 struct DRWInstanceDataList *DRW_instance_data_list_create(void);
138 void DRW_instance_data_list_free(struct DRWInstanceDataList *idatalist);
139
140 void DRW_opengl_context_create(void);
141 void DRW_opengl_context_destroy(void);
142 void DRW_opengl_context_enable(void);
143 void DRW_opengl_context_disable(void);
144
145 /* Never use this. Only for closing blender. */
146 void DRW_opengl_context_enable_ex(bool restore);
147 void DRW_opengl_context_disable_ex(bool restore);
148
149 void DRW_opengl_render_context_enable(void *re_gl_context);
150 void DRW_opengl_render_context_disable(void *re_gl_context);
151 void DRW_gawain_render_context_enable(void *re_gpu_context);
152 void DRW_gawain_render_context_disable(void *re_gpu_context);
153
154 void DRW_deferred_shader_remove(struct GPUMaterial *mat);
155
156 struct DrawDataList *DRW_drawdatalist_from_id(struct ID *id);
157 void DRW_drawdata_free(struct ID *id);
158
159 #endif /* __DRW_ENGINE_H__ */