CompositorNodeKeying(CompositorNode)

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeKeying(CompositorNode)

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 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

bpy_struct.id_data Node.type Node.location Node.width Node.height Node.dimensions Node.name Node.label Node.inputs Node.outputs Node.internal_links Node.parent Node.use_custom_color Node.color Node.select Node.show_options

Node.show_preview Node.hide Node.mute Node.show_texture Node.bl_idname Node.bl_label Node.bl_description Node.bl_icon Node.bl_static_type Node.bl_width_default Node.bl_width_min Node.bl_width_max Node.bl_height_default Node.bl_height_min Node.bl_height_max

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui bpy_struct.is_property_hidden bpy_struct.is_property_overridable_library bpy_struct.is_property_readonly bpy_struct.is_property_set bpy_struct.items bpy_struct.keyframe_delete bpy_struct.keyframe_insert bpy_struct.keys bpy_struct.path_from_id bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.type_recast bpy_struct.values Node.socket_value_update Node.is_registered_node_type Node.poll

Node.poll_instance Node.update Node.insert_link Node.init Node.copy Node.free Node.draw_buttons Node.draw_buttons_ext Node.draw_label Node.poll Node.bl_rna_get_subclass Node.bl_rna_get_subclass_py NodeInternal.poll NodeInternal.poll_instance NodeInternal.update NodeInternal.draw_buttons NodeInternal.draw_buttons_ext NodeInternal.bl_rna_get_subclass NodeInternal.bl_rna_get_subclass_py CompositorNode.tag_need_exec CompositorNode.poll CompositorNode.update CompositorNode.bl_rna_get_subclass CompositorNode.bl_rna_get_subclass_py