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