Fix errors raised at generating Python API docs
[blender.git] / source / blender / makesdna / DNA_light_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_LIGHT_TYPES_H__
25 #define __DNA_LIGHT_TYPES_H__
26
27 #include "DNA_defs.h"
28 #include "DNA_ID.h"
29
30 #ifndef MAX_MTEX
31 #  define MAX_MTEX 18
32 #endif
33
34 struct AnimData;
35 struct CurveMapping;
36 struct Ipo;
37 struct MTex;
38 struct bNodeTree;
39
40 typedef struct Light {
41   ID id;
42   /** Animation data (must be immediately after id for utilities to use it). */
43   struct AnimData *adt;
44
45   short type, flag;
46   int mode;
47
48   float r, g, b, k;
49   float shdwr, shdwg, shdwb, shdwpad;
50
51   float energy, dist, spotsize, spotblend;
52
53   /** Quad1 and Quad2 attenuation. */
54   float att1, att2;
55   float coeff_const, coeff_lin, coeff_quad;
56   char _pad0[4];
57   struct CurveMapping *curfalloff;
58   short falloff_type;
59   char _pad2[2];
60
61   float clipsta, clipend;
62   float bias, soft, bleedbias, bleedexp;
63   short bufsize, samp, buffers, filtertype;
64   char bufflag, buftype;
65
66   short area_shape;
67   float area_size, area_sizey, area_sizez;
68
69   float sun_angle;
70   char _pad3[4];
71
72   /* texact is for buttons */
73   short texact, shadhalostep;
74
75   /** Old animation system, deprecated for 2.5. */
76   struct Ipo *ipo DNA_DEPRECATED;
77   short pr_texture, use_nodes;
78   char _pad6[4];
79
80   /* Eevee */
81   float cascade_max_dist;
82   float cascade_exponent;
83   float cascade_fade;
84   int cascade_count;
85
86   float contact_dist, contact_bias, contact_spread, contact_thickness;
87
88   float spec_fac, att_dist;
89
90   /* preview */
91   struct PreviewImage *preview;
92
93   /* nodes */
94   struct bNodeTree *nodetree;
95 } Light;
96
97 /* **************** LIGHT ********************* */
98
99 /* flag */
100 #define LA_DS_EXPAND (1 << 0)
101 /* NOTE: this must have the same value as MA_DS_SHOW_TEXS,
102  * otherwise anim-editors will not read correctly
103  */
104 #define LA_DS_SHOW_TEXS (1 << 2)
105
106 /* type */
107 #define LA_LOCAL 0
108 #define LA_SUN 1
109 #define LA_SPOT 2
110 /* #define LA_HEMI          3 */ /* not used anymore */
111 #define LA_AREA 4
112
113 /* mode */
114 #define LA_SHADOW (1 << 0)
115 /* #define LA_HALO      (1 << 1) */ /* not used anymore */
116 /* #define LA_LAYER     (1 << 2) */ /* not used anymore */
117 /* #define LA_QUAD      (1 << 3) */ /* not used anymore */
118 /* #define LA_NEG       (1 << 4) */ /* not used anymore */
119 /* #define LA_ONLYSHADOW(1 << 5) */ /* not used anymore */
120 /* #define LA_SPHERE    (1 << 6) */ /* not used anymore */
121 #define LA_SQUARE (1 << 7)
122 /* #define LA_TEXTURE   (1 << 8) */      /* not used anymore */
123 /* #define LA_OSATEX    (1 << 9) */      /* not used anymore */
124 /* #define LA_DEEP_SHADOW   (1 << 10) */ /* not used anywhere */
125 /* #define LA_NO_DIFF       (1 << 11) */ /* not used anywhere */
126 /* #define LA_NO_SPEC       (1 << 12) */ /* not used anywhere */
127 /* #define LA_SHAD_RAY      (1 << 13) */ /* not used anywhere - cleaned */
128 /* yafray: light  shadowbuffer flag, softlight */
129 /* Since it is used with LOCAL light, can't use LA_SHAD */
130 /* #define LA_YF_SOFT       (1 << 14) */ /* not used anymore */
131 /* #define LA_LAYER_SHADOW  (1 << 15) */ /* not used anymore */
132 /* #define LA_SHAD_TEX      (1 << 16) */ /* not used anymore */
133 #define LA_SHOW_CONE (1 << 17)
134 /* #define LA_SHOW_SHADOW_BOX (1 << 18) */
135 #define LA_SHAD_CONTACT (1 << 19)
136 #define LA_CUSTOM_ATTENUATION (1 << 20)
137
138 /* falloff_type */
139 #define LA_FALLOFF_CONSTANT 0
140 #define LA_FALLOFF_INVLINEAR 1
141 #define LA_FALLOFF_INVSQUARE 2
142 #define LA_FALLOFF_CURVE 3
143 #define LA_FALLOFF_SLIDERS 4
144 #define LA_FALLOFF_INVCOEFFICIENTS 5
145
146 /* area shape */
147 #define LA_AREA_SQUARE 0
148 #define LA_AREA_RECT 1
149 /* #define LA_AREA_CUBE 2 */ /* UNUSED */
150 /* #define LA_AREA_BOX  3 */ /* UNUSED */
151 #define LA_AREA_DISK 4
152 #define LA_AREA_ELLIPSE 5
153
154 #endif /* __DNA_LIGHT_TYPES_H__ */