Initial revision
[blender.git] / source / blender / renderconverter / RE_renderconverter.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * Interface to transform the Blender scene into renderable data.
32  *
33  * @mainpage RE - Blender RE-converter external interface
34  *
35  * @section about About the RE-converter module
36  *
37  * The converter takes a Blender scene, and transforms the data into
38  * renderer-specific data.
39  *
40  * Conversions:
41  * 
42  * halos: (world settings) stars ->
43  *        some particle effects  ->
44  *        meshes with halo prop  ->  
45  *                                  HaloRen (made by inithalo)
46  *
47  *
48  *                                  VlakRen (face render data)
49  * Each vlakren needs several VertRens to make sense.
50  *                                  VertRen (vertex render data)
51  *
52  * @section issues Known issues with RE-converter
53  *
54  *
55  * @section dependencies Dependencies
56  *
57  *
58  * */
59
60 #ifndef RE_RENDERCONVERTER_H
61 #define RE_RENDERCONVERTER_H
62
63 #ifdef __cplusplus
64 extern "C" {
65 #endif
66
67         struct LampRen;
68         struct Object;
69         struct Lamp;
70         
71         /** Transform a blender scene to render data. */
72         void RE_rotateBlenderScene(void);
73
74         /** Free all memory used for the conversion. */
75         void RE_freeRotateBlenderScene(void);
76
77         /**
78          * Used by the preview renderer.
79          */
80         void RE_add_render_lamp(struct Object *ob, int doshadbuf);
81
82         /**
83          * Strange support for star rendering for drawview.c... For
84          * rendering purposes, these function pointers should be NULL.
85          */
86         void RE_make_stars(void (*initfunc)(void),
87                                            void (*vertexfunc)(float*),
88                                            void (*termfunc)(void));
89                 
90 #ifdef __cplusplus
91 }
92 #endif
93 #endif
94
95