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