# GPencilSculptBrush(bpy_struct)

base class — `bpy_struct`

class `bpy.types.``GPencilSculptBrush`(bpy_struct)

  Stroke editing brush

  `cursor_color_add`

    Color for the cursor for addition

    Type: | float array of 3 items in [0, 1], default (1.0, 0.6, 0.6)

  `cursor_color_sub`

    Color for the cursor for subtraction

    Type: | float array of 3 items in [0, 1], default (0.6, 0.6, 1.0)

  `direction`
    - `ADD` Add, Add effect of brush.
    - `SUBTRACT` Subtract, Subtract effect of brush.

    Type: | enum in [‘ADD’, ‘SUBTRACT’], default ‘ADD’

  `size`

    Radius of the brush in pixels

    Type: | int in [1, 1000], default 0

  `strength`

    Brush strength

    Type: | float in [0.001, 1], default 0.0

  `use_cursor`

    Enable cursor on screen

    Type: | boolean, default True

  `use_edit_pressure`

    Affect pressure values as well when smoothing strokes

    Type: | boolean, default False

  `use_falloff`

    Strength of brush decays with distance from cursor

    Type: | boolean, default False

  `use_pressure_radius`

    Enable tablet pressure sensitivity for radius

    Type: | boolean, default False

  `use_pressure_strength`

    Enable tablet pressure sensitivity for strength

    Type: | boolean, default False

  `weight`

    Target weight (define a maximum range limit for the weight. Any value above will be clamped)

    Type: | float in [0, 1], default 0.0

  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

`bpy_struct.id_data` |

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_overridable_library` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` `bpy_struct.keyframe_delete` | `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.pop` `bpy_struct.property_overridable_library_set` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`

References

`GPencilSculptSettings.brush` |