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 64
  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 /* note that we do not simply use 0, 1, 2, .. as values for these. this works
  34  * around an obscure CUDA bug that happens when compiling for fermi. why it
  35  * happens i have no idea, but consecutive values are problematic, maybe it
  36  * generates an incorrect jump table. */
  37
  38 typedef enum NodeType {
  39         NODE_END = 0,
  40         NODE_CLOSURE_BSDF = 100,
  41         NODE_CLOSURE_EMISSION = 200,
  42         NODE_CLOSURE_BACKGROUND = 300,
  43         NODE_CLOSURE_SET_WEIGHT = 400,
  44         NODE_CLOSURE_WEIGHT = 500,
  45         NODE_MIX_CLOSURE = 600,
  46         NODE_JUMP = 700,
  47         NODE_TEX_IMAGE = 1000,
  48         NODE_TEX_SKY = 1100,
  49         NODE_GEOMETRY = 1200,
  50         NODE_LIGHT_PATH = 1300,
  51         NODE_VALUE_F = 1400,
  52         NODE_VALUE_V = 1500,
  53         NODE_MIX = 1600,
  54         NODE_ATTR = 1700,
  55         NODE_CONVERT = 1900,
  56         NODE_FRESNEL = 2000,
  57         NODE_EMISSION_WEIGHT = 2100,
  58         NODE_TEX_GRADIENT = 2200,
  59         NODE_TEX_VORONOI = 2300,
  60         NODE_TEX_MUSGRAVE = 2400,
  61         NODE_TEX_WAVE = 2500,
  62         NODE_TEX_MAGIC = 2600,
  63         NODE_TEX_NOISE = 3000,
  64         NODE_SHADER_JUMP = 3100,
  65         NODE_SET_DISPLACEMENT = 3200,
  66         NODE_GEOMETRY_BUMP_DX = 3300,
  67         NODE_GEOMETRY_BUMP_DY = 3400,
  68         NODE_SET_BUMP = 3500,
  69         NODE_MATH = 3600,
  70         NODE_VECTOR_MATH = 3700,
  71         NODE_MAPPING = 3800,
  72         NODE_TEX_COORD = 3900,
  73         NODE_TEX_COORD_BUMP_DX = 4000,
  74         NODE_TEX_COORD_BUMP_DY = 4100,
  75         NODE_ADD_CLOSURE = 4200,
  76         NODE_EMISSION_SET_WEIGHT_TOTAL = 4300,
  77         NODE_ATTR_BUMP_DX = 4400,
  78         NODE_ATTR_BUMP_DY = 4500,
  79         NODE_TEX_ENVIRONMENT = 4600,
  80         NODE_CLOSURE_HOLDOUT = 4700,
  81         NODE_LAYER_WEIGHT = 4800,
  82         NODE_CLOSURE_VOLUME = 4900,
  83         NODE_SEPARATE_RGB = 5000,
  84         NODE_COMBINE_RGB = 5100,
  85         NODE_HSV = 5200,
  86         NODE_CAMERA = 5300,
  87         NODE_INVERT = 5400
  88 } NodeType;
  89
  90 typedef enum NodeAttributeType {
  91         NODE_ATTR_FLOAT = 0,
  92         NODE_ATTR_FLOAT3
  93 } NodeAttributeType;
  94
  95 typedef enum NodeGeometry {
  96         NODE_GEOM_P = 0,
  97         NODE_GEOM_N,
  98         NODE_GEOM_T,
  99         NODE_GEOM_I,
 100         NODE_GEOM_Ng,
 101         NODE_GEOM_uv
 102 } NodeGeometry;
 103
 104 typedef enum NodeLightPath {
 105         NODE_LP_camera = 0,
 106         NODE_LP_shadow,
 107         NODE_LP_diffuse,
 108         NODE_LP_glossy,
 109         NODE_LP_singular,
 110         NODE_LP_reflection,
 111         NODE_LP_transmission,
 112         NODE_LP_backfacing
 113 } NodeLightPath;
 114
 115 typedef enum NodeTexCoord {
 116         NODE_TEXCO_OBJECT,
 117         NODE_TEXCO_CAMERA,
 118         NODE_TEXCO_WINDOW,
 119         NODE_TEXCO_REFLECTION
 120 } NodeTexCoord;
 121
 122 typedef enum NodeMix {
 123         NODE_MIX_BLEND = 0,
 124         NODE_MIX_ADD,
 125         NODE_MIX_MUL,
 126         NODE_MIX_SUB,
 127         NODE_MIX_SCREEN,
 128         NODE_MIX_DIV,
 129         NODE_MIX_DIFF,
 130         NODE_MIX_DARK,
 131         NODE_MIX_LIGHT,
 132         NODE_MIX_OVERLAY,
 133         NODE_MIX_DODGE,
 134         NODE_MIX_BURN,
 135         NODE_MIX_HUE,
 136         NODE_MIX_SAT,
 137         NODE_MIX_VAL,
 138         NODE_MIX_COLOR,
 139         NODE_MIX_SOFT,
 140         NODE_MIX_LINEAR
 141 } NodeMix;
 142
 143 typedef enum NodeMath {
 144         NODE_MATH_ADD,
 145         NODE_MATH_SUBTRACT,
 146         NODE_MATH_MULTIPLY,
 147         NODE_MATH_DIVIDE,
 148         NODE_MATH_SINE,
 149         NODE_MATH_COSINE,
 150         NODE_MATH_TANGENT,
 151         NODE_MATH_ARCSINE,
 152         NODE_MATH_ARCCOSINE,
 153         NODE_MATH_ARCTANGENT,
 154         NODE_MATH_POWER,
 155         NODE_MATH_LOGARITHM,
 156         NODE_MATH_MINIMUM,
 157         NODE_MATH_MAXIMUM,
 158         NODE_MATH_ROUND,
 159         NODE_MATH_LESS_THAN,
 160         NODE_MATH_GREATER_THAN
 161 } NodeMath;
 162
 163 typedef enum NodeVectorMath {
 164         NODE_VECTOR_MATH_ADD,
 165         NODE_VECTOR_MATH_SUBTRACT,
 166         NODE_VECTOR_MATH_AVERAGE,
 167         NODE_VECTOR_MATH_DOT_PRODUCT,
 168         NODE_VECTOR_MATH_CROSS_PRODUCT,
 169         NODE_VECTOR_MATH_NORMALIZE
 170 } NodeVectorMath;
 171
 172 typedef enum NodeConvert {
 173         NODE_CONVERT_FV,
 174         NODE_CONVERT_CF,
 175         NODE_CONVERT_VF
 176 } NodeConvert;
 177
 178 typedef enum NodeDistanceMetric {
 179         NODE_VORONOI_DISTANCE_SQUARED,
 180         NODE_VORONOI_ACTUAL_DISTANCE,
 181         NODE_VORONOI_MANHATTAN,
 182         NODE_VORONOI_CHEBYCHEV,
 183         NODE_VORONOI_MINKOVSKY_H,
 184         NODE_VORONOI_MINKOVSKY_4,
 185         NODE_VORONOI_MINKOVSKY
 186 } NodeDistanceMetric;
 187
 188 typedef enum NodeNoiseBasis {
 189         NODE_NOISE_PERLIN,
 190         NODE_NOISE_VORONOI_F1,
 191         NODE_NOISE_VORONOI_F2,
 192         NODE_NOISE_VORONOI_F3,
 193         NODE_NOISE_VORONOI_F4,
 194         NODE_NOISE_VORONOI_F2_F1,
 195         NODE_NOISE_VORONOI_CRACKLE,
 196         NODE_NOISE_CELL_NOISE
 197 } NodeNoiseBasis;
 198
 199 typedef enum NodeWaveType {
 200         NODE_WAVE_SINE,
 201         NODE_WAVE_SAW,
 202         NODE_WAVE_TRI
 203 } NodeWaveType;
 204
 205 typedef enum NodeMusgraveType {
 206         NODE_MUSGRAVE_MULTIFRACTAL,
 207         NODE_MUSGRAVE_FBM,
 208         NODE_MUSGRAVE_HYBRID_MULTIFRACTAL,
 209         NODE_MUSGRAVE_RIDGED_MULTIFRACTAL,
 210         NODE_MUSGRAVE_HETERO_TERRAIN
 211 } NodeMusgraveType;
 212
 213 typedef enum NodeWoodType {
 214         NODE_WAVE_BANDS,
 215         NODE_WAVE_RINGS
 216 } NodeWoodType;
 217
 218 typedef enum NodeBlendType {
 219         NODE_BLEND_LINEAR,
 220         NODE_BLEND_QUADRATIC,
 221         NODE_BLEND_EASING,
 222         NODE_BLEND_DIAGONAL,
 223         NODE_BLEND_RADIAL,
 224         NODE_BLEND_QUADRATIC_SPHERE,
 225         NODE_BLEND_SPHERICAL
 226 } NodeBlendType;
 227
 228 typedef enum NodeBlendAxis {
 229         NODE_BLEND_HORIZONTAL,
 230         NODE_BLEND_VERTICAL
 231 } NodeBlendAxis;
 232
 233 typedef enum NodeMarbleType {
 234         NODE_MARBLE_SOFT,
 235         NODE_MARBLE_SHARP,
 236         NODE_MARBLE_SHARPER
 237 } NodeMarbleType;
 238
 239 typedef enum NodeStucciType {
 240         NODE_STUCCI_PLASTIC,
 241         NODE_STUCCI_WALL_IN,
 242         NODE_STUCCI_WALL_OUT
 243 } NodeStucciType;
 244
 245 typedef enum NodeVoronoiColoring {
 246         NODE_VORONOI_INTENSITY,
 247         NODE_VORONOI_CELLS
 248 } NodeVoronoiColoring;
 249
 250 typedef enum NodeBlendWeightType {
 251         NODE_LAYER_WEIGHT_FRESNEL,
 252         NODE_LAYER_WEIGHT_FACING
 253 } NodeBlendWeightType;
 254
 255 typedef enum ShaderType {
 256         SHADER_TYPE_SURFACE,
 257         SHADER_TYPE_VOLUME,
 258         SHADER_TYPE_DISPLACEMENT
 259 } ShaderType;
 260
 261 /* Closure */
 262
 263 typedef enum ClosureType {
 264         CLOSURE_BSDF_ID,
 265         CLOSURE_BSDF_DIFFUSE_ID,
 266         CLOSURE_BSDF_OREN_NAYAR_ID,
 267         CLOSURE_BSDF_TRANSLUCENT_ID,
 268         CLOSURE_BSDF_REFLECTION_ID,
 269         CLOSURE_BSDF_REFRACTION_ID,
 270         CLOSURE_BSDF_GLASS_ID,
 271         CLOSURE_BSDF_TRANSPARENT_ID,
 272         CLOSURE_BSDF_MICROFACET_GGX_ID,
 273         CLOSURE_BSDF_MICROFACET_GGX_REFRACTION_ID,
 274         CLOSURE_BSDF_MICROFACET_BECKMANN_ID,
 275         CLOSURE_BSDF_MICROFACET_BECKMANN_REFRACTION_ID,
 276         CLOSURE_BSDF_WARD_ID,
 277         CLOSURE_BSDF_ASHIKHMIN_VELVET_ID,
 278         CLOSURE_BSDF_WESTIN_BACKSCATTER_ID,
 279         CLOSURE_BSDF_WESTIN_SHEEN_ID,
 280
 281         CLOSURE_BSSRDF_CUBIC_ID,
 282         CLOSURE_EMISSION_ID,
 283         CLOSURE_DEBUG_ID,
 284         CLOSURE_BACKGROUND_ID,
 285         CLOSURE_HOLDOUT_ID,
 286         CLOSURE_SUBSURFACE_ID,
 287
 288         CLOSURE_VOLUME_ID,
 289         CLOSURE_VOLUME_TRANSPARENT_ID,
 290         CLOSURE_VOLUME_ISOTROPIC_ID,
 291
 292         NBUILTIN_CLOSURES
 293 } ClosureType;
 294
 295 /* watch this, being lazy with memory usage */
 296 #define CLOSURE_IS_BSDF(type) (type <= CLOSURE_BSDF_WESTIN_SHEEN_ID)
 297 #define CLOSURE_IS_VOLUME(type) (type >= CLOSURE_VOLUME_ID && type <= CLOSURE_VOLUME_ISOTROPIC_ID)
 298 #define CLOSURE_IS_EMISSION(type) (type == CLOSURE_EMISSION_ID)
 299 #define CLOSURE_IS_HOLDOUT(type) (type == CLOSURE_HOLDOUT_ID)
 300 #define CLOSURE_IS_BACKGROUND(type) (type == CLOSURE_BACKGROUND_ID)
 301
 302 CCL_NAMESPACE_END
 303
 304 #endif /*  __SVM_TYPES_H__ */
 305