Cycles: Pass special flag whether BVH motion steps are used
[blender-staging.git] / intern / cycles / kernel / kernel_types.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __KERNEL_TYPES_H__
18 #define __KERNEL_TYPES_H__
19
20 #include "kernel_math.h"
21 #include "svm/svm_types.h"
22 #include "util_static_assert.h"
23
24 #ifndef __KERNEL_GPU__
25 #  define __KERNEL_CPU__
26 #endif
27
28 /* TODO(sergey): This is only to make it possible to include this header
29  * from outside of the kernel. but this could be done somewhat cleaner?
30  */
31 #ifndef ccl_addr_space
32 #  define ccl_addr_space
33 #endif
34
35 CCL_NAMESPACE_BEGIN
36
37 /* constants */
38 #define OBJECT_SIZE             12
39 #define OBJECT_VECTOR_SIZE      6
40 #define LIGHT_SIZE              11
41 #define FILTER_TABLE_SIZE       1024
42 #define RAMP_TABLE_SIZE         256
43 #define SHUTTER_TABLE_SIZE              256
44 #define PARTICLE_SIZE           5
45 #define SHADER_SIZE             5
46
47 #define BSSRDF_MIN_RADIUS                       1e-8f
48 #define BSSRDF_MAX_HITS                         4
49
50 #define BECKMANN_TABLE_SIZE             256
51
52 #define SHADER_NONE                             (~0)
53 #define OBJECT_NONE                             (~0)
54 #define PRIM_NONE                               (~0)
55 #define LAMP_NONE                               (~0)
56
57 #define VOLUME_STACK_SIZE               16
58
59 /* device capabilities */
60 #ifdef __KERNEL_CPU__
61 #  ifdef __KERNEL_SSE2__
62 #    define __QBVH__
63 #  endif
64 #  define __KERNEL_SHADING__
65 #  define __KERNEL_ADV_SHADING__
66 #  define __BRANCHED_PATH__
67 #  ifdef WITH_OSL
68 #    define __OSL__
69 #  endif
70 #  define __SUBSURFACE__
71 #  define __CMJ__
72 #  define __VOLUME__
73 #  define __VOLUME_DECOUPLED__
74 #  define __VOLUME_SCATTER__
75 #  define __SHADOW_RECORD_ALL__
76 #  define __VOLUME_RECORD_ALL__
77 #endif  /* __KERNEL_CPU__ */
78
79 #ifdef __KERNEL_CUDA__
80 #  define __KERNEL_SHADING__
81 #  define __KERNEL_ADV_SHADING__
82 #  define __BRANCHED_PATH__
83 #  define __VOLUME__
84 #  define __VOLUME_SCATTER__
85 #  define __SUBSURFACE__
86 #  define __CMJ__
87 #  define __SHADOW_RECORD_ALL__
88 #endif  /* __KERNEL_CUDA__ */
89
90 #ifdef __KERNEL_OPENCL__
91
92 /* keep __KERNEL_ADV_SHADING__ in sync with opencl_kernel_use_advanced_shading! */
93
94 #  ifdef __KERNEL_OPENCL_NVIDIA__
95 #    define __KERNEL_SHADING__
96 #    define __KERNEL_ADV_SHADING__
97 #    ifdef __KERNEL_EXPERIMENTAL__
98 #      define __CMJ__
99 #    endif
100 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
101
102 #  ifdef __KERNEL_OPENCL_APPLE__
103 #    define __KERNEL_SHADING__
104 #    define __KERNEL_ADV_SHADING__
105 /* TODO(sergey): Currently experimental section is ignored here,
106  * this is because megakernel in device_opencl does not support
107  * custom cflags depending on the scene features.
108  */
109 #    ifdef __KERNEL_EXPERIMENTAL__
110 #      define __CMJ__
111 #    endif
112 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
113
114 #  ifdef __KERNEL_OPENCL_AMD__
115 #    define __CL_USE_NATIVE__
116 #    define __KERNEL_SHADING__
117 #    define __KERNEL_ADV_SHADING__
118 #  endif  /* __KERNEL_OPENCL_AMD__ */
119
120 #  ifdef __KERNEL_OPENCL_INTEL_CPU__
121 #    define __CL_USE_NATIVE__
122 #    define __KERNEL_SHADING__
123 #    define __KERNEL_ADV_SHADING__
124 #    ifdef __KERNEL_EXPERIMENTAL__
125 #      define __CMJ__
126 #    endif
127 #  endif  /* __KERNEL_OPENCL_INTEL_CPU__ */
128
129 #endif  /* __KERNEL_OPENCL__ */
130
131 /* kernel features */
132 #define __SOBOL__
133 #define __INSTANCING__
134 #define __DPDU__
135 #define __UV__
136 #define __BACKGROUND__
137 #define __CAUSTICS_TRICKS__
138 #define __VISIBILITY_FLAG__
139 #define __RAY_DIFFERENTIALS__
140 #define __CAMERA_CLIPPING__
141 #define __INTERSECTION_REFINE__
142 #define __CLAMP_SAMPLE__
143 #define __PATCH_EVAL__
144
145 #ifdef __KERNEL_SHADING__
146 #  define __SVM__
147 #  define __EMISSION__
148 #  define __TEXTURES__
149 #  define __EXTRA_NODES__
150 #  define __HOLDOUT__
151 #endif
152
153 #ifdef __KERNEL_ADV_SHADING__
154 #  define __MULTI_CLOSURE__
155 #  define __TRANSPARENT_SHADOWS__
156 #  define __PASSES__
157 #  define __BACKGROUND_MIS__
158 #  define __LAMP_MIS__
159 #  define __AO__
160 #  define __CAMERA_MOTION__
161 #  define __OBJECT_MOTION__
162 #  define __HAIR__
163 #  define __BAKING__
164 #endif
165
166 #ifdef WITH_CYCLES_DEBUG
167 #  define __KERNEL_DEBUG__
168 #endif
169
170 /* Scene-based selective features compilation. */
171 #ifdef __NO_CAMERA_MOTION__
172 #  undef __CAMERA_MOTION__
173 #endif
174 #ifdef __NO_OBJECT_MOTION__
175 #  undef __OBJECT_MOTION__
176 #endif
177 #ifdef __NO_HAIR__
178 #  undef __HAIR__
179 #endif
180 #ifdef __NO_VOLUME__
181 #  undef __VOLUME__
182 #  undef __VOLUME_SCATTER__
183 #endif
184 #ifdef __NO_SUBSURFACE__
185 #  undef __SUBSURFACE__
186 #endif
187 #ifdef __NO_BAKING__
188 #  undef __BAKING__
189 #endif
190 #ifdef __NO_BRANCHED_PATH__
191 #  undef __BRANCHED_PATH__
192 #endif
193 #ifdef __NO_PATCH_EVAL__
194 #  undef __PATCH_EVAL__
195 #endif
196 #ifdef __NO_TRANSPARENT__
197 #  undef __TRANSPARENT_SHADOWS__
198 #endif
199
200 /* Random Numbers */
201
202 typedef uint RNG;
203
204 /* Shader Evaluation */
205
206 typedef enum ShaderEvalType {
207         SHADER_EVAL_DISPLACE,
208         SHADER_EVAL_BACKGROUND,
209         /* bake types */
210         SHADER_EVAL_BAKE, /* no real shade, it's used in the code to
211                            * differentiate the type of shader eval from the above
212                            */
213         /* data passes */
214         SHADER_EVAL_NORMAL,
215         SHADER_EVAL_UV,
216         SHADER_EVAL_DIFFUSE_COLOR,
217         SHADER_EVAL_GLOSSY_COLOR,
218         SHADER_EVAL_TRANSMISSION_COLOR,
219         SHADER_EVAL_SUBSURFACE_COLOR,
220         SHADER_EVAL_EMISSION,
221
222         /* light passes */
223         SHADER_EVAL_AO,
224         SHADER_EVAL_COMBINED,
225         SHADER_EVAL_SHADOW,
226         SHADER_EVAL_DIFFUSE,
227         SHADER_EVAL_GLOSSY,
228         SHADER_EVAL_TRANSMISSION,
229         SHADER_EVAL_SUBSURFACE,
230
231         /* extra */
232         SHADER_EVAL_ENVIRONMENT,
233 } ShaderEvalType;
234
235 /* Path Tracing
236  * note we need to keep the u/v pairs at even values */
237
238 enum PathTraceDimension {
239         PRNG_FILTER_U = 0,
240         PRNG_FILTER_V = 1,
241         PRNG_LENS_U = 2,
242         PRNG_LENS_V = 3,
243 #ifdef __CAMERA_MOTION__
244         PRNG_TIME = 4,
245         PRNG_UNUSED_0 = 5,
246         PRNG_UNUSED_1 = 6,      /* for some reason (6, 7) is a bad sobol pattern */
247         PRNG_UNUSED_2 = 7,  /* with a low number of samples (< 64) */
248 #endif
249         PRNG_BASE_NUM = 8,
250
251         PRNG_BSDF_U = 0,
252         PRNG_BSDF_V = 1,
253         PRNG_BSDF = 2,
254         PRNG_LIGHT = 3,
255         PRNG_LIGHT_U = 4,
256         PRNG_LIGHT_V = 5,
257         PRNG_LIGHT_TERMINATE = 6,
258         PRNG_TERMINATE = 7,
259
260 #ifdef __VOLUME__
261         PRNG_PHASE_U = 8,
262         PRNG_PHASE_V = 9,
263         PRNG_PHASE = 10,
264         PRNG_SCATTER_DISTANCE = 11,
265 #endif
266
267         PRNG_BOUNCE_NUM = 12,
268 };
269
270 enum SamplingPattern {
271         SAMPLING_PATTERN_SOBOL = 0,
272         SAMPLING_PATTERN_CMJ = 1,
273
274         SAMPLING_NUM_PATTERNS,
275 };
276
277 /* these flags values correspond to raytypes in osl.cpp, so keep them in sync! */
278
279 enum PathRayFlag {
280         PATH_RAY_CAMERA = 1,
281         PATH_RAY_REFLECT = 2,
282         PATH_RAY_TRANSMIT = 4,
283         PATH_RAY_DIFFUSE = 8,
284         PATH_RAY_GLOSSY = 16,
285         PATH_RAY_SINGULAR = 32,
286         PATH_RAY_TRANSPARENT = 64,
287
288         PATH_RAY_SHADOW_OPAQUE = 128,
289         PATH_RAY_SHADOW_TRANSPARENT = 256,
290         PATH_RAY_SHADOW = (PATH_RAY_SHADOW_OPAQUE|PATH_RAY_SHADOW_TRANSPARENT),
291
292         PATH_RAY_CURVE = 512, /* visibility flag to define curve segments */
293         PATH_RAY_VOLUME_SCATTER = 1024, /* volume scattering */
294
295         /* Special flag to tag unaligned BVH nodes. */
296         PATH_RAY_NODE_UNALIGNED = 2048,
297
298         PATH_RAY_ALL_VISIBILITY = (1|2|4|8|16|32|64|128|256|512|1024|2048),
299
300         PATH_RAY_MIS_SKIP = 4096,
301         PATH_RAY_DIFFUSE_ANCESTOR = 8192,
302         PATH_RAY_SINGLE_PASS_DONE = 16384,
303 };
304
305 /* Closure Label */
306
307 typedef enum ClosureLabel {
308         LABEL_NONE = 0,
309         LABEL_TRANSMIT = 1,
310         LABEL_REFLECT = 2,
311         LABEL_DIFFUSE = 4,
312         LABEL_GLOSSY = 8,
313         LABEL_SINGULAR = 16,
314         LABEL_TRANSPARENT = 32,
315         LABEL_VOLUME_SCATTER = 64,
316 } ClosureLabel;
317
318 /* Render Passes */
319
320 typedef enum PassType {
321         PASS_NONE = 0,
322         PASS_COMBINED = (1 << 0),
323         PASS_DEPTH = (1 << 1),
324         PASS_NORMAL = (1 << 2),
325         PASS_UV = (1 << 3),
326         PASS_OBJECT_ID = (1 << 4),
327         PASS_MATERIAL_ID = (1 << 5),
328         PASS_DIFFUSE_COLOR = (1 << 6),
329         PASS_GLOSSY_COLOR = (1 << 7),
330         PASS_TRANSMISSION_COLOR = (1 << 8),
331         PASS_DIFFUSE_INDIRECT = (1 << 9),
332         PASS_GLOSSY_INDIRECT = (1 << 10),
333         PASS_TRANSMISSION_INDIRECT = (1 << 11),
334         PASS_DIFFUSE_DIRECT = (1 << 12),
335         PASS_GLOSSY_DIRECT = (1 << 13),
336         PASS_TRANSMISSION_DIRECT = (1 << 14),
337         PASS_EMISSION = (1 << 15),
338         PASS_BACKGROUND = (1 << 16),
339         PASS_AO = (1 << 17),
340         PASS_SHADOW = (1 << 18),
341         PASS_MOTION = (1 << 19),
342         PASS_MOTION_WEIGHT = (1 << 20),
343         PASS_MIST = (1 << 21),
344         PASS_SUBSURFACE_DIRECT = (1 << 22),
345         PASS_SUBSURFACE_INDIRECT = (1 << 23),
346         PASS_SUBSURFACE_COLOR = (1 << 24),
347         PASS_LIGHT = (1 << 25), /* no real pass, used to force use_light_pass */
348 #ifdef __KERNEL_DEBUG__
349         PASS_BVH_TRAVERSED_NODES = (1 << 26),
350         PASS_BVH_TRAVERSED_INSTANCES = (1 << 27),
351         PASS_BVH_INTERSECTIONS = (1 << 28),
352         PASS_RAY_BOUNCES = (1 << 29),
353 #endif
354 } PassType;
355
356 #define PASS_ALL (~0)
357
358 typedef enum BakePassFilter {
359         BAKE_FILTER_NONE = 0,
360         BAKE_FILTER_DIRECT = (1 << 0),
361         BAKE_FILTER_INDIRECT = (1 << 1),
362         BAKE_FILTER_COLOR = (1 << 2),
363         BAKE_FILTER_DIFFUSE = (1 << 3),
364         BAKE_FILTER_GLOSSY = (1 << 4),
365         BAKE_FILTER_TRANSMISSION = (1 << 5),
366         BAKE_FILTER_SUBSURFACE = (1 << 6),
367         BAKE_FILTER_EMISSION = (1 << 7),
368         BAKE_FILTER_AO = (1 << 8),
369 } BakePassFilter;
370
371 typedef enum BakePassFilterCombos {
372         BAKE_FILTER_COMBINED = (
373             BAKE_FILTER_DIRECT |
374             BAKE_FILTER_INDIRECT |
375             BAKE_FILTER_DIFFUSE |
376             BAKE_FILTER_GLOSSY |
377             BAKE_FILTER_TRANSMISSION |
378             BAKE_FILTER_SUBSURFACE |
379             BAKE_FILTER_EMISSION |
380             BAKE_FILTER_AO),
381         BAKE_FILTER_DIFFUSE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_DIFFUSE),
382         BAKE_FILTER_GLOSSY_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_GLOSSY),
383         BAKE_FILTER_TRANSMISSION_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_TRANSMISSION),
384         BAKE_FILTER_SUBSURFACE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_SUBSURFACE),
385         BAKE_FILTER_DIFFUSE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_DIFFUSE),
386         BAKE_FILTER_GLOSSY_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_GLOSSY),
387         BAKE_FILTER_TRANSMISSION_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_TRANSMISSION),
388         BAKE_FILTER_SUBSURFACE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_SUBSURFACE),
389 } BakePassFilterCombos;
390
391 typedef ccl_addr_space struct PathRadiance {
392 #ifdef __PASSES__
393         int use_light_pass;
394 #endif
395
396         float3 emission;
397 #ifdef __PASSES__
398         float3 background;
399         float3 ao;
400
401         float3 indirect;
402         float3 direct_throughput;
403         float3 direct_emission;
404
405         float3 color_diffuse;
406         float3 color_glossy;
407         float3 color_transmission;
408         float3 color_subsurface;
409         float3 color_scatter;
410
411         float3 direct_diffuse;
412         float3 direct_glossy;
413         float3 direct_transmission;
414         float3 direct_subsurface;
415         float3 direct_scatter;
416
417         float3 indirect_diffuse;
418         float3 indirect_glossy;
419         float3 indirect_transmission;
420         float3 indirect_subsurface;
421         float3 indirect_scatter;
422
423         float3 path_diffuse;
424         float3 path_glossy;
425         float3 path_transmission;
426         float3 path_subsurface;
427         float3 path_scatter;
428
429         float4 shadow;
430         float mist;
431 #endif
432 } PathRadiance;
433
434 typedef struct BsdfEval {
435 #ifdef __PASSES__
436         int use_light_pass;
437 #endif
438
439         float3 diffuse;
440 #ifdef __PASSES__
441         float3 glossy;
442         float3 transmission;
443         float3 transparent;
444         float3 subsurface;
445         float3 scatter;
446 #endif
447 } BsdfEval;
448
449 /* Shader Flag */
450
451 typedef enum ShaderFlag {
452         SHADER_SMOOTH_NORMAL = (1 << 31),
453         SHADER_CAST_SHADOW = (1 << 30),
454         SHADER_AREA_LIGHT = (1 << 29),
455         SHADER_USE_MIS = (1 << 28),
456         SHADER_EXCLUDE_DIFFUSE = (1 << 27),
457         SHADER_EXCLUDE_GLOSSY = (1 << 26),
458         SHADER_EXCLUDE_TRANSMIT = (1 << 25),
459         SHADER_EXCLUDE_CAMERA = (1 << 24),
460         SHADER_EXCLUDE_SCATTER = (1 << 23),
461         SHADER_EXCLUDE_ANY = (SHADER_EXCLUDE_DIFFUSE|SHADER_EXCLUDE_GLOSSY|SHADER_EXCLUDE_TRANSMIT|SHADER_EXCLUDE_CAMERA|SHADER_EXCLUDE_SCATTER),
462
463         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT|SHADER_USE_MIS|SHADER_EXCLUDE_ANY)
464 } ShaderFlag;
465
466 /* Light Type */
467
468 typedef enum LightType {
469         LIGHT_POINT,
470         LIGHT_DISTANT,
471         LIGHT_BACKGROUND,
472         LIGHT_AREA,
473         LIGHT_SPOT,
474         LIGHT_TRIANGLE
475 } LightType;
476
477 /* Camera Type */
478
479 enum CameraType {
480         CAMERA_PERSPECTIVE,
481         CAMERA_ORTHOGRAPHIC,
482         CAMERA_PANORAMA
483 };
484
485 /* Panorama Type */
486
487 enum PanoramaType {
488         PANORAMA_EQUIRECTANGULAR = 0,
489         PANORAMA_FISHEYE_EQUIDISTANT = 1,
490         PANORAMA_FISHEYE_EQUISOLID = 2,
491         PANORAMA_MIRRORBALL = 3,
492
493         PANORAMA_NUM_TYPES,
494 };
495
496 /* Differential */
497
498 typedef struct differential3 {
499         float3 dx;
500         float3 dy;
501 } differential3;
502
503 typedef struct differential {
504         float dx;
505         float dy;
506 } differential;
507
508 /* Ray */
509
510 typedef struct Ray {
511 /* TODO(sergey): This is only needed because current AMD
512  * compiler has hard time building the kernel with this
513  * reshuffle. And at the same time reshuffle will cause
514  * less optimal CPU code in certain places.
515  *
516  * We'll get rid of this nasty exception once AMD compiler
517  * is fixed.
518  */
519 #ifndef __KERNEL_OPENCL_AMD__
520         float3 P;               /* origin */
521         float3 D;               /* direction */
522
523         float t;                /* length of the ray */
524         float time;             /* time (for motion blur) */
525 #else
526         float t;                /* length of the ray */
527         float time;             /* time (for motion blur) */
528         float3 P;               /* origin */
529         float3 D;               /* direction */
530 #endif
531
532 #ifdef __RAY_DIFFERENTIALS__
533         differential3 dP;
534         differential3 dD;
535 #endif
536 } Ray;
537
538 /* Intersection */
539
540 typedef ccl_addr_space struct Intersection {
541         float t, u, v;
542         int prim;
543         int object;
544         int type;
545
546 #ifdef __KERNEL_DEBUG__
547         int num_traversed_nodes;
548         int num_traversed_instances;
549         int num_intersections;
550 #endif
551 } Intersection;
552
553 /* Primitives */
554
555 typedef enum PrimitiveType {
556         PRIMITIVE_NONE            = 0,
557         PRIMITIVE_TRIANGLE        = (1 << 0),
558         PRIMITIVE_MOTION_TRIANGLE = (1 << 1),
559         PRIMITIVE_CURVE           = (1 << 2),
560         PRIMITIVE_MOTION_CURVE    = (1 << 3),
561         /* Lamp primitive is not included below on purpose,
562          * since it is no real traceable primitive.
563          */
564         PRIMITIVE_LAMP            = (1 << 4),
565
566         PRIMITIVE_ALL_TRIANGLE = (PRIMITIVE_TRIANGLE|PRIMITIVE_MOTION_TRIANGLE),
567         PRIMITIVE_ALL_CURVE = (PRIMITIVE_CURVE|PRIMITIVE_MOTION_CURVE),
568         PRIMITIVE_ALL_MOTION = (PRIMITIVE_MOTION_TRIANGLE|PRIMITIVE_MOTION_CURVE),
569         PRIMITIVE_ALL = (PRIMITIVE_ALL_TRIANGLE|PRIMITIVE_ALL_CURVE),
570
571         /* Total number of different traceable primitives.
572          * NOTE: This is an actual value, not a bitflag.
573          */
574         PRIMITIVE_NUM_TOTAL = 4,
575 } PrimitiveType;
576
577 #define PRIMITIVE_PACK_SEGMENT(type, segment) ((segment << PRIMITIVE_NUM_TOTAL) | (type))
578 #define PRIMITIVE_UNPACK_SEGMENT(type) (type >> PRIMITIVE_NUM_TOTAL)
579
580 /* Attributes */
581
582 typedef enum AttributePrimitive {
583         ATTR_PRIM_TRIANGLE = 0,
584         ATTR_PRIM_CURVE,
585         ATTR_PRIM_SUBD,
586
587         ATTR_PRIM_TYPES
588 } AttributePrimitive;
589
590 typedef enum AttributeElement {
591         ATTR_ELEMENT_NONE,
592         ATTR_ELEMENT_OBJECT,
593         ATTR_ELEMENT_MESH,
594         ATTR_ELEMENT_FACE,
595         ATTR_ELEMENT_VERTEX,
596         ATTR_ELEMENT_VERTEX_MOTION,
597         ATTR_ELEMENT_CORNER,
598         ATTR_ELEMENT_CORNER_BYTE,
599         ATTR_ELEMENT_CURVE,
600         ATTR_ELEMENT_CURVE_KEY,
601         ATTR_ELEMENT_CURVE_KEY_MOTION,
602         ATTR_ELEMENT_VOXEL
603 } AttributeElement;
604
605 typedef enum AttributeStandard {
606         ATTR_STD_NONE = 0,
607         ATTR_STD_VERTEX_NORMAL,
608         ATTR_STD_FACE_NORMAL,
609         ATTR_STD_UV,
610         ATTR_STD_UV_TANGENT,
611         ATTR_STD_UV_TANGENT_SIGN,
612         ATTR_STD_GENERATED,
613         ATTR_STD_GENERATED_TRANSFORM,
614         ATTR_STD_POSITION_UNDEFORMED,
615         ATTR_STD_POSITION_UNDISPLACED,
616         ATTR_STD_MOTION_VERTEX_POSITION,
617         ATTR_STD_MOTION_VERTEX_NORMAL,
618         ATTR_STD_PARTICLE,
619         ATTR_STD_CURVE_INTERCEPT,
620         ATTR_STD_PTEX_FACE_ID,
621         ATTR_STD_PTEX_UV,
622         ATTR_STD_VOLUME_DENSITY,
623         ATTR_STD_VOLUME_COLOR,
624         ATTR_STD_VOLUME_FLAME,
625         ATTR_STD_VOLUME_HEAT,
626         ATTR_STD_VOLUME_VELOCITY,
627         ATTR_STD_POINTINESS,
628         ATTR_STD_NUM,
629
630         ATTR_STD_NOT_FOUND = ~0
631 } AttributeStandard;
632
633 typedef enum AttributeFlag {
634         ATTR_FINAL_SIZE = (1 << 0),
635         ATTR_SUBDIVIDED = (1 << 1),
636 } AttributeFlag;
637
638 typedef struct AttributeDescriptor {
639         AttributeElement element;
640         NodeAttributeType type;
641         uint flags; /* see enum AttributeFlag */
642         int offset;
643 } AttributeDescriptor;
644
645 /* Closure data */
646
647 #ifdef __MULTI_CLOSURE__
648 #  ifndef __MAX_CLOSURE__
649 #     define MAX_CLOSURE 64
650 #  else
651 #    define MAX_CLOSURE __MAX_CLOSURE__
652 #  endif
653 #else
654 #  define MAX_CLOSURE 1
655 #endif
656
657 /* This struct is the base class for all closures. The common members are
658  * duplicated in all derived classes since we don't have C++ in the kernel
659  * yet, and because it lets us lay out the members to minimize padding. The
660  * weight member is located at the beginning of the struct for this reason.
661  *
662  * ShaderClosure has a fixed size, and any extra space must be allocated
663  * with closure_alloc_extra().
664  *
665  * We pad the struct to 80 bytes and ensure it is aligned to 16 bytes, which
666  * we assume to be the maximum required alignment for any struct. */
667
668 #define SHADER_CLOSURE_BASE \
669         float3 weight; \
670         ClosureType type; \
671         float sample_weight \
672
673 typedef ccl_addr_space struct ccl_align(16) ShaderClosure {
674         SHADER_CLOSURE_BASE;
675
676         float data[14]; /* pad to 80 bytes */
677 } ShaderClosure;
678
679 /* Shader Context
680  *
681  * For OSL we recycle a fixed number of contexts for speed */
682
683 typedef enum ShaderContext {
684         SHADER_CONTEXT_MAIN = 0,
685         SHADER_CONTEXT_INDIRECT = 1,
686         SHADER_CONTEXT_EMISSION = 2,
687         SHADER_CONTEXT_SHADOW = 3,
688         SHADER_CONTEXT_SSS = 4,
689         SHADER_CONTEXT_VOLUME = 5,
690         SHADER_CONTEXT_NUM = 6
691 } ShaderContext;
692
693 /* Shader Data
694  *
695  * Main shader state at a point on the surface or in a volume. All coordinates
696  * are in world space.
697  */
698
699 enum ShaderDataFlag {
700         /* Runtime flags. */
701
702         /* Set when ray hits backside of surface. */
703         SD_BACKFACING      = (1 << 0),
704         /* Shader has emissive closure. */
705         SD_EMISSION        = (1 << 1),
706         /* Shader has BSDF closure. */
707         SD_BSDF            = (1 << 2),
708         /* Shader has non-singular BSDF closure. */
709         SD_BSDF_HAS_EVAL   = (1 << 3),
710         /* Shader has BSSRDF closure. */
711         SD_BSSRDF          = (1 << 4),
712         /* Shader has holdout closure. */
713         SD_HOLDOUT         = (1 << 5),
714         /* Shader has volume absorption closure. */
715         SD_ABSORPTION      = (1 << 6),
716         /* Shader has have volume phase (scatter) closure. */
717         SD_SCATTER         = (1 << 7),
718         /* Shader has AO closure. */
719         SD_AO              = (1 << 8),
720         /* Shader has transparent closure. */
721         SD_TRANSPARENT     = (1 << 9),
722         /* BSDF requires LCG for evaluation. */
723         SD_BSDF_NEEDS_LCG  = (1 << 10),
724
725         SD_CLOSURE_FLAGS = (SD_EMISSION |
726                             SD_BSDF |
727                             SD_BSDF_HAS_EVAL |
728                             SD_BSSRDF |
729                             SD_HOLDOUT |
730                             SD_ABSORPTION |
731                             SD_SCATTER |
732                             SD_AO |
733                             SD_BSDF_NEEDS_LCG),
734
735         /* Shader flags. */
736
737         /* direct light sample */
738         SD_USE_MIS                = (1 << 16),
739         /* Has transparent shadow. */
740         SD_HAS_TRANSPARENT_SHADOW = (1 << 17),
741         /* Has volume shader. */
742         SD_HAS_VOLUME             = (1 << 18),
743         /* Has only volume shader, no surface. */
744         SD_HAS_ONLY_VOLUME        = (1 << 19),
745         /* Has heterogeneous volume. */
746         SD_HETEROGENEOUS_VOLUME   = (1 << 20),
747         /* BSSRDF normal uses bump. */
748         SD_HAS_BSSRDF_BUMP        = (1 << 21),
749         /* Use equiangular volume sampling */
750         SD_VOLUME_EQUIANGULAR     = (1 << 22),
751         /* Use multiple importance volume sampling. */
752         SD_VOLUME_MIS             = (1 << 23),
753         /* Use cubic interpolation for voxels. */
754         SD_VOLUME_CUBIC           = (1 << 24),
755         /* Has data connected to the displacement input. */
756         SD_HAS_BUMP               = (1 << 25),
757         /* Has true displacement. */
758         SD_HAS_DISPLACEMENT       = (1 << 26),
759         /* Has constant emission (value stored in __shader_flag) */
760         SD_HAS_CONSTANT_EMISSION  = (1 << 27),
761
762         SD_SHADER_FLAGS = (SD_USE_MIS |
763                            SD_HAS_TRANSPARENT_SHADOW |
764                            SD_HAS_VOLUME |
765                            SD_HAS_ONLY_VOLUME |
766                            SD_HETEROGENEOUS_VOLUME|
767                            SD_HAS_BSSRDF_BUMP |
768                            SD_VOLUME_EQUIANGULAR |
769                            SD_VOLUME_MIS |
770                            SD_VOLUME_CUBIC |
771                            SD_HAS_BUMP |
772                            SD_HAS_DISPLACEMENT |
773                            SD_HAS_CONSTANT_EMISSION)
774 };
775
776         /* Object flags. */
777 enum ShaderDataObjectFlag {
778         /* Holdout for camera rays. */
779         SD_OBJECT_HOLDOUT_MASK           = (1 << 0),
780         /* Has object motion blur. */
781         SD_OBJECT_MOTION                 = (1 << 1),
782         /* Vertices have transform applied. */
783         SD_OBJECT_TRANSFORM_APPLIED      = (1 << 2),
784         /* Vertices have negative scale applied. */
785         SD_OBJECT_NEGATIVE_SCALE_APPLIED = (1 << 3),
786         /* Object has a volume shader. */
787         SD_OBJECT_HAS_VOLUME             = (1 << 4),
788         /* Object intersects AABB of an object with volume shader. */
789         SD_OBJECT_INTERSECTS_VOLUME      = (1 << 5),
790         /* Has position for motion vertices. */
791         SD_OBJECT_HAS_VERTEX_MOTION      = (1 << 6),
792
793         SD_OBJECT_FLAGS = (SD_OBJECT_HOLDOUT_MASK |
794                            SD_OBJECT_MOTION |
795                            SD_OBJECT_TRANSFORM_APPLIED |
796                            SD_OBJECT_NEGATIVE_SCALE_APPLIED |
797                            SD_OBJECT_HAS_VOLUME |
798                            SD_OBJECT_INTERSECTS_VOLUME)
799 };
800
801 #ifdef __SPLIT_KERNEL__
802 #  define SD_THREAD (get_global_id(1) * get_global_size(0) + get_global_id(0))
803 #  if !defined(__SPLIT_KERNEL_SOA__)
804      /* ShaderData is stored as an Array-of-Structures */
805 #    define ccl_soa_member(type, name) type soa_##name
806 #    define ccl_fetch(s, t) (s[SD_THREAD].soa_##t)
807 #    define ccl_fetch_array(s, t, index) (&s[SD_THREAD].soa_##t[index])
808 #  else
809      /* ShaderData is stored as an Structure-of-Arrays */
810 #    define SD_GLOBAL_SIZE (get_global_size(0) * get_global_size(1))
811 #    define SD_FIELD_SIZE(t) sizeof(((struct ShaderData*)0)->t)
812 #    define SD_OFFSETOF(t) ((char*)(&((struct ShaderData*)0)->t) - (char*)0)
813 #    define ccl_soa_member(type, name) type soa_##name
814 #    define ccl_fetch(s, t) (((ShaderData*)((ccl_addr_space char*)s + SD_GLOBAL_SIZE * SD_OFFSETOF(soa_##t) +  SD_FIELD_SIZE(soa_##t) * SD_THREAD - SD_OFFSETOF(soa_##t)))->soa_##t)
815 #    define ccl_fetch_array(s, t, index) (&ccl_fetch(s, t)[index])
816 #  endif
817 #else
818 #  define ccl_soa_member(type, name) type name
819 #  define ccl_fetch(s, t) (s->t)
820 #  define ccl_fetch_array(s, t, index) (&s->t[index])
821 #endif
822
823 typedef ccl_addr_space struct ShaderData {
824         /* position */
825         ccl_soa_member(float3, P);
826         /* smooth normal for shading */
827         ccl_soa_member(float3, N);
828         /* true geometric normal */
829         ccl_soa_member(float3, Ng);
830         /* view/incoming direction */
831         ccl_soa_member(float3, I);
832         /* shader id */
833         ccl_soa_member(int, shader);
834         /* booleans describing shader, see ShaderDataFlag */
835         ccl_soa_member(int, flag);
836         /* booleans describing object of the shader, see ShaderDataObjectFlag */
837         ccl_soa_member(int, object_flag);
838
839         /* primitive id if there is one, ~0 otherwise */
840         ccl_soa_member(int, prim);
841
842         /* combined type and curve segment for hair */
843         ccl_soa_member(int, type);
844
845         /* parametric coordinates
846          * - barycentric weights for triangles */
847         ccl_soa_member(float, u);
848         ccl_soa_member(float, v);
849         /* object id if there is one, ~0 otherwise */
850         ccl_soa_member(int, object);
851
852         /* motion blur sample time */
853         ccl_soa_member(float, time);
854
855         /* length of the ray being shaded */
856         ccl_soa_member(float, ray_length);
857
858 #ifdef __RAY_DIFFERENTIALS__
859         /* differential of P. these are orthogonal to Ng, not N */
860         ccl_soa_member(differential3, dP);
861         /* differential of I */
862         ccl_soa_member(differential3, dI);
863         /* differential of u, v */
864         ccl_soa_member(differential, du);
865         ccl_soa_member(differential, dv);
866 #endif
867 #ifdef __DPDU__
868         /* differential of P w.r.t. parametric coordinates. note that dPdu is
869          * not readily suitable as a tangent for shading on triangles. */
870         ccl_soa_member(float3, dPdu);
871         ccl_soa_member(float3, dPdv);
872 #endif
873
874 #ifdef __OBJECT_MOTION__
875         /* object <-> world space transformations, cached to avoid
876          * re-interpolating them constantly for shading */
877         ccl_soa_member(Transform, ob_tfm);
878         ccl_soa_member(Transform, ob_itfm);
879 #endif
880
881         /* Closure data, we store a fixed array of closures */
882         ccl_soa_member(struct ShaderClosure, closure[MAX_CLOSURE]);
883         ccl_soa_member(int, num_closure);
884         ccl_soa_member(int, num_closure_extra);
885         ccl_soa_member(float, randb_closure);
886         ccl_soa_member(float3, svm_closure_weight);
887
888         /* LCG state for closures that require additional random numbers. */
889         ccl_soa_member(uint, lcg_state);
890
891         /* ray start position, only set for backgrounds */
892         ccl_soa_member(float3, ray_P);
893         ccl_soa_member(differential3, ray_dP);
894
895 #ifdef __OSL__
896         struct KernelGlobals *osl_globals;
897         struct PathState *osl_path_state;
898 #endif
899 } ShaderData;
900
901 /* Path State */
902
903 #ifdef __VOLUME__
904 typedef struct VolumeStack {
905         int object;
906         int shader;
907 } VolumeStack;
908 #endif
909
910 typedef struct PathState {
911         /* see enum PathRayFlag */
912         int flag;
913
914         /* random number generator state */
915         int rng_offset;                 /* dimension offset */
916         int sample;                     /* path sample number */
917         int num_samples;                /* total number of times this path will be sampled */
918
919         /* bounce counting */
920         int bounce;
921         int diffuse_bounce;
922         int glossy_bounce;
923         int transmission_bounce;
924         int transparent_bounce;
925
926         /* multiple importance sampling */
927         float min_ray_pdf; /* smallest bounce pdf over entire path up to now */
928         float ray_pdf;     /* last bounce pdf */
929 #ifdef __LAMP_MIS__
930         float ray_t;       /* accumulated distance through transparent surfaces */
931 #endif
932
933         /* volume rendering */
934 #ifdef __VOLUME__
935         int volume_bounce;
936         RNG rng_congruential;
937         VolumeStack volume_stack[VOLUME_STACK_SIZE];
938 #endif
939 } PathState;
940
941 /* Subsurface */
942
943 /* Struct to gather multiple SSS hits. */
944 struct SubsurfaceIntersection
945 {
946         Ray ray;
947         float3 weight[BSSRDF_MAX_HITS];
948
949         int num_hits;
950         struct Intersection hits[BSSRDF_MAX_HITS];
951         float3 Ng[BSSRDF_MAX_HITS];
952 };
953
954 /* Struct to gather SSS indirect rays and delay tracing them. */
955 struct SubsurfaceIndirectRays
956 {
957         bool need_update_volume_stack;
958         bool tracing;
959         PathState state[BSSRDF_MAX_HITS];
960         struct PathRadiance direct_L;
961
962         int num_rays;
963         struct Ray rays[BSSRDF_MAX_HITS];
964         float3 throughputs[BSSRDF_MAX_HITS];
965         struct PathRadiance L[BSSRDF_MAX_HITS];
966 };
967
968 /* Constant Kernel Data
969  *
970  * These structs are passed from CPU to various devices, and the struct layout
971  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
972  * do not use float3 because its size may not be the same on all devices. */
973
974 typedef struct KernelCamera {
975         /* type */
976         int type;
977
978         /* panorama */
979         int panorama_type;
980         float fisheye_fov;
981         float fisheye_lens;
982         float4 equirectangular_range;
983
984         /* stereo */
985         float interocular_offset;
986         float convergence_distance;
987         float pole_merge_angle_from;
988         float pole_merge_angle_to;
989
990         /* matrices */
991         Transform cameratoworld;
992         Transform rastertocamera;
993
994         /* differentials */
995         float4 dx;
996         float4 dy;
997
998         /* depth of field */
999         float aperturesize;
1000         float blades;
1001         float bladesrotation;
1002         float focaldistance;
1003
1004         /* motion blur */
1005         float shuttertime;
1006         int have_motion, have_perspective_motion;
1007
1008         /* clipping */
1009         float nearclip;
1010         float cliplength;
1011
1012         /* sensor size */
1013         float sensorwidth;
1014         float sensorheight;
1015
1016         /* render size */
1017         float width, height;
1018         int resolution;
1019
1020         /* anamorphic lens bokeh */
1021         float inv_aperture_ratio;
1022
1023         int is_inside_volume;
1024
1025         /* more matrices */
1026         Transform screentoworld;
1027         Transform rastertoworld;
1028         /* work around cuda sm 2.0 crash, this seems to
1029          * cross some limit in combination with motion 
1030          * Transform ndctoworld; */
1031         Transform worldtoscreen;
1032         Transform worldtoraster;
1033         Transform worldtondc;
1034         Transform worldtocamera;
1035
1036         MotionTransform motion;
1037
1038         /* Denotes changes in the projective matrix, namely in rastertocamera.
1039          * Used for camera zoom motion blur,
1040          */
1041         PerspectiveMotionTransform perspective_motion;
1042
1043         int shutter_table_offset;
1044
1045         /* Rolling shutter */
1046         int rolling_shutter_type;
1047         float rolling_shutter_duration;
1048
1049         int pad;
1050 } KernelCamera;
1051 static_assert_align(KernelCamera, 16);
1052
1053 typedef struct KernelFilm {
1054         float exposure;
1055         int pass_flag;
1056         int pass_stride;
1057         int use_light_pass;
1058
1059         int pass_combined;
1060         int pass_depth;
1061         int pass_normal;
1062         int pass_motion;
1063
1064         int pass_motion_weight;
1065         int pass_uv;
1066         int pass_object_id;
1067         int pass_material_id;
1068
1069         int pass_diffuse_color;
1070         int pass_glossy_color;
1071         int pass_transmission_color;
1072         int pass_subsurface_color;
1073         
1074         int pass_diffuse_indirect;
1075         int pass_glossy_indirect;
1076         int pass_transmission_indirect;
1077         int pass_subsurface_indirect;
1078         
1079         int pass_diffuse_direct;
1080         int pass_glossy_direct;
1081         int pass_transmission_direct;
1082         int pass_subsurface_direct;
1083         
1084         int pass_emission;
1085         int pass_background;
1086         int pass_ao;
1087         float pass_alpha_threshold;
1088
1089         int pass_shadow;
1090         float pass_shadow_scale;
1091         int filter_table_offset;
1092         int pass_pad2;
1093
1094         int pass_mist;
1095         float mist_start;
1096         float mist_inv_depth;
1097         float mist_falloff;
1098
1099 #ifdef __KERNEL_DEBUG__
1100         int pass_bvh_traversed_nodes;
1101         int pass_bvh_traversed_instances;
1102         int pass_bvh_intersections;
1103         int pass_ray_bounces;
1104 #endif
1105 } KernelFilm;
1106 static_assert_align(KernelFilm, 16);
1107
1108 typedef struct KernelBackground {
1109         /* only shader index */
1110         int surface_shader;
1111         int volume_shader;
1112         int transparent;
1113         int pad;
1114
1115         /* ambient occlusion */
1116         float ao_factor;
1117         float ao_distance;
1118         float ao_pad1, ao_pad2;
1119 } KernelBackground;
1120 static_assert_align(KernelBackground, 16);
1121
1122 typedef struct KernelIntegrator {
1123         /* emission */
1124         int use_direct_light;
1125         int use_ambient_occlusion;
1126         int num_distribution;
1127         int num_all_lights;
1128         float pdf_triangles;
1129         float pdf_lights;
1130         float inv_pdf_lights;
1131         int pdf_background_res;
1132
1133         /* light portals */
1134         float portal_pdf;
1135         int num_portals;
1136         int portal_offset;
1137
1138         /* bounces */
1139         int min_bounce;
1140         int max_bounce;
1141
1142         int max_diffuse_bounce;
1143         int max_glossy_bounce;
1144         int max_transmission_bounce;
1145         int max_volume_bounce;
1146
1147         int ao_bounces;
1148
1149         /* transparent */
1150         int transparent_min_bounce;
1151         int transparent_max_bounce;
1152         int transparent_shadows;
1153
1154         /* caustics */
1155         int caustics_reflective;
1156         int caustics_refractive;
1157         float filter_glossy;
1158
1159         /* seed */
1160         int seed;
1161
1162         /* clamp */
1163         float sample_clamp_direct;
1164         float sample_clamp_indirect;
1165
1166         /* branched path */
1167         int branched;
1168         int diffuse_samples;
1169         int glossy_samples;
1170         int transmission_samples;
1171         int ao_samples;
1172         int mesh_light_samples;
1173         int subsurface_samples;
1174         int sample_all_lights_direct;
1175         int sample_all_lights_indirect;
1176
1177         /* mis */
1178         int use_lamp_mis;
1179
1180         /* sampler */
1181         int sampling_pattern;
1182         int aa_samples;
1183
1184         /* volume render */
1185         int use_volumes;
1186         int volume_max_steps;
1187         float volume_step_size;
1188         int volume_samples;
1189
1190         float light_inv_rr_threshold;
1191
1192         int start_sample;
1193         int pad1, pad2, pad3;
1194 } KernelIntegrator;
1195 static_assert_align(KernelIntegrator, 16);
1196
1197 typedef struct KernelBVH {
1198         /* root node */
1199         int root;
1200         int attributes_map_stride;
1201         int have_motion;
1202         int have_curves;
1203         int have_instancing;
1204         int use_qbvh;
1205         int use_bvh_steps;
1206         int pad1;
1207 } KernelBVH;
1208 static_assert_align(KernelBVH, 16);
1209
1210 typedef enum CurveFlag {
1211         /* runtime flags */
1212         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
1213         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
1214         CURVE_KN_INTERPOLATE = 4,                               /* render as a curve? */
1215         CURVE_KN_ACCURATE = 8,                                  /* use accurate intersections test? */
1216         CURVE_KN_INTERSECTCORRECTION = 16,              /* correct for width after determing closest midpoint? */
1217         CURVE_KN_TRUETANGENTGNORMAL = 32,               /* use tangent normal for geometry? */
1218         CURVE_KN_RIBBONS = 64,                                  /* use flat curve ribbons */
1219 } CurveFlag;
1220
1221 typedef struct KernelCurves {
1222         int curveflags;
1223         int subdivisions;
1224
1225         float minimum_width;
1226         float maximum_width;
1227 } KernelCurves;
1228 static_assert_align(KernelCurves, 16);
1229
1230 typedef struct KernelTables {
1231         int beckmann_offset;
1232         int pad1, pad2, pad3;
1233 } KernelTables;
1234 static_assert_align(KernelTables, 16);
1235
1236 typedef struct KernelData {
1237         KernelCamera cam;
1238         KernelFilm film;
1239         KernelBackground background;
1240         KernelIntegrator integrator;
1241         KernelBVH bvh;
1242         KernelCurves curve;
1243         KernelTables tables;
1244 } KernelData;
1245 static_assert_align(KernelData, 16);
1246
1247 #ifdef __KERNEL_DEBUG__
1248 /* NOTE: This is a runtime-only struct, alignment is not
1249  * really important here.
1250  */
1251 typedef ccl_addr_space struct DebugData {
1252         int num_bvh_traversed_nodes;
1253         int num_bvh_traversed_instances;
1254         int num_bvh_intersections;
1255         int num_ray_bounces;
1256 } DebugData;
1257 #endif
1258
1259 /* Declarations required for split kernel */
1260
1261 /* Macro for queues */
1262 /* Value marking queue's empty slot */
1263 #define QUEUE_EMPTY_SLOT -1
1264
1265 /*
1266  * Queue 1 - Active rays
1267  * Queue 2 - Background queue
1268  * Queue 3 - Shadow ray cast kernel - AO
1269  * Queeu 4 - Shadow ray cast kernel - direct lighting
1270  */
1271 #define NUM_QUEUES 4
1272
1273 /* Queue names */
1274 enum QueueNumber {
1275         /* All active rays and regenerated rays are enqueued here. */
1276         QUEUE_ACTIVE_AND_REGENERATED_RAYS = 0,
1277
1278         /* All
1279          * 1. Background-hit rays,
1280          * 2. Rays that has exited path-iteration but needs to update output buffer
1281          * 3. Rays to be regenerated
1282          * are enqueued here.
1283          */
1284         QUEUE_HITBG_BUFF_UPDATE_TOREGEN_RAYS = 1,
1285
1286         /* All rays for which a shadow ray should be cast to determine radiance
1287          * contribution for AO are enqueued here.
1288          */
1289         QUEUE_SHADOW_RAY_CAST_AO_RAYS = 2,
1290
1291         /* All rays for which a shadow ray should be cast to determine radiance
1292          * contributing for direct lighting are enqueued here.
1293          */
1294         QUEUE_SHADOW_RAY_CAST_DL_RAYS = 3,
1295 };
1296
1297 /* We use RAY_STATE_MASK to get ray_state (enums 0 to 5) */
1298 #define RAY_STATE_MASK 0x007
1299 #define RAY_FLAG_MASK 0x0F8
1300 enum RayState {
1301         /* Denotes ray is actively involved in path-iteration. */
1302         RAY_ACTIVE = 0,
1303         /* Denotes ray has completed processing all samples and is inactive. */
1304         RAY_INACTIVE = 1,
1305         /* Denoted ray has exited path-iteration and needs to update output buffer. */
1306         RAY_UPDATE_BUFFER = 2,
1307         /* Donotes ray has hit background */
1308         RAY_HIT_BACKGROUND = 3,
1309         /* Denotes ray has to be regenerated */
1310         RAY_TO_REGENERATE = 4,
1311         /* Denotes ray has been regenerated */
1312         RAY_REGENERATED = 5,
1313         /* Denotes ray should skip direct lighting */
1314         RAY_SKIP_DL = 6,
1315         /* Flag's ray has to execute shadow blocked function in AO part */
1316         RAY_SHADOW_RAY_CAST_AO = 16,
1317         /* Flag's ray has to execute shadow blocked function in direct lighting part. */
1318         RAY_SHADOW_RAY_CAST_DL = 32,
1319 };
1320
1321 #define ASSIGN_RAY_STATE(ray_state, ray_index, state) (ray_state[ray_index] = ((ray_state[ray_index] & RAY_FLAG_MASK) | state))
1322 #define IS_STATE(ray_state, ray_index, state) ((ray_state[ray_index] & RAY_STATE_MASK) == state)
1323 #define ADD_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] | flag))
1324 #define REMOVE_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] & (~flag)))
1325 #define IS_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] & flag)
1326
1327 /* Patches */
1328
1329 #define PATCH_MAX_CONTROL_VERTS 16
1330
1331 /* Patch map node flags */
1332
1333 #define PATCH_MAP_NODE_IS_SET (1 << 30)
1334 #define PATCH_MAP_NODE_IS_LEAF (1u << 31)
1335 #define PATCH_MAP_NODE_INDEX_MASK (~(PATCH_MAP_NODE_IS_SET | PATCH_MAP_NODE_IS_LEAF))
1336
1337 CCL_NAMESPACE_END
1338
1339 #endif /*  __KERNEL_TYPES_H__ */
1340