Blender V5.3
features.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#pragma once
6
7#include "util/types.h"
8
10
11/* Kernel Feature Flags
12 *
13 * These are set from the host side depending on which features are used by the scene,
14 * either for runtime checks or specialization.
15 *
16 * NOTE: Keep kernel features as defines as they are used by the preprocessor to do
17 * compile time optimization while using adaptive kernel compilation. */
18
19/* Shader nodes. */
20#define KERNEL_FEATURE_NODE_BSDF (1ULL << 0ULL)
21#define KERNEL_FEATURE_NODE_EMISSION (1ULL << 1ULL)
22#define KERNEL_FEATURE_NODE_VOLUME (1ULL << 2ULL)
23#define KERNEL_FEATURE_NODE_BUMP (1ULL << 3ULL)
24#define KERNEL_FEATURE_NODE_BUMP_STATE (1ULL << 4ULL)
25#define KERNEL_FEATURE_NODE_VORONOI_EXTRA (1ULL << 5ULL)
26#define KERNEL_FEATURE_NODE_RAYTRACE (1ULL << 6ULL)
27#define KERNEL_FEATURE_NODE_AOV (1ULL << 7ULL)
28#define KERNEL_FEATURE_NODE_LIGHT_PATH (1ULL << 8ULL)
29#define KERNEL_FEATURE_NODE_PRINCIPLED_HAIR (1ULL << 9ULL)
30#define KERNEL_FEATURE_NODE_PORTAL (1ULL << 10ULL)
31
32/* Use path tracing kernels. */
33#define KERNEL_FEATURE_PATH_TRACING (1ULL << 11ULL)
34
35/* BVH/sampling kernel features. */
36#define KERNEL_FEATURE_POINTCLOUD (1ULL << 12ULL)
37#define KERNEL_FEATURE_HAIR_RIBBON (1ULL << 13ULL)
38#define KERNEL_FEATURE_HAIR_THICK (1ULL << 14ULL)
39#define KERNEL_FEATURE_HAIR (KERNEL_FEATURE_HAIR_RIBBON | KERNEL_FEATURE_HAIR_THICK)
40#define KERNEL_FEATURE_OBJECT_MOTION (1ULL << 15ULL)
41
42/* Denotes whether baking functionality is needed. */
43#define KERNEL_FEATURE_BAKING (1ULL << 16ULL)
44
45/* Use subsurface scattering materials. */
46#define KERNEL_FEATURE_SUBSURFACE (1ULL << 17ULL)
47
48/* Use volume materials. */
49#define KERNEL_FEATURE_VOLUME (1ULL << 18ULL)
50
51/* Use Transparent shadows */
52#define KERNEL_FEATURE_TRANSPARENT (1ULL << 19ULL)
53
54/* Use shadow catcher. */
55#define KERNEL_FEATURE_SHADOW_CATCHER (1ULL << 20ULL)
56
57/* Light render passes. */
58#define KERNEL_FEATURE_LIGHT_PASSES (1ULL << 21ULL)
59
60/* AO. */
61#define KERNEL_FEATURE_AO_PASS (1ULL << 22ULL)
62#define KERNEL_FEATURE_AO_ADDITIVE (1ULL << 23ULL)
63#define KERNEL_FEATURE_AO (KERNEL_FEATURE_AO_PASS | KERNEL_FEATURE_AO_ADDITIVE)
64
65/* MNEE. */
66#define KERNEL_FEATURE_MNEE (1ULL << 24ULL)
67
68/* Path guiding. */
69#define KERNEL_FEATURE_PATH_GUIDING (1ULL << 25ULL)
70
71/* OSL. */
72#define KERNEL_FEATURE_OSL_SHADING (1ULL << 26ULL)
73#define KERNEL_FEATURE_OSL_CAMERA (1ULL << 27ULL)
74
75/* Light and shadow linking. */
76#define KERNEL_FEATURE_LIGHT_LINKING (1ULL << 28ULL)
77#define KERNEL_FEATURE_SHADOW_LINKING (1ULL << 29ULL)
78
79/* Use denoising kernels and output denoising passes. */
80#define KERNEL_FEATURE_DENOISING (1ULL << 30ULL)
81
82/* Light tree. */
83#define KERNEL_FEATURE_LIGHT_TREE (1ULL << 31ULL)
84
85/* Gaussian splats. */
86#define KERNEL_FEATURE_GSPLATS (1ULL << 32ULL)
87
88/* Shader node feature mask, to specialize shader evaluation for kernels. */
89
90#define KERNEL_FEATURE_NODE_MASK_SURFACE_LIGHT \
91 (KERNEL_FEATURE_NODE_EMISSION | KERNEL_FEATURE_NODE_VORONOI_EXTRA | \
92 KERNEL_FEATURE_NODE_LIGHT_PATH | KERNEL_FEATURE_NODE_PORTAL)
93#define KERNEL_FEATURE_NODE_MASK_SURFACE_BACKGROUND \
94 (KERNEL_FEATURE_NODE_MASK_SURFACE_LIGHT | KERNEL_FEATURE_NODE_AOV)
95#define KERNEL_FEATURE_NODE_MASK_SURFACE_SHADOW \
96 (KERNEL_FEATURE_NODE_BSDF | KERNEL_FEATURE_NODE_EMISSION | KERNEL_FEATURE_NODE_BUMP | \
97 KERNEL_FEATURE_NODE_BUMP_STATE | KERNEL_FEATURE_NODE_VORONOI_EXTRA | \
98 KERNEL_FEATURE_NODE_LIGHT_PATH | KERNEL_FEATURE_NODE_PRINCIPLED_HAIR | \
99 KERNEL_FEATURE_NODE_PORTAL)
100#define KERNEL_FEATURE_NODE_MASK_SURFACE \
101 (KERNEL_FEATURE_NODE_MASK_SURFACE_SHADOW | KERNEL_FEATURE_NODE_RAYTRACE | \
102 KERNEL_FEATURE_NODE_AOV | KERNEL_FEATURE_NODE_LIGHT_PATH)
103#define KERNEL_FEATURE_NODE_MASK_VOLUME \
104 (KERNEL_FEATURE_NODE_EMISSION | KERNEL_FEATURE_NODE_VOLUME | \
105 KERNEL_FEATURE_NODE_VORONOI_EXTRA | KERNEL_FEATURE_NODE_LIGHT_PATH | \
106 KERNEL_FEATURE_NODE_PORTAL)
107#define KERNEL_FEATURE_NODE_MASK_DISPLACEMENT \
108 (KERNEL_FEATURE_NODE_VORONOI_EXTRA | KERNEL_FEATURE_NODE_BUMP | \
109 KERNEL_FEATURE_NODE_BUMP_STATE | KERNEL_FEATURE_NODE_PORTAL)
110#define KERNEL_FEATURE_NODE_MASK_BUMP KERNEL_FEATURE_NODE_MASK_DISPLACEMENT
111
112#define IF_KERNEL_FEATURE(feature) \
113 if constexpr ((node_feature_mask & (KERNEL_FEATURE_##feature)) != 0U)
114#define IF_KERNEL_NODES_FEATURE(feature) \
115 if constexpr ((node_feature_mask & (KERNEL_FEATURE_NODE_##feature)) != 0U)
116#define IF_NOT_KERNEL_NODES_FEATURE(feature) \
117 if constexpr ((node_feature_mask & (KERNEL_FEATURE_NODE_##feature)) == 0U)
118
119/* Kernel Feature Guards
120 *
121 * These are used throughout the code to disable code for certain features entirely.
122 * They can be commented out for faster builds, or to measure the performance impact
123 * of the existence of the extra code in the kernel.
124 *
125 * Commenting out the first set of feature guards should work well to reduce kernel
126 * compile time while still working for many scenes. */
127
128#define __AO__
129#define __LIGHT_LINKING__
130#define __MNEE__
131#define __OBJECT_MOTION__
132#define __POINTCLOUD__
133#define __PRINCIPLED_HAIR__
134#define __SHADER_RAYTRACE__
135#define __SHADOW_CATCHER__
136#define __SHADOW_LINKING__
137#define __GSPLATS__
138#define __SUBSURFACE__
139#define __TRANSPARENT_SHADOWS__
140#define __VOLUME__
141
142#define __CAUSTICS_TRICKS__
143#define __CLAMP_SAMPLE__
144#define __DENOISING_FEATURES__
145#define __DPDU__
146#define __HAIR__
147#define __LIGHT_TREE__
148#define __PASSES__
149#define __RAY_DIFFERENTIALS__
150#define __VISIBILITY_FLAG__
151#define __SVM__
152#define __SPECTRAL__
153
154/* Device specific features */
155
156#ifdef WITH_OSL
157# define __OSL__
158# ifdef __KERNEL_OPTIX__
159/* Kernels with OSL support are built separately in OptiX and don't need SVM. */
160# undef __SVM__
161# endif
162#endif
163#ifndef __KERNEL_GPU__
164# if defined(WITH_PATH_GUIDING)
165# define __PATH_GUIDING__
166# endif
167# define __VOLUME_RECORD_ALL__
168#endif /* !__KERNEL_GPU__ */
169
170/* Scene-based selective features compilation. */
171
172#ifdef __KERNEL_FEATURES__
173# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_OBJECT_MOTION)
174# undef __OBJECT_MOTION__
175# endif
176# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_HAIR)
177# undef __HAIR__
178# endif
179# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_POINTCLOUD)
180# undef __POINTCLOUD__
181# endif
182# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_VOLUME)
183# undef __VOLUME__
184# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_TRANSPARENT)
185# undef __TRANSPARENT_SHADOWS__
186# endif
187# endif
188# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_SUBSURFACE)
189# undef __SUBSURFACE__
190# endif
191# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_SHADOW_CATCHER)
192# undef __SHADOW_CATCHER__
193# endif
194# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_DENOISING)
195# undef __DENOISING_FEATURES__
196# endif
197# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_AO)
198# undef __AO__
199# endif
200# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_MNEE)
201# undef __MNEE__
202# endif
203# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_PATH_GUIDING)
204# undef __PATH_GUIDING__
205# endif
206# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_NODE_PRINCIPLED_HAIR)
207# undef __PRINCIPLED_HAIR__
208# endif
209# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_LIGHT_LINKING)
210# undef __LIGHT_LINKING__
211# endif
212# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_SHADOW_LINKING)
213# undef __SHADOW_LINKING__
214# endif
215# if !(__KERNEL_FEATURES__ & KERNEL_FEATURE_GSPLATS)
216# undef __GSPLATS__
217# endif
218#endif
219
220#ifdef WITH_CYCLES_DEBUG_NAN
221# define __KERNEL_DEBUG_NAN__
222#endif
223
224/* Features that enable others */
225
226#if defined(__SUBSURFACE__) || defined(__SHADER_RAYTRACE__)
227# define __BVH_LOCAL__
228#endif
229
230/* Feature mask for integrator states, to allocate state memory only when
231 * certain features are on or off. */
232
236
237 explicit KernelFeatureRequest(const uint64_t on) : on(on), off(0) {}
239
240 bool test(const uint64_t features) const
241 {
242 return (features & on) && !(features & off);
243 }
244};
245
unsigned long long int uint64_t
#define CCL_NAMESPACE_END
KernelFeatureRequest(const uint64_t on, const uint64_t off)
Definition features.h:238
bool test(const uint64_t features) const
Definition features.h:240
KernelFeatureRequest(const uint64_t on)
Definition features.h:237