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_AGE,
 118         NODE_INFO_PAR_LIFETIME
 119 } NodeParticleInfo;
 120
 121 typedef enum NodeLightPath {
 122         NODE_LP_camera = 0,
 123         NODE_LP_shadow,
 124         NODE_LP_diffuse,
 125         NODE_LP_glossy,
 126         NODE_LP_singular,
 127         NODE_LP_reflection,
 128         NODE_LP_transmission,
 129         NODE_LP_backfacing,
 130         NODE_LP_ray_length
 131 } NodeLightPath;
 132
 133 typedef enum NodeLightFalloff {
 134         NODE_LIGHT_FALLOFF_QUADRATIC,
 135         NODE_LIGHT_FALLOFF_LINEAR,
 136         NODE_LIGHT_FALLOFF_CONSTANT
 137 } NodeLightFalloff;
 138
 139 typedef enum NodeTexCoord {
 140         NODE_TEXCO_NORMAL,
 141         NODE_TEXCO_OBJECT,
 142         NODE_TEXCO_CAMERA,
 143         NODE_TEXCO_WINDOW,
 144         NODE_TEXCO_REFLECTION
 145 } NodeTexCoord;
 146
 147 typedef enum NodeMix {
 148         NODE_MIX_BLEND = 0,
 149         NODE_MIX_ADD,
 150         NODE_MIX_MUL,
 151         NODE_MIX_SUB,
 152         NODE_MIX_SCREEN,
 153         NODE_MIX_DIV,
 154         NODE_MIX_DIFF,
 155         NODE_MIX_DARK,
 156         NODE_MIX_LIGHT,
 157         NODE_MIX_OVERLAY,
 158         NODE_MIX_DODGE,
 159         NODE_MIX_BURN,
 160         NODE_MIX_HUE,
 161         NODE_MIX_SAT,
 162         NODE_MIX_VAL,
 163         NODE_MIX_COLOR,
 164         NODE_MIX_SOFT,
 165         NODE_MIX_LINEAR
 166 } NodeMix;
 167
 168 typedef enum NodeMath {
 169         NODE_MATH_ADD,
 170         NODE_MATH_SUBTRACT,
 171         NODE_MATH_MULTIPLY,
 172         NODE_MATH_DIVIDE,
 173         NODE_MATH_SINE,
 174         NODE_MATH_COSINE,
 175         NODE_MATH_TANGENT,
 176         NODE_MATH_ARCSINE,
 177         NODE_MATH_ARCCOSINE,
 178         NODE_MATH_ARCTANGENT,
 179         NODE_MATH_POWER,
 180         NODE_MATH_LOGARITHM,
 181         NODE_MATH_MINIMUM,
 182         NODE_MATH_MAXIMUM,
 183         NODE_MATH_ROUND,
 184         NODE_MATH_LESS_THAN,
 185         NODE_MATH_GREATER_THAN
 186 } NodeMath;
 187
 188 typedef enum NodeVectorMath {
 189         NODE_VECTOR_MATH_ADD,
 190         NODE_VECTOR_MATH_SUBTRACT,
 191         NODE_VECTOR_MATH_AVERAGE,
 192         NODE_VECTOR_MATH_DOT_PRODUCT,
 193         NODE_VECTOR_MATH_CROSS_PRODUCT,
 194         NODE_VECTOR_MATH_NORMALIZE
 195 } NodeVectorMath;
 196
 197 typedef enum NodeConvert {
 198         NODE_CONVERT_FV,
 199         NODE_CONVERT_CF,
 200         NODE_CONVERT_VF
 201 } NodeConvert;
 202
 203 typedef enum NodeDistanceMetric {
 204         NODE_VORONOI_DISTANCE_SQUARED,
 205         NODE_VORONOI_ACTUAL_DISTANCE,
 206         NODE_VORONOI_MANHATTAN,
 207         NODE_VORONOI_CHEBYCHEV,
 208         NODE_VORONOI_MINKOVSKY_H,
 209         NODE_VORONOI_MINKOVSKY_4,
 210         NODE_VORONOI_MINKOVSKY
 211 } NodeDistanceMetric;
 212
 213 typedef enum NodeNoiseBasis {
 214         NODE_NOISE_PERLIN,
 215         NODE_NOISE_VORONOI_F1,
 216         NODE_NOISE_VORONOI_F2,
 217         NODE_NOISE_VORONOI_F3,
 218         NODE_NOISE_VORONOI_F4,
 219         NODE_NOISE_VORONOI_F2_F1,
 220         NODE_NOISE_VORONOI_CRACKLE,
 221         NODE_NOISE_CELL_NOISE
 222 } NodeNoiseBasis;
 223
 224 typedef enum NodeWaveBasis {
 225         NODE_WAVE_SINE,
 226         NODE_WAVE_SAW,
 227         NODE_WAVE_TRI
 228 } NodeWaveBasis;
 229
 230 typedef enum NodeMusgraveType {
 231         NODE_MUSGRAVE_MULTIFRACTAL,
 232         NODE_MUSGRAVE_FBM,
 233         NODE_MUSGRAVE_HYBRID_MULTIFRACTAL,
 234         NODE_MUSGRAVE_RIDGED_MULTIFRACTAL,
 235         NODE_MUSGRAVE_HETERO_TERRAIN
 236 } NodeMusgraveType;
 237
 238 typedef enum NodeWaveType {
 239         NODE_WAVE_BANDS,
 240         NODE_WAVE_RINGS
 241 } NodeWaveType;
 242
 243 typedef enum NodeGradientType {
 244         NODE_BLEND_LINEAR,
 245         NODE_BLEND_QUADRATIC,
 246         NODE_BLEND_EASING,
 247         NODE_BLEND_DIAGONAL,
 248         NODE_BLEND_RADIAL,
 249         NODE_BLEND_QUADRATIC_SPHERE,
 250         NODE_BLEND_SPHERICAL
 251 } NodeGradientType;
 252
 253 typedef enum NodeVoronoiColoring {
 254         NODE_VORONOI_INTENSITY,
 255         NODE_VORONOI_CELLS
 256 } NodeVoronoiColoring;
 257
 258 typedef enum NodeBlendWeightType {
 259         NODE_LAYER_WEIGHT_FRESNEL,
 260         NODE_LAYER_WEIGHT_FACING
 261 } NodeBlendWeightType;
 262
 263 typedef enum ShaderType {
 264         SHADER_TYPE_SURFACE,
 265         SHADER_TYPE_VOLUME,
 266         SHADER_TYPE_DISPLACEMENT
 267 } ShaderType;
 268
 269 /* Closure */
 270
 271 typedef enum ClosureType {
 272         CLOSURE_BSDF_ID,
 273
 274         CLOSURE_BSDF_DIFFUSE_ID,
 275         CLOSURE_BSDF_OREN_NAYAR_ID,
 276
 277         CLOSURE_BSDF_REFLECTION_ID,
 278         CLOSURE_BSDF_MICROFACET_GGX_ID,
 279         CLOSURE_BSDF_MICROFACET_BECKMANN_ID,
 280         CLOSURE_BSDF_WARD_ID,
 281         CLOSURE_BSDF_WESTIN_SHEEN_ID,
 282
 283         CLOSURE_BSDF_TRANSLUCENT_ID,
 284         CLOSURE_BSDF_REFRACTION_ID,
 285         CLOSURE_BSDF_WESTIN_BACKSCATTER_ID,
 286         CLOSURE_BSDF_ASHIKHMIN_VELVET_ID,
 287         CLOSURE_BSDF_MICROFACET_BECKMANN_REFRACTION_ID,
 288         CLOSURE_BSDF_MICROFACET_GGX_REFRACTION_ID,
 289         CLOSURE_BSDF_GLASS_ID,
 290
 291         CLOSURE_BSDF_TRANSPARENT_ID,
 292
 293         CLOSURE_BSSRDF_CUBIC_ID,
 294         CLOSURE_EMISSION_ID,
 295         CLOSURE_DEBUG_ID,
 296         CLOSURE_BACKGROUND_ID,
 297         CLOSURE_HOLDOUT_ID,
 298         CLOSURE_SUBSURFACE_ID,
 299
 300         CLOSURE_VOLUME_ID,
 301         CLOSURE_VOLUME_TRANSPARENT_ID,
 302         CLOSURE_VOLUME_ISOTROPIC_ID,
 303
 304         NBUILTIN_CLOSURES
 305 } ClosureType;
 306
 307 /* watch this, being lazy with memory usage */
 308 #define CLOSURE_IS_BSDF(type) (type <= CLOSURE_BSDF_TRANSPARENT_ID)
 309 #define CLOSURE_IS_BSDF_DIFFUSE(type) (type >= CLOSURE_BSDF_DIFFUSE_ID && type <= CLOSURE_BSDF_OREN_NAYAR_ID)
 310 #define CLOSURE_IS_BSDF_GLOSSY(type) (type >= CLOSURE_BSDF_REFLECTION_ID && type <= CLOSURE_BSDF_WESTIN_SHEEN_ID)
 311 #define CLOSURE_IS_BSDF_TRANSMISSION(type) (type >= CLOSURE_BSDF_TRANSLUCENT_ID && type <= CLOSURE_BSDF_GLASS_ID)
 312 #define CLOSURE_IS_VOLUME(type) (type >= CLOSURE_VOLUME_ID && type <= CLOSURE_VOLUME_ISOTROPIC_ID)
 313 #define CLOSURE_IS_EMISSION(type) (type == CLOSURE_EMISSION_ID)
 314 #define CLOSURE_IS_HOLDOUT(type) (type == CLOSURE_HOLDOUT_ID)
 315 #define CLOSURE_IS_BACKGROUND(type) (type == CLOSURE_BACKGROUND_ID)
 316
 317 CCL_NAMESPACE_END
 318
 319 #endif /*  __SVM_TYPES_H__ */
 320