CompositorNodeMask(CompositorNode)#

base classes — bpy_struct, Node, NodeInternal, CompositorNode

class bpy.types.CompositorNodeMask(CompositorNode)#

Input mask from a mask datablock, created in the image editor

mask#
Type:

Mask

motion_blur_samples#

Number of motion blur samples

Type:

int in [1, 64], default 0

motion_blur_shutter#

Exposure for motion blur as a factor of FPS

Type:

float in [0, 1], default 0.0

size_source#

Where to get the mask size from for aspect/size information

  • SCENE Scene Size.

  • FIXED Fixed – Use pixel size for the buffer.

  • FIXED_SCENE Fixed/Scene – Pixel size scaled by scene percentage.

Type:

enum in [‘SCENE’, ‘FIXED’, ‘FIXED_SCENE’], default ‘SCENE’

size_x#
Type:

int in [1, 10000], default 0

size_y#
Type:

int in [1, 10000], default 0

use_feather#

Use feather information from the mask

Type:

boolean, default False

use_motion_blur#

Use multi-sampled motion blur of the mask

Type:

boolean, default False

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 (str) – 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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties#

Inherited Functions#