File: holdout.rst

package info (click to toggle)
blender-doc 4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 253,604 kB
  • sloc: python: 13,030; javascript: 322; makefile: 113; sh: 107
file content (39 lines) | stat: -rw-r--r-- 601 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.. _bpy.types.ShaderNodeHoldout:

*******
Holdout
*******

.. figure:: /images/node-types_ShaderNodeHoldout.webp
   :align: right
   :alt: Holdout node.

The *Holdout* shader node is used to create a "hole" in the image with zero alpha
transparency, which is useful for compositing (see :term:`Alpha Channel`).


Inputs
======

This node has no inputs.


Properties
==========

This node has no properties.


Outputs
=======

Holdout
   Standard shader output.


Examples
========

.. figure:: /images/render_shader-nodes_shader_holdout_example.jpg

   The checkered area is a region with zero alpha.