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