Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_node_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) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Bob Holcomb, Xavier Thomas
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_node_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_NODE_TYPES_H__
33 #define __DNA_NODE_TYPES_H__
34
35 #include "DNA_ID.h"
36 #include "DNA_vec_types.h"
37 #include "DNA_listBase.h"
38 #include "DNA_texture_types.h"
39 #include "DNA_scene_types.h"
40
41 struct ID;
42 struct ListBase;
43 struct bNodeLink;
44 struct bNodeType;
45 struct bNodeTreeExec;
46 struct bNodePreview;
47 struct bNodeInstanceHash;
48 struct AnimData;
49 struct bGPdata;
50 struct uiBlock;
51 struct Image;
52
53 /* In writefile.c: write deprecated DNA data,
54  * to ensure forward compatibility in 2.6x versions.
55  * Will be removed eventually.
56  */
57 #define USE_NODE_COMPAT_CUSTOMNODES
58
59 #define NODE_MAXSTR 64
60
61 typedef struct bNodeStack {
62         float vec[4];
63         float min, max;
64         void *data;
65         short hasinput;                 /* when input has link, tagged before executing */
66         short hasoutput;                /* when output is linked, tagged before executing */
67         short datatype;                 /* type of data pointer */
68         short sockettype;               /* type of socket stack comes from, to remap linking different sockets */
69         short is_copy;                  /* data is a copy of external data (no freeing) */
70         short external;                 /* data is used by external nodes (no freeing) */
71         short pad[2];
72 } bNodeStack;
73
74 /* ns->datatype, shadetree only */
75 #define NS_OSA_VECTORS          1
76 #define NS_OSA_VALUES           2
77
78 /* node socket/node socket type -b conversion rules */
79 #define NS_CR_CENTER            0
80 #define NS_CR_NONE                      1
81 #define NS_CR_FIT_WIDTH         2
82 #define NS_CR_FIT_HEIGHT        3
83 #define NS_CR_FIT                       4
84 #define NS_CR_STRETCH           5
85
86 typedef struct bNodeSocket {
87         struct bNodeSocket *next, *prev, *new_sock;
88
89         IDProperty *prop;                       /* user-defined properties */
90
91         char identifier[64];            /* unique identifier for mapping */
92
93         char name[64];  /* MAX_NAME */
94
95         /* XXX deprecated, only used for the Image and OutputFile nodes,
96          * should be removed at some point.
97          */
98         void *storage;                          /* custom storage */
99
100         short type, flag;
101         short limit;                            /* max. number of links */
102         short in_out;                           /* input/output type */
103         struct bNodeSocketType *typeinfo;       /* runtime type information */
104         char idname[64];                        /* runtime type identifier */
105
106         float locx, locy;
107
108         void *default_value;            /* default input value used for unlinked sockets */
109
110         /* execution data */
111         short stack_index;                      /* local stack index */
112         /* XXX deprecated, kept for forward compatibility */
113         short stack_type  DNA_DEPRECATED;
114         char draw_shape, pad[3];
115
116         void *cache;                            /* cached data from execution */
117
118         /* internal data to retrieve relations and groups
119          * DEPRECATED, now uses the generic identifier string instead
120          */
121         int own_index  DNA_DEPRECATED;  /* group socket identifiers, to find matching pairs after reading files */
122         /* XXX deprecated, only used for restoring old group node links */
123         int to_index  DNA_DEPRECATED;
124         /* XXX deprecated, still forward compatible since verification restores pointer from matching own_index. */
125         struct bNodeSocket *groupsock  DNA_DEPRECATED;
126
127         struct bNodeLink *link;         /* a link pointer, set in ntreeUpdateTree */
128
129         /* XXX deprecated, socket input values are stored in default_value now. kept for forward compatibility */
130         bNodeStack ns  DNA_DEPRECATED;  /* custom data for inputs, only UI writes in this */
131 } bNodeSocket;
132
133 /* sock->type */
134 typedef enum eNodeSocketDatatype {
135         SOCK_CUSTOM                     = -1,   /* socket has no integer type */
136         SOCK_FLOAT                      = 0,
137         SOCK_VECTOR                     = 1,
138         SOCK_RGBA                       = 2,
139         SOCK_SHADER                     = 3,
140         SOCK_BOOLEAN            = 4,
141         __SOCK_MESH                     = 5,    /* deprecated */
142         SOCK_INT                        = 6,
143         SOCK_STRING                     = 7
144 } eNodeSocketDatatype;
145
146 /* socket shape */
147 typedef enum eNodeSocketDrawShape {
148         SOCK_DRAW_SHAPE_CIRCLE = 0,
149         SOCK_DRAW_SHAPE_SQUARE = 1,
150         SOCK_DRAW_SHAPE_DIAMOND = 2
151 } eNodeSocketDrawShape;
152
153 /* socket side (input/output) */
154 typedef enum eNodeSocketInOut {
155         SOCK_IN = 1,
156         SOCK_OUT = 2
157 } eNodeSocketInOut;
158
159 /* sock->flag, first bit is select */
160 typedef enum eNodeSocketFlag {
161         SOCK_HIDDEN = 2,                                        /* hidden is user defined, to hide unused */
162         SOCK_IN_USE = 4,                                        /* for quick check if socket is linked */
163         SOCK_UNAVAIL = 8,                                       /* unavailable is for dynamic sockets */
164         // SOCK_DYNAMIC = 16,                           /* DEPRECATED  dynamic socket (can be modified by user) */
165         // SOCK_INTERNAL = 32,                          /* DEPRECATED  group socket should not be exposed */
166         SOCK_COLLAPSED = 64,                            /* socket collapsed in UI */
167         SOCK_HIDE_VALUE = 128,                          /* hide socket value, if it gets auto default */
168         SOCK_AUTO_HIDDEN__DEPRECATED = 256,     /* socket hidden automatically, to distinguish from manually hidden */
169         SOCK_NO_INTERNAL_LINK = 512
170 } eNodeSocketFlag;
171
172 /* limit data in bNode to what we want to see saved? */
173 typedef struct bNode {
174         struct bNode *next, *prev, *new_node;
175
176         IDProperty *prop;               /* user-defined properties */
177
178         struct bNodeType *typeinfo;     /* runtime type information */
179         char idname[64];                        /* runtime type identifier */
180
181         char name[64];  /* MAX_NAME */
182         int flag;
183         short type, pad;
184         short done, level;              /* both for dependency and sorting */
185         short lasty, menunr;    /* lasty: check preview render status, menunr: browse ID blocks */
186         short stack_index;              /* for groupnode, offset in global caller stack */
187         short nr;                               /* number of this node in list, used for UI exec events */
188         float color[3];                 /* custom user-defined color */
189
190         ListBase inputs, outputs;
191         struct bNode *parent;   /* parent node */
192         struct ID *id;                  /* optional link to libdata */
193         void *storage;                  /* custom data, must be struct, for storage in file */
194         struct bNode *original; /* the original node in the tree (for localized tree) */
195         ListBase internal_links; /* list of cached internal links (input to output), for muted nodes and operators */
196
197         float locx, locy;               /* root offset for drawing (parent space) */
198         float width, height;    /* node custom width and height */
199         float miniwidth;                /* node width if hidden */
200         float offsetx, offsety; /* additional offset from loc */
201         float anim_init_locx;   /* initial locx for insert offset animation */
202         float anim_ofsx;                /* offset that will be added to locx for insert offset animation */
203
204         int update;                             /* update flags */
205
206         char label[64];                 /* custom user-defined label, MAX_NAME */
207         short custom1, custom2; /* to be abused for buttons */
208         float custom3, custom4;
209
210         short need_exec, exec;  /* need_exec is set as UI execution event, exec is flag during exec */
211         void *threaddata;               /* optional extra storage for use in thread (read only then!) */
212         rctf totr;                              /* entire boundbox (worldspace) */
213         rctf butr;                              /* optional buttons area */
214         rctf prvr;                              /* optional preview area */
215         /* XXX TODO
216          * Node totr size depends on the prvr size, which in turn is determined from preview size.
217          * In earlier versions bNodePreview was stored directly in nodes, but since now there can be
218          * multiple instances using different preview images it is possible that required node size varies between instances.
219          * preview_xsize, preview_ysize defines a common reserved size for preview rect for now,
220          * could be replaced by more accurate node instance drawing, but that requires removing totr from DNA
221          * and replacing all uses with per-instance data.
222          */
223         short preview_xsize, preview_ysize;     /* reserved size of the preview rect */
224         short pad2[2];
225         struct uiBlock *block;  /* runtime during drawing */
226
227         float ssr_id; /* XXX: eevee only, id of screen space reflection layer, needs to be a float to feed GPU_uniform. */
228         float sss_id; /* XXX: eevee only, id of screen subsurface scatter layer, needs to be a float to feed GPU_uniform. */
229 } bNode;
230
231 /* node->flag */
232 #define NODE_SELECT                     1
233 #define NODE_OPTIONS            2
234 #define NODE_PREVIEW            4
235 #define NODE_HIDDEN                     8
236 #define NODE_ACTIVE                     16
237 #define NODE_ACTIVE_ID          32
238 #define NODE_DO_OUTPUT          64
239 #define __NODE_GROUP_EDIT       128             /* DEPRECATED */
240         /* free test flag, undefined */
241 #define NODE_TEST                       256
242         /* node is disabled */
243 #define NODE_MUTED                      512
244 // #define NODE_CUSTOM_NAME     1024    /* deprecated! */
245         /* group node types: use const outputs by default */
246 #define NODE_CONST_OUTPUT       (1<<11)
247         /* node is always behind others */
248 #define NODE_BACKGROUND         (1<<12)
249         /* automatic flag for nodes included in transforms */
250 #define NODE_TRANSFORM          (1<<13)
251         /* node is active texture */
252
253         /* note: take care with this flag since its possible it gets
254          * `stuck` inside/outside the active group - which makes buttons
255          * window texture not update, we try to avoid it by clearing the
256          * flag when toggling group editing - Campbell */
257 #define NODE_ACTIVE_TEXTURE     (1<<14)
258         /* use a custom color for the node */
259 #define NODE_CUSTOM_COLOR       (1<<15)
260         /* Node has been initialized
261          * This flag indicates the node->typeinfo->init function has been called.
262          * In case of undefined type at creation time this can be delayed until
263          * until the node type is registered.
264          */
265 #define NODE_INIT                       (1<<16)
266
267         /* do recalc of output, used to skip recalculation of unwanted
268          * composite out nodes when editing tree
269          */
270 #define NODE_DO_OUTPUT_RECALC   (1<<17)
271
272 /* node->update */
273 /* XXX NODE_UPDATE is a generic update flag. More fine-grained updates
274  * might be used in the future, but currently all work the same way.
275  */
276 #define NODE_UPDATE                     0xFFFF  /* generic update flag (includes all others) */
277 #define NODE_UPDATE_ID          1               /* associated id data block has changed */
278 #define NODE_UPDATE_OPERATOR            2               /* node update triggered from update operator */
279
280 /* Unique hash key for identifying node instances
281  * Defined as a struct because DNA does not support other typedefs.
282  */
283 typedef struct bNodeInstanceKey {
284         unsigned int value;
285 } bNodeInstanceKey;
286
287 /* Base struct for entries in node instance hash.
288  * WARNING: pointers are cast to this struct internally,
289  * it must be first member in hash entry structs!
290  */
291 typedef struct bNodeInstanceHashEntry {
292         bNodeInstanceKey key;
293
294         /* tags for cleaning the cache */
295         short tag;
296         short pad;
297 } bNodeInstanceHashEntry;
298
299
300 typedef struct bNodePreview {
301         bNodeInstanceHashEntry hash_entry;      /* must be first */
302
303         unsigned char *rect;
304         short xsize, ysize;
305         int pad;
306 } bNodePreview;
307
308
309 typedef struct bNodeLink {
310         struct bNodeLink *next, *prev;
311
312         bNode *fromnode, *tonode;
313         bNodeSocket *fromsock, *tosock;
314
315         int flag;
316         int pad;
317 } bNodeLink;
318
319 /* link->flag */
320 #define NODE_LINKFLAG_HILITE    1               /* link has been successfully validated */
321 #define NODE_LINK_VALID                 2
322 #define NODE_LINK_TEST                  4               /* free test flag, undefined */
323
324 /* tree->edit_quality/tree->render_quality */
325 #define NTREE_QUALITY_HIGH    0
326 #define NTREE_QUALITY_MEDIUM  1
327 #define NTREE_QUALITY_LOW     2
328
329 /* tree->chunksize */
330 #define NTREE_CHUNCKSIZE_32 32
331 #define NTREE_CHUNCKSIZE_64 64
332 #define NTREE_CHUNCKSIZE_128 128
333 #define NTREE_CHUNCKSIZE_256 256
334 #define NTREE_CHUNCKSIZE_512 512
335 #define NTREE_CHUNCKSIZE_1024 1024
336
337 /* the basis for a Node tree, all links and nodes reside internal here */
338 /* only re-usable node trees are in the library though, materials and textures allocate own tree struct */
339 typedef struct bNodeTree {
340         ID id;
341         struct AnimData *adt;           /* animation data (must be immediately after id for utilities to use it) */
342
343         struct bNodeTreeType *typeinfo; /* runtime type information */
344         char idname[64];                                /* runtime type identifier */
345
346         struct StructRNA *interface_type;       /* runtime RNA type of the group interface */
347
348         struct bGPdata *gpd;            /* grease pencil data */
349         float view_center[2];           /* node tree stores own offset for consistent editor view */
350
351         ListBase nodes, links;
352
353         int type, init;                                 /* set init on fileread */
354         int cur_index;                                  /* sockets in groups have unique identifiers, adding new sockets always
355                                                                          * will increase this counter */
356         int flag;
357         int update;                                             /* update flags */
358         short is_updating;                              /* flag to prevent reentrant update calls */
359         short done;                                             /* generic temporary flag for recursion check (DFS/BFS) */
360         int pad2;
361
362         int nodetype DNA_DEPRECATED;    /* specific node type this tree is used for */
363
364         short edit_quality;                             /* Quality setting when editing */
365         short render_quality;                           /* Quality setting when rendering */
366         int chunksize;                                  /* tile size for compositor engine */
367
368         rctf viewer_border;
369
370         /* Lists of bNodeSocket to hold default values and own_index.
371          * Warning! Don't make links to these sockets, input/output nodes are used for that.
372          * These sockets are used only for generating external interfaces.
373          */
374         ListBase inputs, outputs;
375
376         /* Node preview hash table
377          * Only available in base node trees (e.g. scene->node_tree)
378          */
379         struct bNodeInstanceHash *previews;
380         /* Defines the node tree instance to use for the "active" context,
381          * in case multiple different editors are used and make context ambiguous.
382          */
383         bNodeInstanceKey active_viewer_key;
384         int pad;
385
386         /* execution data */
387         /* XXX It would be preferable to completely move this data out of the underlying node tree,
388          * so node tree execution could finally run independent of the tree itself. This would allow node trees
389          * to be merely linked by other data (materials, textures, etc.), as ID data is supposed to.
390          * Execution data is generated from the tree once at execution start and can then be used
391          * as long as necessary, even while the tree is being modified.
392          */
393         struct bNodeTreeExec *execdata;
394
395         /* callbacks */
396         void (*progress)(void *, float progress);
397         /** \warning may be called by different threads */
398         void (*stats_draw)(void *, const char *str);
399         int (*test_break)(void *);
400         void (*update_draw)(void *);
401         void *tbh, *prh, *sdh, *udh;
402
403         void *duplilock;
404
405 } bNodeTree;
406
407 /* ntree->type, index */
408 #define NTREE_CUSTOM            -1              /* for dynamically registered custom types */
409 #define NTREE_SHADER            0
410 #define NTREE_COMPOSIT          1
411 #define NTREE_TEXTURE           2
412
413 /* ntree->init, flag */
414 #define NTREE_TYPE_INIT         1
415
416 /* ntree->flag */
417 #define NTREE_DS_EXPAND                         1       /* for animation editors */
418 #define NTREE_COM_OPENCL                        2       /* use opencl */
419 #define NTREE_TWO_PASS                          4       /* two pass */
420 #define NTREE_COM_GROUPNODE_BUFFER      8       /* use groupnode buffers */
421 #define NTREE_VIEWER_BORDER                     16      /* use a border for viewer nodes */
422 #define NTREE_IS_LOCALIZED                      32      /* tree is localized copy, free when deleting node groups */
423
424 /* XXX not nice, but needed as a temporary flags
425  * for group updates after library linking.
426  */
427 #define NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2   1024    /* changes from r35033 */
428 #define NTREE_DO_VERSIONS_CUSTOMNODES_GROUP             2048    /* custom_nodes branch: remove links to node tree sockets */
429 #define NTREE_DO_VERSIONS_CUSTOMNODES_GROUP_CREATE_INTERFACE    4096    /* custom_nodes branch: create group input/output nodes */
430
431 /* ntree->update */
432 typedef enum eNodeTreeUpdate {
433         NTREE_UPDATE            = 0xFFFF,       /* generic update flag (includes all others) */
434         NTREE_UPDATE_LINKS      = 1,            /* links have been added or removed */
435         NTREE_UPDATE_NODES      = 2,            /* nodes or sockets have been added or removed */
436         NTREE_UPDATE_GROUP_IN   = 16,           /* group inputs have changed */
437         NTREE_UPDATE_GROUP_OUT  = 32,           /* group outputs have changed */
438         NTREE_UPDATE_GROUP      = 48            /* group has changed (generic flag including all other group flags) */
439 } eNodeTreeUpdate;
440
441
442 /* socket value structs for input buttons
443  * DEPRECATED now using ID properties
444  */
445
446 typedef struct bNodeSocketValueInt {
447         int subtype;                            /* RNA subtype */
448         int value;
449         int min, max;
450 } bNodeSocketValueInt;
451
452 typedef struct bNodeSocketValueFloat {
453         int subtype;                            /* RNA subtype */
454         float value;
455         float min, max;
456 } bNodeSocketValueFloat;
457
458 typedef struct bNodeSocketValueBoolean {
459         char value;
460         char pad[3];
461 } bNodeSocketValueBoolean;
462
463 typedef struct bNodeSocketValueVector {
464         int subtype;                            /* RNA subtype */
465         float value[3];
466         float min, max;
467 } bNodeSocketValueVector;
468
469 typedef struct bNodeSocketValueRGBA {
470         float value[4];
471 } bNodeSocketValueRGBA;
472
473 typedef struct bNodeSocketValueString {
474         int subtype;
475         int pad;
476         char value[1024];       /* 1024 = FILEMAX */
477 } bNodeSocketValueString;
478
479 /* data structs, for node->storage */
480 enum {
481         CMP_NODE_MASKTYPE_ADD         = 0,
482         CMP_NODE_MASKTYPE_SUBTRACT    = 1,
483         CMP_NODE_MASKTYPE_MULTIPLY    = 2,
484         CMP_NODE_MASKTYPE_NOT         = 3
485 };
486
487 enum {
488         CMP_NODE_LENSFLARE_GHOST   = 1,
489         CMP_NODE_LENSFLARE_GLOW    = 2,
490         CMP_NODE_LENSFLARE_CIRCLE  = 4,
491         CMP_NODE_LENSFLARE_STREAKS = 8
492 };
493
494 enum {
495         CMP_NODE_DILATEERODE_STEP             = 0,
496         CMP_NODE_DILATEERODE_DISTANCE_THRESH  = 1,
497         CMP_NODE_DILATEERODE_DISTANCE         = 2,
498         CMP_NODE_DILATEERODE_DISTANCE_FEATHER = 3
499 };
500
501 enum {
502         CMP_NODE_INPAINT_SIMPLE               = 0
503 };
504
505 enum {
506         /* CMP_NODEFLAG_MASK_AA          = (1 << 0), */  /* DEPRECATED */
507         CMP_NODEFLAG_MASK_NO_FEATHER  = (1 << 1),
508         CMP_NODEFLAG_MASK_MOTION_BLUR = (1 << 2),
509
510         /* we may want multiple aspect options, exposed as an rna enum */
511         CMP_NODEFLAG_MASK_FIXED       = (1 << 8),
512         CMP_NODEFLAG_MASK_FIXED_SCENE = (1 << 9)
513 };
514
515 enum {
516         CMP_NODEFLAG_BLUR_VARIABLE_SIZE = (1 << 0),
517         CMP_NODEFLAG_BLUR_EXTEND_BOUNDS = (1 << 1),
518 };
519
520 typedef struct NodeFrame {
521         short flag;
522         short label_size;
523 } NodeFrame;
524
525 /* this one has been replaced with ImageUser, keep it for do_versions() */
526 typedef struct NodeImageAnim {
527         int frames   DNA_DEPRECATED;
528         int sfra     DNA_DEPRECATED;
529         int nr       DNA_DEPRECATED;
530         char cyclic  DNA_DEPRECATED;
531         char movie   DNA_DEPRECATED;
532         short pad;
533 } NodeImageAnim;
534
535 typedef struct ColorCorrectionData {
536         float saturation;
537         float contrast;
538         float gamma;
539         float gain;
540         float lift;
541         int pad;
542 } ColorCorrectionData;
543
544 typedef struct NodeColorCorrection {
545         ColorCorrectionData master;
546         ColorCorrectionData shadows;
547         ColorCorrectionData midtones;
548         ColorCorrectionData highlights;
549         float startmidtones;
550         float endmidtones;
551 } NodeColorCorrection;
552
553 typedef struct NodeBokehImage {
554         float angle;
555         int flaps;
556         float rounding;
557         float catadioptric;
558         float lensshift;
559 } NodeBokehImage;
560
561 typedef struct NodeBoxMask {
562         float x;
563         float y;
564         float rotation;
565         float height;
566         float width;
567         int pad;
568 } NodeBoxMask;
569
570 typedef struct NodeEllipseMask {
571         float x;
572         float y;
573         float rotation;
574         float height;
575         float width;
576         int pad;
577 } NodeEllipseMask;
578
579 /* layer info for image node outputs */
580 typedef struct NodeImageLayer {
581         /* index in the Image->layers->passes lists */
582         int pass_index  DNA_DEPRECATED;
583         /* render pass name */
584         char pass_name[64]; /* amount defined in openexr_multi.h */
585 } NodeImageLayer;
586
587 typedef struct NodeBlurData {
588         short sizex, sizey;
589         short samples, maxspeed, minspeed, relative, aspect;
590         short curved;
591         float fac, percentx, percenty;
592         short filtertype;
593         char bokeh, gamma;
594         int image_in_width, image_in_height; /* needed for absolute/relative conversions */
595 } NodeBlurData;
596
597 typedef struct NodeDBlurData {
598         float center_x, center_y, distance, angle, spin, zoom;
599         short iter;
600         char wrap, pad;
601 } NodeDBlurData;
602
603 typedef struct NodeBilateralBlurData {
604         float sigma_color, sigma_space;
605         short iter, pad;
606 } NodeBilateralBlurData;
607
608 /* NOTE: Only for do-version code. */
609 typedef struct NodeHueSat {
610         float hue, sat, val;
611 } NodeHueSat;
612
613 typedef struct NodeImageFile {
614         char name[1024]; /* 1024 = FILE_MAX */
615         struct ImageFormatData im_format;
616         int sfra, efra;
617 } NodeImageFile;
618
619 /* XXX first struct fields should match NodeImageFile to ensure forward compatibility */
620 typedef struct NodeImageMultiFile {
621         char base_path[1024];   /* 1024 = FILE_MAX */
622         ImageFormatData format;
623         int sfra DNA_DEPRECATED, efra DNA_DEPRECATED;   /* XXX old frame rand values from NodeImageFile for forward compatibility */
624         int active_input;               /* selected input in details view list */
625         int pad;
626 } NodeImageMultiFile;
627 typedef struct NodeImageMultiFileSocket {
628         /* single layer file output */
629         short use_render_format  DNA_DEPRECATED;
630         short use_node_format;  /* use overall node image format */
631         int pad1;
632         char path[1024];                /* 1024 = FILE_MAX */
633         ImageFormatData format;
634
635         /* multilayer output */
636         char layer[30];         /* EXR_TOT_MAXNAME-2 ('.' and channel char are appended) */
637         char pad2[2];
638 } NodeImageMultiFileSocket;
639
640 typedef struct NodeChroma {
641         float t1, t2, t3;
642         float fsize, fstrength, falpha;
643         float key[4];
644         short algorithm, channel;
645 } NodeChroma;
646
647 typedef struct NodeTwoXYs {
648         short x1, x2, y1, y2;
649         float fac_x1, fac_x2, fac_y1, fac_y2;
650 } NodeTwoXYs;
651
652 typedef struct NodeTwoFloats {
653         float x, y;
654 } NodeTwoFloats;
655
656 typedef struct NodeVertexCol {
657         char name[64];
658 } NodeVertexCol;
659
660 /* qdn: Defocus blur node */
661 typedef struct NodeDefocus {
662         char bktype, pad_c1, preview, gamco;
663         short samples, no_zbuf;
664         float fstop, maxblur, bthresh, scale;
665         float rotation, pad_f1;
666 } NodeDefocus;
667
668 typedef struct NodeScriptDict {
669         void *dict; /* for PyObject *dict */
670         void *node; /* for BPy_Node *node */
671 } NodeScriptDict;
672
673 /* qdn: glare node */
674 typedef struct NodeGlare {
675         char quality, type, iter;
676         /* XXX angle is only kept for backward/forward compatibility, was used for two different things, see T50736. */
677         char angle DNA_DEPRECATED, pad_c1, size, star_45, streaks;
678         float colmod, mix, threshold, fade;
679         float angle_ofs, pad_f1;
680 } NodeGlare;
681
682 /* qdn: tonemap node */
683 typedef struct NodeTonemap {
684         float key, offset, gamma;
685         float f, m, a, c;
686         int type;
687 } NodeTonemap;
688
689 /* qdn: lens distortion node */
690 typedef struct NodeLensDist {
691         short jit, proj, fit, pad;
692 } NodeLensDist;
693
694 typedef struct NodeColorBalance {
695         /* ASC CDL parameters */
696         float slope[3];
697         float offset[3];
698         float power[3];
699         float offset_basis;
700         char _pad[4];
701
702         /* LGG parameters */
703         float lift[3];
704         float gamma[3];
705         float gain[3];
706 } NodeColorBalance;
707
708 typedef struct NodeColorspill {
709         short limchan, unspill;
710         float limscale;
711         float uspillr, uspillg, uspillb;
712 } NodeColorspill;
713
714 typedef struct NodeDilateErode {
715         char falloff;
716         char pad[7];
717 } NodeDilateErode;
718
719 typedef struct NodeMask {
720         int size_x, size_y;
721 } NodeMask;
722
723 typedef struct NodeTexBase {
724         TexMapping tex_mapping;
725         ColorMapping color_mapping;
726 } NodeTexBase;
727
728 typedef struct NodeTexSky {
729         NodeTexBase base;
730         int sky_model;
731         float sun_direction[3];
732         float turbidity;
733         float ground_albedo;
734 } NodeTexSky;
735
736 typedef struct NodeTexImage {
737         NodeTexBase base;
738         ImageUser iuser;
739         int color_space;
740         int projection;
741         float projection_blend;
742         int interpolation;
743         int extension;
744         int pad;
745 } NodeTexImage;
746
747 typedef struct NodeTexChecker {
748         NodeTexBase base;
749 } NodeTexChecker;
750
751 typedef struct NodeTexBrick {
752         NodeTexBase base;
753         int offset_freq, squash_freq;
754         float offset, squash;
755 } NodeTexBrick;
756
757 typedef struct NodeTexEnvironment {
758         NodeTexBase base;
759         ImageUser iuser;
760         int color_space;
761         int projection;
762         int interpolation;
763         int pad;
764 } NodeTexEnvironment;
765
766 typedef struct NodeTexGradient {
767         NodeTexBase base;
768         int gradient_type;
769         int pad;
770 } NodeTexGradient;
771
772 typedef struct NodeTexNoise {
773         NodeTexBase base;
774 } NodeTexNoise;
775
776 typedef struct NodeTexVoronoi {
777         NodeTexBase base;
778         int coloring;
779         int distance;
780         int feature;
781         int pad;
782 } NodeTexVoronoi;
783
784 typedef struct NodeTexMusgrave {
785         NodeTexBase base;
786         int musgrave_type;
787         int pad;
788 } NodeTexMusgrave;
789
790 typedef struct NodeTexWave {
791         NodeTexBase base;
792         int wave_type;
793         int wave_profile;
794 } NodeTexWave;
795
796 typedef struct NodeTexMagic {
797         NodeTexBase base;
798         int depth;
799         int pad;
800 } NodeTexMagic;
801
802 typedef struct NodeShaderAttribute {
803         char name[64];
804 } NodeShaderAttribute;
805
806 typedef struct NodeShaderVectTransform {
807         int type;
808         int convert_from, convert_to;
809         int pad;
810 } NodeShaderVectTransform;
811
812 typedef struct NodeShaderTexPointDensity {
813         NodeTexBase base;
814         short point_source, pad;
815         int particle_system;
816         float radius;
817         int resolution;
818         short space;
819         short interpolation;
820         short color_source;
821         short ob_color_source;
822         char vertex_attribute_name[64]; /* vertex attribute layer for color source, MAX_CUSTOMDATA_LAYER_NAME */
823         /* Used at runtime only by sampling RNA API. */
824         PointDensity pd;
825         int cached_resolution;
826         int pad2;
827 } NodeShaderTexPointDensity;
828
829 /* TEX_output */
830 typedef struct TexNodeOutput {
831         char name[64];
832 } TexNodeOutput;
833
834 typedef struct NodeKeyingScreenData {
835         char tracking_object[64];
836 } NodeKeyingScreenData;
837
838 typedef struct NodeKeyingData {
839         float screen_balance;
840         float despill_factor;
841         float despill_balance;
842         int edge_kernel_radius;
843         float edge_kernel_tolerance;
844         float clip_black, clip_white;
845         int dilate_distance;
846         int feather_distance;
847         int feather_falloff;
848         int blur_pre, blur_post;
849 } NodeKeyingData;
850
851 typedef struct NodeTrackPosData {
852         char tracking_object[64];
853         char track_name[64];
854 } NodeTrackPosData;
855
856 typedef struct NodeTranslateData {
857         char wrap_axis;
858         char relative;
859         char pad[6];
860 } NodeTranslateData;
861
862 typedef struct NodePlaneTrackDeformData {
863         char tracking_object[64];
864         char plane_track_name[64];
865         char flag;
866         char motion_blur_samples;
867         char pad[2];
868         float motion_blur_shutter;
869 } NodePlaneTrackDeformData;
870
871 typedef struct NodeShaderScript {
872         int mode;
873         int flag;
874
875         char filepath[1024]; /* 1024 = FILE_MAX */
876
877         char bytecode_hash[64];
878         char *bytecode;
879 } NodeShaderScript;
880
881 typedef struct NodeShaderTangent {
882         int direction_type;
883         int axis;
884         char uv_map[64];
885 } NodeShaderTangent;
886
887 typedef struct NodeShaderNormalMap {
888         int space;
889         char uv_map[64];
890 } NodeShaderNormalMap;
891
892 typedef struct NodeShaderUVMap {
893         char uv_map[64];
894 } NodeShaderUVMap;
895
896 typedef struct NodeShaderTexIES {
897         int mode;
898
899         char filepath[1024]; /* 1024 = FILE_MAX */
900 } NodeShaderTexIES;
901
902 typedef struct NodeSunBeams {
903         float source[2];
904
905         float ray_length;
906 } NodeSunBeams;
907
908 typedef struct NodeCryptomatte {
909         float add[3];
910         float remove[3];
911         char *matte_id;
912         int num_inputs;
913         int pad;
914 } NodeCryptomatte;
915
916 /* script node mode */
917 #define NODE_SCRIPT_INTERNAL            0
918 #define NODE_SCRIPT_EXTERNAL            1
919
920 /* script node flag */
921 #define NODE_SCRIPT_AUTO_UPDATE         1
922
923 /* ies node mode */
924 #define NODE_IES_INTERNAL               0
925 #define NODE_IES_EXTERNAL               1
926
927 /* frame node flags */
928 #define NODE_FRAME_SHRINK               1       /* keep the bounding box minimal */
929 #define NODE_FRAME_RESIZEABLE   2       /* test flag, if frame can be resized by user */
930
931 /* proxy node flags */
932 #define NODE_PROXY_AUTOTYPE                     1       /* automatically change output type based on link */
933
934 /* comp channel matte */
935 #define CMP_NODE_CHANNEL_MATTE_CS_RGB   1
936 #define CMP_NODE_CHANNEL_MATTE_CS_HSV   2
937 #define CMP_NODE_CHANNEL_MATTE_CS_YUV   3
938 #define CMP_NODE_CHANNEL_MATTE_CS_YCC   4
939
940 /* glossy distributions */
941 #define SHD_GLOSSY_BECKMANN                             0
942 #define SHD_GLOSSY_SHARP                                1
943 #define SHD_GLOSSY_GGX                                  2
944 #define SHD_GLOSSY_ASHIKHMIN_SHIRLEY                    3
945 #define SHD_GLOSSY_MULTI_GGX                            4
946
947 /* vector transform */
948 #define SHD_VECT_TRANSFORM_TYPE_VECTOR  0
949 #define SHD_VECT_TRANSFORM_TYPE_POINT   1
950 #define SHD_VECT_TRANSFORM_TYPE_NORMAL  2
951
952 #define SHD_VECT_TRANSFORM_SPACE_WORLD  0
953 #define SHD_VECT_TRANSFORM_SPACE_OBJECT 1
954 #define SHD_VECT_TRANSFORM_SPACE_CAMERA 2
955
956 /* toon modes */
957 #define SHD_TOON_DIFFUSE        0
958 #define SHD_TOON_GLOSSY         1
959
960 /* hair components */
961 #define SHD_HAIR_REFLECTION             0
962 #define SHD_HAIR_TRANSMISSION           1
963
964 /* principled hair parametrization */
965 #define SHD_PRINCIPLED_HAIR_REFLECTANCE                         0
966 #define SHD_PRINCIPLED_HAIR_PIGMENT_CONCENTRATION       1
967 #define SHD_PRINCIPLED_HAIR_DIRECT_ABSORPTION           2
968
969 /* blend texture */
970 #define SHD_BLEND_LINEAR                        0
971 #define SHD_BLEND_QUADRATIC                     1
972 #define SHD_BLEND_EASING                        2
973 #define SHD_BLEND_DIAGONAL                      3
974 #define SHD_BLEND_RADIAL                        4
975 #define SHD_BLEND_QUADRATIC_SPHERE      5
976 #define SHD_BLEND_SPHERICAL                     6
977
978 /* noise basis for textures */
979 #define SHD_NOISE_PERLIN                        0
980 #define SHD_NOISE_VORONOI_F1            1
981 #define SHD_NOISE_VORONOI_F2            2
982 #define SHD_NOISE_VORONOI_F3            3
983 #define SHD_NOISE_VORONOI_F4            4
984 #define SHD_NOISE_VORONOI_F2_F1         5
985 #define SHD_NOISE_VORONOI_CRACKLE       6
986 #define SHD_NOISE_CELL_NOISE            7
987
988 #define SHD_NOISE_SOFT  0
989 #define SHD_NOISE_HARD  1
990
991 /* voronoi texture */
992 #define SHD_VORONOI_DISTANCE            0
993 #define SHD_VORONOI_MANHATTAN           1
994 #define SHD_VORONOI_CHEBYCHEV           2
995 #define SHD_VORONOI_MINKOWSKI           3
996
997 #define SHD_VORONOI_INTENSITY   0
998 #define SHD_VORONOI_CELLS               1
999
1000 #define SHD_VORONOI_F1          0
1001 #define SHD_VORONOI_F2          1
1002 #define SHD_VORONOI_F3          2
1003 #define SHD_VORONOI_F4          3
1004 #define SHD_VORONOI_F2F1        4
1005
1006 /* musgrave texture */
1007 #define SHD_MUSGRAVE_MULTIFRACTAL                       0
1008 #define SHD_MUSGRAVE_FBM                                        1
1009 #define SHD_MUSGRAVE_HYBRID_MULTIFRACTAL        2
1010 #define SHD_MUSGRAVE_RIDGED_MULTIFRACTAL        3
1011 #define SHD_MUSGRAVE_HETERO_TERRAIN                     4
1012
1013 /* wave texture */
1014 #define SHD_WAVE_BANDS          0
1015 #define SHD_WAVE_RINGS          1
1016
1017 #define SHD_WAVE_PROFILE_SIN    0
1018 #define SHD_WAVE_PROFILE_SAW    1
1019
1020 /* sky texture */
1021 #define SHD_SKY_OLD             0
1022 #define SHD_SKY_NEW             1
1023
1024 /* image/environment texture */
1025 #define SHD_COLORSPACE_NONE             0
1026 #define SHD_COLORSPACE_COLOR    1
1027
1028 /* environment texture */
1029 #define SHD_PROJ_EQUIRECTANGULAR        0
1030 #define SHD_PROJ_MIRROR_BALL            1
1031
1032 #define SHD_IMAGE_EXTENSION_REPEAT      0
1033 #define SHD_IMAGE_EXTENSION_EXTEND      1
1034 #define SHD_IMAGE_EXTENSION_CLIP        2
1035
1036 /* image texture */
1037 #define SHD_PROJ_FLAT                           0
1038 #define SHD_PROJ_BOX                            1
1039 #define SHD_PROJ_SPHERE                         2
1040 #define SHD_PROJ_TUBE                           3
1041
1042 /* image texture interpolation */
1043 #define SHD_INTERP_LINEAR               0
1044 #define SHD_INTERP_CLOSEST              1
1045 #define SHD_INTERP_CUBIC                        2
1046 #define SHD_INTERP_SMART                        3
1047
1048 /* tangent */
1049 #define SHD_TANGENT_RADIAL                      0
1050 #define SHD_TANGENT_UVMAP                       1
1051
1052 /* tangent */
1053 #define SHD_TANGENT_AXIS_X                      0
1054 #define SHD_TANGENT_AXIS_Y                      1
1055 #define SHD_TANGENT_AXIS_Z                      2
1056
1057 /* normal map, displacement space */
1058 #define SHD_SPACE_TANGENT                       0
1059 #define SHD_SPACE_OBJECT                        1
1060 #define SHD_SPACE_WORLD                         2
1061 #define SHD_SPACE_BLENDER_OBJECT        3
1062 #define SHD_SPACE_BLENDER_WORLD         4
1063
1064 #define SHD_AO_INSIDE                           1
1065 #define SHD_AO_LOCAL                            2
1066
1067 /* math node clamp */
1068 #define SHD_MATH_CLAMP          1
1069
1070 /* Math node operation/ */
1071 enum {
1072         NODE_MATH_ADD     = 0,
1073         NODE_MATH_SUB     = 1,
1074         NODE_MATH_MUL     = 2,
1075         NODE_MATH_DIVIDE  = 3,
1076         NODE_MATH_SIN     = 4,
1077         NODE_MATH_COS     = 5,
1078         NODE_MATH_TAN     = 6,
1079         NODE_MATH_ASIN    = 7,
1080         NODE_MATH_ACOS    = 8,
1081         NODE_MATH_ATAN    = 9,
1082         NODE_MATH_POW     = 10,
1083         NODE_MATH_LOG     = 11,
1084         NODE_MATH_MIN     = 12,
1085         NODE_MATH_MAX     = 13,
1086         NODE_MATH_ROUND   = 14,
1087         NODE_MATH_LESS    = 15,
1088         NODE_MATH_GREATER = 16,
1089         NODE_MATH_MOD     = 17,
1090         NODE_MATH_ABS     = 18,
1091         NODE_MATH_ATAN2   = 19,
1092         NODE_MATH_FLOOR   = 20,
1093         NODE_MATH_CEIL    = 21,
1094         NODE_MATH_FRACT   = 22,
1095         NODE_MATH_SQRT    = 23,
1096 };
1097
1098 /* mix rgb node flags */
1099 #define SHD_MIXRGB_USE_ALPHA    1
1100 #define SHD_MIXRGB_CLAMP        2
1101
1102 /* subsurface */
1103 enum {
1104 #ifdef DNA_DEPRECATED
1105         SHD_SUBSURFACE_COMPATIBLE               = 0, // Deprecated
1106 #endif
1107         SHD_SUBSURFACE_CUBIC                    = 1,
1108         SHD_SUBSURFACE_GAUSSIAN                 = 2,
1109         SHD_SUBSURFACE_BURLEY                   = 3,
1110         SHD_SUBSURFACE_RANDOM_WALK              = 4,
1111 };
1112
1113 /* blur node */
1114 #define CMP_NODE_BLUR_ASPECT_NONE               0
1115 #define CMP_NODE_BLUR_ASPECT_Y                  1
1116 #define CMP_NODE_BLUR_ASPECT_X                  2
1117
1118 /* wrapping */
1119 #define CMP_NODE_WRAP_NONE              0
1120 #define CMP_NODE_WRAP_X                 1
1121 #define CMP_NODE_WRAP_Y                 2
1122 #define CMP_NODE_WRAP_XY                3
1123
1124 #define CMP_NODE_MASK_MBLUR_SAMPLES_MAX 64
1125
1126 /* image */
1127 #define CMP_NODE_IMAGE_USE_STRAIGHT_OUTPUT      1
1128
1129 /* viewer and cmposite output */
1130 #define CMP_NODE_OUTPUT_IGNORE_ALPHA            1
1131
1132 /* Plane track deform node */
1133 enum {
1134         CMP_NODEFLAG_PLANETRACKDEFORM_MOTION_BLUR = 1,
1135 };
1136
1137 /* Stabilization node */
1138 enum {
1139         CMP_NODEFLAG_STABILIZE_INVERSE = 1,
1140 };
1141
1142 #define CMP_NODE_PLANETRACKDEFORM_MBLUR_SAMPLES_MAX 64
1143
1144 /* Point Density shader node */
1145
1146 enum {
1147         SHD_POINTDENSITY_SOURCE_PSYS = 0,
1148         SHD_POINTDENSITY_SOURCE_OBJECT = 1,
1149 };
1150
1151 enum {
1152         SHD_POINTDENSITY_SPACE_OBJECT = 0,
1153         SHD_POINTDENSITY_SPACE_WORLD  = 1,
1154 };
1155
1156 enum {
1157         SHD_POINTDENSITY_COLOR_PARTAGE   = 1,
1158         SHD_POINTDENSITY_COLOR_PARTSPEED = 2,
1159         SHD_POINTDENSITY_COLOR_PARTVEL   = 3,
1160 };
1161
1162 enum {
1163         SHD_POINTDENSITY_COLOR_VERTCOL      = 0,
1164         SHD_POINTDENSITY_COLOR_VERTWEIGHT   = 1,
1165         SHD_POINTDENSITY_COLOR_VERTNOR      = 2,
1166 };
1167
1168 /* Output shader node */
1169
1170 typedef enum NodeShaderOutputTarget {
1171         SHD_OUTPUT_ALL     = 0,
1172         SHD_OUTPUT_EEVEE   = 1,
1173         SHD_OUTPUT_CYCLES  = 2,
1174 } NodeShaderOutputTarget;
1175
1176 #endif