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

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

Direction of the stroke at which brush gives maximal thickness (0° for horizontal)

Type:float in [-1.5708, 1.5708], default 0.0
angle_factor

Reduce brush thickness by this factor when stroke is perpendicular to ‘Angle’ direction

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

Curve used for the jitter effect

Type:CurveMapping, (readonly)
curve_sensitivity

Curve used for the sensitivity

Type:CurveMapping, (readonly)
curve_strength

Curve used for the strength

Type:CurveMapping, (readonly)
eraser_mode

Eraser Mode

  • SOFT Soft, Use soft eraser.
  • HARD Hard, Use hard eraser.
  • STROKE Stroke, Use stroke eraser.
Type:enum in [‘SOFT’, ‘HARD’, ‘STROKE’], default ‘SOFT’
eraser_strength_factor

Amount of erasing for strength

Type:float in [0, 100], default 0.0
eraser_thickness_factor

Amount of erasing for thickness

Type:float in [0, 100], default 0.0
fill_draw_mode

Mode to draw boundary limits

  • BOTH Default, 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:enum in [‘BOTH’, ‘STROKE’, ‘CONTROL’], default ‘BOTH’
fill_factor

Multiplier for fill resolution, higher resolution is more accurate but slower

Type:int in [1, 8], default 0
fill_leak

Size in pixels to consider the leak closed

Type:int in [0, 100], default 0
fill_simplify_level

Number of simplify steps (large values reduce fill accuracy)

Type:int in [0, 10], default 0
fill_threshold

Threshold to consider color transparent for filling

Type:float in [0, 1], default 0.0
gp_icon
Type:enum in [‘PENCIL’, ‘PEN’, ‘INK’, ‘INKNOISE’, ‘BLOCK’, ‘MARKER’, ‘FILL’, ‘SOFT’, ‘HARD’, ‘STROKE’], default ‘PENCIL’
gradient_factor

Amount of gradient for Dot and Box strokes (set to 1 for full solid)

Type:float in [0.001, 1], default 1.0
gradient_shape
Type:float array of 2 items in [0.01, 1], default (1.0, 1.0)
input_samples

Generate intermediate points for very fast mouse movements. Set to 0 to disable

Type:int in [0, 10], default 0
material

Material used for strokes drawn using this brush

Type:Material
pen_jitter

Jitter factor for new strokes

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

Pressure sensitivity factor for new strokes

Type:float in [0.1, 3], default 0.0
pen_smooth_factor

Amount of smoothing to apply after finish newly created strokes, to reduce jitter/noise

Type:float in [0, 2], default 0.0
pen_smooth_steps

Number of times to smooth newly created strokes

Type:int in [1, 3], default 0
pen_strength

Color strength for new strokes (affect alpha factor of color)

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

Number of times to subdivide newly created strokes, for less jagged strokes

Type:int in [0, 3], default 0
pen_thick_smooth_factor

Amount of thickness smoothing to apply after finish newly created strokes, to reduce jitter/noise

Type:float in [0, 2], default 0.0
pen_thick_smooth_steps

Number of times to smooth thickness for newly created strokes

Type:int in [1, 3], default 0
random_pressure

Randomness factor for pressure in new strokes

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

Randomness factor strength in new strokes

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

Randomness factor for new strokes after subdivision

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

Show transparent lines to use as boundary for filling

Type:boolean, default True
show_fill_boundary

Show help lines for filling to see boundaries

Type:boolean, default True
show_lasso

Do not draw fill color while drawing the stroke

Type:boolean, default False
trim

Trim intersecting stroke ends

Type:boolean, default False
use_cursor

Enable cursor on screen

Type:boolean, default True
use_default_eraser

Use this brush when enable eraser with fast switch key

Type:boolean, default True
use_jitter_pressure

Use tablet pressure for jitter

Type:boolean, default False
use_material_pin

Keep material assigned to brush

Type:boolean, default False
use_occlude_eraser

Erase only strokes visible and not occluded

Type:boolean, default False
use_pressure

Use tablet pressure

Type:boolean, default False
use_settings_postprocess

Additional post processing options for new strokes

Type:boolean, default False
use_settings_random

Random brush settings

Type:boolean, default False
use_settings_stabilizer

Draw lines with a delay to allow smooth strokes. Press Shift key to override while drawing

Type:boolean, default True
use_strength_pressure

Use tablet pressure for color strength

Type:boolean, default False
uv_random

Random factor for autogenerated UV rotation

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

Inherited Functions

References