Blender
V5.3
intern
cycles
scene
integrator.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 "
kernel/types.h
"
8
9
#include "
device/denoise.h
"
/* For the parameters and type enum. */
10
#include "
graph/node.h
"
11
#include "
integrator/adaptive_sampling.h
"
12
#include "integrator/guiding.h"
13
14
CCL_NAMESPACE_BEGIN
15
16
class
Device
;
17
class
DeviceScene
;
18
class
Scene
;
19
20
struct
HaltonSequence
{
21
HaltonSequence
()
22
{
23
reset
();
24
}
25
26
void
reset
()
27
{
28
a2
= 0;
29
b2
= 1;
30
a3
= 0;
31
b3
= 1;
32
}
33
float2
next
();
34
35
int
a2
,
b2
;
36
int
a3
,
b3
;
37
};
38
39
class
Integrator
:
public
Node
{
40
public
:
41
NODE_DECLARE
42
43
NODE_SOCKET_API
(
int
, min_bounce)
44
NODE_SOCKET_API
(
int
, max_bounce)
45
46
NODE_SOCKET_API
(
int
, max_diffuse_bounce)
47
NODE_SOCKET_API
(
int
, max_glossy_bounce)
48
NODE_SOCKET_API
(
int
, max_transmission_bounce)
49
NODE_SOCKET_API
(
int
, max_volume_bounce)
50
51
#ifdef WITH_CYCLES_DEBUG
52
NODE_SOCKET_API
(
DirectLightSamplingType
, direct_light_sampling_type)
53
#endif
54
55
NODE_SOCKET_API
(
int
, transparent_min_bounce)
56
NODE_SOCKET_API
(
int
, transparent_max_bounce)
57
58
NODE_SOCKET_API
(
int
, ao_bounces)
59
NODE_SOCKET_API
(
float
, ao_factor)
60
NODE_SOCKET_API
(
float
, ao_distance)
61
NODE_SOCKET_API
(
float
, ao_additive_factor)
62
63
NODE_SOCKET_API
(
bool
, volume_ray_marching)
64
NODE_SOCKET_API
(
int
, volume_max_steps)
65
NODE_SOCKET_API
(
float
, volume_step_rate)
66
67
NODE_SOCKET_API
(
bool
, use_guiding);
68
NODE_SOCKET_API
(
bool
, deterministic_guiding);
69
NODE_SOCKET_API
(
bool
, use_surface_guiding);
70
NODE_SOCKET_API
(
float
, surface_guiding_probability);
71
NODE_SOCKET_API
(
bool
, use_volume_guiding);
72
NODE_SOCKET_API
(
float
, volume_guiding_probability);
73
NODE_SOCKET_API
(
int
, guiding_training_samples);
74
NODE_SOCKET_API
(
bool
, use_guiding_direct_light);
75
NODE_SOCKET_API
(
bool
, use_guiding_mis_weights);
76
NODE_SOCKET_API
(
GuidingDistributionType
, guiding_distribution_type);
77
NODE_SOCKET_API
(
GuidingDirectionalSamplingType
, guiding_directional_sampling_type);
78
NODE_SOCKET_API
(
float
, guiding_roughness_threshold);
79
80
NODE_SOCKET_API
(
bool
, caustics_reflective)
81
NODE_SOCKET_API
(
bool
, caustics_refractive)
82
NODE_SOCKET_API
(
float
, filter_glossy)
83
84
NODE_SOCKET_API
(
bool
, use_direct_light);
85
NODE_SOCKET_API
(
bool
, use_indirect_light);
86
NODE_SOCKET_API
(
bool
, use_diffuse);
87
NODE_SOCKET_API
(
bool
, use_glossy);
88
NODE_SOCKET_API
(
bool
, use_transmission);
89
NODE_SOCKET_API
(
bool
, use_emission);
90
91
NODE_SOCKET_API
(
int
, seed)
92
93
NODE_SOCKET_API
(
float
, sample_clamp_direct)
94
NODE_SOCKET_API
(
float
, sample_clamp_indirect)
95
NODE_SOCKET_API
(
bool
, motion_blur)
96
97
/* Maximum number of samples, beyond which we are likely to run into
98
* precision issues for sampling patterns. */
99
static const
int
MAX_SAMPLES
= (1 << 24);
100
101
NODE_SOCKET_API
(
int
, aa_samples)
102
103
NODE_SOCKET_API
(
bool
, use_sample_subset)
104
NODE_SOCKET_API
(
int
, sample_subset_offset)
105
NODE_SOCKET_API
(
int
, sample_subset_length)
106
107
NODE_SOCKET_API
(
bool
, use_light_tree)
108
NODE_SOCKET_API
(
float
, light_sampling_threshold)
109
110
NODE_SOCKET_API
(
bool
, use_adaptive_sampling)
111
NODE_SOCKET_API
(
int
, adaptive_min_samples)
112
NODE_SOCKET_API
(
float
, adaptive_threshold)
113
114
NODE_SOCKET_API
(
SamplingPattern
, sampling_pattern)
115
NODE_SOCKET_API
(
float
, scrambling_distance)
116
117
NODE_SOCKET_API
(
bool
, use_pixel_jitter);
118
NODE_SOCKET_API
(
bool
, use_custom_pixel_jitter_sample);
119
NODE_SOCKET_API_ARRAY
(
array
<
float
>, custom_pixel_jitter_sample);
120
HaltonSequence
pixel_jitter_state
;
121
int
pixel_jitter_frame
= 0;
122
123
NODE_SOCKET_API
(
bool
, use_denoise);
124
NODE_SOCKET_API
(
DenoiserType
, denoiser_type);
125
NODE_SOCKET_API
(
int
, denoise_start_sample);
126
NODE_SOCKET_API
(
DenoiserPassMask
, denoiser_passes);
127
NODE_SOCKET_API
(
DenoiserPrefilter
, denoiser_prefilter);
128
NODE_SOCKET_API
(
bool
, denoise_use_gpu);
129
NODE_SOCKET_API
(
DenoiserQuality
, denoiser_quality);
130
NODE_SOCKET_API
(
float
, denoiser_upscale_factor);
131
132
enum : uint32_t {
133
AO_PASS_MODIFIED
= (1 << 0),
134
OBJECT_MANAGER
= (1 << 1),
135
136
/* tag everything in the manager for an update */
137
UPDATE_ALL
= ~0u,
138
139
UPDATE_NONE
= 0u,
140
};
141
142
bool
shadow_catcher_needs_recalc_
=
true
;
143
bool
scene_has_shadow_catcher_
=
false
;
144
145
Integrator
();
146
~Integrator
()
override
;
147
148
void
device_update
(
Device
*device,
DeviceScene
*dscene,
Scene
*scene);
149
void
device_free
(
Device
*device,
DeviceScene
*dscene,
bool
force_free =
false
);
150
151
void
tag_update
(
Scene
*scene,
const
uint32_t flag);
152
153
uint64_t
get_kernel_features
()
const
;
154
155
AdaptiveSampling
get_adaptive_sampling
()
const
;
156
DenoiseParams
get_denoise_params
()
const
;
157
GuidingParams
get_guiding_params
(
const
Device
*device)
const
;
158
159
bool
is_modified
()
const
;
160
void
clear_modified
();
161
};
162
163
CCL_NAMESPACE_END
uint64_t
unsigned long long int uint64_t
Definition
btConvexHullComputer.cpp:33
AdaptiveSampling
Definition
integrator/adaptive_sampling.h:9
DenoiseParams
Definition
denoise.h:65
DeviceScene
Definition
devicescene.h:16
Device
Definition
device/device.h:154
Integrator::tag_update
void tag_update(Scene *scene, const uint32_t flag)
Definition
integrator.cpp:435
Integrator::device_update
void device_update(Device *device, DeviceScene *dscene, Scene *scene)
Definition
integrator.cpp:203
Integrator::pixel_jitter_state
HaltonSequence pixel_jitter_state
Definition
integrator.h:120
Integrator::get_kernel_features
uint64_t get_kernel_features() const
Definition
integrator.cpp:462
Integrator::get_denoise_params
DenoiseParams get_denoise_params() const
Definition
integrator.cpp:535
Integrator::NODE_SOCKET_API_ARRAY
NODE_SOCKET_API_ARRAY(array< float >, custom_pixel_jitter_sample)
Integrator::~Integrator
~Integrator() override
Integrator::NODE_SOCKET_API
NODE_DECLARE NODE_SOCKET_API(bool, use_guiding)
Integrator::scene_has_shadow_catcher_
bool scene_has_shadow_catcher_
Definition
integrator.h:143
Integrator::Integrator
Integrator()
Definition
integrator.cpp:199
Integrator::pixel_jitter_frame
int pixel_jitter_frame
Definition
integrator.h:121
Integrator::get_adaptive_sampling
AdaptiveSampling get_adaptive_sampling() const
Definition
integrator.cpp:477
Integrator::device_free
void device_free(Device *device, DeviceScene *dscene, bool force_free=false)
Definition
integrator.cpp:419
Integrator::get_guiding_params
GuidingParams get_guiding_params(const Device *device) const
Definition
integrator.cpp:562
Integrator::is_modified
bool is_modified() const
Definition
integrator.cpp:424
Integrator::MAX_SAMPLES
static const int MAX_SAMPLES
Definition
integrator.h:99
Integrator::clear_modified
void clear_modified()
Definition
integrator.cpp:429
Integrator::shadow_catcher_needs_recalc_
bool shadow_catcher_needs_recalc_
Definition
integrator.h:142
Integrator::UPDATE_NONE
@ UPDATE_NONE
Definition
integrator.h:139
Integrator::UPDATE_ALL
@ UPDATE_ALL
Definition
integrator.h:137
Integrator::OBJECT_MANAGER
@ OBJECT_MANAGER
Definition
integrator.h:134
Integrator::AO_PASS_MODIFIED
@ AO_PASS_MODIFIED
Definition
integrator.h:133
Scene
Definition
scene.h:133
array
Definition
cycles/util/array.h:22
denoise.h
DenoiserQuality
DenoiserQuality
Definition
denoise.h:55
DenoiserPrefilter
DenoiserPrefilter
Definition
denoise.h:39
DenoiserPassMask
int DenoiserPassMask
Definition
denoise.h:37
DenoiserType
DenoiserType
Definition
denoise.h:11
CCL_NAMESPACE_END
#define CCL_NAMESPACE_END
Definition
device/cuda/compat.h:10
node.h
adaptive_sampling.h
types.h
DirectLightSamplingType
DirectLightSamplingType
Definition
kernel/types.h:593
GuidingDirectionalSamplingType
GuidingDirectionalSamplingType
Definition
kernel/types.h:554
SamplingPattern
SamplingPattern
Definition
kernel/types.h:133
GuidingDistributionType
GuidingDistributionType
Definition
kernel/types.h:544
CCL_NAMESPACE_BEGIN
Definition
python.cpp:41
NODE_DECLARE
#define NODE_DECLARE
Definition
node_type.h:150
GuidingParams
Definition
integrator/guiding.h:11
HaltonSequence
Definition
integrator.h:20
HaltonSequence::reset
void reset()
Definition
integrator.h:26
HaltonSequence::a2
int a2
Definition
integrator.h:35
HaltonSequence::a3
int a3
Definition
integrator.h:36
HaltonSequence::b2
int b2
Definition
integrator.h:35
HaltonSequence::HaltonSequence
HaltonSequence()
Definition
integrator.h:21
HaltonSequence::next
float2 next()
Definition
integrator.cpp:47
HaltonSequence::b3
int b3
Definition
integrator.h:36
Node::Node
Node(const NodeType *type, ustring name=ustring())
Definition
graph/node.cpp:18
float2
Definition
types_float2.h:13
Generated on
for Blender by
doxygen
1.18.0