BlendDataBrushes(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.BlendDataBrushes(bpy_prop_collection)

Collection of brushes

new(name, *, mode='TEXTURE_PAINT')

Add a new brush to the main database

Parameters:

  • name (str) – New name for the data-block (never None)

  • mode (Literal[Object Mode Items]) – Paint Mode for the new brush (optional)

Returns:

New brush data-block

Return type:

Brush

remove(brush, *, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove a brush from the current blendfile

Parameters:

  • brush (Brush) – Brush to remove (never None)

  • do_unlink (bool) – Unlink all usages of this brush before deleting it (optional)

  • do_id_user (bool) – Decrement user counter of all data-blocks used by this brush (optional)

  • do_ui_user (bool) – Make sure interface does not reference this brush (optional)

tag(value)

tag

Parameters:

value (bool) – Value

create_gpencil_data(brush)

Add Grease Pencil brush settings

Parameters:

brush (Brush) – Brush (never None)

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

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

References