BlendDataBrushes(bpy_struct)

base class — bpy_struct

class bpy.types.BlendDataBrushes(bpy_struct)

Collection of brushes

new(name, mode='TEXTURE_PAINT')

Add a new brush to the main database

Parameters

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

  • mode (enum in ['OBJECT', 'EDIT', 'POSE', 'SCULPT', 'VERTEX_PAINT', 'WEIGHT_PAINT', 'TEXTURE_PAINT', 'PARTICLE_EDIT', 'EDIT_GPENCIL', 'SCULPT_GPENCIL', 'PAINT_GPENCIL', 'WEIGHT_GPENCIL', 'VERTEX_GPENCIL', 'SCULPT_CURVES'], (optional)) –

    Paint Mode for the new brush

    • OBJECT Object Mode.

    • EDIT Edit Mode.

    • POSE Pose Mode.

    • SCULPT Sculpt Mode.

    • VERTEX_PAINT Vertex Paint.

    • WEIGHT_PAINT Weight Paint.

    • TEXTURE_PAINT Texture Paint.

    • PARTICLE_EDIT Particle Edit.

    • EDIT_GPENCIL Edit Mode – Edit Grease Pencil Strokes.

    • SCULPT_GPENCIL Sculpt Mode – Sculpt Grease Pencil Strokes.

    • PAINT_GPENCIL Draw Mode – Paint Grease Pencil Strokes.

    • WEIGHT_GPENCIL Weight Paint – Grease Pencil Weight Paint Strokes.

    • VERTEX_GPENCIL Vertex Paint – Grease Pencil Vertex Paint Strokes.

    • SCULPT_CURVES Sculpt Mode.

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, (never None)) – Brush to remove

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

  • do_id_user (boolean, (optional)) – Decrement user counter of all datablocks used by this brush

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

tag(value)

tag

Parameters

value (boolean) – Value

create_gpencil_data(brush)

Add grease pencil brush settings

Parameters

brush (Brush, (never None)) – Brush

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

Inherited Functions

References