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