CompositorNodeCryptomatteV2(CompositorNode)

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeCryptomatteV2(CompositorNode)

Generate matte for individual objects and materials using Cryptomatte render passes

add

Add object or material to matte, by picking a color from the Pick output (array of 3 items, in [-inf, inf], default (1.0, 1.0, 1.0))

Type:

mathutils.Color

entries

(default None, readonly)

Type:

bpy_prop_collection[CryptomatteEntry]

frame_duration

Number of images of a movie to use (in [0, 1048574], default 0)

Type:

int

frame_offset

Offset the number of the frame to use in the animation (in [-1048574, 1048574], default 0)

Type:

int

frame_start

Global starting frame of the movie/sequence, assuming first picture has a #1 (in [-1048574, 1048574], default 0)

Type:

int

has_layers

True if this image has any named layer (default False, readonly)

Type:

bool

has_views

True if this image has multiple views (default False, readonly)

Type:

bool

image
Type:

Image

layer

(default 'PLACEHOLDER')

Type:

Literal[‘PLACEHOLDER’]

layer_name

What Cryptomatte layer is used (default 'CryptoObject')

  • CryptoObject Object – Use Object layer.

  • CryptoMaterial Material – Use Material layer.

  • CryptoAsset Asset – Use Asset layer.

Type:

Literal[‘CryptoObject’, ‘CryptoMaterial’, ‘CryptoAsset’]

matte_id

List of object and material crypto IDs to include in matte (default “”, never None)

Type:

str

remove

Remove object or material from matte, by picking a color from the Pick output (array of 3 items, in [-inf, inf], default (1.0, 1.0, 1.0))

Type:

mathutils.Color

scene
Type:

Scene

source

Where the Cryptomatte passes are loaded from (default 'RENDER')

  • RENDER Render – Use Cryptomatte passes from a render.

  • IMAGE Image – Use Cryptomatte passes from an image.

Type:

Literal[‘RENDER’, ‘IMAGE’]

use_auto_refresh

Always refresh image on frame changes (default False)

Type:

bool

use_cyclic

Cycle the images in the movie (default False)

Type:

bool

view

(default 'ALL')

Type:

Literal[‘ALL’]

classmethod is_registered_node_type()

True if a registered node type

Returns:

Result

Return type:

bool

classmethod input_template(index)

Input socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)

Output socket template

Parameters:

index (int) – Index, (in [0, inf])

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions