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