node_shader_holdout.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2005 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include "node_shader_util.hh"
 
namespace blender::nodes::node_shader_holdout_cc {
 
static void node_declare(NodeDeclarationBuilder &b)
{
  b.add_input<decl::Float>("Weight").available(false);
  b.add_output<decl::Shader>("Holdout");
}
 
static int gpu_shader_rgb(GPUMaterial *mat,
                          bNode *node,
                          bNodeExecData * /*execdata*/,
                          GPUNodeStack *in,
                          GPUNodeStack *out)
{
  return GPU_stack_link(mat, node, "node_holdout", in, out);
}
 
}  // namespace blender::nodes::node_shader_holdout_cc
 
/* node type definition */
void register_node_type_sh_holdout()
{
  namespace file_ns = blender::nodes::node_shader_holdout_cc;
 
  static blender::bke::bNodeType ntype;
 
  sh_node_type_base(&ntype, "ShaderNodeHoldout", SH_NODE_HOLDOUT);
  ntype.ui_name = "Holdout";
  ntype.ui_description =
      "Create a \"hole\" in the image with zero alpha transparency, which is useful for "
      "compositing.\nNote: the holdout shader can only create alpha when transparency is enabled "
      "in the film settings";
  ntype.enum_name_legacy = "HOLDOUT";
  ntype.nclass = NODE_CLASS_SHADER;
  ntype.add_ui_poll = object_shader_nodes_poll;
  ntype.declare = file_ns::node_declare;
  ntype.gpu_fn = file_ns::gpu_shader_rgb;
 
  blender::bke::node_register_type(ntype);
}