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