RenderEngine: steps towards implementation of this proposal:
[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 Object;
39 struct Render;
40 struct RenderEngine;
41 struct RenderEngineType;
42 struct RenderLayer;
43 struct RenderResult;
44 struct ReportList;
45 struct Scene;
46
47 /* External Engine */
48
49 /* RenderEngineType.flag */
50 #define RE_INTERNAL                             1
51 #define RE_GAME                                 2
52 #define RE_USE_PREVIEW                  4
53 #define RE_USE_POSTPROCESS              8
54
55 /* RenderEngine.flag */
56 #define RE_ENGINE_ANIMATION             1
57 #define RE_ENGINE_PREVIEW               2
58 #define RE_ENGINE_DO_DRAW               4
59 #define RE_ENGINE_DO_UPDATE             8
60
61 extern ListBase R_engines;
62
63 typedef struct RenderEngineType {
64         struct RenderEngineType *next, *prev;
65
66         /* type info */
67         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
68         char name[64];
69         int flag;
70
71         void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Scene *scene);
72         void (*render)(struct RenderEngine *engine, struct Scene *scene);
73
74         /* RNA integration */
75         ExtensionRNA ext;
76 } RenderEngineType;
77
78 typedef struct RenderEngine {
79         RenderEngineType *type;
80         void *py_instance;
81
82         int flag;
83
84         struct Render *re;
85         ListBase fullresult;
86         char *text;
87 } RenderEngine;
88
89 RenderEngine *RE_engine_create(RenderEngineType *type);
90 void RE_engine_free(RenderEngine *engine);
91
92 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
93 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
94
95 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h);
96 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
97 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result);
98
99 int RE_engine_test_break(RenderEngine *engine);
100 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
101 void RE_engine_update_progress(RenderEngine *engine, float progress);
102 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
103
104 int RE_engine_render(struct Render *re, int do_all);
105
106 /* Engine Types */
107
108 void RE_engines_init(void);
109 void RE_engines_exit(void);
110
111 RenderEngineType *RE_engines_find(const char *idname);
112
113 #endif /* RE_ENGINE_H */
114