GreasePencilLayerMasks(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.GreasePencilLayerMasks(bpy_prop_collection)

Collection of Grease Pencil masking layers

active_mask_index

Active index in layer mask array (in [0, inf], default 0)

Type:

int

add(layer)

Add an existing layer as a mask to this layer

Parameters:

layer (GreasePencilLayer) – Layer to add as a mask (never None)

Returns:

The mask entry referencing the layer

Return type:

GreasePencilLayerMask

remove(mask)

Remove a mask from the layer

Parameters:

mask (GreasePencilLayerMask) – Mask to remove (never None)

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

References