Paint(bpy_struct)

base class — bpy_struct

subclasses — CurvesSculpt, GpPaint, GpSculptPaint, GpVertexPaint, GpWeightPaint, ImagePaint, Sculpt, VertexPaint

class bpy.types.Paint(bpy_struct)
brush

Active brush (readonly)

Type:

Brush

brush_asset_reference

A weak reference to the matching brush asset, used e.g. to restore the last used brush on file load (readonly)

Type:

AssetWeakReference

cavity_curve

Editable cavity curve (readonly, never None)

Type:

CurveMapping

eraser_brush

Default eraser brush for quickly alternating with the main brush

Type:

Brush

eraser_brush_asset_reference

A weak reference to the matching brush asset, used e.g. to restore the last used brush on file load (readonly)

Type:

AssetWeakReference

palette

Active Palette

Type:

Palette

show_brush

(default True)

Type:

bool

show_brush_on_surface

(default False)

Type:

bool

show_bvh_nodes

Show the underlying BVH nodes as differently colored faces (default False)

Type:

bool

show_jitter_curve

(default False)

Type:

bool

show_low_resolution

For multires, show low resolution while navigating the view (default False)

Type:

bool

show_size_curve

(default False)

Type:

bool

show_strength_curve

(default False)

Type:

bool

tile_offset

Stride at which tiled strokes are copied (array of 3 items, in [0.01, inf], default (1.0, 1.0, 1.0))

Type:

mathutils.Vector

tile_x

Tile along X axis (default False)

Type:

bool

tile_y

Tile along Y axis (default False)

Type:

bool

tile_z

Tile along Z axis (default False)

Type:

bool

unified_paint_settings

(readonly, never None)

Type:

UnifiedPaintSettings

use_cavity

Mask painting according to mesh geometry cavity (default False)

Type:

bool

use_sculpt_delay_updates

Update the geometry when it enters the view, providing faster view navigation (default False)

Type:

bool

use_symmetry_feather

Reduce the strength of the brush where it overlaps symmetrical daubs (default True)

Type:

bool

use_symmetry_x

Mirror brush across the X axis (default False)

Type:

bool

use_symmetry_y

Mirror brush across the Y axis (default False)

Type:

bool

use_symmetry_z

Mirror brush across the Z axis (default False)

Type:

bool

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

Inherited Functions