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