BrushGpencilSettings(bpy_struct)

base class — bpy_struct

class bpy.types.BrushGpencilSettings(bpy_struct)

Settings for Grease Pencil brush

active_smooth_factor

Amount of smoothing while drawing (in [0, 1], default 0.0)

Type:: float

angle

Direction of the stroke at which brush gives maximal thickness (0° for horizontal) (in [-1.5708, 1.5708], default 0.0)

Type:: float

angle_factor

Reduce brush thickness by this factor when stroke is perpendicular to ‘Angle’ direction (in [0, 1], default 0.0)

Type:: float

aspect

(array of 2 items, in [0.01, 1], default (0.0, 0.0))

Type:: mathutils.Vector

brush_draw_mode

Preselected mode when using this brush (default 'ACTIVE')

ACTIVE Active – Use current mode.
MATERIAL Material – Use always material mode.
VERTEXCOLOR Vertex Color – Use always Vertex Color mode.

Type:: Literal[‘ACTIVE’, ‘MATERIAL’, ‘VERTEXCOLOR’]

caps_type

The shape of the start and end of the stroke (default 'ROUND')

Type:: Literal[‘ROUND’, ‘FLAT’]

curve_jitter

Curve used for the jitter effect (readonly)

Type:: CurveMapping

curve_random_hue

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_random_pressure

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_random_saturation

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_random_strength

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_random_uv

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_random_value

Curve used for modulating effect (readonly)

Type:: CurveMapping

curve_sensitivity

Curve used for the sensitivity (readonly)

Type:: CurveMapping

curve_strength

Curve used for the strength (readonly)

Type:: CurveMapping

dilate

Number of pixels to expand or contract fill area (in [-40, 40], default 1)

Type:: int

eraser_mode

Eraser Mode (default 'SOFT')

SOFT Dissolve – Erase strokes, fading their points strength and thickness.
HARD Point – Erase stroke points.
STROKE Stroke – Erase entire strokes.

Type:: Literal[‘SOFT’, ‘HARD’, ‘STROKE’]

eraser_strength_factor

Amount of erasing for strength (in [0, 100], default 0.0)

Type:: float

eraser_thickness_factor

Amount of erasing for thickness (in [0, 100], default 0.0)

Type:: float

extend_stroke_factor

Strokes end extension for closing gaps, use zero to disable (in [0, 10], default 0.0)

Type:: float

fill_direction

Direction of the fill (default 'NORMAL')

NORMAL Normal – Fill internal area.
INVERT Inverted – Fill inverted area.

Type:: Literal[‘NORMAL’, ‘INVERT’]

fill_draw_mode

Mode to draw boundary limits (default 'BOTH')

BOTH All – Use both visible strokes and edit lines as fill boundary limits.
STROKE Strokes – Use visible strokes as fill boundary limits.
CONTROL Edit Lines – Use edit lines as fill boundary limits.

Type:: Literal[‘BOTH’, ‘STROKE’, ‘CONTROL’]

fill_extend_mode

Types of stroke extensions used for closing gaps (default 'EXTEND')

EXTEND Extend – Extend strokes in straight lines.
RADIUS Radius – Connect endpoints that are close together.

Type:: Literal[‘EXTEND’, ‘RADIUS’]

fill_factor

Factor for fill boundary accuracy, higher values are more accurate but slower (in [0.05, 8], default 0.0)

Type:: float

fill_layer_mode

Layers used as boundaries (default 'VISIBLE')

VISIBLE Visible – Visible layers.
ACTIVE Active – Only active layer.
ABOVE Layer Above – Layer above active.
BELOW Layer Below – Layer below active.
ALL_ABOVE All Above – All layers above active.
ALL_BELOW All Below – All layers below active.

Type:: Literal[‘VISIBLE’, ‘ACTIVE’, ‘ABOVE’, ‘BELOW’, ‘ALL_ABOVE’, ‘ALL_BELOW’]

fill_simplify_level

Number of simplify steps (large values reduce fill accuracy) (in [0, 10], default 0)

Type:: int

fill_threshold

Threshold to consider color transparent for filling (in [0, 1], default 0.0)

Type:: float

hardness

Gradient from the center of Dot and Box strokes (set to 1 for a solid stroke) (in [0.001, 1], default 1.0)

Type:: float

input_samples

Generated intermediate points for very fast mouse movements (Set to 0 to disable) (in [0, 10], default 0)

Type:: int

material

Material used for strokes drawn using this brush

Type:: Material

material_alt

Material used for secondary uses for this brush

Type:: Material

outline_thickness_factor

Thickness of the outline stroke relative to current brush thickness (in [0, 1], default 0.0)

Type:: float

pen_jitter

Jitter factor of brush radius for new strokes (in [0, 100], default 0.0)

Type:: float

pen_smooth_factor

Amount of smoothing to apply after finish newly created strokes, to reduce jitter/noise (in [0, 2], default 0.0)

Type:: float

pen_smooth_steps

Number of times to smooth newly created strokes (in [0, 100], default 0)

Type:: int

pen_strength

Color strength for new strokes (affect alpha factor of color) (in [0, 1], default 0.0)

Type:: float

pen_subdivision_steps

Number of times to subdivide newly created strokes, for less jagged strokes (in [0, 3], default 0)

Type:: int

pin_draw_mode

Pin the mode to the brush (default False)

Type:: bool

random_hue_factor

Random factor to modify original hue (in [0, 1], default 0.0)

Type:: float

random_pressure

Randomness factor for pressure in new strokes (in [0, 1], default 0.0)

Type:: float

random_saturation_factor

Random factor to modify original saturation (in [0, 1], default 0.0)

Type:: float

random_strength

Randomness factor strength in new strokes (in [0, 1], default 0.0)

Type:: float

random_value_factor

Random factor to modify original value (in [0, 1], default 0.0)

Type:: float

show_fill

Show transparent lines to use as boundary for filling (default True)

Type:: bool

show_fill_boundary

Show help lines for filling to see boundaries (default True)

Type:: bool

show_fill_extend

Show help lines for stroke extension (default True)

Type:: bool

show_lasso

Do not display fill color while drawing the stroke (default True)

Type:: bool

simplify_factor

Factor of Simplify using adaptive algorithm (in [0, 100], default 0.0)

Type:: float

simplify_pixel_threshold

Threshold in screen space used for the simplify algorithm. Points within this threshold are treated as if they were in a straight line. (in [0, 10], default 0.0)

Type:: float

stroke_type

Mode to use when creating strokes (default 'STROKE')

Type:: Literal[‘STROKE’, ‘FILL’, ‘BOTH’]

use_active_layer_only

Only edit the active layer of the object (default False)

Type:: bool

use_auto_remove_fill_guides

Automatically remove fill guide strokes after fill operation (default True)

Type:: bool

use_collide_strokes

Check if extend lines collide with strokes (default False)

Type:: bool

use_edit_position

The brush affects the position of the point (default False)

Type:: bool

use_edit_strength

The brush affects the color strength of the point (default False)

Type:: bool

use_edit_thickness

The brush affects the thickness of the point (default False)

Type:: bool

use_edit_uv

The brush affects the UV rotation of the point (default False)

Type:: bool

use_fill_limit

Fill only visible areas in viewport (default True)

Type:: bool

use_jitter_pressure

Use tablet pressure for jitter (default False)

Type:: bool

use_keep_caps_eraser

Keep the caps as they are and don’t flatten them when erasing (default False)

Type:: bool

use_material_pin

Keep material assigned to brush (default False)

Type:: bool

use_occlude_eraser

Erase only strokes visible and not occluded (default False)

Type:: bool

use_pressure

Use tablet pressure (default False)

Type:: bool

use_random_press_hue