Fix threading issues of viewport rendering when using movies/generated images
[blender.git] / source / blender / render / extern / include / RE_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  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file RE_engine.h
29  *  \ingroup render
30  */
31
32 #ifndef __RE_ENGINE_H__
33 #define __RE_ENGINE_H__
34
35 #include "DNA_listBase.h"
36 #include "RNA_types.h"
37
38 struct bNode;
39 struct bNodeTree;
40 struct Object;
41 struct Render;
42 struct RenderEngine;
43 struct RenderEngineType;
44 struct RenderLayer;
45 struct RenderResult;
46 struct ReportList;
47 struct Scene;
48
49 /* External Engine */
50
51 /* RenderEngineType.flag */
52 #define RE_INTERNAL                             1
53 #define RE_GAME                                 2
54 #define RE_USE_PREVIEW                  4
55 #define RE_USE_POSTPROCESS              8
56 #define RE_USE_SHADING_NODES    16
57
58 /* RenderEngine.flag */
59 #define RE_ENGINE_ANIMATION             1
60 #define RE_ENGINE_PREVIEW               2
61 #define RE_ENGINE_DO_DRAW               4
62 #define RE_ENGINE_DO_UPDATE             8
63 #define RE_ENGINE_RENDERING             16
64 #define RE_ENGINE_HIGHLIGHT_TILES       32
65 #define RE_ENGINE_USED_FOR_VIEWPORT     64
66
67 extern ListBase R_engines;
68
69 typedef struct RenderEngineType {
70         struct RenderEngineType *next, *prev;
71
72         /* type info */
73         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
74         char name[64];
75         int flag;
76
77         void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Scene *scene);
78         void (*render)(struct RenderEngine *engine, struct Scene *scene);
79
80         void (*view_update)(struct RenderEngine *engine, const struct bContext *context);
81         void (*view_draw)(struct RenderEngine *engine, const struct bContext *context);
82
83         void (*update_script_node)(struct RenderEngine *engine, struct bNodeTree *ntree, struct bNode *node);
84
85         /* RNA integration */
86         ExtensionRNA ext;
87 } RenderEngineType;
88
89 typedef struct RenderEngine {
90         RenderEngineType *type;
91         void *py_instance;
92
93         int flag;
94         struct Object *camera_override;
95
96         int tile_x;
97         int tile_y;
98
99         struct Render *re;
100         ListBase fullresult;
101         char *text;
102
103         int resolution_x, resolution_y;
104
105         struct ReportList *reports;
106 } RenderEngine;
107
108 RenderEngine *RE_engine_create(RenderEngineType *type);
109 RenderEngine *RE_engine_create_ex(RenderEngineType *type, int use_for_viewport);
110 void RE_engine_free(RenderEngine *engine);
111
112 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
113 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
114
115 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h, const char *layername);
116 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
117 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result, int cancel);
118
119 int RE_engine_test_break(RenderEngine *engine);
120 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
121 void RE_engine_update_progress(RenderEngine *engine, float progress);
122 void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
123 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
124
125 int RE_engine_render(struct Render *re, int do_all);
126
127 int RE_engine_is_external(struct Render *re);
128
129 /* Engine Types */
130
131 void RE_engines_init(void);
132 void RE_engines_exit(void);
133
134 RenderEngineType *RE_engines_find(const char *idname);
135
136 void RE_engine_get_current_tiles(struct Render *re, int *total_tiles_r, rcti **tiles_r);
137
138 #endif /* __RE_ENGINE_H__ */
139