node_composite_group_output.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2025 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include "BLI_bounds_types.hh"
#include "BLI_math_vector_types.hh"
 
#include "BLT_translation.hh"
 
#include "UI_resources.hh"
 
#include "DNA_space_types.h"
 
#include "GPU_shader.hh"
 
#include "BKE_context.hh"
 
#include "NOD_composite.hh"
#include "NOD_node_extra_info.hh"
 
#include "COM_node_operation.hh"
#include "COM_utilities.hh"
 
namespace blender::nodes::node_composite_group_output_cc {
 
using namespace blender::compositor;
 
class GroupOutputOperation : public NodeOperation {
 public:
  GroupOutputOperation(Context &context, DNode node) : NodeOperation(context, node)
  {
    for (const bNodeSocket *input : node->input_sockets()) {
      if (!is_socket_available(input)) {
        continue;
      }
 
      /* The structure type of the inputs of Group Output nodes are inferred, so we need to
       * manually specify this here. */
      InputDescriptor &descriptor = this->get_input_descriptor(input->identifier);
      descriptor.expects_single_value = false;
    }
  }
 
  void execute() override
  {
    if (!this->context().is_valid_compositing_region()) {
      return;
    }
 
    /* Get the first input to be written to the output. The rest of the inputs are ignored. Only
     * color sockets are supported. */
    const bNodeSocket *input_socket = this->node()->input_sockets()[0];
    if (input_socket->type != SOCK_RGBA) {
      return;
    }
 
    const Result &image = this->get_input(input_socket->identifier);
    if (image.is_single_value()) {
      this->execute_clear(image);
    }
    else {
      this->execute_copy(image);
    }
  }
 
  void execute_clear(const Result &image)
  {
    float4 color = image.get_single_value<float4>();
 
    const Domain domain = this->compute_domain();
    Result output = this->context().get_output(domain);
    if (this->context().use_gpu()) {
      GPU_texture_clear(output, GPU_DATA_FLOAT, color);
    }
    else {
      parallel_for(domain.size, [&](const int2 texel) { output.store_pixel(texel, color); });
    }
  }
 
  void execute_copy(const Result &image)
  {
    if (this->context().use_gpu()) {
      this->execute_copy_gpu(image);
    }
    else {
      this->execute_copy_cpu(image);
    }
  }
 
  void execute_copy_gpu(const Result &image)
  {
    const Domain domain = this->compute_domain();
    Result output = this->context().get_output(domain);
 
    gpu::Shader *shader = this->context().get_shader("compositor_write_output",
                                                     output.precision());
    GPU_shader_bind(shader);
 
    const Bounds<int2> bounds = this->context().get_compositing_region();
    GPU_shader_uniform_2iv(shader, "lower_bound", bounds.min);
    GPU_shader_uniform_2iv(shader, "upper_bound", bounds.max);
 
    image.bind_as_texture(shader, "input_tx");
 
    output.bind_as_image(shader, "output_img");
 
    compute_dispatch_threads_at_least(shader, domain.size);
 
    image.unbind_as_texture();
    output.unbind_as_image();
    GPU_shader_unbind();
  }
 
  void execute_copy_cpu(const Result &image)
  {
    const Domain domain = this->compute_domain();
    Result output = this->context().get_output(domain);
 
    const Bounds<int2> bounds = this->context().use_context_bounds_for_input_output() ?
                                    this->context().get_compositing_region() :
                                    Bounds<int2>(int2(0, 0), domain.size);
    parallel_for(domain.size, [&](const int2 texel) {
      const int2 output_texel = texel + bounds.min;
      if (output_texel.x > bounds.max.x || output_texel.y > bounds.max.y) {
        return;
      }
      output.store_pixel(texel + bounds.min, image.load_pixel<float4>(texel));
    });
  }
 
  /* The operation domain has the same size as the compositing region without any transformations
   * applied. */
  Domain compute_domain() override
  {
    if (this->context().use_context_bounds_for_input_output()) {
      return Domain(this->context().get_compositing_region_size());
    }
    return NodeOperation::compute_domain();
  }
};
 
}  // namespace blender::nodes::node_composite_group_output_cc
 
namespace blender::nodes {
 
compositor::NodeOperation *get_group_output_compositor_operation(compositor::Context &context,
                                                                 DNode node)
{
  return new node_composite_group_output_cc::GroupOutputOperation(context, node);
}
 
void get_compositor_group_output_extra_info(blender::nodes::NodeExtraInfoParams &parameters)
{
  if (parameters.tree.type != NTREE_COMPOSIT) {
    return;
  }
 
  SpaceNode *space_node = CTX_wm_space_node(&parameters.C);
  if (space_node->edittree != space_node->nodetree) {
    return;
  }
 
  Span<const bNodeSocket *> group_outputs = parameters.node.input_sockets().drop_back(1);
  if (group_outputs.is_empty()) {
    blender::nodes::NodeExtraInfoRow row;
    row.text = IFACE_("No Output");
    row.icon = ICON_ERROR;
    row.tooltip = TIP_("Node group must have a Color output socket");
    parameters.rows.append(std::move(row));
    return;
  }
 
  if (group_outputs[0]->type != SOCK_RGBA) {
    blender::nodes::NodeExtraInfoRow row;
    row.text = IFACE_("Wrong Output Type");
    row.icon = ICON_ERROR;
    row.tooltip = TIP_("Node group's first output must be a color output");
    parameters.rows.append(std::move(row));
    return;
  }
 
  if (group_outputs.size() > 1) {
    blender::nodes::NodeExtraInfoRow row;
    row.text = IFACE_("Ignored Outputs");
    row.icon = ICON_WARNING_LARGE;
    row.tooltip = TIP_("Only the first output is considered while the rest are ignored");
    parameters.rows.append(std::move(row));
    return;
  }
}
 
}  // namespace blender::nodes