Blender V5.3
node_composite_convert_to_display.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2021 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include "DNA_color_types.h"
6
7#include "BKE_colortools.hh"
8
10
12#include "UI_resources.hh"
13
15
16#include "GPU_shader.hh"
17
18#include "COM_node_operation.hh"
20#include "COM_utilities.hh"
21
22#include "RNA_access.hh"
23
25
27
29
31{
32 b.add_input<decl::Color>("Image"_ustr)
33 .default_value({1.0f, 1.0f, 1.0f, 1.0f})
34 .structure_type(StructureType::Dynamic);
35 b.add_input<decl::Bool>("Invert"_ustr)
36 .default_value(false)
37 .description(
38 "Convert from display to scene linear instead. Not all view transforms can be inverted "
39 "exactly, and the result may not match the original scene linear image");
40
41 b.add_output<decl::Color>("Image"_ustr).structure_type(StructureType::Dynamic);
42}
43
44static void node_init(bNodeTree * /*ntree*/, bNode *node)
45{
46 NodeConvertToDisplay *nctd = MEM_new<NodeConvertToDisplay>(__func__);
50 node->storage = nctd;
51}
52
53static void node_free(bNode *node)
54{
55 NodeConvertToDisplay *nctd = static_cast<NodeConvertToDisplay *>(node->storage);
57 MEM_delete(nctd);
58}
59
60static void node_copy(bNodeTree * /*dest_ntree*/, bNode *dest_node, const bNode *src_node)
61{
62 NodeConvertToDisplay *dest = MEM_new<NodeConvertToDisplay>(__func__);
63 const NodeConvertToDisplay *src = static_cast<const NodeConvertToDisplay *>(src_node->storage);
66 dest_node->storage = dest;
67}
68
69static void node_blend_write(const bNodeTree & /*tree*/, const bNode &node, BlendWriter &writer)
70{
71 const NodeConvertToDisplay *nctd = static_cast<const NodeConvertToDisplay *>(node.storage);
73}
74
75static void node_blend_read(bNodeTree & /*tree*/, bNode &node, BlendDataReader &reader)
76{
77 NodeConvertToDisplay *nctd = static_cast<NodeConvertToDisplay *>(node.storage);
79}
80
81static void node_draw_buttons(ui::Layout &layout, bContext * /*C*/, PointerRNA *ptr)
82{
83 PointerRNA display_ptr = RNA_pointer_get(ptr, "display_settings");
84 PointerRNA view_ptr = RNA_pointer_get(ptr, "view_settings");
85
86 layout.prop(&display_ptr, "display_device", UI_ITEM_NONE, std::nullopt, ICON_NONE);
87 layout.prop(&view_ptr, "view_transform", UI_ITEM_NONE, std::nullopt, ICON_NONE);
88 layout.prop(&view_ptr, "look", UI_ITEM_NONE, IFACE_("Look"), ICON_NONE);
89}
90
91using namespace blender::compositor;
92
94 public:
96
98 {
99 return this->get_input("Invert").get_single_value_default<bool>();
100 }
101
102 void execute() override
103 {
104 const Result &input_image = this->get_input("Image");
105
106 if (input_image.is_single_value()) {
108 return;
109 }
110 if (this->context().use_gpu()) {
111 execute_gpu();
112 }
113 else {
114 execute_cpu();
115 }
116 }
117
119 {
120 const NodeConvertToDisplay &nctd = node_storage(node());
121
124
126
127 /* A null shader indicates that the conversion shader is just a stub implementation since OCIO
128 * is disabled at compile time, so pass the input through in that case. */
129 const Result &input_image = this->get_input("Image");
130 Result &output_image = this->get_result("Image");
131 if (!shader) {
132 output_image.share_data(input_image);
133 return;
134 }
135
136 input_image.bind_as_texture(shader, ocio_shader.input_sampler_name());
137
138 const Domain domain = compute_domain();
139 output_image.allocate_texture(domain);
140 output_image.bind_as_image(shader, ocio_shader.output_image_name());
141
143
144 input_image.unbind_as_texture();
145 output_image.unbind_as_image();
146 ocio_shader.unbind_shader_and_resources();
147 }
148
150 {
151 const NodeConvertToDisplay &nctd = node_storage(node());
154
155 Result &input_image = get_input("Image");
156
157 const Domain domain = compute_domain();
158 Result &output_image = get_result("Image");
159 output_image.allocate_texture(domain);
160
161 parallel_for(domain.data_size, [&](const int2 texel) {
162 output_image.store_pixel(texel, input_image.load_pixel<Color>(texel));
163 });
164
165 color_processor.apply(static_cast<float *>(output_image.cpu_data_for_write().data()),
166 domain.data_size.x,
167 domain.data_size.y,
168 input_image.channels_count(),
169 false);
170 }
171
173 {
174 const NodeConvertToDisplay &nctd = node_storage(node());
177
178 Result &input_image = get_input("Image");
179 Color color = input_image.get_single_value<Color>();
180
181 color_processor.apply_pixel(color, 3);
182
183 Result &output_image = get_result("Image");
184 output_image.allocate_single_value();
185 output_image.set_single_value(color);
186 }
187};
188
190{
191 return new ConvertToDisplayOperation(context, node);
192}
193
194static void node_register()
195{
196 static bke::bNodeType ntype;
197
198 cmp_node_type_base(&ntype, "CompositorNodeConvertToDisplay"_ustr, CMP_NODE_CONVERT_TO_DISPLAY);
199 ntype.ui_name = "Convert to Display";
200 ntype.ui_description =
201 "Convert from scene linear to display color space, with a view transform and look for tone "
202 "mapping";
203 ntype.enum_name_legacy = "CONVERT_TO_DISPLAY";
205 ntype.declare = node_declare;
208 ntype.initfunc = node_init;
209 bke::node_type_storage(ntype, "NodeConvertToDisplay", node_free, node_copy);
214
216}
218
219} // namespace blender::nodes::node_composite_convert_to_display_cc
#define NODE_CLASS_CONVERTER
Definition BKE_node.hh:484
#define NODE_STORAGE_FUNCS(StorageT)
Definition BKE_node.hh:1353
#define CMP_NODE_CONVERT_TO_DISPLAY
#define IFACE_(msgid)
#define NOD_REGISTER_NODE(REGISTER_FUNC)
#define UI_ITEM_NONE
static ColormanageProcessor display_processor_new(const ColorManagedViewSettings *view_settings, const ColorManagedDisplaySettings *display_settings, ColorManagedDisplaySpace display_space=DISPLAY_SPACE_DRAW, bool inverse=false, const char *from_colorspace=nullptr)
void apply(float *buffer, int width, int height, int channels, bool predivide) const
void apply_pixel(float *pixel, int channels) const
NodeOperation(Context &context, const bNode &node)
OCIOToDisplayShader & get(Context &context, const ColorManagedDisplaySettings &display_settings, const ColorManagedViewSettings &view_settings, const bool inverse)
Result & get_result(StringRef identifier)
Definition operation.cc:40
Context & context() const
Definition operation.cc:57
Result & get_input(StringRef identifier) const
Definition operation.cc:35
virtual Domain compute_domain()
Definition operation.cc:62
void share_data(const Result &source)
Definition result.cc:996
void allocate_texture(const Domain domain, const bool from_pool=true, const std::optional< ResultStorageType > storage_type=std::nullopt)
Definition result.cc:554
void unbind_as_texture() const
Definition result.cc:964
int64_t channels_count() const
Definition result.cc:1180
void set_single_value(const T &value)
GMutableSpan cpu_data_for_write()
void bind_as_texture(gpu::Shader *shader, const char *texture_name) const
Definition result.cc:854
void unbind_as_image() const
Definition result.cc:990
void bind_as_image(gpu::Shader *shader, const char *image_name, bool read=false) const
Definition result.cc:951
const T & get_single_value() const
OCIOToDisplayShaderContainer ocio_to_display_shaders
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
void node_type_storage(bNodeType &ntype, std::optional< StringRefNull > storagename, void(*freefunc)(bNode *node), void(*copyfunc)(bNodeTree *dest_ntree, bNode *dest_node, const bNode *src_node))
Definition node.cc:6166
void compute_dispatch_threads_at_least(gpu::Shader *shader, int2 threads_range, int2 local_size=int2(16))
Definition utilities.cc:235
ColorSceneLinear4f< eAlpha::Premultiplied > Color
Definition COM_result.hh:96
void parallel_for(const int2 range, const Function &function)
static void node_copy(bNodeTree *, bNode *dest_node, const bNode *src_node)
static void node_blend_read(bNodeTree &, bNode &node, BlendDataReader &reader)
static void node_blend_write(const bNodeTree &, const bNode &node, BlendWriter &writer)
static NodeOperation * get_compositor_operation(Context &context, const bNode &node)
static void node_draw_buttons(ui::Layout &layout, bContext *, PointerRNA *ptr)
@ COLORMANAGE_VIEW_ONLY_VIEW_LOOK
void BKE_color_managed_view_settings_init(ColorManagedViewSettings *view_settings, const ColorManagedDisplaySettings *display_settings, const char *view_transform)
void BKE_color_managed_display_settings_init(ColorManagedDisplaySettings *settings)
void BKE_color_managed_view_settings_blend_read_data(BlendDataReader *reader, ColorManagedViewSettings *settings)
void BKE_color_managed_view_settings_copy(ColorManagedViewSettings *new_settings, const ColorManagedViewSettings *settings)
void BKE_color_managed_display_settings_copy(ColorManagedDisplaySettings *new_settings, const ColorManagedDisplaySettings *settings)
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
void BKE_color_managed_view_settings_free(ColorManagedViewSettings *settings)
void BKE_color_managed_view_settings_blend_write(BlendWriter *writer, const ColorManagedViewSettings *settings)
void cmp_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
ColorManagedDisplaySettings display_settings
ColorManagedViewSettings view_settings
static constexpr int _160
Definition BKE_node.hh:246
static constexpr int _240
Definition BKE_node.hh:250
Defines a node type.
Definition BKE_node.hh:265
void(*) draw_buttons(ui::Layout &, bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:290
NodeBlendWriteFunction blend_write_storage_content
Definition BKE_node.hh:421
std::string ui_description
Definition BKE_node.hh:271
NodeBlendDataReadFunction blend_data_read_storage_content
Definition BKE_node.hh:422
NodeGetCompositorOperationFunction get_compositor_operation
Definition BKE_node.hh:379
void(*) initfunc(bNodeTree *ntree, bNode *node)
Definition BKE_node.hh:320
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeDeclareFunction declare
Definition BKE_node.hh:393
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)