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