Brush(ID)

base classes — bpy_struct, ID

class bpy.types.Brush(ID)

Brush data-block for storing brush settings for painting and sculpting

area_radius_factor

Ratio between the brush radius and the radius that is going to be used to sample the area center (in [0, 2], default 0.5)

Type:

float

auto_smooth_factor

Amount of smoothing to automatically apply to each stroke (in [0, 1], default 0.0)

Type:

float

automasking_boundary_edges_propagation_steps

Distance where boundary edge automasking is going to protect vertices from the fully masked edge (in [1, 20], default 1)

Type:

int

automasking_cavity_blur_steps

The number of times the cavity mask is blurred (in [0, 25], default 0)

Type:

int

automasking_cavity_curve

Curve used for the sensitivity (readonly)

Type:

CurveMapping

automasking_cavity_factor

The contrast of the cavity mask (in [0, 5], default 1.0)

Type:

float

automasking_start_normal_falloff

Extend the angular range with a falloff gradient (in [0.0001, 1], default 0.25)

Type:

float

automasking_start_normal_limit

The range of angles that will be affected (in [0.0001, 3.14159], default 0.349066)

Type:

float

automasking_view_normal_falloff

Extend the angular range with a falloff gradient (in [0.0001, 1], default 0.25)

Type:

float

automasking_view_normal_limit

The range of angles that will be affected (in [0.0001, 3.14159], default 1.5708)

Type:

float

blend

Brush blending mode (default 'MIX')

• MIX Mix – Use Mix blending mode while painting.

• DARKEN Darken – Use Darken blending mode while painting.

• MUL Multiply – Use Multiply blending mode while painting.

• COLORBURN Color Burn – Use Color Burn blending mode while painting.

• LINEARBURN Linear Burn – Use Linear Burn blending mode while painting.

• LIGHTEN Lighten – Use Lighten blending mode while painting.

• SCREEN Screen – Use Screen blending mode while painting.

• COLORDODGE Color Dodge – Use Color Dodge blending mode while painting.

• ADD Add – Use Add blending mode while painting.

• OVERLAY Overlay – Use Overlay blending mode while painting.

• SOFTLIGHT Soft Light – Use Soft Light blending mode while painting.

• HARDLIGHT Hard Light – Use Hard Light blending mode while painting.

• VIVIDLIGHT Vivid Light – Use Vivid Light blending mode while painting.

• LINEARLIGHT Linear Light – Use Linear Light blending mode while painting.

• PINLIGHT Pin Light – Use Pin Light blending mode while painting.

• DIFFERENCE Difference – Use Difference blending mode while painting.

• EXCLUSION Exclusion – Use Exclusion blending mode while painting.

• SUB Subtract – Use Subtract blending mode while painting.

• HUE Hue – Use Hue blending mode while painting.

• SATURATION Saturation – Use Saturation blending mode while painting.

• COLOR Color – Use Color blending mode while painting.

• LUMINOSITY Value – Use Value blending mode while painting.

• ERASE_ALPHA Erase Alpha – Erase alpha while painting.

• ADD_ALPHA Add Alpha – Add alpha while painting.

Type:

Literal[‘MIX’, ‘DARKEN’, ‘MUL’, ‘COLORBURN’, ‘LINEARBURN’, ‘LIGHTEN’, ‘SCREEN’, ‘COLORDODGE’, ‘ADD’, ‘OVERLAY’, ‘SOFTLIGHT’, ‘HARDLIGHT’, ‘VIVIDLIGHT’, ‘LINEARLIGHT’, ‘PINLIGHT’, ‘DIFFERENCE’, ‘EXCLUSION’, ‘SUB’, ‘HUE’, ‘SATURATION’, ‘COLOR’, ‘LUMINOSITY’, ‘ERASE_ALPHA’, ‘ADD_ALPHA’]

blur_kernel_radius

Radius of kernel used for soften and sharpen in pixels (in [1, 10000], default 2)

Type:

int

blur_mode

(default 'GAUSSIAN')

Type:

Literal[‘BOX’, ‘GAUSSIAN’]

boundary_deform_type

Deformation type that is used in the brush (default 'BEND')

Type:

Literal[‘BEND’, ‘EXPAND’, ‘INFLATE’, ‘GRAB’, ‘TWIST’, ‘SMOOTH’]

boundary_falloff_type

How the brush falloff is applied across the boundary (default 'CONSTANT')

• CONSTANT Constant – Applies the same deformation in the entire boundary.

• RADIUS Brush Radius – Applies the deformation in a localized area limited by the brush radius.

• LOOP Loop – Applies the brush falloff in a loop pattern.

• LOOP_INVERT Loop and Invert – Applies the falloff radius in a loop pattern, inverting the displacement direction in each pattern repetition.

Type:

Literal[‘CONSTANT’, ‘RADIUS’, ‘LOOP’, ‘LOOP_INVERT’]

boundary_offset

Offset of the boundary origin in relation to the brush radius (in [0, 30], default 0.0)

Type:

float

brush_capabilities

Brush’s capabilities (readonly, never None)

Type:

BrushCapabilities

cloth_constraint_softbody_strength

How much the cloth preserves the original shape, acting as a soft body (in [0, 1], default 0.0)

Type:

float

cloth_damping

How much the applied forces are propagated through the cloth (in [0.01, 1], default 0.01)

Type:

float

cloth_deform_type

Deformation type that is used in the brush (default 'DRAG')

Type:

Literal[‘DRAG’, ‘PUSH’, ‘PINCH_POINT’, ‘PINCH_PERPENDICULAR’, ‘INFLATE’, ‘GRAB’, ‘EXPAND’, ‘SNAKE_HOOK’]

cloth_force_falloff_type

Shape used in the brush to apply force to the cloth (default 'RADIAL')

Type:

Literal[‘RADIAL’, ‘PLANE’]

cloth_mass

Mass of each simulation particle (in [0.01, 2], default 1.0)

Type:

float

cloth_sim_falloff

Area to apply deformation falloff to the effects of the simulation (in [0, 1], default 0.75)

Type:

float

cloth_sim_limit

Factor added relative to the size of the radius to limit the cloth simulation effects (in [0.1, 10], default 2.5)

Type:

float

cloth_simulation_area_type

Part of the mesh that is going to be simulated when the stroke is active (default 'LOCAL')

• LOCAL Local – Simulates only a specific area around the brush limited by a fixed radius.

• GLOBAL Global – Simulates the entire mesh.

• DYNAMIC Dynamic – The active simulation area moves with the brush.

Type:

Literal[‘LOCAL’, ‘GLOBAL’, ‘DYNAMIC’]

color

(array of 3 items, in [0, inf], default (1.0, 1.0, 1.0))

Type:

mathutils.Color

color_type

Use single color or gradient when painting (default 'COLOR')

• COLOR Color – Paint with a single color.

• GRADIENT Gradient – Paint with a gradient.

Type:

Literal[‘COLOR’, ‘GRADIENT’]

crease_pinch_factor

How much the crease brush pinches (in [0, 1], default 0.5)

Type:

float

cursor_color_add

Color of cursor when adding (array of 4 items, in [0, inf], default (1.0, 0.39, 0.39, 0.9))

Type:

bpy_prop_array[float]

cursor_color_subtract

Color of cursor when subtracting (array of 4 items, in [0, inf], default (0.39, 0.39, 1.0, 0.9))

Type:

bpy_prop_array[float]

cursor_overlay_alpha

(in [0, 100], default 33)

Type:

int

curve_distance_falloff

Editable falloff curve (readonly, never None)

Type:

CurveMapping

curve_distance_falloff_preset

(default 'CUSTOM')

Type:

Literal[Brush Curve Preset Items]

curve_jitter

Curve used to map pressure to brush jitter (readonly)

Type:

CurveMapping

curve_random_hue

Curve used for modulating effect (readonly)

Type:

CurveMapping

curve_random_saturation

Curve used for modulating effect (readonly)

Type:

CurveMapping

curve_random_value

Curve used for modulating effect (readonly)

Type:

CurveMapping

curve_size

Curve used to map pressure to brush size (readonly)

Type:

CurveMapping

curve_strength

Curve used to map pressure to brush strength (readonly)

Type:

CurveMapping

curves_sculpt_brush_type

(default 'COMB')

Type:

Literal[Brush Curves Sculpt Brush Type Items]

curves_sculpt_settings

(readonly)

Type:

BrushCurvesSculptSettings

dash_ratio

Ratio of samples in a cycle that the brush is enabled (in [0, 1], default 1.0)

Type:

float

dash_samples

Length of a dash cycle measured in stroke samples (in [1, 10000], default 20)

Type:

int

deform_target

How the deformation of the brush will affect the object (default 'GEOMETRY')

• GEOMETRY Geometry – Brush deformation displaces the vertices of the mesh.

• CLOTH_SIM Cloth Simulation – Brush deforms the mesh by deforming the constraints of a cloth simulation.

Type:

Literal[‘GEOMETRY’, ‘CLOTH_SIM’]

density

Amount of random elements that are going to be affected by the brush (in [0, 1], default 0.0)

Type:

float

direction

(default 'ADD')

• ADD Add – Add effect of brush.

• SUBTRACT Subtract – Subtract effect of brush.

Type:

Literal[‘ADD’, ‘SUBTRACT’]

disconnected_distance_max

Maximum distance to search for disconnected loose parts in the mesh (in [0, 10], default 0.1)

Type:

float

elastic_deform_type

Deformation type that is used in the brush (default 'GRAB')

Type:

Literal[‘GRAB’, ‘GRAB_BISCALE’, ‘GRAB_TRISCALE’, ‘SCALE’, ‘TWIST’]

elastic_deform_volume_preservation

Poisson ratio for elastic deformation. Higher values preserve volume more, but also lead to more bulging. (in [0, 0.9], default 0.0)

Type:

float

falloff_angle

Paint most on faces pointing towards the view according to this angle (in [0, 1.5708], default 0.0)

Type:

float

falloff_shape

Use projected or spherical falloff (default 'SPHERE')

• SPHERE Sphere – Apply brush influence in a Sphere, outwards from the center.

• PROJECTED Projected – Apply brush influence in a 2D circle, projected from the view.

Type:

Literal[‘SPHERE’, ‘PROJECTED’]

fill_threshold

Threshold above which filling is not propagated (in [0, 100], default 0.2)

Type:

float

flow

Amount of paint that is applied per stroke sample (in [0, 1], default 0.0)

Type:

float

gpencil_brush_type

(default 'DRAW')

Type:

Literal[Brush Gpencil Types Items]

gpencil_sculpt_brush_type

(default 'SMOOTH')

Type:

Literal[Brush Gpencil Sculpt Types Items]

gpencil_settings

(readonly)

Type:

BrushGpencilSettings

gpencil_vertex_brush_type

(default 'DRAW')

Type:

Literal[Brush Gpencil Vertex Types Items]

gpencil_weight_brush_type

(default 'WEIGHT')

Type:

Literal[Brush Gpencil Weight Types Items]

grad_spacing

Spacing before brush gradient goes full circle (in [1, 10000], default 0)

Type:

int

gradient

(readonly)

Type:

ColorRamp

gradient_fill_mode

(default 'LINEAR')

Type:

Literal[‘LINEAR’, ‘RADIAL’]

gradient_stroke_mode

(default 'PRESSURE')

Type:

Literal[‘PRESSURE’, ‘SPACING_REPEAT’, ‘SPACING_CLAMP’]

hardness

How close the brush falloff starts from the edge of the brush (in [0, 1], default 0.0)

Type:

float

has_unsaved_changes

Indicates that there are any user visible changes since the brush has been imported or read from the file (default False, readonly)

Type:

bool

height

Affectable height of brush (i.e. the layer height for the layer tool) (in [0, 1], default 0.5)

Type:

float

hue_jitter

Color jitter effect on hue (in [0, 1], default 0.0)

Type:

float

image_brush_type

(default 'DRAW')

Type:

Literal[Brush Image Brush Type Items]

image_paint_capabilities

(readonly, never None)

Type:

BrushCapabilitiesImagePaint

input_samples

Number of input samples to average together to smooth the brush stroke (in [1, 64], default 1)

Type:

int

invert_density_pressure

Invert the modulation of pressure in density (default False)

Type:

bool

invert_flow_pressure

Invert the modulation of pressure in flow (default False)

Type:

bool

invert_hardness_pressure

Invert the modulation of pressure in hardness (default False)

Type:

bool

invert_to_scrape_fill

Use Scrape or Fill brush when inverting this brush instead of inverting its displacement direction (default False)

Type:

bool

invert_wet_mix_pressure

Invert the modulation of pressure in wet mix (default False)

Type:

bool

invert_wet_persistence_pressure

Invert the modulation of pressure in wet persistence (default False)

Type:

bool

jitter

Jitter the position of the brush while painting (in [0, 1000], default 0.0)

Type:

float

jitter_absolute

Jitter the position of the brush in pixels while painting (in [0, 1000000], default 0)

Type:

int

jitter_unit

Jitter in screen space or relative to brush size (default 'VIEW')

• VIEW View – Jittering happens in screen space, in pixels.

• BRUSH Brush – Jittering happens relative to the brush size.

Type:

Literal[‘VIEW’, ‘BRUSH’]

mask_overlay_alpha

(in [0, 100], default 33)

Type:

int

mask_stencil_dimension

Dimensions of mask stencil in viewport (array of 2 items, in [-inf, inf], default (256.0, 256.0))

Type:

mathutils.Vector

mask_stencil_pos

Position of mask stencil in viewport (array of 2 items, in [-inf, inf], default (256.0, 256.0))

Type:

mathutils.Vector

mask_texture

Type:

Texture

mask_texture_slot

(readonly)

Type:

BrushTextureSlot

mask_tool

(default 'DRAW')

Type:

Literal[‘DRAW’, ‘SMOOTH’]

multiplane_scrape_angle

Angle between the planes of the crease (in [0, 160], default 0.0)

Type:

float

normal_radius_factor

Ratio between the brush radius and the radius that is going to be used to sample the normal (in [0, 2], default 0.5)

Type:

float

normal_weight

How much grab will pull vertices out of surface during a grab (in [0, 1], default 0.0)

Type:

float

paint_curve

Active paint curve

Type:

PaintCurve

plane_depth

The maximum distance below the plane for affected vertices. Increasing the depth affects vertices farther below the plane. (in [0, 1], default 0.0)

Type:

float

plane_height

The maximum distance above the plane for affected vertices. Increasing the height affects vertices farther above the plane. (in [0, 1], default 1.0)

Type:

float

plane_inversion_mode

Inversion Mode (default 'INVERT_DISPLACEMENT')

• INVERT_DISPLACEMENT Invert Displacement – Displace the vertices away from the plane..

• SWAP_DEPTH_AND_HEIGHT Swap Height and Depth – Swap the roles of Height and Depth..

Type:

Literal[‘INVERT_DISPLACEMENT’, ‘SWAP_DEPTH_AND_HEIGHT’]

plane_offset

Adjust plane on which the brush acts towards or away from the object surface (in [-2, 2], default 0.0)

Type:

float

plane_trim

If a vertex is further away from offset plane than this, then it is not affected (in [0, 1], default 0.5)

Type:

float

pose_deform_type

Deformation type that is used in the brush (default 'ROTATE_TWIST')

Type:

Literal[‘ROTATE_TWIST’, ‘SCALE_TRANSLATE’, ‘SQUASH_STRETCH’]

pose_ik_segments

Number of segments of the inverse kinematics chain that will deform the mesh (in [1, 20], default 1)

Type:

int

pose_offset

Offset of the pose origin in relation to the brush radius (in [0, 2], default 0.0)

Type:

float

pose_origin_type

Method to set the rotation origins for the segments of the brush (default 'TOPOLOGY')

• TOPOLOGY Topology – Sets the rotation origin automatically using the topology and shape of the mesh as a guide.

• FACE_SETS Face Sets – Creates a pose segment per face set, starting from the active face set.

• FACE_SETS_FK Face Sets FK – Simulates an FK deformation using the face set under the cursor as control.

Type:

Literal[‘TOPOLOGY’, ‘FACE_SETS’, ‘FACE_SETS_FK’]

pose_smooth_iterations

Smooth iterations applied after calculating the pose factor of each vertex (in [0, 100], default 4)

Type:

int

rake_factor

How much grab will follow cursor rotation (in [0, 10], default 0.0)

Type:

float

rate

Interval between paints for Airbrush (in [0.0001, 10000], default 0.1)

Type:

float

saturation_jitter

Color jitter effect on saturation (in [0, 1], default 0.0)

Type:

float

sculpt_brush_type

(default 'DRAW')

Type:

Literal[Brush Sculpt Brush Type Items]

sculpt_capabilities

(readonly, never None)

Type:

BrushCapabilitiesSculpt

sculpt_plane

(default 'AREA')

Type:

Literal[‘AREA’, ‘VIEW’, ‘X’, ‘Y’, ‘Z’]

secondary_color

(array of 3 items, in [0, inf], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

sharp_threshold

Threshold below which, no sharpening is done (in [0, 100], default 0.0)

Type:

float

show_multiplane_scrape_planes_preview

Preview the scrape planes in the cursor during the stroke (default False)

Type:

bool

size

Diameter of the brush in pixels (in [1, 10000], default 70)

Type:

int

slide_deform_type

Deformation type that is used in the brush (default 'DRAG')

Type:

Literal[‘DRAG’, ‘PINCH’, ‘EXPAND’]

smear_deform_type

Deformation type that is used in the brush (default 'DRAG')

Type:

Literal[‘DRAG’, ‘PINCH’, ‘EXPAND’]

smooth_deform_type

Deformation type that is used in the brush (default 'LAPLACIAN')

• LAPLACIAN Laplacian – Smooths the surface and the volume.

• SURFACE Surface – Smooths the surface of the mesh, preserving the volume.

Type:

Literal[‘LAPLACIAN’, ‘SURFACE’]

smooth_stroke_factor

Higher values give a smoother stroke (in [0.5, 0.99], default 0.9)

Type:

float

smooth_stroke_radius

Minimum distance from last point before stroke continues (in [10, 200], default 75)

Type:

int

snake_hook_deform_type

Deformation type that is used in the brush (default 'FALLOFF')

• FALLOFF Radius Falloff – Applies the brush falloff in the tip of the brush.

• ELASTIC Elastic – Modifies the entire mesh using elastic deform.

Type:

Literal[‘FALLOFF’, ‘ELASTIC’]

spacing

Spacing between brush daubs as a percentage of brush diameter (in [1, 1000], default 10)

Type:

int

stabilize_normal

How stable the plane normal is over the course of the stroke. A value of 0 corresponds to using the current normal, and a value of 1 corresponds to using the initial normal. (in [0, 1], default 0.0)

Type:

float

stabilize_plane

How stable the plane center is over the course of the stroke. A value of 0 corresponds to using the current center, and a value of 1 corresponds to using the initial center. (in [0, 1], default 0.0)

Type:

float

stencil_dimension

Dimensions of stencil in viewport (array of 2 items, in [-inf, inf], default (256.0, 256.0))

Type:

mathutils.Vector

stencil_pos

Position of stencil in viewport (array of 2 items, in [-inf, inf], default (256.0, 256.0))

Type:

mathutils.Vector

strength

How powerful the effect of the brush is when applied (in [0, 10], default 1.0)

Type:

float

stroke_method

(default 'DOTS')

• DOTS Dots – Apply paint on each mouse move step.

• DRAG_DOT Drag Dot – Allows a single dot to be carefully positioned.

• SPACE Space – Limit brush application to the distance specified by spacing.

• AIRBRUSH Airbrush – Keep applying paint effect while holding mouse (spray).

• ANCHORED Anchored – Keep the brush anchored to the initial location.

• LINE Line – Draw a line with dabs separated according to spacing.

• CURVE Curve – Define the stroke curve with a Bézier curve (dabs are separated according to spacing).

Type:

Literal[‘DOTS’, ‘DRAG_DOT’, ‘SPACE’, ‘AIRBRUSH’, ‘ANCHORED’, ‘LINE’, ‘CURVE’]

surface_smooth_current_vertex

How much the position of each individual vertex influences the final result (in [0, 1], default 0.0)

Type:

float

surface_smooth_iterations

Number of smoothing iterations per brush step (in [1, 10], default 0)

Type:

int

surface_smooth_shape_preservation

How much of the original shape is preserved when smoothing (in [0, 1], default 0.0)

Type:

float

texture

Type:

Texture

texture_overlay_alpha

(in [0, 100], default 33)

Type:

int

texture_sample_bias

Value added to texture samples (in [-1, 1], default 0.0)

Type:

float

texture_slot

(readonly)

Type:

BrushTextureSlot

tilt_strength_factor

How much the tilt of the pen will affect the brush. Negative values indicate inverting the tilt directions. (in [-1, 1], default 0.0)

Type:

float

tip_roundness

Roundness of the brush tip (in [0, 1], default 1.0)

Type:

float

tip_scale_x

Scale of the brush tip in the X axis (in [0.0001, 1], default 1.0)

Type:

float

topology_rake_factor

Automatically align edges to the brush direction to generate cleaner topology and define sharp features. Best used on low-poly meshes as it has a performance impact. (in [0, 1], default 0.0)

Type:

float

unprojected_size

Diameter of brush in Blender units (in [0.001, inf], default 0.1)

Type:

float

use_accumulate

Accumulate stroke daubs on top of each other (default False)

Type:

bool

use_adaptive_space

Space daubs according to surface orientation instead of screen space (default False)

Type:

bool

use_alpha

When this is disabled, lock alpha while painting (default True)

Type:

bool

use_automasking_boundary_edges

Do not affect non manifold boundary edges (default False)

Type:

bool

use_automasking_boundary_face_sets

Do not affect vertices that belong to a face set boundary (default False)

Type:

bool

use_automasking_cavity

Do not affect vertices on peaks, based on the surface curvature (default False)

Type:

bool

use_automasking_cavity_inverted

Do not affect vertices within crevices, based on the surface curvature (default False)

Type:

bool

use_automasking_custom_cavity_curve

Use custom curve (default False)

Type:

bool

use_automasking_face_sets

Affect only vertices that share face sets with the active vertex (default False)

Type:

bool

use_automasking_start_normal

Affect only vertices with a similar normal to where the stroke starts (default False)

Type:

bool

use_automasking_topology

Affect only vertices connected to the active vertex under the brush (default False)

Type:

bool

use_automasking_view_normal

Affect only vertices with a normal that faces the viewer (default False)

Type:

bool

use_automasking_view_occlusion

Only affect vertices that are not occluded by other faces (slower performance) (default False)

Type:

bool

use_cloth_collision

Collide with objects during the simulation (default False)

Type:

bool

use_cloth_pin_simulation_boundary

Lock the position of the vertices in the simulation falloff area to avoid artifacts and create a softer transition with unaffected areas (default False)

Type:

bool

use_color_as_displacement

Handle each pixel color as individual vector for displacement (area plane mapping only) (default False)

Type:

bool

use_color_jitter

Jitter brush color (default False)

Type:

bool

use_connected_only

Affect only topologically connected elements (default False)

Type:

bool

use_cursor_overlay

Show cursor in viewport (default False)

Type:

bool

use_cursor_overlay_override

Don’t show overlay during a stroke (default False)

Type:

bool

use_density_pressure

Use pressure to modulate density (default False)

Type:

bool

use_edge_to_edge

Drag anchor brush from edge-to-edge (default False)

Type:

bool

use_flow_pressure

Use pressure to modulate flow (default False)

Type:

bool

use_frontface

Brush only affects vertices that face the viewer (default False)

Type:

bool

use_frontface_falloff

Blend brush influence by how much they face the front (default False)

Type:

bool

use_grab_active_vertex

Apply the maximum grab strength to the active vertex instead of the cursor location (default False)

Type:

bool

use_grab_silhouette

Grabs trying to automask the silhouette of the object (default False)

Type:

bool

use_hardness_pressure

Use pressure to modulate hardness (default False)

Type:

bool

use_inverse_smooth_pressure

Lighter pressure causes more smoothing to be applied (default False)

Type:

bool

use_locked_size

Measure brush size relative to the view or the scene (default 'VIEW')

• VIEW View – Measure brush size relative to the view.

• SCENE Scene – Measure brush size relative to the scene.

Type:

Literal[‘VIEW’, ‘SCENE’]

use_multiplane_scrape_dynamic

The angle between the planes changes during the stroke to fit the surface under the cursor (default False)

Type:

bool

use_offset_pressure

Enable tablet pressure sensitivity for offset (default False)

Type:

bool

use_original_normal

When locked keep using normal of surface where stroke was initiated (default False)

Type:

bool

use_original_plane

When locked keep using the plane origin of surface where stroke was initiated (default False)

Type:

bool

use_paint_antialiasing

Smooths the edges of the strokes (default True)

Type:

bool

use_paint_grease_pencil

Use this brush in Grease Pencil drawing mode (default False)

Type:

bool

use_paint_image

Use this brush in texture paint mode (default True)

Type:

bool

use_paint_sculpt

Use this brush in sculpt mode (default True)

Type:

bool

use_paint_sculpt_curves

Use this brush in sculpt curves mode (default False)

Type:

bool

use_paint_uv_sculpt

Use this brush in UV sculpt mode (default False)

Type:

bool

use_paint_vertex

Use this brush in vertex paint mode (default True)

Type:

bool

use_paint_weight

Use this brush in weight paint mode (default True)

Type:

bool

use_persistent

Sculpt on a persistent layer of the mesh (default False)

Type:

bool

use_plane_trim

Limit the distance from the offset plane that a vertex can be affected (default False)

Type:

bool

use_pose_ik_anchored

Keep the position of the last segment in the IK chain fixed (default False)

Type:

bool

use_pose_lock_rotation

Do not rotate the segment when using the scale deform mode (default False)

Type:

bool

use_pressure_area_radius

Enable tablet pressure sensitivity for area radius (default False)

Type:

bool

use_pressure_jitter

Enable tablet pressure sensitivity for jitter (default False)

Type:

bool

use_pressure_masking

Pen pressure makes texture influence smaller (default 'NONE')

Type:

Literal[‘NONE’, ‘RAMP’, ‘CUTOFF’]

use_pressure_size

Enable tablet pressure sensitivity for size (default False)

Type:

bool

use_pressure_spacing

Enable tablet pressure sensitivity for spacing (default False)

Type:

bool

use_pressure_strength

Enable tablet pressure sensitivity for strength (default True)

Type:

bool

use_primary_overlay

Show texture in viewport (default False)

Type:

bool

use_primary_overlay_override

Don’t show overlay during a stroke (default False)

Type:

bool

use_random_press_hue

Use pressure to modulate randomness (default False)

Type:

bool

use_random_press_sat

Use pressure to modulate randomness (default False)

Type:

bool

use_random_press_val

Use pressure to modulate randomness (default False)

Type:

bool

use_scene_spacing

Calculate the brush spacing using view or scene distance (default 'VIEW')

• VIEW View – Calculate brush spacing relative to the view.

• SCENE Scene – Calculate brush spacing relative to the scene using the stroke location.

Type:

Literal[‘VIEW’, ‘SCENE’]

use_secondary_overlay

Show texture in viewport (default False)

Type:

bool

use_secondary_overlay_override

Don’t show overlay during a stroke (default False)

Type:

bool

use_smooth_stroke

Brush lags behind mouse and follows a smoother path (default False)

Type:

bool

use_space_attenuation

Automatically adjust strength to give consistent results for different spacings (default True)

Type:

bool

use_stroke_random_hue

Use randomness at stroke level (default False)

Type:

bool

use_stroke_random_sat

Use randomness at stroke level (default False)

Type:

bool

use_stroke_random_val

Use randomness at stroke level (default False)

Type:

bool

use_vertex_grease_pencil

Use this brush in Grease Pencil vertex color mode (default False)

Type:

bool

use_wet_mix_pressure

Use pressure to modulate wet mix (default False)

Type:

bool

use_wet_persistence_pressure

Use pressure to modulate wet persistence (default False)

Type:

bool

value_jitter

Color jitter effect on value (in [0, 1], default 0.0)

Type:

float

vertex_brush_type

(default 'DRAW')

Type:

Literal[Brush Vertex Brush Type Items]

vertex_paint_capabilities

(readonly, never None)

Type:

BrushCapabilitiesVertexPaint

weight

Vertex weight when brush is applied (in [0, 1], default 1.0)

Type:

float

weight_brush_type

(default 'DRAW')

Type:

Literal[Brush Weight Brush Type Items]

weight_paint_capabilities

(readonly, never None)

Type:

BrushCapabilitiesWeightPaint

wet_mix

Amount of paint that is picked from the surface into the brush color (in [0, 1], default 0.0)

Type:

float

wet_paint_radius_factor

Ratio between the brush radius and the radius that is going to be used to sample the color to blend in wet paint (in [0, 2], default 0.5)

Type:

float

wet_persistence

Amount of wet paint that stays in the brush after applying paint to the surface (in [0, 1], default 0.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)

Parameters:

• id (str) – The RNA type identifier.

• default (bpy.types.Struct | None) – The value to return when not found.

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.

• default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

bpy_struct.id_data ID.name ID.name_full ID.id_type ID.session_uid ID.is_evaluated ID.original ID.users ID.use_fake_user ID.use_extra_user ID.is_embedded_data

ID.is_linked_packed ID.is_missing ID.is_runtime_data ID.is_editable ID.tag ID.is_library_indirect ID.library ID.library_weak_reference ID.asset_data ID.override_library ID.preview

Inherited Functions

bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui 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_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors

bpy_struct.type_recast bpy_struct.values ID.bl_system_properties_get ID.rename ID.evaluated_get ID.copy ID.asset_mark ID.asset_clear ID.asset_generate_preview ID.override_create ID.override_hierarchy_create ID.user_clear ID.user_remap ID.make_local ID.user_of_id ID.animation_data_create ID.animation_data_clear ID.update_tag ID.preview_ensure ID.bl_rna_get_subclass ID.bl_rna_get_subclass_py

References

bpy.context.brush BlendData.brushes BlendDataBrushes.create_gpencil_data BlendDataBrushes.new

BlendDataBrushes.remove Paint.brush Paint.eraser_brush