Blender V5.3
COM_denoised_auxiliary_pass.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2025 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
7#ifdef WITH_OPENIMAGEDENOISE
8
9# include <cstdint>
10# include <memory>
11# include <string>
12
13# include "BLI_map.hh"
14
15# include <OpenImageDenoise/oidn.hpp>
16
17# include "COM_result.hh"
18
19namespace blender::compositor {
20
21class Context;
22class Result;
23
24enum class DenoisedAuxiliaryPassType : uint8_t {
25 Albedo,
26 Normal,
27};
28
29/* ------------------------------------------------------------------------------------------------
30 * Denoised Auxiliary Pass Key.
31 */
32class DenoisedAuxiliaryPassKey {
33 public:
34 DenoisedAuxiliaryPassType type;
35 oidn::Quality quality;
36
37 DenoisedAuxiliaryPassKey(const DenoisedAuxiliaryPassType type, const oidn::Quality quality);
38
39 uint64_t hash() const;
40};
41
42bool operator==(const DenoisedAuxiliaryPassKey &a, const DenoisedAuxiliaryPassKey &b);
43
44/* -------------------------------------------------------------------------------------------------
45 * Denoised Auxiliary Pass.
46 *
47 * A derived result that stores a denoised version of the auxiliary pass of the given type using
48 * the given quality. */
49class DenoisedAuxiliaryPass {
50 public:
51 Result result;
52
53 public:
54 DenoisedAuxiliaryPass(Context &context,
55 const Result &pass,
56 const DenoisedAuxiliaryPassType type,
57 const oidn::Quality quality);
58
59 ~DenoisedAuxiliaryPass();
60};
61
62/* ------------------------------------------------------------------------------------------------
63 * Denoised Auxiliary Pass Container.
64 */
66 private:
67 Map<DenoisedAuxiliaryPassKey, std::unique_ptr<DenoisedAuxiliaryPass>> map_;
68
69 public:
70 /* Check if there is an available DenoisedAuxiliaryPass derived resource with the given
71 * parameters in the container, if one exists, return it, otherwise, return a newly created one
72 * and add it to the container. */
73 DenoisedAuxiliaryPass &get(Context &context,
74 const Result &pass,
75 const DenoisedAuxiliaryPassType type,
76 const oidn::Quality quality);
77};
78
79} // namespace blender::compositor
80
81#else
82
83namespace blender::compositor {
84
85/* Building without OIDN, define a dummy container. User is not expected to use it if OIDN is not
86 * available. */
88
89} // namespace blender::compositor
90
91#endif
unsigned long long int uint64_t
bool operator==(const BokehKernelKey &a, const BokehKernelKey &b)
std::shared_ptr< const T > get(const GenericKey &key, FunctionRef< std::unique_ptr< T >()> compute_fn)
unsigned char uint8_t
Definition BKE_text.h:79
#define hash
Definition noise_c.cc:156