Code cleanup: make L_transparent part of PathRadiance.
[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 #ifdef __KERNEL_DEBUG__
472 /* NOTE: This is a runtime-only struct, alignment is not
473  * really important here.
474  */
475 typedef struct DebugData {
476         int num_bvh_traversed_nodes;
477         int num_bvh_traversed_instances;
478         int num_bvh_intersections;
479         int num_ray_bounces;
480 } DebugData;
481 #endif
482
483 typedef ccl_addr_space struct PathRadiance {
484 #ifdef __PASSES__
485         int use_light_pass;
486 #endif
487
488         float transparent;
489         float3 emission;
490 #ifdef __PASSES__
491         float3 background;
492         float3 ao;
493
494         float3 indirect;
495         float3 direct_throughput;
496         float3 direct_emission;
497
498         float3 color_diffuse;
499         float3 color_glossy;
500         float3 color_transmission;
501         float3 color_subsurface;
502         float3 color_scatter;
503
504         float3 direct_diffuse;
505         float3 direct_glossy;
506         float3 direct_transmission;
507         float3 direct_subsurface;
508         float3 direct_scatter;
509
510         float3 indirect_diffuse;
511         float3 indirect_glossy;
512         float3 indirect_transmission;
513         float3 indirect_subsurface;
514         float3 indirect_scatter;
515
516         float3 path_diffuse;
517         float3 path_glossy;
518         float3 path_transmission;
519         float3 path_subsurface;
520         float3 path_scatter;
521
522         float4 shadow;
523         float mist;
524 #endif
525
526 #ifdef __SHADOW_TRICKS__
527         /* Total light reachable across the path, ignoring shadow blocked queries. */
528         float3 path_total;
529         /* Total light reachable across the path with shadow blocked queries
530          * applied here.
531          *
532          * Dividing this figure by path_total will give estimate of shadow pass.
533          */
534         float3 path_total_shaded;
535
536         /* Color of the background on which shadow is alpha-overed. */
537         float3 shadow_background_color;
538
539         /* Path radiance sum and throughput at the moment when ray hits shadow
540          * catcher object.
541          */
542         float3 shadow_radiance_sum;
543         float shadow_throughput;
544
545         /* Accumulated transparency along the path after shadow catcher bounce. */
546         float shadow_transparency;
547 #endif
548
549 #ifdef __DENOISING_FEATURES__
550         float3 denoising_normal;
551         float3 denoising_albedo;
552         float denoising_depth;
553 #endif  /* __DENOISING_FEATURES__ */
554
555 #ifdef __KERNEL_DEBUG__
556         DebugData debug_data;
557 #endif /* __KERNEL_DEBUG__ */
558 } PathRadiance;
559
560 typedef struct BsdfEval {
561 #ifdef __PASSES__
562         int use_light_pass;
563 #endif
564
565         float3 diffuse;
566 #ifdef __PASSES__
567         float3 glossy;
568         float3 transmission;
569         float3 transparent;
570         float3 subsurface;
571         float3 scatter;
572 #endif
573 #ifdef __SHADOW_TRICKS__
574         float3 sum_no_mis;
575 #endif
576 } BsdfEval;
577
578 /* Shader Flag */
579
580 typedef enum ShaderFlag {
581         SHADER_SMOOTH_NORMAL = (1 << 31),
582         SHADER_CAST_SHADOW = (1 << 30),
583         SHADER_AREA_LIGHT = (1 << 29),
584         SHADER_USE_MIS = (1 << 28),
585         SHADER_EXCLUDE_DIFFUSE = (1 << 27),
586         SHADER_EXCLUDE_GLOSSY = (1 << 26),
587         SHADER_EXCLUDE_TRANSMIT = (1 << 25),
588         SHADER_EXCLUDE_CAMERA = (1 << 24),
589         SHADER_EXCLUDE_SCATTER = (1 << 23),
590         SHADER_EXCLUDE_ANY = (SHADER_EXCLUDE_DIFFUSE|SHADER_EXCLUDE_GLOSSY|SHADER_EXCLUDE_TRANSMIT|SHADER_EXCLUDE_CAMERA|SHADER_EXCLUDE_SCATTER),
591
592         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT|SHADER_USE_MIS|SHADER_EXCLUDE_ANY)
593 } ShaderFlag;
594
595 /* Light Type */
596
597 typedef enum LightType {
598         LIGHT_POINT,
599         LIGHT_DISTANT,
600         LIGHT_BACKGROUND,
601         LIGHT_AREA,
602         LIGHT_SPOT,
603         LIGHT_TRIANGLE
604 } LightType;
605
606 /* Camera Type */
607
608 enum CameraType {
609         CAMERA_PERSPECTIVE,
610         CAMERA_ORTHOGRAPHIC,
611         CAMERA_PANORAMA
612 };
613
614 /* Panorama Type */
615
616 enum PanoramaType {
617         PANORAMA_EQUIRECTANGULAR = 0,
618         PANORAMA_FISHEYE_EQUIDISTANT = 1,
619         PANORAMA_FISHEYE_EQUISOLID = 2,
620         PANORAMA_MIRRORBALL = 3,
621
622         PANORAMA_NUM_TYPES,
623 };
624
625 /* Differential */
626
627 typedef struct differential3 {
628         float3 dx;
629         float3 dy;
630 } differential3;
631
632 typedef struct differential {
633         float dx;
634         float dy;
635 } differential;
636
637 /* Ray */
638
639 typedef struct Ray {
640 /* TODO(sergey): This is only needed because current AMD
641  * compiler has hard time building the kernel with this
642  * reshuffle. And at the same time reshuffle will cause
643  * less optimal CPU code in certain places.
644  *
645  * We'll get rid of this nasty exception once AMD compiler
646  * is fixed.
647  */
648 #ifndef __KERNEL_OPENCL_AMD__
649         float3 P;               /* origin */
650         float3 D;               /* direction */
651
652         float t;                /* length of the ray */
653         float time;             /* time (for motion blur) */
654 #else
655         float t;                /* length of the ray */
656         float time;             /* time (for motion blur) */
657         float3 P;               /* origin */
658         float3 D;               /* direction */
659 #endif
660
661 #ifdef __RAY_DIFFERENTIALS__
662         differential3 dP;
663         differential3 dD;
664 #endif
665 } Ray;
666
667 /* Intersection */
668
669 typedef struct Intersection {
670         float t, u, v;
671         int prim;
672         int object;
673         int type;
674
675 #ifdef __KERNEL_DEBUG__
676         int num_traversed_nodes;
677         int num_traversed_instances;
678         int num_intersections;
679 #endif
680 } Intersection;
681
682 /* Primitives */
683
684 typedef enum PrimitiveType {
685         PRIMITIVE_NONE            = 0,
686         PRIMITIVE_TRIANGLE        = (1 << 0),
687         PRIMITIVE_MOTION_TRIANGLE = (1 << 1),
688         PRIMITIVE_CURVE           = (1 << 2),
689         PRIMITIVE_MOTION_CURVE    = (1 << 3),
690         /* Lamp primitive is not included below on purpose,
691          * since it is no real traceable primitive.
692          */
693         PRIMITIVE_LAMP            = (1 << 4),
694
695         PRIMITIVE_ALL_TRIANGLE = (PRIMITIVE_TRIANGLE|PRIMITIVE_MOTION_TRIANGLE),
696         PRIMITIVE_ALL_CURVE = (PRIMITIVE_CURVE|PRIMITIVE_MOTION_CURVE),
697         PRIMITIVE_ALL_MOTION = (PRIMITIVE_MOTION_TRIANGLE|PRIMITIVE_MOTION_CURVE),
698         PRIMITIVE_ALL = (PRIMITIVE_ALL_TRIANGLE|PRIMITIVE_ALL_CURVE),
699
700         /* Total number of different traceable primitives.
701          * NOTE: This is an actual value, not a bitflag.
702          */
703         PRIMITIVE_NUM_TOTAL = 4,
704 } PrimitiveType;
705
706 #define PRIMITIVE_PACK_SEGMENT(type, segment) ((segment << PRIMITIVE_NUM_TOTAL) | (type))
707 #define PRIMITIVE_UNPACK_SEGMENT(type) (type >> PRIMITIVE_NUM_TOTAL)
708
709 /* Attributes */
710
711 typedef enum AttributePrimitive {
712         ATTR_PRIM_TRIANGLE = 0,
713         ATTR_PRIM_CURVE,
714         ATTR_PRIM_SUBD,
715
716         ATTR_PRIM_TYPES
717 } AttributePrimitive;
718
719 typedef enum AttributeElement {
720         ATTR_ELEMENT_NONE,
721         ATTR_ELEMENT_OBJECT,
722         ATTR_ELEMENT_MESH,
723         ATTR_ELEMENT_FACE,
724         ATTR_ELEMENT_VERTEX,
725         ATTR_ELEMENT_VERTEX_MOTION,
726         ATTR_ELEMENT_CORNER,
727         ATTR_ELEMENT_CORNER_BYTE,
728         ATTR_ELEMENT_CURVE,
729         ATTR_ELEMENT_CURVE_KEY,
730         ATTR_ELEMENT_CURVE_KEY_MOTION,
731         ATTR_ELEMENT_VOXEL
732 } AttributeElement;
733
734 typedef enum AttributeStandard {
735         ATTR_STD_NONE = 0,
736         ATTR_STD_VERTEX_NORMAL,
737         ATTR_STD_FACE_NORMAL,
738         ATTR_STD_UV,
739         ATTR_STD_UV_TANGENT,
740         ATTR_STD_UV_TANGENT_SIGN,
741         ATTR_STD_GENERATED,
742         ATTR_STD_GENERATED_TRANSFORM,
743         ATTR_STD_POSITION_UNDEFORMED,
744         ATTR_STD_POSITION_UNDISPLACED,
745         ATTR_STD_MOTION_VERTEX_POSITION,
746         ATTR_STD_MOTION_VERTEX_NORMAL,
747         ATTR_STD_PARTICLE,
748         ATTR_STD_CURVE_INTERCEPT,
749         ATTR_STD_PTEX_FACE_ID,
750         ATTR_STD_PTEX_UV,
751         ATTR_STD_VOLUME_DENSITY,
752         ATTR_STD_VOLUME_COLOR,
753         ATTR_STD_VOLUME_FLAME,
754         ATTR_STD_VOLUME_HEAT,
755         ATTR_STD_VOLUME_VELOCITY,
756         ATTR_STD_POINTINESS,
757         ATTR_STD_NUM,
758
759         ATTR_STD_NOT_FOUND = ~0
760 } AttributeStandard;
761
762 typedef enum AttributeFlag {
763         ATTR_FINAL_SIZE = (1 << 0),
764         ATTR_SUBDIVIDED = (1 << 1),
765 } AttributeFlag;
766
767 typedef struct AttributeDescriptor {
768         AttributeElement element;
769         NodeAttributeType type;
770         uint flags; /* see enum AttributeFlag */
771         int offset;
772 } AttributeDescriptor;
773
774 /* Closure data */
775
776 #ifdef __MULTI_CLOSURE__
777 #  ifndef __MAX_CLOSURE__
778 #     define MAX_CLOSURE 64
779 #  else
780 #    define MAX_CLOSURE __MAX_CLOSURE__
781 #  endif
782 #else
783 #  define MAX_CLOSURE 1
784 #endif
785
786 /* This struct is the base class for all closures. The common members are
787  * duplicated in all derived classes since we don't have C++ in the kernel
788  * yet, and because it lets us lay out the members to minimize padding. The
789  * weight member is located at the beginning of the struct for this reason.
790  *
791  * ShaderClosure has a fixed size, and any extra space must be allocated
792  * with closure_alloc_extra().
793  *
794  * We pad the struct to 80 bytes and ensure it is aligned to 16 bytes, which
795  * we assume to be the maximum required alignment for any struct. */
796
797 #define SHADER_CLOSURE_BASE \
798         float3 weight; \
799         ClosureType type; \
800         float sample_weight; \
801         float3 N
802
803 typedef ccl_addr_space struct ccl_align(16) ShaderClosure {
804         SHADER_CLOSURE_BASE;
805
806         float data[10]; /* pad to 80 bytes */
807 } ShaderClosure;
808
809 /* Shader Context
810  *
811  * For OSL we recycle a fixed number of contexts for speed */
812
813 typedef enum ShaderContext {
814         SHADER_CONTEXT_MAIN = 0,
815         SHADER_CONTEXT_INDIRECT = 1,
816         SHADER_CONTEXT_EMISSION = 2,
817         SHADER_CONTEXT_SHADOW = 3,
818         SHADER_CONTEXT_SSS = 4,
819         SHADER_CONTEXT_VOLUME = 5,
820         SHADER_CONTEXT_NUM = 6
821 } ShaderContext;
822
823 /* Shader Data
824  *
825  * Main shader state at a point on the surface or in a volume. All coordinates
826  * are in world space.
827  */
828
829 enum ShaderDataFlag {
830         /* Runtime flags. */
831
832         /* Set when ray hits backside of surface. */
833         SD_BACKFACING      = (1 << 0),
834         /* Shader has emissive closure. */
835         SD_EMISSION        = (1 << 1),
836         /* Shader has BSDF closure. */
837         SD_BSDF            = (1 << 2),
838         /* Shader has non-singular BSDF closure. */
839         SD_BSDF_HAS_EVAL   = (1 << 3),
840         /* Shader has BSSRDF closure. */
841         SD_BSSRDF          = (1 << 4),
842         /* Shader has holdout closure. */
843         SD_HOLDOUT         = (1 << 5),
844         /* Shader has volume absorption closure. */
845         SD_ABSORPTION      = (1 << 6),
846         /* Shader has have volume phase (scatter) closure. */
847         SD_SCATTER         = (1 << 7),
848         /* Shader has AO closure. */
849         SD_AO              = (1 << 8),
850         /* Shader has transparent closure. */
851         SD_TRANSPARENT     = (1 << 9),
852         /* BSDF requires LCG for evaluation. */
853         SD_BSDF_NEEDS_LCG  = (1 << 10),
854
855         SD_CLOSURE_FLAGS = (SD_EMISSION |
856                             SD_BSDF |
857                             SD_BSDF_HAS_EVAL |
858                             SD_BSSRDF |
859                             SD_HOLDOUT |
860                             SD_ABSORPTION |
861                             SD_SCATTER |
862                             SD_AO |
863                             SD_BSDF_NEEDS_LCG),
864
865         /* Shader flags. */
866
867         /* direct light sample */
868         SD_USE_MIS                = (1 << 16),
869         /* Has transparent shadow. */
870         SD_HAS_TRANSPARENT_SHADOW = (1 << 17),
871         /* Has volume shader. */
872         SD_HAS_VOLUME             = (1 << 18),
873         /* Has only volume shader, no surface. */
874         SD_HAS_ONLY_VOLUME        = (1 << 19),
875         /* Has heterogeneous volume. */
876         SD_HETEROGENEOUS_VOLUME   = (1 << 20),
877         /* BSSRDF normal uses bump. */
878         SD_HAS_BSSRDF_BUMP        = (1 << 21),
879         /* Use equiangular volume sampling */
880         SD_VOLUME_EQUIANGULAR     = (1 << 22),
881         /* Use multiple importance volume sampling. */
882         SD_VOLUME_MIS             = (1 << 23),
883         /* Use cubic interpolation for voxels. */
884         SD_VOLUME_CUBIC           = (1 << 24),
885         /* Has data connected to the displacement input. */
886         SD_HAS_BUMP               = (1 << 25),
887         /* Has true displacement. */
888         SD_HAS_DISPLACEMENT       = (1 << 26),
889         /* Has constant emission (value stored in __shader_flag) */
890         SD_HAS_CONSTANT_EMISSION  = (1 << 27),
891
892         SD_SHADER_FLAGS = (SD_USE_MIS |
893                            SD_HAS_TRANSPARENT_SHADOW |
894                            SD_HAS_VOLUME |
895                            SD_HAS_ONLY_VOLUME |
896                            SD_HETEROGENEOUS_VOLUME|
897                            SD_HAS_BSSRDF_BUMP |
898                            SD_VOLUME_EQUIANGULAR |
899                            SD_VOLUME_MIS |
900                            SD_VOLUME_CUBIC |
901                            SD_HAS_BUMP |
902                            SD_HAS_DISPLACEMENT |
903                            SD_HAS_CONSTANT_EMISSION)
904 };
905
906         /* Object flags. */
907 enum ShaderDataObjectFlag {
908         /* Holdout for camera rays. */
909         SD_OBJECT_HOLDOUT_MASK           = (1 << 0),
910         /* Has object motion blur. */
911         SD_OBJECT_MOTION                 = (1 << 1),
912         /* Vertices have transform applied. */
913         SD_OBJECT_TRANSFORM_APPLIED      = (1 << 2),
914         /* Vertices have negative scale applied. */
915         SD_OBJECT_NEGATIVE_SCALE_APPLIED = (1 << 3),
916         /* Object has a volume shader. */
917         SD_OBJECT_HAS_VOLUME             = (1 << 4),
918         /* Object intersects AABB of an object with volume shader. */
919         SD_OBJECT_INTERSECTS_VOLUME      = (1 << 5),
920         /* Has position for motion vertices. */
921         SD_OBJECT_HAS_VERTEX_MOTION      = (1 << 6),
922         /* object is used to catch shadows */
923         SD_OBJECT_SHADOW_CATCHER         = (1 << 7),
924
925         SD_OBJECT_FLAGS = (SD_OBJECT_HOLDOUT_MASK |
926                            SD_OBJECT_MOTION |
927                            SD_OBJECT_TRANSFORM_APPLIED |
928                            SD_OBJECT_NEGATIVE_SCALE_APPLIED |
929                            SD_OBJECT_HAS_VOLUME |
930                            SD_OBJECT_INTERSECTS_VOLUME |
931                            SD_OBJECT_SHADOW_CATCHER)
932 };
933
934 typedef ccl_addr_space struct ShaderData {
935         /* position */
936         float3 P;
937         /* smooth normal for shading */
938         float3 N;
939         /* true geometric normal */
940         float3 Ng;
941         /* view/incoming direction */
942         float3 I;
943         /* shader id */
944         int shader;
945         /* booleans describing shader, see ShaderDataFlag */
946         int flag;
947         /* booleans describing object of the shader, see ShaderDataObjectFlag */
948         int object_flag;
949
950         /* primitive id if there is one, ~0 otherwise */
951         int prim;
952
953         /* combined type and curve segment for hair */
954         int type;
955
956         /* parametric coordinates
957          * - barycentric weights for triangles */
958         float u;
959         float v;
960         /* object id if there is one, ~0 otherwise */
961         int object;
962
963         /* motion blur sample time */
964         float time;
965
966         /* length of the ray being shaded */
967         float ray_length;
968
969 #ifdef __RAY_DIFFERENTIALS__
970         /* differential of P. these are orthogonal to Ng, not N */
971         differential3 dP;
972         /* differential of I */
973         differential3 dI;
974         /* differential of u, v */
975         differential du;
976         differential dv;
977 #endif
978 #ifdef __DPDU__
979         /* differential of P w.r.t. parametric coordinates. note that dPdu is
980          * not readily suitable as a tangent for shading on triangles. */
981         float3 dPdu;
982         float3 dPdv;
983 #endif
984
985 #ifdef __OBJECT_MOTION__
986         /* object <-> world space transformations, cached to avoid
987          * re-interpolating them constantly for shading */
988         Transform ob_tfm;
989         Transform ob_itfm;
990 #endif
991
992         /* Closure data, we store a fixed array of closures */
993         struct ShaderClosure closure[MAX_CLOSURE];
994         int num_closure;
995         int num_closure_extra;
996         float randb_closure;
997         float3 svm_closure_weight;
998
999         /* LCG state for closures that require additional random numbers. */
1000         uint lcg_state;
1001
1002         /* ray start position, only set for backgrounds */
1003         float3 ray_P;
1004         differential3 ray_dP;
1005
1006 #ifdef __OSL__
1007         struct KernelGlobals *osl_globals;
1008         struct PathState *osl_path_state;
1009 #endif
1010 } ShaderData;
1011
1012 /* Path State */
1013
1014 #ifdef __VOLUME__
1015 typedef struct VolumeStack {
1016         int object;
1017         int shader;
1018 } VolumeStack;
1019 #endif
1020
1021 typedef struct PathState {
1022         /* see enum PathRayFlag */
1023         int flag;
1024
1025         /* random number generator state */
1026         int rng_offset;                 /* dimension offset */
1027         int sample;                     /* path sample number */
1028         int num_samples;                /* total number of times this path will be sampled */
1029
1030         /* bounce counting */
1031         int bounce;
1032         int diffuse_bounce;
1033         int glossy_bounce;
1034         int transmission_bounce;
1035         int transparent_bounce;
1036
1037 #ifdef __DENOISING_FEATURES__
1038         float denoising_feature_weight;
1039 #endif  /* __DENOISING_FEATURES__ */
1040
1041         /* multiple importance sampling */
1042         float min_ray_pdf; /* smallest bounce pdf over entire path up to now */
1043         float ray_pdf;     /* last bounce pdf */
1044 #ifdef __LAMP_MIS__
1045         float ray_t;       /* accumulated distance through transparent surfaces */
1046 #endif
1047
1048         /* volume rendering */
1049 #ifdef __VOLUME__
1050         int volume_bounce;
1051         RNG rng_congruential;
1052         VolumeStack volume_stack[VOLUME_STACK_SIZE];
1053 #endif
1054 } PathState;
1055
1056 /* Subsurface */
1057
1058 /* Struct to gather multiple SSS hits. */
1059 typedef struct SubsurfaceIntersection
1060 {
1061         Ray ray;
1062         float3 weight[BSSRDF_MAX_HITS];
1063
1064         int num_hits;
1065         struct Intersection hits[BSSRDF_MAX_HITS];
1066         float3 Ng[BSSRDF_MAX_HITS];
1067 } SubsurfaceIntersection;
1068
1069 /* Struct to gather SSS indirect rays and delay tracing them. */
1070 typedef struct SubsurfaceIndirectRays
1071 {
1072         bool need_update_volume_stack;
1073         bool tracing;
1074         PathState state[BSSRDF_MAX_HITS];
1075         struct PathRadiance direct_L;
1076
1077         int num_rays;
1078         struct Ray rays[BSSRDF_MAX_HITS];
1079         float3 throughputs[BSSRDF_MAX_HITS];
1080         struct PathRadiance L[BSSRDF_MAX_HITS];
1081 } SubsurfaceIndirectRays;
1082
1083 /* Constant Kernel Data
1084  *
1085  * These structs are passed from CPU to various devices, and the struct layout
1086  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
1087  * do not use float3 because its size may not be the same on all devices. */
1088
1089 typedef struct KernelCamera {
1090         /* type */
1091         int type;
1092
1093         /* panorama */
1094         int panorama_type;
1095         float fisheye_fov;
1096         float fisheye_lens;
1097         float4 equirectangular_range;
1098
1099         /* stereo */
1100         float interocular_offset;
1101         float convergence_distance;
1102         float pole_merge_angle_from;
1103         float pole_merge_angle_to;
1104
1105         /* matrices */
1106         Transform cameratoworld;
1107         Transform rastertocamera;
1108
1109         /* differentials */
1110         float4 dx;
1111         float4 dy;
1112
1113         /* depth of field */
1114         float aperturesize;
1115         float blades;
1116         float bladesrotation;
1117         float focaldistance;
1118
1119         /* motion blur */
1120         float shuttertime;
1121         int have_motion, have_perspective_motion;
1122
1123         /* clipping */
1124         float nearclip;
1125         float cliplength;
1126
1127         /* sensor size */
1128         float sensorwidth;
1129         float sensorheight;
1130
1131         /* render size */
1132         float width, height;
1133         int resolution;
1134
1135         /* anamorphic lens bokeh */
1136         float inv_aperture_ratio;
1137
1138         int is_inside_volume;
1139
1140         /* more matrices */
1141         Transform screentoworld;
1142         Transform rastertoworld;
1143         /* work around cuda sm 2.0 crash, this seems to
1144          * cross some limit in combination with motion 
1145          * Transform ndctoworld; */
1146         Transform worldtoscreen;
1147         Transform worldtoraster;
1148         Transform worldtondc;
1149         Transform worldtocamera;
1150
1151         MotionTransform motion;
1152
1153         /* Denotes changes in the projective matrix, namely in rastertocamera.
1154          * Used for camera zoom motion blur,
1155          */
1156         PerspectiveMotionTransform perspective_motion;
1157
1158         int shutter_table_offset;
1159
1160         /* Rolling shutter */
1161         int rolling_shutter_type;
1162         float rolling_shutter_duration;
1163
1164         int pad;
1165 } KernelCamera;
1166 static_assert_align(KernelCamera, 16);
1167
1168 typedef struct KernelFilm {
1169         float exposure;
1170         int pass_flag;
1171         int pass_stride;
1172         int use_light_pass;
1173
1174         int pass_combined;
1175         int pass_depth;
1176         int pass_normal;
1177         int pass_motion;
1178
1179         int pass_motion_weight;
1180         int pass_uv;
1181         int pass_object_id;
1182         int pass_material_id;
1183
1184         int pass_diffuse_color;
1185         int pass_glossy_color;
1186         int pass_transmission_color;
1187         int pass_subsurface_color;
1188         
1189         int pass_diffuse_indirect;
1190         int pass_glossy_indirect;
1191         int pass_transmission_indirect;
1192         int pass_subsurface_indirect;
1193         
1194         int pass_diffuse_direct;
1195         int pass_glossy_direct;
1196         int pass_transmission_direct;
1197         int pass_subsurface_direct;
1198         
1199         int pass_emission;
1200         int pass_background;
1201         int pass_ao;
1202         float pass_alpha_threshold;
1203
1204         int pass_shadow;
1205         float pass_shadow_scale;
1206         int filter_table_offset;
1207         int pass_pad2;
1208
1209         int pass_mist;
1210         float mist_start;
1211         float mist_inv_depth;
1212         float mist_falloff;
1213
1214         int pass_denoising_data;
1215         int pass_denoising_clean;
1216         int denoising_flags;
1217         int pad;
1218
1219 #ifdef __KERNEL_DEBUG__
1220         int pass_bvh_traversed_nodes;
1221         int pass_bvh_traversed_instances;
1222         int pass_bvh_intersections;
1223         int pass_ray_bounces;
1224 #endif
1225 } KernelFilm;
1226 static_assert_align(KernelFilm, 16);
1227
1228 typedef struct KernelBackground {
1229         /* only shader index */
1230         int surface_shader;
1231         int volume_shader;
1232         int transparent;
1233         int pad;
1234
1235         /* ambient occlusion */
1236         float ao_factor;
1237         float ao_distance;
1238         float ao_pad1, ao_pad2;
1239 } KernelBackground;
1240 static_assert_align(KernelBackground, 16);
1241
1242 typedef struct KernelIntegrator {
1243         /* emission */
1244         int use_direct_light;
1245         int use_ambient_occlusion;
1246         int num_distribution;
1247         int num_all_lights;
1248         float pdf_triangles;
1249         float pdf_lights;
1250         float inv_pdf_lights;
1251         int pdf_background_res;
1252
1253         /* light portals */
1254         float portal_pdf;
1255         int num_portals;
1256         int portal_offset;
1257
1258         /* bounces */
1259         int max_bounce;
1260
1261         int max_diffuse_bounce;
1262         int max_glossy_bounce;
1263         int max_transmission_bounce;
1264         int max_volume_bounce;
1265
1266         int ao_bounces;
1267
1268         /* transparent */
1269         int transparent_max_bounce;
1270         int transparent_shadows;
1271
1272         /* caustics */
1273         int caustics_reflective;
1274         int caustics_refractive;
1275         float filter_glossy;
1276
1277         /* seed */
1278         int seed;
1279
1280         /* clamp */
1281         float sample_clamp_direct;
1282         float sample_clamp_indirect;
1283
1284         /* branched path */
1285         int branched;
1286         int diffuse_samples;
1287         int glossy_samples;
1288         int transmission_samples;
1289         int ao_samples;
1290         int mesh_light_samples;
1291         int subsurface_samples;
1292         int sample_all_lights_direct;
1293         int sample_all_lights_indirect;
1294
1295         /* mis */
1296         int use_lamp_mis;
1297
1298         /* sampler */
1299         int sampling_pattern;
1300         int aa_samples;
1301
1302         /* volume render */
1303         int use_volumes;
1304         int volume_max_steps;
1305         float volume_step_size;
1306         int volume_samples;
1307
1308         float light_inv_rr_threshold;
1309
1310         int start_sample;
1311         int pad1;
1312 } KernelIntegrator;
1313 static_assert_align(KernelIntegrator, 16);
1314
1315 typedef struct KernelBVH {
1316         /* root node */
1317         int root;
1318         int attributes_map_stride;
1319         int have_motion;
1320         int have_curves;
1321         int have_instancing;
1322         int use_qbvh;
1323         int use_bvh_steps;
1324         int pad1;
1325 } KernelBVH;
1326 static_assert_align(KernelBVH, 16);
1327
1328 typedef enum CurveFlag {
1329         /* runtime flags */
1330         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
1331         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
1332         CURVE_KN_INTERPOLATE = 4,                               /* render as a curve? */
1333         CURVE_KN_ACCURATE = 8,                                  /* use accurate intersections test? */
1334         CURVE_KN_INTERSECTCORRECTION = 16,              /* correct for width after determing closest midpoint? */
1335         CURVE_KN_TRUETANGENTGNORMAL = 32,               /* use tangent normal for geometry? */
1336         CURVE_KN_RIBBONS = 64,                                  /* use flat curve ribbons */
1337 } CurveFlag;
1338
1339 typedef struct KernelCurves {
1340         int curveflags;
1341         int subdivisions;
1342
1343         float minimum_width;
1344         float maximum_width;
1345 } KernelCurves;
1346 static_assert_align(KernelCurves, 16);
1347
1348 typedef struct KernelTables {
1349         int beckmann_offset;
1350         int pad1, pad2, pad3;
1351 } KernelTables;
1352 static_assert_align(KernelTables, 16);
1353
1354 typedef struct KernelData {
1355         KernelCamera cam;
1356         KernelFilm film;
1357         KernelBackground background;
1358         KernelIntegrator integrator;
1359         KernelBVH bvh;
1360         KernelCurves curve;
1361         KernelTables tables;
1362 } KernelData;
1363 static_assert_align(KernelData, 16);
1364
1365 /* Declarations required for split kernel */
1366
1367 /* Macro for queues */
1368 /* Value marking queue's empty slot */
1369 #define QUEUE_EMPTY_SLOT -1
1370
1371 /*
1372  * Queue 1 - Active rays
1373  * Queue 2 - Background queue
1374  * Queue 3 - Shadow ray cast kernel - AO
1375  * Queeu 4 - Shadow ray cast kernel - direct lighting
1376  */
1377
1378 /* Queue names */
1379 enum QueueNumber {
1380         /* All active rays and regenerated rays are enqueued here. */
1381         QUEUE_ACTIVE_AND_REGENERATED_RAYS = 0,
1382
1383         /* All
1384          * 1. Background-hit rays,
1385          * 2. Rays that has exited path-iteration but needs to update output buffer
1386          * 3. Rays to be regenerated
1387          * are enqueued here.
1388          */
1389         QUEUE_HITBG_BUFF_UPDATE_TOREGEN_RAYS,
1390
1391         /* All rays for which a shadow ray should be cast to determine radiance
1392          * contribution for AO are enqueued here.
1393          */
1394         QUEUE_SHADOW_RAY_CAST_AO_RAYS,
1395
1396         /* All rays for which a shadow ray should be cast to determine radiance
1397          * contributing for direct lighting are enqueued here.
1398          */
1399         QUEUE_SHADOW_RAY_CAST_DL_RAYS,
1400
1401         /* Rays sorted according to shader->id */
1402         QUEUE_SHADER_SORTED_RAYS,
1403
1404 #ifdef __BRANCHED_PATH__
1405         /* All rays moving to next iteration of the indirect loop for light */
1406         QUEUE_LIGHT_INDIRECT_ITER,
1407         /* Queue of all inactive rays. These are candidates for sharing work of indirect loops */
1408         QUEUE_INACTIVE_RAYS,
1409 #  ifdef __VOLUME__
1410         /* All rays moving to next iteration of the indirect loop for volumes */
1411         QUEUE_VOLUME_INDIRECT_ITER,
1412 #  endif
1413 #  ifdef __SUBSURFACE__
1414         /* All rays moving to next iteration of the indirect loop for subsurface */
1415         QUEUE_SUBSURFACE_INDIRECT_ITER,
1416 #  endif
1417 #endif  /* __BRANCHED_PATH__ */
1418
1419         NUM_QUEUES
1420 };
1421
1422 /* We use RAY_STATE_MASK to get ray_state */
1423 #define RAY_STATE_MASK 0x0F
1424 #define RAY_FLAG_MASK 0xF0
1425 enum RayState {
1426         RAY_INVALID = 0,
1427         /* Denotes ray is actively involved in path-iteration. */
1428         RAY_ACTIVE,
1429         /* Denotes ray has completed processing all samples and is inactive. */
1430         RAY_INACTIVE,
1431         /* Denoted ray has exited path-iteration and needs to update output buffer. */
1432         RAY_UPDATE_BUFFER,
1433         /* Donotes ray has hit background */
1434         RAY_HIT_BACKGROUND,
1435         /* Denotes ray has to be regenerated */
1436         RAY_TO_REGENERATE,
1437         /* Denotes ray has been regenerated */
1438         RAY_REGENERATED,
1439         /* Denotes ray is moving to next iteration of the branched indirect loop */
1440         RAY_LIGHT_INDIRECT_NEXT_ITER,
1441         RAY_VOLUME_INDIRECT_NEXT_ITER,
1442         RAY_SUBSURFACE_INDIRECT_NEXT_ITER,
1443
1444         /* Ray flags */
1445
1446         /* Flags to denote that the ray is currently evaluating the branched indirect loop */
1447         RAY_BRANCHED_LIGHT_INDIRECT = (1 << 4),
1448         RAY_BRANCHED_VOLUME_INDIRECT = (1 << 5),
1449         RAY_BRANCHED_SUBSURFACE_INDIRECT = (1 << 6),
1450         RAY_BRANCHED_INDIRECT = (RAY_BRANCHED_LIGHT_INDIRECT | RAY_BRANCHED_VOLUME_INDIRECT | RAY_BRANCHED_SUBSURFACE_INDIRECT),
1451
1452         /* Ray is evaluating an iteration of an indirect loop for another thread */
1453         RAY_BRANCHED_INDIRECT_SHARED = (1 << 7),
1454 };
1455
1456 #define ASSIGN_RAY_STATE(ray_state, ray_index, state) (ray_state[ray_index] = ((ray_state[ray_index] & RAY_FLAG_MASK) | state))
1457 #define IS_STATE(ray_state, ray_index, state) ((ray_index) != QUEUE_EMPTY_SLOT && ((ray_state)[(ray_index)] & RAY_STATE_MASK) == (state))
1458 #define ADD_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] | flag))
1459 #define REMOVE_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] & (~flag)))
1460 #define IS_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] & flag)
1461
1462 /* Patches */
1463
1464 #define PATCH_MAX_CONTROL_VERTS 16
1465
1466 /* Patch map node flags */
1467
1468 #define PATCH_MAP_NODE_IS_SET (1 << 30)
1469 #define PATCH_MAP_NODE_IS_LEAF (1u << 31)
1470 #define PATCH_MAP_NODE_INDEX_MASK (~(PATCH_MAP_NODE_IS_SET | PATCH_MAP_NODE_IS_LEAF))
1471
1472 CCL_NAMESPACE_END
1473
1474 #endif /*  __KERNEL_TYPES_H__ */
1475