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