COM_utilities.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <optional>
 
#include "BLI_index_range.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_task.hh"
 
#include "NOD_derived_node_tree.hh"
 
#include "GPU_shader.hh"
 
#include "COM_input_descriptor.hh"
#include "COM_result.hh"
 
namespace blender::compositor {
 
using namespace nodes::derived_node_tree_types;
 
/* Returns true if the socket is available and not virtual. Returns false otherwise. */
bool is_socket_available(const bNodeSocket *socket);

DSocket get_input_origin_socket(DInputSocket input);

DOutputSocket get_output_linked_to_input(DInputSocket input);

ResultType socket_data_type_to_result_type(const eNodeSocketDatatype data_type,
                                           const std::optional<int> dimensions = std::nullopt);

ResultType get_node_socket_result_type(const bNodeSocket *socket);

bool is_output_linked_to_node_conditioned(DOutputSocket output,
                                          FunctionRef<bool(DNode)> condition);

int number_of_inputs_linked_to_output_conditioned(DOutputSocket output,
                                                  FunctionRef<bool(DInputSocket)> condition);

bool is_pixel_node(DNode node);

InputDescriptor input_descriptor_from_input_socket(const bNodeSocket *socket);

void compute_dispatch_threads_at_least(gpu::Shader *shader,
                                       int2 threads_range,
                                       int2 local_size = int2(16));
 
/* Returns true if a node preview needs to be computed for the give node. */
bool is_node_preview_needed(const DNode &node);
 
/* Returns the node output that will be used to generate previews. */
DOutputSocket find_preview_output_socket(const DNode &node);
 
/* -------------------------------------------------------------------- */
/* Inline Functions.
 */
 
/* Executes the given function in parallel over the given 2D range. The given function gets the
 * texel coordinates of the element of the range as an argument. */
template<typename Function> inline void parallel_for(const int2 range, const Function &function)
{
  threading::parallel_for(IndexRange(range.y), 1, [&](const IndexRange sub_y_range) {
    for (const int64_t y : sub_y_range) {
      for (const int64_t x : IndexRange(range.x)) {
        function(int2(x, y));
      }
    }
  });
}
 
}  // namespace blender::compositor