ImagePaint(Paint)

base classes — bpy_struct, Paint

class bpy.types.ImagePaint(Paint)

Properties of image and texture painting mode

canvas

Image used as canvas

Type:

Image

clone_alpha

Opacity of clone image display (in [0, 1], default 0.5)

Type:

float

clone_image

Image used as clone source

Type:

Image

clone_offset

(array of 2 items, in [-inf, inf], default (0.0, 0.0))

Type:

mathutils.Vector

dither

Amount of dithering when painting on byte images (in [0, 2], default 0.0)

Type:

float

interpolation

Texture filtering type (default 'LINEAR')

  • LINEAR Linear – Linear interpolation.

  • CLOSEST Closest – No interpolation (sample closest texel).

Type:

Literal[‘LINEAR’, ‘CLOSEST’]

invert_stencil

Invert the stencil layer (default False)

Type:

bool

missing_materials

The mesh is missing materials (default False, readonly)

Type:

bool

missing_stencil

Image Painting does not have a stencil (default False, readonly)

Type:

bool

missing_texture

Image Painting does not have a texture to paint on (default False, readonly)

Type:

bool

missing_uvs

A UV layer is missing on the mesh (default False, readonly)

Type:

bool

mode

Mode of operation for projection painting (default 'MATERIAL')

  • MATERIAL Material – Detect image slots from the material.

  • IMAGE Single Image – Set image for texture painting directly.

Type:

Literal[‘MATERIAL’, ‘IMAGE’]

normal_angle

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

Type:

int

screen_grab_size

Size to capture the image for re-projecting (array of 2 items, in [512, 16384], default (0, 0))

Type:

bpy_prop_array[int]

seam_bleed

Extend paint beyond the faces’ UVs to reduce seams (in pixels, slower) (in [-32768, 32767], default 2)

Type:

int

stencil_color

Stencil color in the viewport (array of 3 items, in [0, 1], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

stencil_image

Image used as stencil

Type:

Image

use_backface_culling

Ignore faces pointing away from the view (faster) (default True)

Type:

bool

use_clone_layer

Use another UV map as clone source, otherwise use the 3D cursor as the source (default False)

Type:

bool

use_normal_falloff

Paint most on faces pointing towards the view (default True)

Type:

bool

use_occlude

Only paint onto the faces directly under the brush (slower) (default True)

Type:

bool

use_stencil_layer

Set the mask layer from the UV map buttons (default False)

Type:

bool

detect_data()

Check if required texpaint data exist

Return 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

References