afe0d5f5ab8ac1cc5b9ba3b8d563fe0a6ae9ef1e
[blender.git] / source / blender / makesdna / DNA_scene_types.h
1 /**
2  * blenlib/DNA_scene_types.h (mar-2001 nzc)
3  *
4  * Renderrecipe and scene decription. The fact that there is a
5  * hierarchy here is a bit strange, and not desirable.
6  *
7  * $Id$ 
8  *
9  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version. The Blender
15  * Foundation also sells licenses for use in proprietary software under
16  * the Blender License.  See http://www.blender.org/BL/ for information
17  * about this.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  *
28  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
29  * All rights reserved.
30  *
31  * The Original Code is: all of this file.
32  *
33  * Contributor(s): none yet.
34  *
35  * ***** END GPL/BL DUAL LICENSE BLOCK *****
36  */
37 #ifndef DNA_SCENE_TYPES_H
38 #define DNA_SCENE_TYPES_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include "DNA_vec_types.h"
45 #include "DNA_listBase.h"
46 #include "DNA_scriptlink_types.h"
47 #include "DNA_ID.h"
48 #include "DNA_scriptlink_types.h"
49
50 struct FreeCamera;
51 struct Radio;
52 struct Object;
53 struct World;
54 struct Scene;
55 struct Image;
56 struct Group;
57
58 typedef struct Base {
59         struct Base *next, *prev;
60         unsigned int lay, selcol;
61         int flag;
62         short sx, sy;
63         struct Object *object;
64 } Base;
65
66 typedef struct AviCodecData {
67         void                    *lpFormat;                      /* save format */
68         void                    *lpParms;                       /* compressor options */
69         unsigned int    cbFormat;                       /* size of lpFormat buffer */
70         unsigned int    cbParms;                        /* size of lpParms buffer */
71
72         unsigned int    fccType;            /* stream type, for consistency */
73         unsigned int    fccHandler;         /* compressor */
74         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
75         unsigned int    dwQuality;          /* compress quality 0-10,000 */
76         unsigned int    dwBytesPerSecond;   /* bytes per second */
77         unsigned int    dwFlags;            /* flags... see below */
78         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
79         unsigned int    pad;
80
81         char                    avicodecname[128];
82 } AviCodecData;
83
84 typedef struct RenderData {
85         struct AviCodecData *avicodecdata;
86         
87         short cfra, sfra, efra; /* fames as in 'images' */
88         short images, framapto, flag;
89         float ctime;                    /* use for calcutions */
90         float framelen, blurfac;
91
92         /** For UR edge rendering: give the edges this colour */
93         float edgeR, edgeG, edgeB;
94         
95         short fullscreen, xplay, yplay, freqplay;       /* standalone player */
96         short depth, attrib, rt1, rt2;                          /* standalone player */
97
98         short stereomode;                                       /* standalone player stereo settings */
99         short pad[3];
100
101         short size, maximsize;  /* size in %, max in Kb */
102         /* from buttons: */
103         /**
104          * The desired number of pixels in the x direction
105          */
106         short xsch;
107         /**
108          * The desired number of pixels in the y direction
109          */
110         short ysch;
111         /**
112          * Adjustment factors for the aspect ratio in the x direction
113          */
114         short xasp;
115         /**
116          * Adjustment factors for the aspect ratio in the x direction
117          */
118         short yasp;
119         /**
120          * The number of part to use in the x direction
121          */
122         short xparts;
123         /**
124          * The number of part to use in the y direction
125          */
126         short yparts;
127         /* should rewrite this I think... */
128         rctf safety, border;
129         
130         short winpos, planes, imtype;
131         /** Mode bits:                                                           */
132         /* 0: Enable backbuffering for images                                    */
133         short bufflag;
134         short quality;
135         /**
136          * Flags for render settings. Use bit-masking to access the settings.
137          * 0: enable sequence output rendering                                   
138          * 1: render daemon                                                      
139          * 4: add extensions to filenames
140          */
141         short scemode;
142
143         /**
144          * Flags for render settings. Use bit-masking to access the settings.
145          * The bits have these meanings:
146          * 0: do oversampling                                                    
147          * 1: do shadows                                                         
148          * 2: do gamma correction                                                
149          * 3: ortho (not used?)                                                  
150          * 4: trace (not used?)                                                  
151          * 5: edge shading                                                       
152          * 6: field rendering                                                    
153          * 7: Disables time difference in field calculations                     
154          * 8: Gauss ? is this for sampling?                                      
155          * 9: borders                                                            
156          * 10: panorama                                                          
157          * 11: crop                                                              
158          * 12: save SGI movies with Cosmo hardware (????)                        
159          * 13: odd field first rendering                                         
160          * 14: motion blur                                                       
161          * 15: use unified renderer for this pic!                                
162          */
163         short mode;
164
165         /**
166          * What to do with the sky/background. Picks sky/premul/key
167          * blending for the background
168          */
169         short alphamode;
170         /**
171          * Toggles whether to apply a gamma correction for subpixel to
172          * pixel blending
173          */
174         short dogamma;
175         /**
176          * The number of samples to use per pixel.
177          */
178         short osa;
179         short frs_sec, edgeint;
180
181         /** For unified renderer: reduce intensity on boundaries with
182          * identical materials with this number.*/
183         short same_mat_redux, pad_3[3];
184         
185         /**
186          * The gamma for the normal rendering. Used when doing
187          * oversampling, to correctly blend subpixels to pixels.  */
188         float gamma;
189         /** post-production settings. Don't really belong here */
190         float postmul, postgamma, postadd, postigamma;
191         
192         char backbuf[160], pic[160], ftype[160];
193         
194 } RenderData;
195
196
197 typedef struct GameFraming {
198         float col[3];
199         char type, pad1, pad2, pad3;
200 } GameFraming;
201
202 #define SCE_GAMEFRAMING_BARS   0
203 #define SCE_GAMEFRAMING_EXTEND 1
204 #define SCE_GAMEFRAMING_SCALE  2
205
206 typedef struct Scene {
207         ID id;
208         struct Object *camera;
209         struct World *world;
210         
211         struct Scene *set;
212         struct Image *ima;
213         
214         ListBase base;
215         struct Base *basact;
216         struct Group *group;
217         
218         float cursor[3];
219         unsigned int lay;
220
221         /* some realtime vars */
222         struct FreeCamera *fcam;  /* old, can be removed (ton) */
223         
224         void *ed;
225         struct Radio *radio;
226         void *sumohandle;
227         
228         struct GameFraming framing;
229
230         /* migrate or replace? depends on some internal things... */
231         /* no, is on the right place (ton) */
232         struct RenderData r;
233         
234         ScriptLink scriptlink;
235 } Scene;
236
237
238 /* **************** RENDERDATA ********************* */
239
240 /* bufflag */
241 #define R_BACKBUF               1
242 #define R_BACKBUFANIM   2
243 #define R_FRONTBUF              4
244 #define R_FRONTBUFANIM  8
245
246 /* mode */
247 #define R_OSA                   0x0001  
248 #define R_SHADOW                0x0002  
249 #define R_GAMMA                 0x0004
250 #define R_ORTHO                 0x0008
251 #define R_TRACE                 0x0010
252 #define R_EDGE                  0x0020
253 #define R_FIELDS                0x0040
254 #define R_FIELDSTILL    0x0080
255 #define R_GAUSS                 0x0100
256 #define R_BORDER                0x0200
257 #define R_PANORAMA              0x0400
258 #define R_MOVIECROP             0x0800
259 #define R_COSMO                 0x1000
260 /* these difines were different between IrisGL and OpenGL!!! */
261 #define R_ODDFIELD              0x2000
262 #define R_MBLUR                 0x4000
263 #define R_UNIFIED       0x8000
264
265 /* scemode */
266 #define R_DOSEQ                 0x0001
267 #define R_BG_RENDER             0x0002
268
269 #define R_EXTENSION             0x0010
270 #define R_OGL                   0x0020
271
272 /* alphamode */
273 #define R_ADDSKY                0
274 #define R_ALPHAPREMUL   1
275 #define R_ALPHAKEY              2
276
277 /* planes */
278 #define R_PLANES24              24
279 #define R_PLANES32              32
280 #define R_PLANESBW              8
281
282 /* imtype */
283 #define R_TARGA         0
284 #define R_IRIS          1
285 #define R_HAMX          2
286 #define R_FTYPE         3
287 #define R_JPEG90        4
288 #define R_MOVIE         5
289 #define R_IRIZ          7
290 #define R_RAWTGA        14
291 #define R_AVIRAW        15
292 #define R_AVIJPEG       16
293 #define R_PNG           17
294 #define R_AVICODEC      18
295 #define R_QUICKTIME 19
296
297
298 /* **************** RENDER ********************* */
299 /* mode flag is same as for renderdata */
300 /* flag */
301 #define R_ZTRA                  1
302 #define R_HALO                  2
303 #define R_SEC_FIELD             4
304 #define R_LAMPHALO              8
305 #define R_RENDERING             16
306 #define R_ANIMRENDER    32
307
308 /* vlakren->flag (vlak = face in dutch) */
309 #define R_SMOOTH                1
310 #define R_VISIBLE               2
311 #define R_NOPUNOFLIP    8
312 #define R_CMAPCODE              16
313 #define R_FACE_SPLIT    32
314
315 /* vertren->texofs (texcoordinate offset relative to vertren->orco */
316 #define R_UVOFS3        1
317
318 /* **************** SCENE ********************* */
319 #define RAD_PHASE_PATCHES       1
320 #define RAD_PHASE_FACES         2
321
322 /* base->flag and ob->flag */
323 #define BA_WASSEL                       2
324 #define BA_PARSEL                       4
325 #define BA_WHERE_UPDATE         8
326 #define BA_DISP_UPDATE          16
327 #define BA_DO_IPO                       32
328 #define BA_FROMSET                      128
329 #define OB_DO_IMAT                      256
330 #define OB_FROMDUPLI            512
331 #define OB_DONE                         1024
332 #define OB_RADIO                        2048
333 #define OB_FROMGROUP            4096
334
335 /* sce->flag */
336 #define SCE_ADDSCENAME          1
337
338 /* return flag next_object function */
339 #define F_START                 0
340 #define F_SCENE                 1
341 #define F_SET                   2
342 #define F_DUPLI                 3
343
344 #ifdef __cplusplus
345 }
346 #endif
347
348 #endif
349