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