Merge branch 'master' into blende2.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 = (1 << 1),                     /* hidden is user defined, to hide unused */
162         SOCK_IN_USE = (1 << 2),                     /* for quick check if socket is linked */
163         SOCK_UNAVAIL = (1 << 3),                    /* unavailable is for dynamic sockets */
164         // SOCK_DYNAMIC = (1 << 4),                 /* DEPRECATED  dynamic socket (can be modified by user) */
165         // SOCK_INTERNAL = (1 << 5),                /* DEPRECATED  group socket should not be exposed */
166         SOCK_COLLAPSED = (1 << 6),                  /* socket collapsed in UI */
167         SOCK_HIDE_VALUE = (1 << 7),                 /* hide socket value, if it gets auto default */
168         SOCK_AUTO_HIDDEN__DEPRECATED = (1 << 8),    /* socket hidden automatically, to distinguish from manually hidden */
169         SOCK_NO_INTERNAL_LINK = (1 << 9),
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 tmp_flag, pad2;   /* Used at runtime when going through the tree. Initialize before use. */
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 << 0)                /* link has been successfully validated */
321 #define NODE_LINK_VALID                 (1 << 1)
322 #define NODE_LINK_TEST                  (1 << 2)                /* 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 << 0)        /* for animation editors */
418 #define NTREE_COM_OPENCL                        (1 << 1)        /* use opencl */
419 #define NTREE_TWO_PASS                          (1 << 2)        /* two pass */
420 #define NTREE_COM_GROUPNODE_BUFFER      (1 << 3)        /* use groupnode buffers */
421 #define NTREE_VIEWER_BORDER                     (1 << 4)        /* use a border for viewer nodes */
422 /* NOTE: DEPRECATED, use (id->tag & LIB_TAG_LOCALIZED) instead. */
423 /* #define NTREE_IS_LOCALIZED                   (1 << 5) */     /* tree is localized copy, free when deleting node groups */
424
425 /* XXX not nice, but needed as a temporary flags
426  * for group updates after library linking.
427  */
428
429 /* changes from r35033 */
430 #define NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2   (1 << 10)
431 /* custom_nodes branch: remove links to node tree sockets */
432 #define NTREE_DO_VERSIONS_CUSTOMNODES_GROUP     (1 << 11)
433 /* custom_nodes branch: create group input/output nodes */
434 #define NTREE_DO_VERSIONS_CUSTOMNODES_GROUP_CREATE_INTERFACE    (1 << 12)
435
436 /* ntree->update */
437 typedef enum eNodeTreeUpdate {
438         NTREE_UPDATE            = 0xFFFF,       /* generic update flag (includes all others) */
439         NTREE_UPDATE_LINKS      = (1 << 0),             /* links have been added or removed */
440         NTREE_UPDATE_NODES      = (1 << 1),             /* nodes or sockets have been added or removed */
441         NTREE_UPDATE_GROUP_IN   = (1 << 4),             /* group inputs have changed */
442         NTREE_UPDATE_GROUP_OUT  = (1 << 5),             /* group outputs have changed */
443         /* group has changed (generic flag including all other group flags) */
444         NTREE_UPDATE_GROUP      = (NTREE_UPDATE_GROUP_IN | NTREE_UPDATE_GROUP_OUT)
445 } eNodeTreeUpdate;
446
447
448 /* socket value structs for input buttons
449  * DEPRECATED now using ID properties
450  */
451
452 typedef struct bNodeSocketValueInt {
453         int subtype;                            /* RNA subtype */
454         int value;
455         int min, max;
456 } bNodeSocketValueInt;
457
458 typedef struct bNodeSocketValueFloat {
459         int subtype;                            /* RNA subtype */
460         float value;
461         float min, max;
462 } bNodeSocketValueFloat;
463
464 typedef struct bNodeSocketValueBoolean {
465         char value;
466         char pad[3];
467 } bNodeSocketValueBoolean;
468
469 typedef struct bNodeSocketValueVector {
470         int subtype;                            /* RNA subtype */
471         float value[3];
472         float min, max;
473 } bNodeSocketValueVector;
474
475 typedef struct bNodeSocketValueRGBA {
476         float value[4];
477 } bNodeSocketValueRGBA;
478
479 typedef struct bNodeSocketValueString {
480         int subtype;
481         int pad;
482         char value[1024];       /* 1024 = FILEMAX */
483 } bNodeSocketValueString;
484
485 /* data structs, for node->storage */
486 enum {
487         CMP_NODE_MASKTYPE_ADD         = 0,
488         CMP_NODE_MASKTYPE_SUBTRACT    = 1,
489         CMP_NODE_MASKTYPE_MULTIPLY    = 2,
490         CMP_NODE_MASKTYPE_NOT         = 3
491 };
492
493 enum {
494         CMP_NODE_LENSFLARE_GHOST   = (1 << 0),
495         CMP_NODE_LENSFLARE_GLOW    = (1 << 1),
496         CMP_NODE_LENSFLARE_CIRCLE  = (1 << 2),
497         CMP_NODE_LENSFLARE_STREAKS = (1 << 3)
498 };
499
500 enum {
501         CMP_NODE_DILATEERODE_STEP             = 0,
502         CMP_NODE_DILATEERODE_DISTANCE_THRESH  = 1,
503         CMP_NODE_DILATEERODE_DISTANCE         = 2,
504         CMP_NODE_DILATEERODE_DISTANCE_FEATHER = 3
505 };
506
507 enum {
508         CMP_NODE_INPAINT_SIMPLE               = 0
509 };
510
511 enum {
512         /* CMP_NODEFLAG_MASK_AA          = (1 << 0), */  /* DEPRECATED */
513         CMP_NODEFLAG_MASK_NO_FEATHER  = (1 << 1),
514         CMP_NODEFLAG_MASK_MOTION_BLUR = (1 << 2),
515
516         /* we may want multiple aspect options, exposed as an rna enum */
517         CMP_NODEFLAG_MASK_FIXED       = (1 << 8),
518         CMP_NODEFLAG_MASK_FIXED_SCENE = (1 << 9)
519 };
520
521 enum {
522         CMP_NODEFLAG_BLUR_VARIABLE_SIZE = (1 << 0),
523         CMP_NODEFLAG_BLUR_EXTEND_BOUNDS = (1 << 1),
524 };
525
526 typedef struct NodeFrame {
527         short flag;
528         short label_size;
529 } NodeFrame;
530
531 /* this one has been replaced with ImageUser, keep it for do_versions() */
532 typedef struct NodeImageAnim {
533         int frames   DNA_DEPRECATED;
534         int sfra     DNA_DEPRECATED;
535         int nr       DNA_DEPRECATED;
536         char cyclic  DNA_DEPRECATED;
537         char movie   DNA_DEPRECATED;
538         short pad;
539 } NodeImageAnim;
540
541 typedef struct ColorCorrectionData {
542         float saturation;
543         float contrast;
544         float gamma;
545         float gain;
546         float lift;
547         int pad;
548 } ColorCorrectionData;
549
550 typedef struct NodeColorCorrection {
551         ColorCorrectionData master;
552         ColorCorrectionData shadows;
553         ColorCorrectionData midtones;
554         ColorCorrectionData highlights;
555         float startmidtones;
556         float endmidtones;
557 } NodeColorCorrection;
558
559 typedef struct NodeBokehImage {
560         float angle;
561         int flaps;
562         float rounding;
563         float catadioptric;
564         float lensshift;
565 } NodeBokehImage;
566
567 typedef struct NodeBoxMask {
568         float x;
569         float y;
570         float rotation;
571         float height;
572         float width;
573         int pad;
574 } NodeBoxMask;
575
576 typedef struct NodeEllipseMask {
577         float x;
578         float y;
579         float rotation;
580         float height;
581         float width;
582         int pad;
583 } NodeEllipseMask;
584
585 /* layer info for image node outputs */
586 typedef struct NodeImageLayer {
587         /* index in the Image->layers->passes lists */
588         int pass_index  DNA_DEPRECATED;
589         /* render pass name */
590         char pass_name[64]; /* amount defined in openexr_multi.h */
591 } NodeImageLayer;
592
593 typedef struct NodeBlurData {
594         short sizex, sizey;
595         short samples, maxspeed, minspeed, relative, aspect;
596         short curved;
597         float fac, percentx, percenty;
598         short filtertype;
599         char bokeh, gamma;
600         int image_in_width, image_in_height; /* needed for absolute/relative conversions */
601 } NodeBlurData;
602
603 typedef struct NodeDBlurData {
604         float center_x, center_y, distance, angle, spin, zoom;
605         short iter;
606         char wrap, pad;
607 } NodeDBlurData;
608
609 typedef struct NodeBilateralBlurData {
610         float sigma_color, sigma_space;
611         short iter, pad;
612 } NodeBilateralBlurData;
613
614 /* NOTE: Only for do-version code. */
615 typedef struct NodeHueSat {
616         float hue, sat, val;
617 } NodeHueSat;
618
619 typedef struct NodeImageFile {
620         char name[1024]; /* 1024 = FILE_MAX */
621         struct ImageFormatData im_format;
622         int sfra, efra;
623 } NodeImageFile;
624
625 /* XXX first struct fields should match NodeImageFile to ensure forward compatibility */
626 typedef struct NodeImageMultiFile {
627         char base_path[1024];   /* 1024 = FILE_MAX */
628         ImageFormatData format;
629         int sfra DNA_DEPRECATED, efra DNA_DEPRECATED;   /* XXX old frame rand values from NodeImageFile for forward compatibility */
630         int active_input;               /* selected input in details view list */
631         int pad;
632 } NodeImageMultiFile;
633 typedef struct NodeImageMultiFileSocket {
634         /* single layer file output */
635         short use_render_format  DNA_DEPRECATED;
636         short use_node_format;  /* use overall node image format */
637         int pad1;
638         char path[1024];                /* 1024 = FILE_MAX */
639         ImageFormatData format;
640
641         /* multilayer output */
642         char layer[30];         /* EXR_TOT_MAXNAME-2 ('.' and channel char are appended) */
643         char pad2[2];
644 } NodeImageMultiFileSocket;
645
646 typedef struct NodeChroma {
647         float t1, t2, t3;
648         float fsize, fstrength, falpha;
649         float key[4];
650         short algorithm, channel;
651 } NodeChroma;
652
653 typedef struct NodeTwoXYs {
654         short x1, x2, y1, y2;
655         float fac_x1, fac_x2, fac_y1, fac_y2;
656 } NodeTwoXYs;
657
658 typedef struct NodeTwoFloats {
659         float x, y;
660 } NodeTwoFloats;
661
662 typedef struct NodeVertexCol {
663         char name[64];
664 } NodeVertexCol;
665
666 /* qdn: Defocus blur node */
667 typedef struct NodeDefocus {
668         char bktype, pad_c1, preview, gamco;
669         short samples, no_zbuf;
670         float fstop, maxblur, bthresh, scale;
671         float rotation, pad_f1;
672 } NodeDefocus;
673
674 typedef struct NodeScriptDict {
675         void *dict; /* for PyObject *dict */
676         void *node; /* for BPy_Node *node */
677 } NodeScriptDict;
678
679 /* qdn: glare node */
680 typedef struct NodeGlare {
681         char quality, type, iter;
682         /* XXX angle is only kept for backward/forward compatibility, was used for two different things, see T50736. */
683         char angle DNA_DEPRECATED, pad_c1, size, star_45, streaks;
684         float colmod, mix, threshold, fade;
685         float angle_ofs, pad_f1;
686 } NodeGlare;
687
688 /* qdn: tonemap node */
689 typedef struct NodeTonemap {
690         float key, offset, gamma;
691         float f, m, a, c;
692         int type;
693 } NodeTonemap;
694
695 /* qdn: lens distortion node */
696 typedef struct NodeLensDist {
697         short jit, proj, fit, pad;
698 } NodeLensDist;
699
700 typedef struct NodeColorBalance {
701         /* ASC CDL parameters */
702         float slope[3];
703         float offset[3];
704         float power[3];
705         float offset_basis;
706         char _pad[4];
707
708         /* LGG parameters */
709         float lift[3];
710         float gamma[3];
711         float gain[3];
712 } NodeColorBalance;
713
714 typedef struct NodeColorspill {
715         short limchan, unspill;
716         float limscale;
717         float uspillr, uspillg, uspillb;
718 } NodeColorspill;
719
720 typedef struct NodeDilateErode {
721         char falloff;
722         char pad[7];
723 } NodeDilateErode;
724
725 typedef struct NodeMask {
726         int size_x, size_y;
727 } NodeMask;
728
729 typedef struct NodeTexBase {
730         TexMapping tex_mapping;
731         ColorMapping color_mapping;
732 } NodeTexBase;
733
734 typedef struct NodeTexSky {
735         NodeTexBase base;
736         int sky_model;
737         float sun_direction[3];
738         float turbidity;
739         float ground_albedo;
740 } NodeTexSky;
741
742 typedef struct NodeTexImage {
743         NodeTexBase base;
744         ImageUser iuser;
745         int color_space;
746         int projection;
747         float projection_blend;
748         int interpolation;
749         int extension;
750         int pad;
751 } NodeTexImage;
752
753 typedef struct NodeTexChecker {
754         NodeTexBase base;
755 } NodeTexChecker;
756
757 typedef struct NodeTexBrick {
758         NodeTexBase base;
759         int offset_freq, squash_freq;
760         float offset, squash;
761 } NodeTexBrick;
762
763 typedef struct NodeTexEnvironment {
764         NodeTexBase base;
765         ImageUser iuser;
766         int color_space;
767         int projection;
768         int interpolation;
769         int pad;
770 } NodeTexEnvironment;
771
772 typedef struct NodeTexGradient {
773         NodeTexBase base;
774         int gradient_type;
775         int pad;
776 } NodeTexGradient;
777
778 typedef struct NodeTexNoise {
779         NodeTexBase base;
780 } NodeTexNoise;
781
782 typedef struct NodeTexVoronoi {
783         NodeTexBase base;
784         int coloring;
785         int distance;
786         int feature;
787         int pad;
788 } NodeTexVoronoi;
789
790 typedef struct NodeTexMusgrave {
791         NodeTexBase base;
792         int musgrave_type;
793         int pad;
794 } NodeTexMusgrave;
795
796 typedef struct NodeTexWave {
797         NodeTexBase base;
798         int wave_type;
799         int wave_profile;
800 } NodeTexWave;
801
802 typedef struct NodeTexMagic {
803         NodeTexBase base;
804         int depth;
805         int pad;
806 } NodeTexMagic;
807
808 typedef struct NodeShaderAttribute {
809         char name[64];
810 } NodeShaderAttribute;
811
812 typedef struct NodeShaderVectTransform {
813         int type;
814         int convert_from, convert_to;
815         int pad;
816 } NodeShaderVectTransform;
817
818 typedef struct NodeShaderTexPointDensity {
819         NodeTexBase base;
820         short point_source, pad;
821         int particle_system;
822         float radius;
823         int resolution;
824         short space;
825         short interpolation;
826         short color_source;
827         short ob_color_source;
828         char vertex_attribute_name[64]; /* vertex attribute layer for color source, MAX_CUSTOMDATA_LAYER_NAME */
829         /* Used at runtime only by sampling RNA API. */
830         PointDensity pd;
831         int cached_resolution;
832         int pad2;
833 } NodeShaderTexPointDensity;
834
835 /* TEX_output */
836 typedef struct TexNodeOutput {
837         char name[64];
838 } TexNodeOutput;
839
840 typedef struct NodeKeyingScreenData {
841         char tracking_object[64];
842 } NodeKeyingScreenData;
843
844 typedef struct NodeKeyingData {
845         float screen_balance;
846         float despill_factor;
847         float despill_balance;
848         int edge_kernel_radius;
849         float edge_kernel_tolerance;
850         float clip_black, clip_white;
851         int dilate_distance;
852         int feather_distance;
853         int feather_falloff;
854         int blur_pre, blur_post;
855 } NodeKeyingData;
856
857 typedef struct NodeTrackPosData {
858         char tracking_object[64];
859         char track_name[64];
860 } NodeTrackPosData;
861
862 typedef struct NodeTranslateData {
863         char wrap_axis;
864         char relative;
865         char pad[6];
866 } NodeTranslateData;
867
868 typedef struct NodePlaneTrackDeformData {
869         char tracking_object[64];
870         char plane_track_name[64];
871         char flag;
872         char motion_blur_samples;
873         char pad[2];
874         float motion_blur_shutter;
875 } NodePlaneTrackDeformData;
876
877 typedef struct NodeShaderScript {
878         int mode;
879         int flag;
880
881         char filepath[1024]; /* 1024 = FILE_MAX */
882
883         char bytecode_hash[64];
884         char *bytecode;
885 } NodeShaderScript;
886
887 typedef struct NodeShaderTangent {
888         int direction_type;
889         int axis;
890         char uv_map[64];
891 } NodeShaderTangent;
892
893 typedef struct NodeShaderNormalMap {
894         int space;
895         char uv_map[64];
896 } NodeShaderNormalMap;
897
898 typedef struct NodeShaderUVMap {
899         char uv_map[64];
900 } NodeShaderUVMap;
901
902 typedef struct NodeShaderTexIES {
903         int mode;
904
905         char filepath[1024]; /* 1024 = FILE_MAX */
906 } NodeShaderTexIES;
907
908 typedef struct NodeSunBeams {
909         float source[2];
910
911         float ray_length;
912 } NodeSunBeams;
913
914 typedef struct NodeCryptomatte {
915         float add[3];
916         float remove[3];
917         char *matte_id;
918         int num_inputs;
919         int pad;
920 } NodeCryptomatte;
921
922 /* script node mode */
923 #define NODE_SCRIPT_INTERNAL            0
924 #define NODE_SCRIPT_EXTERNAL            1
925
926 /* script node flag */
927 #define NODE_SCRIPT_AUTO_UPDATE         1
928
929 /* ies node mode */
930 #define NODE_IES_INTERNAL               0
931 #define NODE_IES_EXTERNAL               1
932
933 /* frame node flags */
934 #define NODE_FRAME_SHRINK               1       /* keep the bounding box minimal */
935 #define NODE_FRAME_RESIZEABLE   2       /* test flag, if frame can be resized by user */
936
937 /* proxy node flags */
938 #define NODE_PROXY_AUTOTYPE                     1       /* automatically change output type based on link */
939
940 /* comp channel matte */
941 #define CMP_NODE_CHANNEL_MATTE_CS_RGB   1
942 #define CMP_NODE_CHANNEL_MATTE_CS_HSV   2
943 #define CMP_NODE_CHANNEL_MATTE_CS_YUV   3
944 #define CMP_NODE_CHANNEL_MATTE_CS_YCC   4
945
946 /* glossy distributions */
947 #define SHD_GLOSSY_BECKMANN                             0
948 #define SHD_GLOSSY_SHARP                                1
949 #define SHD_GLOSSY_GGX                                  2
950 #define SHD_GLOSSY_ASHIKHMIN_SHIRLEY                    3
951 #define SHD_GLOSSY_MULTI_GGX                            4
952
953 /* vector transform */
954 #define SHD_VECT_TRANSFORM_TYPE_VECTOR  0
955 #define SHD_VECT_TRANSFORM_TYPE_POINT   1
956 #define SHD_VECT_TRANSFORM_TYPE_NORMAL  2
957
958 #define SHD_VECT_TRANSFORM_SPACE_WORLD  0
959 #define SHD_VECT_TRANSFORM_SPACE_OBJECT 1
960 #define SHD_VECT_TRANSFORM_SPACE_CAMERA 2
961
962 /* toon modes */
963 #define SHD_TOON_DIFFUSE        0
964 #define SHD_TOON_GLOSSY         1
965
966 /* hair components */
967 #define SHD_HAIR_REFLECTION             0
968 #define SHD_HAIR_TRANSMISSION           1
969
970 /* principled hair parametrization */
971 #define SHD_PRINCIPLED_HAIR_REFLECTANCE                         0
972 #define SHD_PRINCIPLED_HAIR_PIGMENT_CONCENTRATION       1
973 #define SHD_PRINCIPLED_HAIR_DIRECT_ABSORPTION           2
974
975 /* blend texture */
976 #define SHD_BLEND_LINEAR                        0
977 #define SHD_BLEND_QUADRATIC                     1
978 #define SHD_BLEND_EASING                        2
979 #define SHD_BLEND_DIAGONAL                      3
980 #define SHD_BLEND_RADIAL                        4
981 #define SHD_BLEND_QUADRATIC_SPHERE      5
982 #define SHD_BLEND_SPHERICAL                     6
983
984 /* noise basis for textures */
985 #define SHD_NOISE_PERLIN                        0
986 #define SHD_NOISE_VORONOI_F1            1
987 #define SHD_NOISE_VORONOI_F2            2
988 #define SHD_NOISE_VORONOI_F3            3
989 #define SHD_NOISE_VORONOI_F4            4
990 #define SHD_NOISE_VORONOI_F2_F1         5
991 #define SHD_NOISE_VORONOI_CRACKLE       6
992 #define SHD_NOISE_CELL_NOISE            7
993
994 #define SHD_NOISE_SOFT  0
995 #define SHD_NOISE_HARD  1
996
997 /* voronoi texture */
998 #define SHD_VORONOI_DISTANCE            0
999 #define SHD_VORONOI_MANHATTAN           1
1000 #define SHD_VORONOI_CHEBYCHEV           2
1001 #define SHD_VORONOI_MINKOWSKI           3
1002
1003 #define SHD_VORONOI_INTENSITY   0
1004 #define SHD_VORONOI_CELLS               1
1005
1006 #define SHD_VORONOI_F1          0
1007 #define SHD_VORONOI_F2          1
1008 #define SHD_VORONOI_F3          2
1009 #define SHD_VORONOI_F4          3
1010 #define SHD_VORONOI_F2F1        4
1011
1012 /* musgrave texture */
1013 #define SHD_MUSGRAVE_MULTIFRACTAL                       0
1014 #define SHD_MUSGRAVE_FBM                                        1
1015 #define SHD_MUSGRAVE_HYBRID_MULTIFRACTAL        2
1016 #define SHD_MUSGRAVE_RIDGED_MULTIFRACTAL        3
1017 #define SHD_MUSGRAVE_HETERO_TERRAIN                     4
1018
1019 /* wave texture */
1020 #define SHD_WAVE_BANDS          0
1021 #define SHD_WAVE_RINGS          1
1022
1023 #define SHD_WAVE_PROFILE_SIN    0
1024 #define SHD_WAVE_PROFILE_SAW    1
1025
1026 /* sky texture */
1027 #define SHD_SKY_OLD             0
1028 #define SHD_SKY_NEW             1
1029
1030 /* image/environment texture */
1031 #define SHD_COLORSPACE_NONE             0
1032 #define SHD_COLORSPACE_COLOR    1
1033
1034 /* environment texture */
1035 #define SHD_PROJ_EQUIRECTANGULAR        0
1036 #define SHD_PROJ_MIRROR_BALL            1
1037
1038 #define SHD_IMAGE_EXTENSION_REPEAT      0
1039 #define SHD_IMAGE_EXTENSION_EXTEND      1
1040 #define SHD_IMAGE_EXTENSION_CLIP        2
1041
1042 /* image texture */
1043 #define SHD_PROJ_FLAT                           0
1044 #define SHD_PROJ_BOX                            1
1045 #define SHD_PROJ_SPHERE                         2
1046 #define SHD_PROJ_TUBE                           3
1047
1048 /* image texture interpolation */
1049 #define SHD_INTERP_LINEAR               0
1050 #define SHD_INTERP_CLOSEST              1
1051 #define SHD_INTERP_CUBIC                        2
1052 #define SHD_INTERP_SMART                        3
1053
1054 /* tangent */
1055 #define SHD_TANGENT_RADIAL                      0
1056 #define SHD_TANGENT_UVMAP                       1
1057
1058 /* tangent */
1059 #define SHD_TANGENT_AXIS_X                      0
1060 #define SHD_TANGENT_AXIS_Y                      1
1061 #define SHD_TANGENT_AXIS_Z                      2
1062
1063 /* normal map, displacement space */
1064 #define SHD_SPACE_TANGENT                       0
1065 #define SHD_SPACE_OBJECT                        1
1066 #define SHD_SPACE_WORLD                         2
1067 #define SHD_SPACE_BLENDER_OBJECT        3
1068 #define SHD_SPACE_BLENDER_WORLD         4
1069
1070 #define SHD_AO_INSIDE                           1
1071 #define SHD_AO_LOCAL                            2
1072
1073 /* math node clamp */
1074 #define SHD_MATH_CLAMP          1
1075
1076 /* Math node operation/ */
1077 enum {
1078         NODE_MATH_ADD     = 0,
1079         NODE_MATH_SUB     = 1,
1080         NODE_MATH_MUL     = 2,
1081         NODE_MATH_DIVIDE  = 3,
1082         NODE_MATH_SIN     = 4,
1083         NODE_MATH_COS     = 5,
1084         NODE_MATH_TAN     = 6,
1085         NODE_MATH_ASIN    = 7,
1086         NODE_MATH_ACOS    = 8,
1087         NODE_MATH_ATAN    = 9,
1088         NODE_MATH_POW     = 10,
1089         NODE_MATH_LOG     = 11,
1090         NODE_MATH_MIN     = 12,
1091         NODE_MATH_MAX     = 13,
1092         NODE_MATH_ROUND   = 14,
1093         NODE_MATH_LESS    = 15,
1094         NODE_MATH_GREATER = 16,
1095         NODE_MATH_MOD     = 17,
1096         NODE_MATH_ABS     = 18,
1097         NODE_MATH_ATAN2   = 19,
1098         NODE_MATH_FLOOR   = 20,
1099         NODE_MATH_CEIL    = 21,
1100         NODE_MATH_FRACT   = 22,
1101         NODE_MATH_SQRT    = 23,
1102 };
1103
1104 /* mix rgb node flags */
1105 #define SHD_MIXRGB_USE_ALPHA    1
1106 #define SHD_MIXRGB_CLAMP        2
1107
1108 /* subsurface */
1109 enum {
1110 #ifdef DNA_DEPRECATED
1111         SHD_SUBSURFACE_COMPATIBLE               = 0, // Deprecated
1112 #endif
1113         SHD_SUBSURFACE_CUBIC                    = 1,
1114         SHD_SUBSURFACE_GAUSSIAN                 = 2,
1115         SHD_SUBSURFACE_BURLEY                   = 3,
1116         SHD_SUBSURFACE_RANDOM_WALK              = 4,
1117 };
1118
1119 /* blur node */
1120 #define CMP_NODE_BLUR_ASPECT_NONE               0
1121 #define CMP_NODE_BLUR_ASPECT_Y                  1
1122 #define CMP_NODE_BLUR_ASPECT_X                  2
1123
1124 /* wrapping */
1125 #define CMP_NODE_WRAP_NONE              0
1126 #define CMP_NODE_WRAP_X                 1
1127 #define CMP_NODE_WRAP_Y                 2
1128 #define CMP_NODE_WRAP_XY                3
1129
1130 #define CMP_NODE_MASK_MBLUR_SAMPLES_MAX 64
1131
1132 /* image */
1133 #define CMP_NODE_IMAGE_USE_STRAIGHT_OUTPUT      1
1134
1135 /* viewer and cmposite output */
1136 #define CMP_NODE_OUTPUT_IGNORE_ALPHA            1
1137
1138 /* Plane track deform node */
1139 enum {
1140         CMP_NODEFLAG_PLANETRACKDEFORM_MOTION_BLUR = 1,
1141 };
1142
1143 /* Stabilization node */
1144 enum {
1145         CMP_NODEFLAG_STABILIZE_INVERSE = 1,
1146 };
1147
1148 #define CMP_NODE_PLANETRACKDEFORM_MBLUR_SAMPLES_MAX 64
1149
1150 /* Point Density shader node */
1151
1152 enum {
1153         SHD_POINTDENSITY_SOURCE_PSYS = 0,
1154         SHD_POINTDENSITY_SOURCE_OBJECT = 1,
1155 };
1156
1157 enum {
1158         SHD_POINTDENSITY_SPACE_OBJECT = 0,
1159         SHD_POINTDENSITY_SPACE_WORLD  = 1,
1160 };
1161
1162 enum {
1163         SHD_POINTDENSITY_COLOR_PARTAGE   = 1,
1164         SHD_POINTDENSITY_COLOR_PARTSPEED = 2,
1165         SHD_POINTDENSITY_COLOR_PARTVEL   = 3,
1166 };
1167
1168 enum {
1169         SHD_POINTDENSITY_COLOR_VERTCOL      = 0,
1170         SHD_POINTDENSITY_COLOR_VERTWEIGHT   = 1,
1171         SHD_POINTDENSITY_COLOR_VERTNOR      = 2,
1172 };
1173
1174 /* Output shader node */
1175
1176 typedef enum NodeShaderOutputTarget {
1177         SHD_OUTPUT_ALL     = 0,
1178         SHD_OUTPUT_EEVEE   = 1,
1179         SHD_OUTPUT_CYCLES  = 2,
1180 } NodeShaderOutputTarget;
1181
1182 #endif