Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_scene_types.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) 2001-2002 by NaN Holding BV.
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 DNA_scene_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_SCENE_TYPES_H__
33 #define __DNA_SCENE_TYPES_H__
34
35 #include "DNA_defs.h"
36
37 /* XXX, temp feature - campbell */
38 #define DURIAN_CAMERA_SWITCH
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include "DNA_color_types.h"  /* color management */
45 #include "DNA_vec_types.h"
46 #include "DNA_listBase.h"
47 #include "DNA_ID.h"
48 #include "DNA_freestyle_types.h"
49 #include "DNA_gpu_types.h"
50 #include "DNA_layer_types.h"
51 #include "DNA_material_types.h"
52 #include "DNA_userdef_types.h"
53
54 struct CurveMapping;
55 struct Object;
56 struct Brush;
57 struct World;
58 struct Scene;
59 struct Image;
60 struct Group;
61 struct Text;
62 struct bNodeTree;
63 struct AnimData;
64 struct Editing;
65 struct SceneStats;
66 struct bGPdata;
67 struct bGPDbrush;
68 struct MovieClip;
69 struct ColorSpace;
70 struct SceneCollection;
71
72 /* ************************************************************* */
73 /* Scene Data */
74
75 /* ************************************************************* */
76 /* Output Format Data */
77
78 typedef struct AviCodecData {
79         void                    *lpFormat;  /* save format */
80         void                    *lpParms;   /* compressor options */
81         unsigned int    cbFormat;           /* size of lpFormat buffer */
82         unsigned int    cbParms;            /* size of lpParms buffer */
83
84         unsigned int    fccType;            /* stream type, for consistency */
85         unsigned int    fccHandler;         /* compressor */
86         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
87         unsigned int    dwQuality;          /* compress quality 0-10,000 */
88         unsigned int    dwBytesPerSecond;   /* bytes per second */
89         unsigned int    dwFlags;            /* flags... see below */
90         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
91         unsigned int    pad;
92
93         char                    avicodecname[128];
94 } AviCodecData;
95
96 typedef enum eFFMpegPreset {
97         FFM_PRESET_NONE,
98         FFM_PRESET_ULTRAFAST,
99         FFM_PRESET_SUPERFAST,
100         FFM_PRESET_VERYFAST,
101         FFM_PRESET_FASTER,
102         FFM_PRESET_FAST,
103         FFM_PRESET_MEDIUM,
104         FFM_PRESET_SLOW,
105         FFM_PRESET_SLOWER,
106         FFM_PRESET_VERYSLOW,
107 } eFFMpegPreset;
108
109
110 /* Mapping from easily-understandable descriptions to CRF values.
111  * Assumes we output 8-bit video. Needs to be remapped if 10-bit
112  * is output.
113  * We use a slightly wider than "subjectively sane range" according
114  * to https://trac.ffmpeg.org/wiki/Encode/H.264#a1.ChooseaCRFvalue
115  */
116 typedef enum eFFMpegCrf {
117         FFM_CRF_NONE = -1,
118         FFM_CRF_LOSSLESS = 0,
119         FFM_CRF_PERC_LOSSLESS = 17,
120         FFM_CRF_HIGH = 20,
121         FFM_CRF_MEDIUM = 23,
122         FFM_CRF_LOW = 26,
123         FFM_CRF_VERYLOW = 29,
124         FFM_CRF_LOWEST = 32,
125 } eFFMpegCrf;
126
127 typedef struct FFMpegCodecData {
128         int type;
129         int codec;
130         int audio_codec;
131         int video_bitrate;
132         int audio_bitrate;
133         int audio_mixrate;
134         int audio_channels;
135         int audio_pad;
136         float audio_volume;
137         int gop_size;
138         int max_b_frames; /* only used if FFMPEG_USE_MAX_B_FRAMES flag is set. */
139         int flags;
140         int constant_rate_factor;
141         int ffmpeg_preset; /* see eFFMpegPreset */
142
143         int rc_min_rate;
144         int rc_max_rate;
145         int rc_buffer_size;
146         int mux_packet_size;
147         int mux_rate;
148         int pad1;
149
150         IDProperty *properties;
151 } FFMpegCodecData;
152
153 /* ************************************************************* */
154 /* Audio */
155
156 typedef struct AudioData {
157         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
158         float main; // 2.5: now in FFMpegCodecData: audio_volume
159         float speed_of_sound;
160         float doppler_factor;
161         int distance_model;
162         short flag;
163         short pad;
164         float volume;
165         float pad2;
166 } AudioData;
167
168 /* *************************************************************** */
169 /* Render Layers */
170
171 /* Render Layer */
172 typedef struct SceneRenderLayer {
173         struct SceneRenderLayer *next, *prev;
174         
175         char name[64] DNA_DEPRECATED;   /* MAX_NAME */
176         
177         struct Material *mat_override DNA_DEPRECATED; /* Converted to ViewLayer override. */
178         
179         unsigned int lay DNA_DEPRECATED; /* Converted to LayerCollection cycles camera visibility override. */
180         unsigned int lay_zmask DNA_DEPRECATED; /* Converted to LayerCollection cycles holdout override. */
181         unsigned int lay_exclude DNA_DEPRECATED;
182         int layflag DNA_DEPRECATED; /* Converted to ViewLayer layflag and flag. */
183         
184         int passflag DNA_DEPRECATED; /* pass_xor has to be after passflag */
185         int pass_xor DNA_DEPRECATED; /* Converted to ViewLayer passflag and flag. */
186
187         int samples DNA_DEPRECATED; /* Converted to ViewLayer override. */
188         float pass_alpha_threshold DNA_DEPRECATED; /* Converted to ViewLayer pass_alpha_threshold. */
189
190         IDProperty *prop DNA_DEPRECATED; /* Converted to ViewLayer id_properties. */
191
192         struct FreestyleConfig freestyleConfig DNA_DEPRECATED; /* Converted to ViewLayer freestyleConfig. */
193 } SceneRenderLayer;
194
195 /* srl->layflag */
196 #define SCE_LAY_SOLID   1
197 #define SCE_LAY_ZTRA    2
198 #define SCE_LAY_HALO    4
199 #define SCE_LAY_EDGE    8
200 #define SCE_LAY_SKY             16
201 #define SCE_LAY_STRAND  32
202 #define SCE_LAY_FRS             64
203 #define SCE_LAY_AO              128
204         /* flags between 256 and 0x8000 are set to 1 already, for future options */
205
206 #define SCE_LAY_ALL_Z           0x8000
207 #define SCE_LAY_XOR                     0x10000
208 #define SCE_LAY_DISABLE         0x20000
209 #define SCE_LAY_ZMASK           0x40000
210 #define SCE_LAY_NEG_ZMASK       0x80000
211
212 /* srl->passflag */
213 typedef enum eScenePassType {
214         SCE_PASS_COMBINED                 = (1 << 0),
215         SCE_PASS_Z                        = (1 << 1),
216         SCE_PASS_RGBA                     = (1 << 2),
217         SCE_PASS_DIFFUSE                  = (1 << 3),
218         SCE_PASS_SPEC                     = (1 << 4),
219         SCE_PASS_SHADOW                   = (1 << 5),
220         SCE_PASS_AO                       = (1 << 6),
221         SCE_PASS_REFLECT                  = (1 << 7),
222         SCE_PASS_NORMAL                   = (1 << 8),
223         SCE_PASS_VECTOR                   = (1 << 9),
224         SCE_PASS_REFRACT                  = (1 << 10),
225         SCE_PASS_INDEXOB                  = (1 << 11),
226         SCE_PASS_UV                       = (1 << 12),
227         SCE_PASS_INDIRECT                 = (1 << 13),
228         SCE_PASS_MIST                     = (1 << 14),
229         SCE_PASS_RAYHITS                  = (1 << 15),
230         SCE_PASS_EMIT                     = (1 << 16),
231         SCE_PASS_ENVIRONMENT              = (1 << 17),
232         SCE_PASS_INDEXMA                  = (1 << 18),
233         SCE_PASS_DIFFUSE_DIRECT           = (1 << 19),
234         SCE_PASS_DIFFUSE_INDIRECT         = (1 << 20),
235         SCE_PASS_DIFFUSE_COLOR            = (1 << 21),
236         SCE_PASS_GLOSSY_DIRECT            = (1 << 22),
237         SCE_PASS_GLOSSY_INDIRECT          = (1 << 23),
238         SCE_PASS_GLOSSY_COLOR             = (1 << 24),
239         SCE_PASS_TRANSM_DIRECT            = (1 << 25),
240         SCE_PASS_TRANSM_INDIRECT          = (1 << 26),
241         SCE_PASS_TRANSM_COLOR             = (1 << 27),
242         SCE_PASS_SUBSURFACE_DIRECT        = (1 << 28),
243         SCE_PASS_SUBSURFACE_INDIRECT      = (1 << 29),
244         SCE_PASS_SUBSURFACE_COLOR         = (1 << 30),
245 } eScenePassType;
246
247 #define RE_PASSNAME_COMBINED "Combined"
248 #define RE_PASSNAME_Z "Depth"
249 #define RE_PASSNAME_VECTOR "Vector"
250 #define RE_PASSNAME_NORMAL "Normal"
251 #define RE_PASSNAME_UV "UV"
252 #define RE_PASSNAME_RGBA "Color"
253 #define RE_PASSNAME_EMIT "Emit"
254 #define RE_PASSNAME_DIFFUSE "Diffuse"
255 #define RE_PASSNAME_SPEC "Spec"
256 #define RE_PASSNAME_SHADOW "Shadow"
257
258 #define RE_PASSNAME_AO "AO"
259 #define RE_PASSNAME_ENVIRONMENT "Env"
260 #define RE_PASSNAME_INDIRECT "Indirect"
261 #define RE_PASSNAME_REFLECT "Reflect"
262 #define RE_PASSNAME_REFRACT "Refract"
263 #define RE_PASSNAME_INDEXOB "IndexOB"
264 #define RE_PASSNAME_INDEXMA "IndexMA"
265 #define RE_PASSNAME_MIST "Mist"
266
267 #define RE_PASSNAME_RAYHITS "RayHits"
268 #define RE_PASSNAME_DIFFUSE_DIRECT "DiffDir"
269 #define RE_PASSNAME_DIFFUSE_INDIRECT "DiffInd"
270 #define RE_PASSNAME_DIFFUSE_COLOR "DiffCol"
271 #define RE_PASSNAME_GLOSSY_DIRECT "GlossDir"
272 #define RE_PASSNAME_GLOSSY_INDIRECT "GlossInd"
273 #define RE_PASSNAME_GLOSSY_COLOR "GlossCol"
274 #define RE_PASSNAME_TRANSM_DIRECT "TransDir"
275 #define RE_PASSNAME_TRANSM_INDIRECT "TransInd"
276 #define RE_PASSNAME_TRANSM_COLOR "TransCol"
277
278 #define RE_PASSNAME_SUBSURFACE_DIRECT "SubsurfaceDir"
279 #define RE_PASSNAME_SUBSURFACE_INDIRECT "SubsurfaceInd"
280 #define RE_PASSNAME_SUBSURFACE_COLOR "SubsurfaceCol"
281
282 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
283
284 /* View - MultiView */
285 typedef struct SceneRenderView {
286         struct SceneRenderView *next, *prev;
287
288         char name[64];  /* MAX_NAME */
289         char suffix[64];        /* MAX_NAME */
290
291         int viewflag;
292         int pad[2];
293         char pad2[4];
294
295 } SceneRenderView;
296
297 /* srv->viewflag */
298 #define SCE_VIEW_DISABLE                (1<<0)
299
300 /* scene.render.views_format */
301 enum {
302         SCE_VIEWS_FORMAT_STEREO_3D = 0,
303         SCE_VIEWS_FORMAT_MULTIVIEW = 1,
304 };
305
306 /* ImageFormatData.views_output */
307 enum {
308         R_IMF_VIEWS_INDIVIDUAL = 0,
309         R_IMF_VIEWS_STEREO_3D  = 1,
310         R_IMF_VIEWS_MULTIVIEW  = 2,
311 };
312
313 typedef struct Stereo3dFormat {
314         short flag;
315         char display_mode; /* encoding mode */
316         char anaglyph_type; /* anaglyph scheme for the user display */
317         char interlace_type;  /* interlace type for the user display */
318         char pad[3];
319 } Stereo3dFormat;
320
321 /* Stereo3dFormat.display_mode */
322 typedef enum eStereoDisplayMode {
323         S3D_DISPLAY_ANAGLYPH    = 0,
324         S3D_DISPLAY_INTERLACE   = 1,
325         S3D_DISPLAY_PAGEFLIP    = 2,
326         S3D_DISPLAY_SIDEBYSIDE  = 3,
327         S3D_DISPLAY_TOPBOTTOM   = 4,
328 } eStereoDisplayMode;
329
330 /* Stereo3dFormat.flag */
331 typedef enum eStereo3dFlag {
332         S3D_INTERLACE_SWAP        = (1 << 0),
333         S3D_SIDEBYSIDE_CROSSEYED  = (1 << 1),
334         S3D_SQUEEZED_FRAME        = (1 << 2),
335 } eStereo3dFlag;
336
337 /* Stereo3dFormat.anaglyph_type */
338 typedef enum eStereo3dAnaglyphType {
339         S3D_ANAGLYPH_REDCYAN      = 0,
340         S3D_ANAGLYPH_GREENMAGENTA = 1,
341         S3D_ANAGLYPH_YELLOWBLUE   = 2,
342 } eStereo3dAnaglyphType;
343
344 /* Stereo3dFormat.interlace_type */
345 typedef enum eStereo3dInterlaceType {
346         S3D_INTERLACE_ROW          = 0,
347         S3D_INTERLACE_COLUMN       = 1,
348         S3D_INTERLACE_CHECKERBOARD = 2,
349 } eStereo3dInterlaceType;
350
351 /* *************************************************************** */
352
353 /* Generic image format settings,
354  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
355  *
356  * note: its a bit strange that even though this is an image format struct
357  *  the imtype can still be used to select video formats.
358  *  RNA ensures these enum's are only selectable for render output.
359  */
360 typedef struct ImageFormatData {
361         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
362                        /* note, video types should only ever be set from this
363                         * structure when used from RenderData */
364         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
365                         * not a flag, only set 1 at a time */
366
367         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
368         char flag;     /* generic options for all image types, alpha zbuffer */
369
370         char quality;  /* (0 - 100), eg: jpeg quality */
371         char compress; /* (0 - 100), eg: png compression */
372
373
374         /* --- format specific --- */
375
376         /* OpenEXR */
377         char  exr_codec;
378
379         /* Cineon */
380         char  cineon_flag;
381         short cineon_white, cineon_black;
382         float cineon_gamma;
383
384         /* Jpeg2000 */
385         char  jp2_flag;
386         char jp2_codec;
387
388         /* TIFF */
389         char tiff_codec;
390
391         char pad[4];
392
393         /* Multiview */
394         char views_format;
395         Stereo3dFormat stereo3d_format;
396
397         /* color management */
398         ColorManagedViewSettings view_settings;
399         ColorManagedDisplaySettings display_settings;
400 } ImageFormatData;
401
402
403 /* ImageFormatData.imtype */
404 #define R_IMF_IMTYPE_TARGA           0
405 #define R_IMF_IMTYPE_IRIS            1
406 /* #define R_HAMX                    2 */ /* hamx is nomore */
407 /* #define R_FTYPE                   3 */ /* ftype is nomore */
408 #define R_IMF_IMTYPE_JPEG90          4
409 /* #define R_MOVIE                   5 */ /* movie is nomore */
410 #define R_IMF_IMTYPE_IRIZ            7
411 #define R_IMF_IMTYPE_RAWTGA         14
412 #define R_IMF_IMTYPE_AVIRAW         15
413 #define R_IMF_IMTYPE_AVIJPEG        16
414 #define R_IMF_IMTYPE_PNG            17
415 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
416 /* #define R_IMF_IMTYPE_QUICKTIME   19 */ /* quicktime is nomore */
417 #define R_IMF_IMTYPE_BMP            20
418 #define R_IMF_IMTYPE_RADHDR         21
419 #define R_IMF_IMTYPE_TIFF           22
420 #define R_IMF_IMTYPE_OPENEXR        23
421 #define R_IMF_IMTYPE_FFMPEG         24
422 #define R_IMF_IMTYPE_FRAMESERVER    25
423 #define R_IMF_IMTYPE_CINEON         26
424 #define R_IMF_IMTYPE_DPX            27
425 #define R_IMF_IMTYPE_MULTILAYER     28
426 #define R_IMF_IMTYPE_DDS            29
427 #define R_IMF_IMTYPE_JP2            30
428 #define R_IMF_IMTYPE_H264           31
429 #define R_IMF_IMTYPE_XVID           32
430 #define R_IMF_IMTYPE_THEORA         33
431 #define R_IMF_IMTYPE_PSD            34
432
433 #define R_IMF_IMTYPE_INVALID        255
434
435 /* ImageFormatData.flag */
436 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
437 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
438
439 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
440 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
441 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
442 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
443 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
444 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
445 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
446 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
447
448 /* ImageFormatData.planes */
449 #define R_IMF_PLANES_RGB   24
450 #define R_IMF_PLANES_RGBA  32
451 #define R_IMF_PLANES_BW    8
452
453 /* ImageFormatData.exr_codec */
454 #define R_IMF_EXR_CODEC_NONE  0
455 #define R_IMF_EXR_CODEC_PXR24 1
456 #define R_IMF_EXR_CODEC_ZIP   2
457 #define R_IMF_EXR_CODEC_PIZ   3
458 #define R_IMF_EXR_CODEC_RLE   4
459 #define R_IMF_EXR_CODEC_ZIPS  5
460 #define R_IMF_EXR_CODEC_B44   6
461 #define R_IMF_EXR_CODEC_B44A  7
462 #define R_IMF_EXR_CODEC_DWAA  8
463 #define R_IMF_EXR_CODEC_DWAB  9
464 #define R_IMF_EXR_CODEC_MAX  10
465
466 /* ImageFormatData.jp2_flag */
467 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
468 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
469 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
470
471 /* ImageFormatData.jp2_codec */
472 #define R_IMF_JP2_CODEC_JP2  0
473 #define R_IMF_JP2_CODEC_J2K  1
474
475 /* ImageFormatData.cineon_flag */
476 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
477
478 /* ImageFormatData.tiff_codec */
479 enum {
480         R_IMF_TIFF_CODEC_DEFLATE   = 0,
481         R_IMF_TIFF_CODEC_LZW       = 1,
482         R_IMF_TIFF_CODEC_PACKBITS  = 2,
483         R_IMF_TIFF_CODEC_NONE      = 3,
484 };
485
486 typedef struct BakeData {
487         struct ImageFormatData im_format;
488
489         char filepath[1024]; /* FILE_MAX */
490
491         short width, height;
492         short margin, flag;
493
494         float cage_extrusion;
495         int pass_filter;
496
497         char normal_swizzle[3];
498         char normal_space;
499
500         char save_mode;
501         char pad[3];
502
503         char cage[64];  /* MAX_NAME */
504 } BakeData;
505
506 /* (char) normal_swizzle */
507 typedef enum eBakeNormalSwizzle {
508         R_BAKE_POSX = 0,
509         R_BAKE_POSY = 1,
510         R_BAKE_POSZ = 2,
511         R_BAKE_NEGX = 3,
512         R_BAKE_NEGY = 4,
513         R_BAKE_NEGZ = 5,
514 } eBakeNormalSwizzle;
515
516 /* (char) save_mode */
517 typedef enum eBakeSaveMode {
518         R_BAKE_SAVE_INTERNAL = 0,
519         R_BAKE_SAVE_EXTERNAL = 1,
520 } eBakeSaveMode;
521
522 /* bake->pass_filter */
523 typedef enum eBakePassFilter {
524         R_BAKE_PASS_FILTER_NONE           = 0,
525         R_BAKE_PASS_FILTER_AO             = (1 << 0),
526         R_BAKE_PASS_FILTER_EMIT           = (1 << 1),
527         R_BAKE_PASS_FILTER_DIFFUSE        = (1 << 2),
528         R_BAKE_PASS_FILTER_GLOSSY         = (1 << 3),
529         R_BAKE_PASS_FILTER_TRANSM         = (1 << 4),
530         R_BAKE_PASS_FILTER_SUBSURFACE     = (1 << 5),
531         R_BAKE_PASS_FILTER_DIRECT         = (1 << 6),
532         R_BAKE_PASS_FILTER_INDIRECT       = (1 << 7),
533         R_BAKE_PASS_FILTER_COLOR          = (1 << 8),
534 } eBakePassFilter;
535
536 #define R_BAKE_PASS_FILTER_ALL (~0)
537
538 /* RenderEngineSettingsClay.options */
539 typedef enum ClayFlagSettings {
540         CLAY_USE_AO     = (1 << 0),
541         CLAY_USE_HSV    = (1 << 1),
542 } ClayFlagSettings;
543
544 /* *************************************************************** */
545 /* Render Data */
546
547 typedef struct RenderData {
548         struct ImageFormatData im_format;
549         
550         struct AviCodecData *avicodecdata;
551         struct FFMpegCodecData ffcodecdata;
552
553         int cfra, sfra, efra;   /* frames as in 'images' */
554         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
555         int psfra, pefra;               /* start+end frames of preview range */
556
557         int images, framapto;
558         short flag, threads;
559
560         float framelen, blurfac;
561
562         /** For UR edge rendering: give the edges this color */
563         float edgeR, edgeG, edgeB;
564
565
566         /* standalone player */  //  XXX deprecated since 2.5
567         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
568         short freqplay  DNA_DEPRECATED;
569         /* standalone player */  //  XXX deprecated since 2.5
570         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
571
572
573         int frame_step;         /* frames to jump during render/playback */
574
575         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
576         
577         short dimensionspreset;         /* for the dimensions presets menu */
578
579         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
580
581         short size; /* size in % */
582         
583         short maximsize DNA_DEPRECATED; /* max in Kb */
584
585         short pad6;
586
587         /* from buttons: */
588         /**
589          * The desired number of pixels in the x direction
590          */
591         int xsch;
592         /**
593          * The desired number of pixels in the y direction
594          */
595         int ysch;
596
597         /**
598          * The number of part to use in the x direction
599          */
600         short xparts DNA_DEPRECATED;
601         /**
602          * The number of part to use in the y direction
603          */
604         short yparts DNA_DEPRECATED;
605
606         /**
607          * render tile dimensions
608          */
609         int tilex, tiley;
610
611         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
612         
613         /**
614          * Render to image editor, fullscreen or to new window.
615          */
616         short displaymode;
617         char use_lock_interface;
618         char pad7;
619
620         /**
621          * Flags for render settings. Use bit-masking to access the settings.
622          */
623         int scemode;
624
625         /**
626          * Flags for render settings. Use bit-masking to access the settings.
627          */
628         int mode;
629
630         /**
631          * Flags for raytrace settings. Use bit-masking to access the settings.
632          */
633         int raytrace_options;
634         
635         /**
636          * Raytrace acceleration structure
637          */
638         short raytrace_structure;
639
640         short pad1;
641
642         /* octree resolution */
643         short ocres;
644         short pad4;
645         
646         /**
647          * What to do with the sky/background. Picks sky/premul/key
648          * blending for the background
649          */
650         short alphamode;
651
652         /**
653          * The number of samples to use per pixel.
654          */
655         short osa;
656
657         short frs_sec, edgeint;
658
659         
660         /* safety, border and display rect */
661         rctf safety, border;
662         rcti disprect;
663         
664         /* information on different layers to be rendered */
665         ListBase layers DNA_DEPRECATED; /* Converted to Scene->view_layers. */
666         short actlay DNA_DEPRECATED; /* Converted to Scene->active_layer. */
667         
668         /* number of mblur samples */
669         short mblur_samples;
670         
671         /**
672          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
673          */
674         float xasp, yasp;
675
676         float frs_sec_base;
677         
678         /**
679          * Value used to define filter size for all filter options  */
680         float gauss;
681         
682         
683         /* color management settings - color profiles, gamma correction, etc */
684         int color_mgt_flag;
685         
686         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
687         float postgamma, posthue, postsat;
688         
689          /* Dither noise intensity */
690         float dither_intensity;
691         
692         /* Bake Render options */
693         short bake_osa, bake_filter, bake_mode, bake_flag;
694         short bake_normal_space, bake_quad_split;
695         float bake_maxdist, bake_biasdist;
696         short bake_samples, bake_pad;
697         float bake_user_scale, bake_pad1;
698
699         /* path to render output */
700         char pic[1024]; /* 1024 = FILE_MAX */
701
702         /* stamps flags. */
703         int stamp;
704         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
705
706         /* stamp info user data. */
707         char stamp_udata[768];
708
709         /* foreground/background color. */
710         float fg_stamp[4];
711         float bg_stamp[4];
712
713         /* sequencer options */
714         char seq_prev_type;
715         char seq_rend_type;  /* UNUSED! */
716         char seq_flag; /* flag use for sequence render/draw */
717         char pad5[5];
718
719         /* render simplify */
720         int simplify_flag;
721         short simplify_subsurf;
722         short simplify_subsurf_render;
723         short simplify_shadowsamples, pad9;
724         float simplify_particles;
725         float simplify_particles_render;
726         float simplify_aosss;
727
728         /* cineon */
729         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
730         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
731         
732         /* jpeg2000 */
733         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
734         int rpad3;
735
736         /* Dome variables */ //  XXX deprecated since 2.5
737         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
738         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
739         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
740         float pad2;
741         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
742
743         /* Freestyle line thickness options */
744         int line_thickness_mode;
745         float unit_line_thickness; /* in pixels */
746
747         /* render engine */
748         char engine[32] DNA_DEPRECATED; // XXX deprecated since 2.8
749
750         /* Cycles baking */
751         struct BakeData bake;
752
753         int preview_start_resolution;
754         short preview_pixel_size;
755
756         /* Type of the debug pass to use.
757          * Only used when built with debug passes support.
758          */
759         short debug_pass_type;
760
761         /* MultiView */
762         ListBase views;  /* SceneRenderView */
763         short actview;
764         short views_format;
765         short pad8[2];
766
767         /* Motion blur shutter */
768         struct CurveMapping mblur_shutter_curve;
769 } RenderData;
770
771 /* *************************************************************** */
772 /* Settings related to viewport drawing/render, only settings used by WorkSpace and Scene. */
773 typedef struct ViewRender {
774         char engine_id[32];
775 } ViewRender;
776
777 /* *************************************************************** */
778 /* Render Conversion/Simplfication Settings */
779
780 /* control render convert and shading engine */
781 typedef struct RenderProfile {
782         struct RenderProfile *next, *prev;
783         char name[32];
784         
785         short particle_perc;
786         short subsurf_max;
787         short shadbufsample_max;
788         short pad1;
789         
790         float ao_error, pad2;
791         
792 } RenderProfile;
793
794 /* *************************************************************** */
795 /* Game Engine - Dome */
796
797 typedef struct GameDome {
798         short res, mode;
799         short angle, tilt;
800         float resbuf, pad2;
801         struct Text *warptext;
802 } GameDome;
803
804 #define DOME_FISHEYE                    1
805 #define DOME_TRUNCATED_FRONT    2
806 #define DOME_TRUNCATED_REAR             3
807 #define DOME_ENVMAP                             4
808 #define DOME_PANORAM_SPH                5
809 #define DOME_NUM_MODES                  6
810
811 /* *************************************************************** */
812 /* Game Engine */
813
814 typedef struct GameFraming {
815         float col[3];
816         char type, pad1, pad2, pad3;
817 } GameFraming;
818
819 #define SCE_GAMEFRAMING_BARS   0
820 #define SCE_GAMEFRAMING_EXTEND 1
821 #define SCE_GAMEFRAMING_SCALE  2
822
823 typedef struct RecastData {
824         float cellsize;
825         float cellheight;
826         float agentmaxslope;
827         float agentmaxclimb;
828         float agentheight;
829         float agentradius;
830         float edgemaxlen;
831         float edgemaxerror;
832         float regionminsize;
833         float regionmergesize;
834         int vertsperpoly;
835         float detailsampledist;
836         float detailsamplemaxerror;
837         char partitioning;
838         char pad1;
839         short pad2;
840 } RecastData;
841
842 #define RC_PARTITION_WATERSHED 0
843 #define RC_PARTITION_MONOTONE 1
844 #define RC_PARTITION_LAYERS 2
845
846 typedef struct GameData {
847
848         /* standalone player */
849         struct GameFraming framing;
850         short playerflag, xplay, yplay, freqplay;
851         short depth, attrib, rt1, rt2;
852         short aasamples, pad4[3];
853
854         /* stereo/dome mode */
855         struct GameDome dome;
856         short stereoflag, stereomode;
857         float eyeseparation;
858         RecastData recastData;
859
860
861         /* physics (it was in world)*/
862         float gravity; /*Gravitation constant for the game world*/
863
864         /*
865          * Radius of the activity bubble, in Manhattan length. Objects
866          * outside the box are activity-culled. */
867         float activityBoxRadius;
868
869         /*
870          * bit 3: (gameengine): Activity culling is enabled.
871          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustum culling
872          */
873         int flag;
874         short mode, matmode;
875         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
876         short physicsEngine;
877         short exitkey;
878         short vsync; /* Controls vsync: off, on, or adaptive (if supported) */
879         short ticrate, maxlogicstep, physubstep, maxphystep;
880         short obstacleSimulation;
881         short raster_storage;
882         float levelHeight;
883         float deactivationtime, lineardeactthreshold, angulardeactthreshold;
884
885         /* Scene LoD */
886         short lodflag, pad2;
887         int scehysteresis, pad5;
888 } GameData;
889
890 #define STEREO_NOSTEREO         1
891 #define STEREO_ENABLED          2
892 #define STEREO_DOME                     3
893
894 //#define STEREO_NOSTEREO                1
895 #define STEREO_QUADBUFFERED 2
896 #define STEREO_ABOVEBELOW        3
897 #define STEREO_INTERLACED        4
898 #define STEREO_ANAGLYPH         5
899 #define STEREO_SIDEBYSIDE       6
900 #define STEREO_VINTERLACE       7
901 //#define STEREO_DOME           8
902 #define STEREO_3DTVTOPBOTTOM 9
903
904 /* physicsEngine */
905 #define WOPHY_NONE              0
906 #define WOPHY_BULLET    5
907
908 /* obstacleSimulation */
909 #define OBSTSIMULATION_NONE             0
910 #define OBSTSIMULATION_TOI_rays         1
911 #define OBSTSIMULATION_TOI_cells        2
912
913 /* Raster storage */
914 #define RAS_STORE_AUTO          0
915 #define RAS_STORE_IMMEDIATE     1
916 #define RAS_STORE_VA            2
917 #define RAS_STORE_VBO           3
918
919 /* vsync */
920 #define VSYNC_ON        0
921 #define VSYNC_OFF       1
922 #define VSYNC_ADAPTIVE  2
923
924 /* GameData.flag */
925 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
926 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
927 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
928 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
929 #define GAME_SHOW_PHYSICS                                       (1 << 4)
930 // #define GAME_DISPLAY_LISTS                                   (1 << 5)   /* deprecated */
931 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
932 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
933 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
934 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
935 #define GAME_GLSL_NO_NODES                                      (1 << 10)
936 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
937 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
938 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
939 #define GAME_SHOW_MOUSE                                         (1 << 14)
940 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
941 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
942 #define GAME_NO_MATERIAL_CACHING                        (1 << 17)
943 #define GAME_GLSL_NO_ENV_LIGHTING                       (1 << 18)
944 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
945
946 /* GameData.playerflag */
947 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
948 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
949
950 /* GameData.matmode */
951 enum {
952 #ifdef DNA_DEPRECATED
953         GAME_MAT_TEXFACE    = 0, /* deprecated */
954 #endif
955         GAME_MAT_MULTITEX   = 1,
956         GAME_MAT_GLSL       = 2,
957 };
958
959 /* GameData.lodflag */
960 #define SCE_LOD_USE_HYST                (1 << 0)
961
962 /* UV Paint */
963 #define UV_SCULPT_LOCK_BORDERS                          1
964 #define UV_SCULPT_ALL_ISLANDS                           2
965
966 #define UV_SCULPT_TOOL_PINCH                            1
967 #define UV_SCULPT_TOOL_RELAX                            2
968 #define UV_SCULPT_TOOL_GRAB                                     3
969
970 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
971 #define UV_SCULPT_TOOL_RELAX_HC                 2
972
973 /* Stereo Flags */
974 #define STEREO_RIGHT_NAME "right"
975 #define STEREO_LEFT_NAME "left"
976 #define STEREO_RIGHT_SUFFIX "_R"
977 #define STEREO_LEFT_SUFFIX "_L"
978
979 typedef enum eStereoViews {
980         STEREO_LEFT_ID = 0,
981         STEREO_RIGHT_ID = 1,
982         STEREO_3D_ID = 2,
983         STEREO_MONO_ID = 3,
984 } eStereoViews;
985
986 /* *************************************************************** */
987 /* Markers */
988
989 typedef struct TimeMarker {     
990         struct TimeMarker *next, *prev;
991         int frame;
992         char name[64];
993         unsigned int flag;
994         struct Object *camera;
995 } TimeMarker;
996
997 /* *************************************************************** */
998 /* Paint Mode/Tool Data */
999
1000 #define PAINT_MAX_INPUT_SAMPLES 64
1001
1002 /* Paint Tool Base */
1003 typedef struct Paint {
1004         struct Brush *brush;
1005         struct Palette *palette;
1006         struct CurveMapping *cavity_curve; /* cavity curve */
1007
1008         /* WM Paint cursor */
1009         void *paint_cursor;
1010         unsigned char paint_cursor_col[4];
1011
1012         /* enum ePaintFlags */
1013         int flags;
1014
1015         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
1016          * smooth the stroke */
1017         int num_input_samples;
1018         
1019         /* flags used for symmetry */
1020         int symmetry_flags;
1021
1022         float tile_offset[3];
1023         int pad2;
1024 } Paint;
1025
1026 /* ------------------------------------------- */
1027 /* Image Paint */
1028
1029 /* Texture/Image Editor */
1030 typedef struct ImagePaintSettings {
1031         Paint paint;
1032
1033         short flag, missing_data;
1034         
1035         /* for projection painting only */
1036         short seam_bleed, normal_angle;
1037         short screen_grab_size[2]; /* capture size for re-projection */
1038
1039         int mode;                  /* mode used for texture painting */
1040
1041         void *paintcursor;                 /* wm handle */
1042         struct Image *stencil;     /* workaround until we support true layer masks */
1043         struct Image *clone;       /* clone layer for image mode for projective texture painting */
1044         struct Image *canvas;      /* canvas when the explicit system is used for painting */
1045         float stencil_col[3];
1046         float dither;              /* dither amount used when painting on byte images */
1047 } ImagePaintSettings;
1048
1049 /* ------------------------------------------- */
1050 /* Particle Edit */
1051
1052 /* Settings for a Particle Editing Brush */
1053 typedef struct ParticleBrushData {
1054         short size;                                             /* common setting */
1055         short step, invert, count;              /* for specific brushes only */
1056         int flag;
1057         float strength;
1058 } ParticleBrushData;
1059
1060 /* Particle Edit Mode Settings */
1061 typedef struct ParticleEditSettings {
1062         short flag;
1063         short totrekey;
1064         short totaddkey;
1065         short brushtype;
1066
1067         ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
1068         void *paintcursor;                      /* runtime */
1069
1070         float emitterdist, rt;
1071
1072         int selectmode;
1073         int edittype;
1074
1075         int draw_step, fade_frames;
1076
1077         struct Scene *scene;
1078         struct ViewLayer *view_layer;
1079         struct Object *object;
1080         struct Object *shape_object;
1081 } ParticleEditSettings;
1082
1083 /* ------------------------------------------- */
1084 /* Sculpt */
1085
1086 /* Sculpt */
1087 typedef struct Sculpt {
1088         Paint paint;
1089
1090         /* For rotating around a pivot point */
1091         //float pivot[3]; XXX not used?
1092         int flags;
1093
1094         /* Control tablet input */
1095         //char tablet_size, tablet_strength; XXX not used?
1096         int radial_symm[3];
1097
1098         /* Maximum edge length for dynamic topology sculpting (in pixels) */
1099         float detail_size;
1100
1101         /* Direction used for SCULPT_OT_symmetrize operator */
1102         int symmetrize_direction;
1103
1104         /* gravity factor for sculpting */
1105         float gravity_factor;
1106
1107         /* scale for constant detail size */
1108         float constant_detail; /* Constant detail resolution (Blender unit / constant_detail) */
1109         float detail_percent;
1110         float pad;
1111
1112         struct Object *gravity_object;
1113 } Sculpt;
1114
1115 typedef struct UvSculpt {
1116         Paint paint;
1117 } UvSculpt;
1118
1119 /* ------------------------------------------- */
1120 /* Vertex Paint */
1121
1122 /* Vertex Paint */
1123 typedef struct VPaint {
1124         Paint paint;
1125         char flag;
1126         char pad[3];
1127         int radial_symm[3]; /* For mirrored painting */
1128 } VPaint;
1129
1130 /* VPaint.flag */
1131 enum {
1132         /* weight paint only */
1133         VP_FLAG_VGROUP_RESTRICT     = (1 << 7)
1134 };
1135
1136 /* ------------------------------------------- */
1137 /* GPencil Stroke Sculpting */
1138
1139 /* Brush types */
1140 typedef enum eGP_EditBrush_Types {
1141         GP_EDITBRUSH_TYPE_SMOOTH    = 0,
1142         GP_EDITBRUSH_TYPE_THICKNESS = 1,
1143         GP_EDITBRUSH_TYPE_GRAB      = 2,
1144         GP_EDITBRUSH_TYPE_PUSH      = 3,
1145         GP_EDITBRUSH_TYPE_TWIST     = 4,
1146         GP_EDITBRUSH_TYPE_PINCH     = 5,
1147         GP_EDITBRUSH_TYPE_RANDOMIZE = 6,
1148         GP_EDITBRUSH_TYPE_SUBDIVIDE = 7,
1149         GP_EDITBRUSH_TYPE_SIMPLIFY  = 8,
1150         GP_EDITBRUSH_TYPE_CLONE     = 9,
1151         GP_EDITBRUSH_TYPE_STRENGTH  = 10,
1152
1153         /* !!! Update GP_EditBrush_Data brush[###]; below !!! */
1154         TOT_GP_EDITBRUSH_TYPES
1155 } eGP_EditBrush_Types;
1156
1157 /* Lock axis options */
1158 typedef enum eGP_Lockaxis_Types {
1159         GP_LOCKAXIS_NONE = 0,
1160         GP_LOCKAXIS_X = 1,
1161         GP_LOCKAXIS_Y = 2,
1162         GP_LOCKAXIS_Z = 3
1163 } eGP_Lockaxis_Types;
1164
1165 /* Settings for a GPencil Stroke Sculpting Brush */
1166 typedef struct GP_EditBrush_Data {
1167         short size;             /* radius of brush */
1168         short flag;             /* eGP_EditBrush_Flag */
1169         float strength;         /* strength of effect */
1170 } GP_EditBrush_Data;
1171
1172 /* GP_EditBrush_Data.flag */
1173 typedef enum eGP_EditBrush_Flag {
1174         /* invert the effect of the brush */
1175         GP_EDITBRUSH_FLAG_INVERT       = (1 << 0),
1176         /* adjust strength using pen pressure */
1177         GP_EDITBRUSH_FLAG_USE_PRESSURE = (1 << 1),
1178         
1179         /* strength of brush falls off with distance from cursor */
1180         GP_EDITBRUSH_FLAG_USE_FALLOFF  = (1 << 2),
1181         
1182         /* smooth brush affects pressure values as well */
1183         GP_EDITBRUSH_FLAG_SMOOTH_PRESSURE  = (1 << 3)
1184 } eGP_EditBrush_Flag;
1185
1186
1187
1188 /* GPencil Stroke Sculpting Settings */
1189 typedef struct GP_BrushEdit_Settings {
1190         GP_EditBrush_Data brush[11];  /* TOT_GP_EDITBRUSH_TYPES */
1191         void *paintcursor;            /* runtime */
1192         
1193         int brushtype;                /* eGP_EditBrush_Types */
1194         int flag;                     /* eGP_BrushEdit_SettingsFlag */
1195         int lock_axis;                /* lock drawing to one axis */
1196         float alpha;                  /* alpha factor for selection color */
1197 } GP_BrushEdit_Settings;
1198
1199 /* GP_BrushEdit_Settings.flag */
1200 typedef enum eGP_BrushEdit_SettingsFlag {
1201         /* only affect selected points */
1202         GP_BRUSHEDIT_FLAG_SELECT_MASK = (1 << 0),
1203         /* apply brush to position */
1204         GP_BRUSHEDIT_FLAG_APPLY_POSITION = (1 << 1),
1205         /* apply brush to strength */
1206         GP_BRUSHEDIT_FLAG_APPLY_STRENGTH = (1 << 2),
1207         /* apply brush to thickness */
1208         GP_BRUSHEDIT_FLAG_APPLY_THICKNESS = (1 << 3),
1209 } eGP_BrushEdit_SettingsFlag;
1210
1211
1212 /* Settings for GP Interpolation Operators */
1213 typedef struct GP_Interpolate_Settings {
1214         short flag;                        /* eGP_Interpolate_SettingsFlag */
1215         
1216         char type;                         /* eGP_Interpolate_Type - Interpolation Mode */ 
1217         char easing;                       /* eBezTriple_Easing - Easing mode (if easing equation used) */
1218         
1219         float back;                        /* BEZT_IPO_BACK */
1220         float amplitude, period;           /* BEZT_IPO_ELASTIC */
1221         
1222         struct CurveMapping *custom_ipo;   /* custom interpolation curve (for use with GP_IPO_CURVEMAP) */
1223 } GP_Interpolate_Settings;
1224
1225 /* GP_Interpolate_Settings.flag */
1226 typedef enum eGP_Interpolate_SettingsFlag {
1227         /* apply interpolation to all layers */
1228         GP_TOOLFLAG_INTERPOLATE_ALL_LAYERS    = (1 << 0),
1229         /* apply interpolation to only selected */
1230         GP_TOOLFLAG_INTERPOLATE_ONLY_SELECTED = (1 << 1),
1231 } eGP_Interpolate_SettingsFlag;
1232
1233 /* GP_Interpolate_Settings.type */
1234 typedef enum eGP_Interpolate_Type {
1235         /* Traditional Linear Interpolation */
1236         GP_IPO_LINEAR   = 0,
1237         
1238         /* CurveMap Defined Interpolation */
1239         GP_IPO_CURVEMAP = 1,
1240         
1241         /* Easing Equations */
1242         GP_IPO_BACK = 3,
1243         GP_IPO_BOUNCE = 4,
1244         GP_IPO_CIRC = 5,
1245         GP_IPO_CUBIC = 6,
1246         GP_IPO_ELASTIC = 7,
1247         GP_IPO_EXPO = 8,
1248         GP_IPO_QUAD = 9,
1249         GP_IPO_QUART = 10,
1250         GP_IPO_QUINT = 11,
1251         GP_IPO_SINE = 12,
1252 } eGP_Interpolate_Type;
1253
1254 /* *************************************************************** */
1255 /* Unified Paint Settings
1256  */
1257
1258 /* These settings can override the equivalent fields in the active
1259  * Brush for any paint mode; the flag field controls whether these
1260  * values are used */
1261 typedef struct UnifiedPaintSettings {
1262         /* unified radius of brush in pixels */
1263         int size;
1264
1265         /* unified radius of brush in Blender units */
1266         float unprojected_radius;
1267
1268         /* unified strength of brush */
1269         float alpha;
1270
1271         /* unified brush weight, [0, 1] */
1272         float weight;
1273
1274         /* unified brush color */
1275         float rgb[3];
1276         /* unified brush secondary color */
1277         float secondary_rgb[3];
1278
1279         /* user preferences for sculpt and paint */
1280         int flag;
1281
1282         /* rake rotation */
1283
1284         /* record movement of mouse so that rake can start at an intuitive angle */
1285         float last_rake[2];
1286         float last_rake_angle;
1287         
1288         int last_stroke_valid;
1289         float average_stroke_accum[3];
1290         int average_stroke_counter;
1291         
1292
1293         float brush_rotation;
1294         float brush_rotation_sec;
1295
1296         /*********************************************************************************
1297          *  all data below are used to communicate with cursor drawing and tex sampling  *
1298          *********************************************************************************/
1299         int anchored_size;
1300
1301         float overlap_factor; /* normalization factor due to accumulated value of curve along spacing.
1302                                * Calculated when brush spacing changes to dampen strength of stroke
1303                                * if space attenuation is used*/
1304         char draw_inverted;
1305         /* check is there an ongoing stroke right now */
1306         char stroke_active;
1307
1308         char draw_anchored;
1309         char do_linear_conversion;
1310
1311         /* store last location of stroke or whether the mesh was hit. Valid only while stroke is active */
1312         float last_location[3];
1313         int last_hit;
1314
1315         float anchored_initial_mouse[2];
1316
1317         /* radius of brush, premultiplied with pressure.
1318          * In case of anchored brushes contains the anchored radius */
1319         float pixel_radius;
1320
1321         /* drawing pressure */
1322         float size_pressure_value;
1323
1324         /* position of mouse, used to sample the texture */
1325         float tex_mouse[2];
1326
1327         /* position of mouse, used to sample the mask texture */
1328         float mask_tex_mouse[2];
1329
1330         /* ColorSpace cache to avoid locking up during sampling */
1331         struct ColorSpace *colorspace;
1332 } UnifiedPaintSettings;
1333
1334 typedef enum {
1335         UNIFIED_PAINT_SIZE  = (1 << 0),
1336         UNIFIED_PAINT_ALPHA = (1 << 1),
1337         UNIFIED_PAINT_WEIGHT = (1 << 5),
1338         UNIFIED_PAINT_COLOR = (1 << 6),
1339
1340         /* only used if unified size is enabled, mirrors the brush flags
1341          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
1342         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
1343         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
1344
1345         /* only used if unified alpha is enabled, mirrors the brush flag
1346          * BRUSH_ALPHA_PRESSURE */
1347         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
1348 } eUnifiedPaintSettingsFlags;
1349
1350
1351 typedef struct CurvePaintSettings {
1352         char curve_type;
1353         char flag;
1354         char depth_mode;
1355         char surface_plane;
1356         char fit_method;
1357         char pad;
1358         short error_threshold;
1359         float radius_min, radius_max;
1360         float radius_taper_start, radius_taper_end;
1361         float surface_offset;
1362         float corner_angle;
1363 } CurvePaintSettings;
1364
1365 /* CurvePaintSettings.flag */
1366 enum {
1367         CURVE_PAINT_FLAG_CORNERS_DETECT             = (1 << 0),
1368         CURVE_PAINT_FLAG_PRESSURE_RADIUS            = (1 << 1),
1369         CURVE_PAINT_FLAG_DEPTH_STROKE_ENDPOINTS     = (1 << 2),
1370         CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS    = (1 << 3),
1371 };
1372
1373 /* CurvePaintSettings.fit_method */
1374 enum {
1375         CURVE_PAINT_FIT_METHOD_REFIT            = 0,
1376         CURVE_PAINT_FIT_METHOD_SPLIT            = 1,
1377 };
1378
1379 /* CurvePaintSettings.depth_mode */
1380 enum {
1381         CURVE_PAINT_PROJECT_CURSOR              = 0,
1382         CURVE_PAINT_PROJECT_SURFACE             = 1,
1383 };
1384
1385 /* CurvePaintSettings.surface_plane */
1386 enum {
1387         CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW           = 0,
1388         CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE        = 1,
1389         CURVE_PAINT_SURFACE_PLANE_VIEW                  = 2,
1390 };
1391
1392
1393 /* *************************************************************** */
1394 /* Stats */
1395
1396 /* Stats for Meshes */
1397 typedef struct MeshStatVis {
1398         char type;
1399         char _pad1[2];
1400
1401         /* overhang */
1402         char  overhang_axis;
1403         float overhang_min, overhang_max;
1404
1405         /* thickness */
1406         float thickness_min, thickness_max;
1407         char thickness_samples;
1408         char _pad2[3];
1409
1410         /* distort */
1411         float distort_min, distort_max;
1412
1413         /* sharp */
1414         float sharp_min, sharp_max;
1415 } MeshStatVis;
1416
1417
1418 /* *************************************************************** */
1419 /* Tool Settings */
1420
1421 typedef struct ToolSettings {
1422         VPaint *vpaint;         /* vertex paint */
1423         VPaint *wpaint;         /* weight paint */
1424         Sculpt *sculpt;
1425         UvSculpt *uvsculpt;     /* uv smooth */
1426         
1427         /* Vertex group weight - used only for editmode, not weight
1428          * paint */
1429         float vgroup_weight;
1430
1431         float doublimit;        /* remove doubles limit */
1432         float normalsize;       /* size of normals */
1433         short automerge;
1434
1435         /* Selection Mode for Mesh */
1436         short selectmode;
1437
1438         /* UV Calculation */
1439         char unwrapper;
1440         char uvcalc_flag;
1441         char uv_flag;
1442         char uv_selectmode;
1443
1444         float uvcalc_margin;
1445
1446         /* Auto-IK */
1447         short autoik_chainlen;  /* runtime only */
1448
1449         /* Grease Pencil */
1450         char gpencil_flags;             /* flags/options for how the tool works */
1451         char gpencil_src;               /* for main 3D view Grease Pencil, where data comes from */
1452
1453         char gpencil_v3d_align; /* stroke placement settings: 3D View */
1454         char gpencil_v2d_align; /*                          : General 2D Editor */
1455         char gpencil_seq_align; /*                          : Sequencer Preview */
1456         char gpencil_ima_align; /*                          : Image Editor */
1457         
1458         /* Grease Pencil Sculpt */
1459         struct GP_BrushEdit_Settings gp_sculpt;
1460         
1461         /* Grease Pencil Interpolation Tool(s) */
1462         struct GP_Interpolate_Settings gp_interpolate;
1463         
1464         /* Grease Pencil Drawing Brushes (bGPDbrush) */
1465         ListBase gp_brushes; 
1466
1467         /* Image Paint (8 byttse aligned please!) */
1468         struct ImagePaintSettings imapaint;
1469
1470         /* Particle Editing */
1471         struct ParticleEditSettings particle;
1472         
1473         /* Transform Proportional Area of Effect */
1474         float proportional_size;
1475
1476         /* Select Group Threshold */
1477         float select_thresh;
1478
1479         /* Auto-Keying Mode */
1480         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1481         char keyframe_type;                 /* keyframe type (see DNA_curve_types.h) */
1482
1483         /* Multires */
1484         char multires_subdiv_type;
1485
1486         /* Skeleton generation */
1487         short skgen_resolution;
1488         float skgen_threshold_internal;
1489         float skgen_threshold_external;
1490         float skgen_length_ratio;
1491         float skgen_length_limit;
1492         float skgen_angle_limit;
1493         float skgen_correlation_limit;
1494         float skgen_symmetry_limit;
1495         float skgen_retarget_angle_weight;
1496         float skgen_retarget_length_weight;
1497         float skgen_retarget_distance_weight;
1498         short skgen_options;
1499         char  skgen_postpro;
1500         char  skgen_postpro_passes;
1501         char  skgen_subdivisions[3];
1502         char  skgen_multi_level;
1503
1504         /* Skeleton Sketching */
1505         struct Object *skgen_template;
1506         char bone_sketching;
1507         char bone_sketching_convert;
1508         char skgen_subdivision_number;
1509         char skgen_retarget_options;
1510         char skgen_retarget_roll;
1511         char skgen_side_string[8];
1512         char skgen_num_string[8];
1513         
1514         /* Alt+RMB option */
1515         char edge_mode;
1516         char edge_mode_live_unwrap;
1517
1518         /* Transform */
1519         char snap_mode, snap_node_mode;
1520         char snap_uv_mode;
1521         short snap_flag, snap_target;
1522         short proportional, prop_mode;
1523         char proportional_objects; /* proportional edit, object mode */
1524         char proportional_mask; /* proportional edit, mask editing */
1525         char proportional_action; /* proportional edit, action editor */
1526         char proportional_fcurve; /* proportional edit, graph editor */
1527         char lock_markers; /* lock marker editing */
1528         char pad4[5];
1529
1530         char auto_normalize; /*auto normalizing mode in wpaint*/
1531         char multipaint; /* paint multiple bones in wpaint */
1532         char weightuser;
1533         char vgroupsubset; /* subset selection filter in wpaint */
1534
1535         /* UV painting */
1536         int use_uv_sculpt;
1537         int uv_sculpt_settings;
1538         int uv_sculpt_tool;
1539         int uv_relax_method;
1540         /* XXX: these sculpt_paint_* fields are deprecated, use the
1541          * unified_paint_settings field instead! */
1542         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1543         int sculpt_paint_unified_size DNA_DEPRECATED;
1544         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1545         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1546
1547         /* Unified Paint Settings */
1548         struct UnifiedPaintSettings unified_paint_settings;
1549
1550         struct CurvePaintSettings curve_paint_settings;
1551
1552         struct MeshStatVis statvis;
1553 } ToolSettings;
1554
1555 /* *************************************************************** */
1556 /* Assorted Scene Data */
1557
1558 /* ------------------------------------------- */
1559 /* Stats (show in Info header) */
1560
1561 typedef struct bStats {
1562         /* scene totals for visible layers */
1563         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1564         int totvert, totface;
1565 } bStats;
1566
1567 /* ------------------------------------------- */
1568 /* Unit Settings */
1569
1570 typedef struct UnitSettings {
1571         /* Display/Editing unit options for each scene */
1572         float scale_length; /* maybe have other unit conversions? */
1573         char system; /* imperial, metric etc */
1574         char system_rotation; /* not implemented as a proper unit system yet */
1575         short flag;
1576 } UnitSettings;
1577
1578 /* ------------------------------------------- */
1579 /* Global/Common Physics Settings */
1580
1581 typedef struct PhysicsSettings {
1582         float gravity[3];
1583         int flag, quick_cache_step, rt;
1584 } PhysicsSettings;
1585
1586 /* ------------------------------------------- */
1587 /* Safe Area options used in Camera View & VSE
1588  */
1589 typedef struct DisplaySafeAreas {
1590         /* each value represents the (x,y) margins as a multiplier.
1591          * 'center' in this context is just the name for a different kind of safe-area */
1592
1593         float title[2];         /* Title Safe */
1594         float action[2];        /* Image/Graphics Safe */
1595
1596         /* use for alternate aspect ratio */
1597         float title_center[2];
1598         float action_center[2];
1599 } DisplaySafeAreas;
1600
1601 /* *************************************************************** */
1602 /* Scene ID-Block */
1603
1604 typedef struct Scene {
1605         ID id;
1606         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
1607         
1608         struct Object *camera;
1609         struct World *world;
1610         
1611         struct Scene *set;
1612         
1613         ListBase base DNA_DEPRECATED;
1614         struct Base  *basact DNA_DEPRECATED; /* active base */
1615         struct Object *obedit;          /* name replaces old G.obedit */
1616         
1617         float cursor[3];                        /* 3d cursor location */
1618         char _pad[4];
1619         
1620         unsigned int lay;                       /* bitflags for layer visibility */
1621         int layact;             /* active layer */
1622         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1623         
1624         short flag;                                                             /* various settings */
1625         
1626         char use_nodes;
1627         char pad[1];
1628         
1629         struct bNodeTree *nodetree;
1630         
1631         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1632         
1633         struct ToolSettings *toolsettings;              /* default allocated now */
1634         void *pad2;
1635         struct DisplaySafeAreas safe_areas;
1636
1637         /* migrate or replace? depends on some internal things... */
1638         /* no, is on the right place (ton) */
1639         struct RenderData r;
1640         struct AudioData audio;
1641
1642         ListBase markers;
1643         ListBase transform_spaces DNA_DEPRECATED;
1644
1645         void *sound_scene;
1646         void *playback_handle;
1647         void *sound_scrub_handle;
1648         void *speaker_handles;
1649         
1650         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1651         
1652         /* none of the dependency graph  vars is mean to be saved */
1653         struct GHash *depsgraph_hash;
1654         int pad7;
1655
1656         /* User-Defined KeyingSets */
1657         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1658         ListBase keyingsets;                    /* KeyingSets for this scene */
1659         
1660         /* Game Settings */
1661         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1662         struct GameData gm;
1663
1664         /* Units */
1665         struct UnitSettings unit;
1666         
1667         /* Grease Pencil */
1668         struct bGPdata *gpd;
1669
1670         /* Movie Tracking */
1671         struct MovieClip *clip;                 /* active movie clip */
1672
1673         /* Physics simulation settings */
1674         struct PhysicsSettings physics_settings;
1675
1676         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1677         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1678
1679
1680         /* Color Management */
1681         ColorManagedViewSettings view_settings;
1682         ColorManagedDisplaySettings display_settings;
1683         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1684         
1685         /* RigidBody simulation world+settings */
1686         struct RigidBodyWorld *rigidbody_world;
1687
1688         struct PreviewImage *preview;
1689
1690         ListBase view_layers;
1691         struct SceneCollection *collection;
1692         int active_view_layer;
1693         int pad4;
1694
1695         IDProperty *collection_properties;  /* settings to be overriden by layer collections */
1696         IDProperty *layer_properties;  /* settings to be override by workspaces */
1697
1698         int pad5[2];
1699
1700         ViewRender view_render;
1701 } Scene;
1702
1703 /* **************** RENDERDATA ********************* */
1704
1705 /* flag */
1706         /* use preview range */
1707 #define SCER_PRV_RANGE  (1<<0)
1708 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1709         /* show/use subframes (for checking motion blur) */
1710 #define SCER_SHOW_SUBFRAME      (1<<3)
1711
1712 /* mode (int now) */
1713 #define R_OSA                   0x0001
1714 #define R_SHADOW                0x0002
1715 #define R_GAMMA                 0x0004
1716 #define R_ORTHO                 0x0008
1717 #define R_ENVMAP                0x0010
1718 #define R_EDGE                  0x0020
1719 #define R_FIELDS                0x0040
1720 #define R_FIELDSTILL    0x0080
1721 /*#define R_RADIO                       0x0100 */ /* deprecated */
1722 #define R_BORDER                0x0200
1723 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1724 #define R_CROP                  0x0800
1725 /*#define R_COSMO                       0x1000 deprecated */
1726 #define R_ODDFIELD              0x2000
1727 #define R_MBLUR                 0x4000
1728                 /* unified was here */
1729 #define R_RAYTRACE      0x10000
1730                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1731 #define R_GAUSS         0x20000
1732                 /* fbuf obsolete... */
1733 /*#define R_FBUF                        0x40000*/
1734                 /* threads obsolete... is there for old files, now use for autodetect threads */
1735 #define R_THREADS               0x80000
1736                 /* Use the same flag for autothreads */
1737 #define R_FIXED_THREADS         0x80000 
1738
1739 #define R_SPEED                         0x100000
1740 #define R_SSS                           0x200000
1741 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1742 #define R_TOUCH                         0x800000  /* touch files before rendering */
1743 #define R_SIMPLIFY                      0x1000000
1744 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1745 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1746 #define R_USE_WS_SHADING        0x8000000 /* use world space interpretation of lighting data */
1747
1748 /* seq_flag */
1749 enum {
1750         // R_SEQ_GL_PREV = (1 << 1),  // UNUSED, we just use setting from seq_prev_type now.
1751         // R_SEQ_GL_REND = (1 << 2),  // UNUSED, opengl render has its own operator now.
1752         R_SEQ_SOLID_TEX  = (1 << 3),
1753         R_SEQ_CAMERA_DOF = (1 << 4),
1754 };
1755
1756 /* displaymode */
1757
1758 #define R_OUTPUT_SCREEN 0
1759 #define R_OUTPUT_AREA   1
1760 #define R_OUTPUT_WINDOW 2
1761 #define R_OUTPUT_NONE   3
1762 /*#define R_OUTPUT_FORKED       4*/
1763
1764 /* filtertype */
1765 #define R_FILTER_BOX    0
1766 #define R_FILTER_TENT   1
1767 #define R_FILTER_QUAD   2
1768 #define R_FILTER_CUBIC  3
1769 #define R_FILTER_CATROM 4
1770 #define R_FILTER_GAUSS  5
1771 #define R_FILTER_MITCH  6
1772 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1773
1774 /* raytrace structure */
1775 #define R_RAYSTRUCTURE_AUTO                             0
1776 #define R_RAYSTRUCTURE_OCTREE                   1
1777 #define R_RAYSTRUCTURE_BLIBVH                   2       /* removed */
1778 #define R_RAYSTRUCTURE_VBVH                             3
1779 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1780 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1781
1782 /* raytrace_options */
1783 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1784 #define R_RAYTRACE_USE_INSTANCES                0x0002
1785
1786 /* scemode (int now) */
1787 #define R_DOSEQ                         0x0001
1788 #define R_BG_RENDER                     0x0002
1789                 /* passepartout is camera option now, keep this for backward compatibility */
1790 #define R_PASSEPARTOUT          0x0004
1791 #define R_BUTS_PREVIEW          0x0008
1792 #define R_EXTENSION                     0x0010
1793 #define R_MATNODE_PREVIEW       0x0020
1794 #define R_DOCOMP                        0x0040
1795 #define R_COMP_CROP                     0x0080
1796 #define R_FREE_IMAGE            0x0100
1797 #define R_SINGLE_LAYER          0x0200
1798 #define R_EXR_TILE_FILE         0x0400
1799 /* #define R_COMP_FREE                  0x0800 */
1800 #define R_NO_IMAGE_LOAD         0x1000
1801 #define R_NO_TEX                        0x2000
1802 #define R_NO_FRAME_UPDATE       0x4000
1803 #define R_FULL_SAMPLE           0x8000
1804 /* #define R_DEPRECATED         0x10000 */
1805 /* #define R_RECURS_PROTECTION  0x20000 */
1806 #define R_TEXNODE_PREVIEW       0x40000
1807 #define R_VIEWPORT_PREVIEW      0x80000
1808 #define R_EXR_CACHE_FILE        0x100000
1809 #define R_MULTIVIEW                     0x200000
1810
1811 /* r->stamp */
1812 #define R_STAMP_TIME    0x0001
1813 #define R_STAMP_FRAME   0x0002
1814 #define R_STAMP_DATE    0x0004
1815 #define R_STAMP_CAMERA  0x0008
1816 #define R_STAMP_SCENE   0x0010
1817 #define R_STAMP_NOTE    0x0020
1818 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1819 #define R_STAMP_MARKER  0x0080
1820 #define R_STAMP_FILENAME        0x0100
1821 #define R_STAMP_SEQSTRIP        0x0200
1822 #define R_STAMP_RENDERTIME      0x0400
1823 #define R_STAMP_CAMERALENS      0x0800
1824 #define R_STAMP_STRIPMETA       0x1000
1825 #define R_STAMP_MEMORY          0x2000
1826 #define R_STAMP_HIDE_LABELS     0x4000
1827 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1828                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1829                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS|R_STAMP_MEMORY|                 \
1830                      R_STAMP_HIDE_LABELS)
1831
1832 /* alphamode */
1833 #define R_ADDSKY                0
1834 #define R_ALPHAPREMUL   1
1835 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1836
1837 /* color_mgt_flag */
1838 enum {
1839         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1840         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1841 };
1842
1843 #ifdef DNA_DEPRECATED
1844 /* subimtype, flag options for imtype */
1845 enum {
1846         R_OPENEXR_HALF  = 1,  /*deprecated*/
1847         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1848         R_PREVIEW_JPG   = 4,  /*deprecated*/
1849         R_CINEON_LOG    = 8,  /*deprecated*/
1850         R_TIFF_16BIT    = 16, /*deprecated*/
1851
1852         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1853         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1854         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1855         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1856         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1857 };
1858 #endif
1859
1860 /* bake_mode: same as RE_BAKE_xxx defines */
1861 /* bake_flag: */
1862 #define R_BAKE_CLEAR            1
1863 #define R_BAKE_OSA                      2
1864 #define R_BAKE_TO_ACTIVE        4
1865 #define R_BAKE_NORMALIZE        8
1866 #define R_BAKE_MULTIRES         16
1867 #define R_BAKE_LORES_MESH       32
1868 #define R_BAKE_VCOL                     64
1869 #define R_BAKE_USERSCALE        128
1870 #define R_BAKE_CAGE                     256
1871 #define R_BAKE_SPLIT_MAT        512
1872 #define R_BAKE_AUTO_NAME        1024
1873
1874 /* bake_normal_space */
1875 #define R_BAKE_SPACE_CAMERA      0
1876 #define R_BAKE_SPACE_WORLD       1
1877 #define R_BAKE_SPACE_OBJECT      2
1878 #define R_BAKE_SPACE_TANGENT 3
1879
1880 /* simplify_flag */
1881 #define R_SIMPLE_NO_TRIANGULATE         1
1882
1883 /* line_thickness_mode */
1884 #define R_LINE_THICKNESS_ABSOLUTE 1
1885 #define R_LINE_THICKNESS_RELATIVE 2
1886
1887 /* sequencer seq_prev_type seq_rend_type */
1888
1889 /* scene->r.engine (scene.c) */
1890 extern const char *RE_engine_id_BLENDER_RENDER;
1891 extern const char *RE_engine_id_BLENDER_GAME;
1892 extern const char *RE_engine_id_BLENDER_CLAY;
1893 extern const char *RE_engine_id_BLENDER_EEVEE;
1894 extern const char *RE_engine_id_CYCLES;
1895
1896 /* **************** SCENE ********************* */
1897
1898 /* note that much higher maxframes give imprecise sub-frames, see: T46859 */
1899 /* Current precision is 16 for the sub-frames closer to MAXFRAME. */
1900
1901 /* for general use */
1902 #define MAXFRAME        1048574
1903 #define MAXFRAMEF       1048574.0f
1904
1905 #define MINFRAME        0
1906 #define MINFRAMEF       0.0f
1907
1908 /* (minimum frame number for current-frame) */
1909 #define MINAFRAME       -1048574
1910 #define MINAFRAMEF      -1048574.0f
1911
1912 /* deprecate this! */
1913 #define TESTBASE(base)  (                                                     \
1914         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1915         (((base)->flag & BASE_VISIBLED) != 0))
1916 #define TESTBASELIB(base)  (                                                  \
1917         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1918         ((base)->object->id.lib == NULL) &&                                       \
1919         (((base)->flag & BASE_VISIBLED) != 0))
1920 #define TESTBASELIB_BGMODE(base)  (                                           \
1921         (((base)->flag & BASE_SELECTED) != 0) &&                                  \
1922         ((base)->object->id.lib == NULL) &&                                       \
1923         (((base)->flag & BASE_VISIBLED) != 0))
1924 #define BASE_EDITABLE_BGMODE(base)  (                                         \
1925         ((base)->object->id.lib == NULL) &&                                       \
1926         (((base)->flag & BASE_VISIBLED) != 0))
1927 #define BASE_SELECTABLE(base)                                                 \
1928         (((base)->flag & BASE_SELECTABLED) != 0)
1929 #define BASE_VISIBLE(base)  (                                                 \
1930         ((base)->flag & BASE_VISIBLED) != 0)
1931
1932 #define FIRSTBASE(_view_layer)  ((_view_layer)->object_bases.first)
1933 #define LASTBASE(_view_layer)   ((_view_layer)->object_bases.last)
1934 #define BASACT(_view_layer)     ((_view_layer)->basact)
1935 #define OBACT(_view_layer)      (BASACT(_view_layer) ? BASACT(_view_layer)->object: NULL)
1936
1937 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1938 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1939
1940 #define CFRA            (scene->r.cfra)
1941 #define SUBFRA          (scene->r.subframe)
1942 #define SFRA            (scene->r.sfra)
1943 #define EFRA            (scene->r.efra)
1944 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1945 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1946 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1947 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1948 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1949 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1950
1951 /* base->legacy_flag is in DNA_object_types.h */
1952
1953 /* toolsettings->snap_flag */
1954 #define SCE_SNAP                                1
1955 #define SCE_SNAP_ROTATE                 2
1956 #define SCE_SNAP_PEEL_OBJECT    4
1957 #define SCE_SNAP_PROJECT                8
1958 #define SCE_SNAP_NO_SELF                16
1959 #define SCE_SNAP_ABS_GRID               32
1960
1961 /* toolsettings->snap_target */
1962 #define SCE_SNAP_TARGET_CLOSEST 0
1963 #define SCE_SNAP_TARGET_CENTER  1
1964 #define SCE_SNAP_TARGET_MEDIAN  2
1965 #define SCE_SNAP_TARGET_ACTIVE  3
1966 /* toolsettings->snap_mode */
1967 #define SCE_SNAP_MODE_INCREMENT 0
1968 #define SCE_SNAP_MODE_VERTEX    1
1969 #define SCE_SNAP_MODE_EDGE              2
1970 #define SCE_SNAP_MODE_FACE              3
1971 #define SCE_SNAP_MODE_VOLUME    4
1972 #define SCE_SNAP_MODE_NODE_X    5
1973 #define SCE_SNAP_MODE_NODE_Y    6
1974 #define SCE_SNAP_MODE_NODE_XY   7
1975 #define SCE_SNAP_MODE_GRID              8
1976
1977 /* toolsettings->selectmode */
1978 #define SCE_SELECT_VERTEX       1 /* for mesh */
1979 #define SCE_SELECT_EDGE         2
1980 #define SCE_SELECT_FACE         4
1981
1982 /* toolsettings->statvis->type */
1983 #define SCE_STATVIS_OVERHANG    0
1984 #define SCE_STATVIS_THICKNESS   1
1985 #define SCE_STATVIS_INTERSECT   2
1986 #define SCE_STATVIS_DISTORT             3
1987 #define SCE_STATVIS_SHARP               4
1988
1989 /* toolsettings->particle.selectmode for particles */
1990 #define SCE_SELECT_PATH         1
1991 #define SCE_SELECT_POINT        2
1992 #define SCE_SELECT_END          4
1993
1994 /* toolsettings->prop_mode (proportional falloff) */
1995 #define PROP_SMOOTH            0
1996 #define PROP_SPHERE            1
1997 #define PROP_ROOT              2
1998 #define PROP_SHARP             3
1999 #define PROP_LIN               4
2000 #define PROP_CONST             5
2001 #define PROP_RANDOM            6
2002 #define PROP_INVSQUARE         7
2003 #define PROP_MODE_MAX          8
2004
2005 /* toolsettings->proportional */
2006 #define PROP_EDIT_OFF                   0
2007 #define PROP_EDIT_ON                    1
2008 #define PROP_EDIT_CONNECTED             2
2009 #define PROP_EDIT_PROJECTED             3
2010
2011 /* toolsettings->weightuser */
2012 enum {
2013         OB_DRAW_GROUPUSER_NONE      = 0,
2014         OB_DRAW_GROUPUSER_ACTIVE    = 1,
2015         OB_DRAW_GROUPUSER_ALL       = 2
2016 };
2017
2018 /* toolsettings->vgroupsubset */
2019 /* object_vgroup.c */
2020 typedef enum eVGroupSelect {
2021         WT_VGROUP_ALL = 0,
2022         WT_VGROUP_ACTIVE = 1,
2023         WT_VGROUP_BONE_SELECT = 2,
2024         WT_VGROUP_BONE_DEFORM = 3,
2025         WT_VGROUP_BONE_DEFORM_OFF = 4
2026 } eVGroupSelect;
2027
2028 #define WT_VGROUP_MASK_ALL \
2029         ((1 << WT_VGROUP_ACTIVE) | \
2030          (1 << WT_VGROUP_BONE_SELECT) | \
2031          (1 << WT_VGROUP_BONE_DEFORM) | \
2032          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
2033          (1 << WT_VGROUP_ALL))
2034
2035
2036 /* sce->flag */
2037 #define SCE_DS_SELECTED                 (1<<0)
2038 #define SCE_DS_COLLAPSED                (1<<1)
2039 #define SCE_NLA_EDIT_ON                 (1<<2)
2040 #define SCE_FRAME_DROP                  (1<<3)
2041 #define SCE_KEYS_NO_SELONLY         (1<<4)
2042
2043
2044         /* return flag BKE_scene_base_iter_next functions */
2045 /* #define F_ERROR                      -1 */  /* UNUSED */
2046 #define F_START                 0
2047 #define F_SCENE                 1
2048 #define F_DUPLI                 3
2049
2050 /* audio->flag */
2051 #define AUDIO_MUTE                (1<<0)
2052 #define AUDIO_SYNC                (1<<1)
2053 #define AUDIO_SCRUB                       (1<<2)
2054 #define AUDIO_VOLUME_ANIMATED     (1<<3)
2055
2056 enum {
2057 #ifdef DNA_DEPRECATED
2058         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
2059 #endif
2060         FFMPEG_AUTOSPLIT_OUTPUT = 2,
2061         FFMPEG_LOSSLESS_OUTPUT  = 4,
2062         FFMPEG_USE_MAX_B_FRAMES = (1 << 3),
2063 };
2064
2065 /* Paint.flags */
2066 typedef enum ePaintFlags {
2067         PAINT_SHOW_BRUSH = (1 << 0),
2068         PAINT_FAST_NAVIGATE = (1 << 1),
2069         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
2070         PAINT_USE_CAVITY_MASK = (1 << 3)
2071 } ePaintFlags;
2072
2073 /* Paint.symmetry_flags
2074  * (for now just a duplicate of sculpt symmetry flags) */
2075 typedef enum ePaintSymmetryFlags {
2076         PAINT_SYMM_X = (1 << 0),
2077         PAINT_SYMM_Y = (1 << 1),
2078         PAINT_SYMM_Z = (1 << 2),
2079         PAINT_SYMMETRY_FEATHER = (1 << 3),
2080         PAINT_TILE_X = (1 << 4),
2081         PAINT_TILE_Y = (1 << 5),
2082         PAINT_TILE_Z = (1 << 6),
2083 } ePaintSymmetryFlags;
2084
2085 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
2086
2087 /* Sculpt.flags */
2088 /* These can eventually be moved to paint flags? */
2089 typedef enum eSculptFlags {
2090 #ifdef DNA_DEPRECATED
2091         /* deprecated, part of paint struct symmetry_flags now */
2092         SCULPT_SYMM_X = (1 << 0),
2093         SCULPT_SYMM_Y = (1 << 1),
2094         SCULPT_SYMM_Z = (1 << 2),
2095 #endif
2096
2097         SCULPT_LOCK_X = (1 << 3),
2098         SCULPT_LOCK_Y = (1 << 4),
2099         SCULPT_LOCK_Z = (1 << 5),
2100         /* deprecated, part of paint struct symmetry_flags now */
2101         SCULPT_SYMMETRY_FEATHER = (1 << 6),
2102
2103         SCULPT_USE_OPENMP = (1 << 7),
2104         SCULPT_ONLY_DEFORM = (1 << 8),
2105         SCULPT_SHOW_DIFFUSE = (1 << 9),
2106
2107         /* If set, the mesh will be drawn with smooth-shading in
2108          * dynamic-topology mode */
2109         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
2110
2111         /* If set, dynamic-topology brushes will subdivide short edges */
2112         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
2113         /* If set, dynamic-topology brushes will collapse short edges */
2114         SCULPT_DYNTOPO_COLLAPSE = (1 << 11),
2115
2116         /* If set, dynamic-topology detail size will be constant in object space */
2117         SCULPT_DYNTOPO_DETAIL_CONSTANT = (1 << 13),
2118         SCULPT_DYNTOPO_DETAIL_BRUSH = (1 << 14),
2119
2120         /* Don't display mask in viewport, but still use it for strokes. */
2121         SCULPT_HIDE_MASK = (1 << 15),
2122 } eSculptFlags;
2123
2124 typedef enum eImageePaintMode {
2125         IMAGEPAINT_MODE_MATERIAL, /* detect texture paint slots from the material */
2126         IMAGEPAINT_MODE_IMAGE,    /* select texture paint image directly */
2127 } eImageePaintMode;
2128
2129 /* ImagePaintSettings.flag */
2130 #define IMAGEPAINT_DRAWING                              1
2131 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
2132 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
2133
2134 /* projection painting only */
2135 #define IMAGEPAINT_PROJECT_XRAY                 (1 << 4)
2136 #define IMAGEPAINT_PROJECT_BACKFACE             (1 << 5)
2137 #define IMAGEPAINT_PROJECT_FLAT                 (1 << 6)
2138 #define IMAGEPAINT_PROJECT_LAYER_CLONE  (1 << 7)
2139 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        (1 << 8)
2140 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    (1 << 9)
2141
2142
2143 #define IMAGEPAINT_MISSING_UVS       (1 << 0)
2144 #define IMAGEPAINT_MISSING_MATERIAL  (1 << 1)
2145 #define IMAGEPAINT_MISSING_TEX       (1 << 2)
2146 #define IMAGEPAINT_MISSING_STENCIL   (1 << 3)
2147
2148 /* toolsettings->uvcalc_flag */
2149 #define UVCALC_FILLHOLES                        1
2150 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
2151 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
2152 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
2153
2154 /* toolsettings->uv_flag */
2155 #define UV_SYNC_SELECTION       1
2156 #define UV_SHOW_SAME_IMAGE      2
2157
2158 /* toolsettings->uv_selectmode */
2159 #define UV_SELECT_VERTEX        1
2160 #define UV_SELECT_EDGE          2
2161 #define UV_SELECT_FACE          4
2162 #define UV_SELECT_ISLAND        8
2163
2164 /* toolsettings->edge_mode */
2165 #define EDGE_MODE_SELECT                                0
2166 #define EDGE_MODE_TAG_SEAM                              1
2167 #define EDGE_MODE_TAG_SHARP                             2
2168 #define EDGE_MODE_TAG_CREASE                    3
2169 #define EDGE_MODE_TAG_BEVEL                             4
2170 #define EDGE_MODE_TAG_FREESTYLE                 5
2171
2172 /* toolsettings->gpencil_flags */
2173 typedef enum eGPencil_Flags {
2174         /* "Continuous Drawing" - The drawing operator enters a mode where multiple strokes can be drawn */
2175         GP_TOOL_FLAG_PAINTSESSIONS_ON       = (1 << 0),
2176         /* When creating new frames, the last frame gets used as the basis for the new one */
2177         GP_TOOL_FLAG_RETAIN_LAST            = (1 << 1),
2178         /* Add the strokes below all strokes in the layer */
2179         GP_TOOL_FLAG_PAINT_ONBACK = (1 << 2)
2180 } eGPencil_Flags;
2181
2182 /* toolsettings->gpencil_src */
2183 typedef enum eGPencil_Source_3D {
2184         GP_TOOL_SOURCE_SCENE    = 0,
2185         GP_TOOL_SOURCE_OBJECT   = 1
2186 } eGPencil_Source_3d;
2187
2188 /* toolsettings->gpencil_*_align - Stroke Placement mode flags */
2189 typedef enum eGPencil_Placement_Flags {
2190         /* New strokes are added in viewport/data space (i.e. not screen space) */
2191         GP_PROJECT_VIEWSPACE    = (1 << 0),
2192         
2193         /* Viewport space, but relative to render canvas (Sequencer Preview Only) */
2194         GP_PROJECT_CANVAS       = (1 << 1),
2195         
2196         /* Project into the screen's Z values */
2197         GP_PROJECT_DEPTH_VIEW   = (1 << 2),
2198         GP_PROJECT_DEPTH_STROKE = (1 << 3),
2199         
2200         /* "Use Endpoints" */
2201         GP_PROJECT_DEPTH_STROKE_ENDPOINTS = (1 << 4),
2202 } eGPencil_Placement_Flags;
2203
2204 /* toolsettings->particle flag */
2205 #define PE_KEEP_LENGTHS                 1
2206 #define PE_LOCK_FIRST                   2
2207 #define PE_DEFLECT_EMITTER              4
2208 #define PE_INTERPOLATE_ADDED    8
2209 #define PE_DRAW_PART                    16
2210 /* #define PE_X_MIRROR                  64 */   /* deprecated */
2211 #define PE_FADE_TIME                    128
2212 #define PE_AUTO_VELOCITY                256
2213
2214 /* toolsetting->particle brushtype */
2215 #define PE_BRUSH_NONE           -1
2216 #define PE_BRUSH_COMB           0
2217 #define PE_BRUSH_CUT            1
2218 #define PE_BRUSH_LENGTH         2
2219 #define PE_BRUSH_PUFF           3
2220 #define PE_BRUSH_ADD            4
2221 #define PE_BRUSH_SMOOTH         5
2222 #define PE_BRUSH_WEIGHT         6
2223
2224 /* this must equal ParticleEditSettings.brush array size */
2225 #define PE_TOT_BRUSH            6
2226
2227 /* ParticleBrushData->flag */
2228 #define PE_BRUSH_DATA_PUFF_VOLUME 1
2229
2230 /* tooksettings->particle edittype */
2231 #define PE_TYPE_PARTICLES       0
2232 #define PE_TYPE_SOFTBODY        1
2233 #define PE_TYPE_CLOTH           2
2234
2235 /* toolsettings->skgen_options */
2236 #define SKGEN_FILTER_INTERNAL   (1 << 0)
2237 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
2238 #define SKGEN_SYMMETRY                  (1 << 2)
2239 #define SKGEN_CUT_LENGTH                (1 << 3)
2240 #define SKGEN_CUT_ANGLE                 (1 << 4)
2241 #define SKGEN_CUT_CORRELATION   (1 << 5)
2242 #define SKGEN_HARMONIC                  (1 << 6)
2243 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
2244 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
2245 #define SKGEN_FILTER_SMART              (1 << 9)
2246 #define SKGEN_DISP_LENGTH               (1 << 10)
2247 #define SKGEN_DISP_WEIGHT               (1 << 11)
2248 #define SKGEN_DISP_ORIG                 (1 << 12)
2249 #define SKGEN_DISP_EMBED                (1 << 13)
2250 #define SKGEN_DISP_INDEX                (1 << 14)
2251
2252 #define SKGEN_SUB_LENGTH                0
2253 #define SKGEN_SUB_ANGLE                 1
2254 #define SKGEN_SUB_CORRELATION   2
2255 #define SKGEN_SUB_TOTAL                 3
2256
2257 /* toolsettings->skgen_postpro */
2258 #define SKGEN_SMOOTH                    0
2259 #define SKGEN_AVERAGE                   1
2260 #define SKGEN_SHARPEN                   2
2261
2262 /* toolsettings->bone_sketching */
2263 #define BONE_SKETCHING                  1
2264 #define BONE_SKETCHING_QUICK    2
2265 #define BONE_SKETCHING_ADJUST   4
2266
2267 /* toolsettings->bone_sketching_convert */
2268 #define SK_CONVERT_CUT_FIXED                    0
2269 #define SK_CONVERT_CUT_LENGTH                   1
2270 #define SK_CONVERT_CUT_ADAPTATIVE               2
2271 #define SK_CONVERT_RETARGET                             3
2272
2273 /* toolsettings->skgen_retarget_options */
2274 #define SK_RETARGET_AUTONAME                    1
2275
2276 /* toolsettings->skgen_retarget_roll */
2277 #define SK_RETARGET_ROLL_NONE                   0
2278 #define SK_RETARGET_ROLL_VIEW                   1
2279 #define SK_RETARGET_ROLL_JOINT                  2
2280
2281 /* physics_settings->flag */
2282 #define PHYS_GLOBAL_GRAVITY             1
2283
2284 /* UnitSettings */
2285
2286 /* UnitSettings->system */
2287 #define USER_UNIT_NONE                  0
2288 #define USER_UNIT_METRIC                1
2289 #define USER_UNIT_IMPERIAL              2
2290 /* UnitSettings->flag */
2291 #define USER_UNIT_OPT_SPLIT             1
2292 #define USER_UNIT_ROT_RADIANS   2
2293
2294 #ifdef __cplusplus
2295 }
2296 #endif
2297
2298 #endif  /* __DNA_SCENE_TYPES_H__ */