38232eb9c04c51c11b1fc06143c66603fb484582
[blender.git] / intern / cycles / kernel / svm / svm_types.h
1 /*
2  * Copyright 2011, Blender Foundation.
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
19 #ifndef __SVM_TYPES_H__
20 #define __SVM_TYPES_H__
21
22 CCL_NAMESPACE_BEGIN
23
24 /* Stack */
25
26 /* SVM stack has a fixed size */
27 #define SVM_STACK_SIZE 255
28 /* SVM stack offsets with this value indicate that it's not on the stack */
29 #define SVM_STACK_INVALID 255 
30
31 /* Nodes */
32
33 typedef enum NodeType {
34         NODE_END = 0,
35         NODE_CLOSURE_BSDF,
36         NODE_CLOSURE_EMISSION,
37         NODE_CLOSURE_BACKGROUND,
38         NODE_CLOSURE_SET_WEIGHT,
39         NODE_CLOSURE_WEIGHT,
40         NODE_MIX_CLOSURE,
41         NODE_JUMP,
42         NODE_TEX_IMAGE,
43         NODE_TEX_SKY,
44         NODE_GEOMETRY,
45         NODE_LIGHT_PATH,
46         NODE_VALUE_F,
47         NODE_VALUE_V,
48         NODE_MIX,
49         NODE_ATTR,
50         NODE_CONVERT,
51         NODE_FRESNEL,
52         NODE_EMISSION_WEIGHT,
53         NODE_TEX_GRADIENT,
54         NODE_TEX_VORONOI,
55         NODE_TEX_MUSGRAVE,
56         NODE_TEX_WAVE,
57         NODE_TEX_MAGIC,
58         NODE_TEX_NOISE,
59         NODE_SHADER_JUMP,
60         NODE_SET_DISPLACEMENT,
61         NODE_GEOMETRY_BUMP_DX,
62         NODE_GEOMETRY_BUMP_DY,
63         NODE_SET_BUMP,
64         NODE_MATH,
65         NODE_VECTOR_MATH,
66         NODE_MAPPING,
67         NODE_TEX_COORD,
68         NODE_TEX_COORD_BUMP_DX,
69         NODE_TEX_COORD_BUMP_DY,
70         NODE_ADD_CLOSURE,
71         NODE_EMISSION_SET_WEIGHT_TOTAL,
72         NODE_ATTR_BUMP_DX,
73         NODE_ATTR_BUMP_DY,
74         NODE_TEX_ENVIRONMENT,
75         NODE_CLOSURE_HOLDOUT,
76         NODE_LAYER_WEIGHT,
77         NODE_CLOSURE_VOLUME,
78         NODE_SEPARATE_RGB,
79         NODE_COMBINE_RGB,
80         NODE_HSV,
81         NODE_CAMERA,
82         NODE_INVERT,
83         NODE_NORMAL,
84         NODE_GAMMA,
85         NODE_TEX_CHECKER,
86         NODE_BRIGHTCONTRAST,
87         NODE_RGB_RAMP,
88         NODE_RGB_CURVES,
89         NODE_MIN_MAX,
90         NODE_LIGHT_FALLOFF,
91         NODE_OBJECT_INFO,
92         NODE_PARTICLE_INFO
93 } NodeType;
94
95 typedef enum NodeAttributeType {
96         NODE_ATTR_FLOAT = 0,
97         NODE_ATTR_FLOAT3
98 } NodeAttributeType;
99
100 typedef enum NodeGeometry {
101         NODE_GEOM_P = 0,
102         NODE_GEOM_N,
103         NODE_GEOM_T,
104         NODE_GEOM_I,
105         NODE_GEOM_Ng,
106         NODE_GEOM_uv
107 } NodeGeometry;
108
109 typedef enum NodeObjectInfo {
110         NODE_INFO_OB_LOCATION,
111         NODE_INFO_OB_INDEX,
112         NODE_INFO_MAT_INDEX,
113         NODE_INFO_OB_RANDOM
114 } NodeObjectInfo;
115
116 typedef enum NodeParticleInfo {
117         NODE_INFO_PAR_INDEX,
118         NODE_INFO_PAR_AGE,
119         NODE_INFO_PAR_LIFETIME
120 } NodeParticleInfo;
121
122 typedef enum NodeLightPath {
123         NODE_LP_camera = 0,
124         NODE_LP_shadow,
125         NODE_LP_diffuse,
126         NODE_LP_glossy,
127         NODE_LP_singular,
128         NODE_LP_reflection,
129         NODE_LP_transmission,
130         NODE_LP_backfacing,
131         NODE_LP_ray_length
132 } NodeLightPath;
133
134 typedef enum NodeLightFalloff {
135         NODE_LIGHT_FALLOFF_QUADRATIC,
136         NODE_LIGHT_FALLOFF_LINEAR,
137         NODE_LIGHT_FALLOFF_CONSTANT
138 } NodeLightFalloff;
139
140 typedef enum NodeTexCoord {
141         NODE_TEXCO_NORMAL,
142         NODE_TEXCO_OBJECT,
143         NODE_TEXCO_CAMERA,
144         NODE_TEXCO_WINDOW,
145         NODE_TEXCO_REFLECTION
146 } NodeTexCoord;
147
148 typedef enum NodeMix {
149         NODE_MIX_BLEND = 0,
150         NODE_MIX_ADD,
151         NODE_MIX_MUL,
152         NODE_MIX_SUB,
153         NODE_MIX_SCREEN,
154         NODE_MIX_DIV,
155         NODE_MIX_DIFF,
156         NODE_MIX_DARK,
157         NODE_MIX_LIGHT,
158         NODE_MIX_OVERLAY,
159         NODE_MIX_DODGE,
160         NODE_MIX_BURN,
161         NODE_MIX_HUE,
162         NODE_MIX_SAT,
163         NODE_MIX_VAL,
164         NODE_MIX_COLOR,
165         NODE_MIX_SOFT,
166         NODE_MIX_LINEAR,
167         NODE_MIX_CLAMP /* used for the clamp UI option */
168 } NodeMix;
169
170 typedef enum NodeMath {
171         NODE_MATH_ADD,
172         NODE_MATH_SUBTRACT,
173         NODE_MATH_MULTIPLY,
174         NODE_MATH_DIVIDE,
175         NODE_MATH_SINE,
176         NODE_MATH_COSINE,
177         NODE_MATH_TANGENT,
178         NODE_MATH_ARCSINE,
179         NODE_MATH_ARCCOSINE,
180         NODE_MATH_ARCTANGENT,
181         NODE_MATH_POWER,
182         NODE_MATH_LOGARITHM,
183         NODE_MATH_MINIMUM,
184         NODE_MATH_MAXIMUM,
185         NODE_MATH_ROUND,
186         NODE_MATH_LESS_THAN,
187         NODE_MATH_GREATER_THAN,
188         NODE_MATH_CLAMP /* used for the clamp UI option */
189 } NodeMath;
190
191 typedef enum NodeVectorMath {
192         NODE_VECTOR_MATH_ADD,
193         NODE_VECTOR_MATH_SUBTRACT,
194         NODE_VECTOR_MATH_AVERAGE,
195         NODE_VECTOR_MATH_DOT_PRODUCT,
196         NODE_VECTOR_MATH_CROSS_PRODUCT,
197         NODE_VECTOR_MATH_NORMALIZE
198 } NodeVectorMath;
199
200 typedef enum NodeConvert {
201         NODE_CONVERT_FV,
202         NODE_CONVERT_CF,
203         NODE_CONVERT_VF
204 } NodeConvert;
205
206 typedef enum NodeDistanceMetric {
207         NODE_VORONOI_DISTANCE_SQUARED,
208         NODE_VORONOI_ACTUAL_DISTANCE,
209         NODE_VORONOI_MANHATTAN,
210         NODE_VORONOI_CHEBYCHEV,
211         NODE_VORONOI_MINKOVSKY_H,
212         NODE_VORONOI_MINKOVSKY_4,
213         NODE_VORONOI_MINKOVSKY
214 } NodeDistanceMetric;
215
216 typedef enum NodeNoiseBasis {
217         NODE_NOISE_PERLIN,
218         NODE_NOISE_VORONOI_F1,
219         NODE_NOISE_VORONOI_F2,
220         NODE_NOISE_VORONOI_F3,
221         NODE_NOISE_VORONOI_F4,
222         NODE_NOISE_VORONOI_F2_F1,
223         NODE_NOISE_VORONOI_CRACKLE,
224         NODE_NOISE_CELL_NOISE
225 } NodeNoiseBasis;
226
227 typedef enum NodeWaveBasis {
228         NODE_WAVE_SINE,
229         NODE_WAVE_SAW,
230         NODE_WAVE_TRI
231 } NodeWaveBasis;
232
233 typedef enum NodeMusgraveType {
234         NODE_MUSGRAVE_MULTIFRACTAL,
235         NODE_MUSGRAVE_FBM,
236         NODE_MUSGRAVE_HYBRID_MULTIFRACTAL,
237         NODE_MUSGRAVE_RIDGED_MULTIFRACTAL,
238         NODE_MUSGRAVE_HETERO_TERRAIN
239 } NodeMusgraveType;
240
241 typedef enum NodeWaveType {
242         NODE_WAVE_BANDS,
243         NODE_WAVE_RINGS
244 } NodeWaveType;
245
246 typedef enum NodeGradientType {
247         NODE_BLEND_LINEAR,
248         NODE_BLEND_QUADRATIC,
249         NODE_BLEND_EASING,
250         NODE_BLEND_DIAGONAL,
251         NODE_BLEND_RADIAL,
252         NODE_BLEND_QUADRATIC_SPHERE,
253         NODE_BLEND_SPHERICAL
254 } NodeGradientType;
255
256 typedef enum NodeVoronoiColoring {
257         NODE_VORONOI_INTENSITY,
258         NODE_VORONOI_CELLS
259 } NodeVoronoiColoring;
260
261 typedef enum NodeBlendWeightType {
262         NODE_LAYER_WEIGHT_FRESNEL,
263         NODE_LAYER_WEIGHT_FACING
264 } NodeBlendWeightType;
265
266 typedef enum ShaderType {
267         SHADER_TYPE_SURFACE,
268         SHADER_TYPE_VOLUME,
269         SHADER_TYPE_DISPLACEMENT
270 } ShaderType;
271
272 /* Closure */
273
274 typedef enum ClosureType {
275         CLOSURE_BSDF_ID,
276
277         CLOSURE_BSDF_DIFFUSE_ID,
278         CLOSURE_BSDF_OREN_NAYAR_ID,
279
280         CLOSURE_BSDF_REFLECTION_ID,
281         CLOSURE_BSDF_MICROFACET_GGX_ID,
282         CLOSURE_BSDF_MICROFACET_BECKMANN_ID,
283         CLOSURE_BSDF_WARD_ID,
284         CLOSURE_BSDF_WESTIN_SHEEN_ID,
285
286         CLOSURE_BSDF_TRANSLUCENT_ID,
287         CLOSURE_BSDF_REFRACTION_ID,
288         CLOSURE_BSDF_WESTIN_BACKSCATTER_ID,
289         CLOSURE_BSDF_ASHIKHMIN_VELVET_ID,
290         CLOSURE_BSDF_MICROFACET_BECKMANN_REFRACTION_ID,
291         CLOSURE_BSDF_MICROFACET_GGX_REFRACTION_ID,
292         CLOSURE_BSDF_GLASS_ID,
293
294         CLOSURE_BSDF_TRANSPARENT_ID,
295
296         CLOSURE_BSSRDF_CUBIC_ID,
297         CLOSURE_EMISSION_ID,
298         CLOSURE_DEBUG_ID,
299         CLOSURE_BACKGROUND_ID,
300         CLOSURE_HOLDOUT_ID,
301         CLOSURE_SUBSURFACE_ID,
302
303         CLOSURE_VOLUME_ID,
304         CLOSURE_VOLUME_TRANSPARENT_ID,
305         CLOSURE_VOLUME_ISOTROPIC_ID,
306
307         NBUILTIN_CLOSURES
308 } ClosureType;
309
310 /* watch this, being lazy with memory usage */
311 #define CLOSURE_IS_BSDF(type) (type <= CLOSURE_BSDF_TRANSPARENT_ID)
312 #define CLOSURE_IS_BSDF_DIFFUSE(type) (type >= CLOSURE_BSDF_DIFFUSE_ID && type <= CLOSURE_BSDF_OREN_NAYAR_ID)
313 #define CLOSURE_IS_BSDF_GLOSSY(type) (type >= CLOSURE_BSDF_REFLECTION_ID && type <= CLOSURE_BSDF_WESTIN_SHEEN_ID)
314 #define CLOSURE_IS_BSDF_TRANSMISSION(type) (type >= CLOSURE_BSDF_TRANSLUCENT_ID && type <= CLOSURE_BSDF_GLASS_ID)
315 #define CLOSURE_IS_VOLUME(type) (type >= CLOSURE_VOLUME_ID && type <= CLOSURE_VOLUME_ISOTROPIC_ID)
316 #define CLOSURE_IS_EMISSION(type) (type == CLOSURE_EMISSION_ID)
317 #define CLOSURE_IS_HOLDOUT(type) (type == CLOSURE_HOLDOUT_ID)
318 #define CLOSURE_IS_BACKGROUND(type) (type == CLOSURE_BACKGROUND_ID)
319
320 CCL_NAMESPACE_END
321
322 #endif /*  __SVM_TYPES_H__ */
323