Code refactoring: move external engine functions into own file.
[blender.git] / source / blender / render / extern / include / RE_engine.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2006 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file RE_engine.h
31  *  \ingroup render
32  */
33
34 #ifndef RE_ENGINE_H
35 #define RE_ENGINE_H
36
37 #include "DNA_listBase.h"
38 #include "RNA_types.h"
39
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 #define RE_INTERNAL                     1
52 #define RE_GAME                         2
53 #define RE_DO_PREVIEW           4
54 #define RE_DO_ALL                       8
55
56 extern ListBase R_engines;
57
58 typedef struct RenderEngineType {
59         struct RenderEngineType *next, *prev;
60
61         /* type info */
62         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
63         char name[64];
64         int flag;
65
66         void (*render)(struct RenderEngine *engine, struct Scene *scene);
67
68         /* RNA integration */
69         ExtensionRNA ext;
70 } RenderEngineType;
71
72 typedef struct RenderEngine {
73         RenderEngineType *type;
74         struct Render *re;
75         ListBase fullresult;
76 } RenderEngine;
77
78 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
79 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
80
81 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h);
82 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
83 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result);
84
85 int RE_engine_test_break(RenderEngine *engine);
86 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
87 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
88
89 int RE_engine_render(struct Render *re, int do_all);
90
91 /* Engine Types */
92
93 void RE_engines_init(void);
94 void RE_engines_exit(void);
95
96 #endif /* RE_ENGINE_H */
97