CompositorNodeKeying(CompositorNode)#

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeKeying(CompositorNode)#

Perform both chroma keying (to remove the backdrop) and despill (to correct color cast from the backdrop)

blur_post#

Matte blur size which applies after clipping and dilate/eroding

Type:

int in [0, 2048], default 0

blur_pre#

Chroma pre-blur size which applies before running keyer

Type:

int in [0, 2048], default 0

clip_black#

Value of non-scaled matte pixel which considers as fully background pixel

Type:

float in [0, 1], default 0.0

clip_white#

Value of non-scaled matte pixel which considers as fully foreground pixel

Type:

float in [0, 1], default 0.0

despill_balance#

Balance between non-key colors used to detect amount of key color to be removed

Type:

float in [0, 1], default 0.0

despill_factor#

Factor of despilling screen color from image

Type:

float in [0, 1], default 0.0

dilate_distance#

Distance to grow/shrink the matte

Type:

int in [-100, 100], default 0

edge_kernel_radius#

Radius of kernel used to detect whether pixel belongs to edge

Type:

int in [0, 100], default 0

edge_kernel_tolerance#

Tolerance to pixels inside kernel which are treating as belonging to the same plane

Type:

float in [0, 1], default 0.0

feather_distance#

Distance to grow/shrink the feather

Type:

int in [-100, 100], default 0

feather_falloff#

Falloff type of the feather

Type:

enum in Proportional Falloff Curve Only Items, default ‘SMOOTH’

screen_balance#

Balance between two non-primary channels primary channel is comparing against

Type:

float in [0, 1], default 0.0

classmethod is_registered_node_type()#

True if a registered node type

Returns:

Result

Return type:

boolean

classmethod input_template(index)#

Input socket template

Parameters:

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

Returns:

result

Return type:

NodeInternalSocketTemplate

classmethod output_template(index)#

Output socket template

Parameters:

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

Returns:

result

Return type:

NodeInternalSocketTemplate

update()#
classmethod bl_rna_get_subclass(id, default=None)#
Parameters:

id (string) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

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

id (string) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#