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