Blender V5.3
denoise.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 "graph/node.h"
8
10
20
21/* COnstruct human-readable string which denotes the denoiser type. */
23
24using DenoiserTypeMask = int;
25
36
37using DenoiserPassMask = int;
38
40 /* Best quality of the result without extra processing time, but requires guiding passes to be
41 * noise-free. */
43
44 /* Denoise color and guiding passes together.
45 * Improves quality when guiding passes are noisy using least amount of extra processing time. */
47
48 /* Prefilter noisy guiding passes before denoising color.
49 * Improves quality when guiding passes are noisy using extra processing time. */
51
53};
54
61
62/* NOTE: Is not a real scene node. Using Node API for ease of (de)serialization.
63 * The default values here do not really matter as they are always initialized from the
64 * Integrator node. */
65class DenoiseParams : public Node {
66 public:
68
69 /* Apply denoiser to image. */
70 bool use = false;
71
72 /* Denoiser type. */
74
75 /* Viewport start sample. */
76 int start_sample = 0;
77
78 /* Auxiliary passes. */
80
81 /* Configure the denoiser to use motion vectors, previous image and a temporally stable model. */
82 bool temporally_stable = false;
83
84 /* If true, then allow, if supported, OpenImageDenoise to use GPU device.
85 * If false, then OpenImageDenoise will always use CPU regardless of GPU device presence. */
86 bool use_gpu = true;
87
90 float upscale_factor = 1.0f;
91
92 static const NodeEnum *get_type_enum();
93 static const NodeEnum *get_prefilter_enum();
94 static const NodeEnum *get_quality_enum();
95
97};
98
float upscale_factor
Definition denoise.h:90
static const NodeEnum * get_quality_enum()
Definition denoise.cpp:54
DenoiserType type
Definition denoise.h:73
bool temporally_stable
Definition denoise.h:82
DenoiserQuality quality
Definition denoise.h:89
static const NodeEnum * get_prefilter_enum()
Definition denoise.cpp:41
static const NodeEnum * get_type_enum()
Definition denoise.cpp:28
bool use_gpu
Definition denoise.h:86
DenoiserPassMask passes
Definition denoise.h:79
int start_sample
Definition denoise.h:76
DenoiserPrefilter prefilter
Definition denoise.h:88
NODE_DECLARE bool use
Definition denoise.h:70
CCL_NAMESPACE_BEGIN const char * denoiserTypeToHumanReadable(DenoiserType type)
Definition denoise.cpp:9
int DenoiserTypeMask
Definition denoise.h:24
DenoiserQuality
Definition denoise.h:55
@ DENOISER_QUALITY_FAST
Definition denoise.h:58
@ DENOISER_QUALITY_NUM
Definition denoise.h:59
@ DENOISER_QUALITY_BALANCED
Definition denoise.h:57
@ DENOISER_QUALITY_HIGH
Definition denoise.h:56
DenoiserPrefilter
Definition denoise.h:39
@ DENOISER_PREFILTER_FAST
Definition denoise.h:46
@ DENOISER_PREFILTER_NONE
Definition denoise.h:42
@ DENOISER_PREFILTER_NUM
Definition denoise.h:52
@ DENOISER_PREFILTER_ACCURATE
Definition denoise.h:50
int DenoiserPassMask
Definition denoise.h:37
DenoiserPass
Definition denoise.h:26
@ DENOISER_PASS_NONE
Definition denoise.h:27
@ DENOISER_PASS_DEPTH
Definition denoise.h:32
@ DENOISER_PASS_ROUGHNESS
Definition denoise.h:31
@ DENOISER_PASS_NORMAL
Definition denoise.h:30
@ DENOISER_PASS_ALBEDO
Definition denoise.h:28
@ DENOISER_PASS_SPECULAR_ALBEDO
Definition denoise.h:29
@ DENOISER_PASS_BACKWARD_MOTION
Definition denoise.h:33
@ DENOISER_PASS_SPECULAR_MOTION
Definition denoise.h:34
DenoiserType
Definition denoise.h:11
@ DENOISER_NONE
Definition denoise.h:17
@ DENOISER_OPTIX
Definition denoise.h:12
@ DENOISER_OPENIMAGEDENOISE
Definition denoise.h:13
@ DENOISER_ALL
Definition denoise.h:18
@ DENOISER_NUM
Definition denoise.h:15
@ DENOISER_DLSS
Definition denoise.h:14
#define CCL_NAMESPACE_END
#define NODE_DECLARE
Definition node_type.h:150
Node(const NodeType *type, ustring name=ustring())