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