GreasePencilv3Layers(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.GreasePencilv3Layers(bpy_prop_collection)

Collection of Grease Pencil layers

active

Active Grease Pencil layer

Type:

GreasePencilLayer

new(name, *, set_active=True, layer_group=None)

Add a new Grease Pencil layer

Parameters:

  • name (str) – Name, Name of the layer (never None)

  • set_active (bool) – Set Active, Set the newly created layer as the active layer (optional)

  • layer_group (GreasePencilLayerGroup) – The layer group the new layer will be created in (use None for the main stack) (optional)

Returns:

The newly created layer

Return type:

GreasePencilLayer

remove(layer)

Remove a Grease Pencil layer

Parameters:

layer (GreasePencilLayer) – The layer to remove (never None)

move(layer, type)

Move a Grease Pencil layer in the layer group or main stack

Parameters:

  • layer (GreasePencilLayer) – The layer to move (never None)

  • type (Literal['DOWN', 'UP']) – Direction of movement

move_top(layer)

Move a Grease Pencil layer to the top of the layer group or main stack

Parameters:

layer (GreasePencilLayer) – The layer to move (never None)

move_bottom(layer)

Move a Grease Pencil layer to the bottom of the layer group or main stack

Parameters:

layer (GreasePencilLayer) – The layer to move (never None)

move_to_layer_group(layer, layer_group)

Move a Grease Pencil layer into a layer group

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