Blender V5.3
node_composite_luminance_key.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2006 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include "BLI_math_base.hh"
6#include "BLI_math_vector.hh"
8
10
11#include "NOD_multi_function.hh"
12
14
15#include "GPU_material.hh"
16
17#include "COM_result.hh"
18
20
22
24{
25 b.use_custom_socket_order();
26 b.allow_any_socket_order();
27 b.is_function_node();
28 b.add_input<decl::Color>("Image"_ustr).default_value({1.0f, 1.0f, 1.0f, 1.0f}).hide_value();
29 b.add_output<decl::Color>("Image"_ustr).align_with_previous();
30 b.add_output<decl::Float>("Matte"_ustr);
31
32 b.add_input<decl::Float>("Minimum"_ustr)
33 .default_value(0.0f)
35 .min(0.0f)
36 .max(1.0f)
37 .description("Pixels whose luminance values lower than this minimum are keyed");
38 b.add_input<decl::Float>("Maximum"_ustr)
39 .default_value(1.0f)
41 .min(0.0f)
42 .max(1.0f)
43 .description("Pixels whose luminance values higher than this maximum are not keyed");
44}
45
46using namespace blender::compositor;
47
48static int node_gpu_material(GPUMaterial *material,
49 bNode *node,
50 bNodeExecData * /*execdata*/,
51 GPUNodeStack *inputs,
52 GPUNodeStack *outputs)
53{
54 float luminance_coefficients[3];
56
57 return GPU_stack_link(material,
58 node,
59 "node_composite_luminance_matte",
60 inputs,
61 outputs,
62 GPU_constant(luminance_coefficients));
63}
64
66
67static void luminance_matte(const float4 &color,
68 const float &minimum,
69 const float &maximum,
70 const float3 luminance_coefficients,
72 float &matte)
73{
74 float luminance = math::dot(color.xyz(), luminance_coefficients);
75 float alpha = math::clamp((luminance - minimum) / (maximum - minimum), 0.0f, 1.0f);
76 matte = math::min(alpha, color.w);
77 result = color * matte;
78}
79
81{
82 float3 luminance_coefficients;
84
86 return mf::build::SI3_SO2<Color, float, float, Color, float>(
87 "Luminance Key",
88 [=](const Color &color,
89 const float &minimum,
90 const float &maximum,
91 Color &output_color,
92 float &matte) -> void {
93 float4 out_color;
95 float4(color), minimum, maximum, luminance_coefficients, out_color, matte);
96 output_color = Color(out_color);
97 },
98 mf::build::exec_presets::SomeSpanOrSingle<0>());
99 });
100}
101
102static void node_register()
103{
104 static bke::bNodeType ntype;
105
106 cmp_node_type_base(&ntype, "CompositorNodeLumaMatte"_ustr, CMP_NODE_LUMA_MATTE);
107 ntype.ui_name = "Luminance Key";
108 ntype.ui_description = "Create a matte based on luminance (brightness) difference";
109 ntype.enum_name_legacy = "LUMA_MATTE";
110 ntype.nclass = NODE_CLASS_MATTE;
111 ntype.declare = node_declare;
112 ntype.flag |= NODE_PREVIEW;
115
117}
119
120} // namespace blender::nodes::node_composite_luminance_key_cc
#define NODE_CLASS_MATTE
Definition BKE_node.hh:485
#define CMP_NODE_LUMA_MATTE
#define NOD_REGISTER_NODE(REGISTER_FUNC)
void construct_and_set_matching_fn_cb(Fn &&create_multi_function)
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
ColorSceneLinear4f< eAlpha::Premultiplied > Color
Definition COM_result.hh:96
T clamp(const T &a, const T &min, const T &max)
T dot(const QuaternionBase< T > &a, const QuaternionBase< T > &b)
T min(const T &a, const T &b)
static void node_build_multi_function(nodes::NodeMultiFunctionBuilder &builder)
static int node_gpu_material(GPUMaterial *material, bNode *node, bNodeExecData *, GPUNodeStack *inputs, GPUNodeStack *outputs)
static void luminance_matte(const float4 &color, const float &minimum, const float &maximum, const float3 luminance_coefficients, float4 &result, float &matte)
bool GPU_stack_link(GPUMaterial *mat, const bNode *node, const char *name, GPUNodeStack *in, GPUNodeStack *out,...)
BLI_INLINE void IMB_colormanagement_get_luminance_coefficients(float r_rgb[3])
GPUNodeLink * GPU_constant(const float *num)
@ PROP_FACTOR
Definition RNA_types.hh:308
void cmp_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
Defines a node type.
Definition BKE_node.hh:265
std::string ui_description
Definition BKE_node.hh:271
NodeGPUExecFunction gpu_fn
Definition BKE_node.hh:373
NodeMultiFunctionBuildFunction build_multi_function
Definition BKE_node.hh:382
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeDeclareFunction declare
Definition BKE_node.hh:393