DynamicPaintSurface(bpy_struct)

base class — bpy_struct

class bpy.types.DynamicPaintSurface(bpy_struct)

A canvas surface layer

brush_collection

Only use brush objects from this collection

Type:

Collection

brush_influence_scale

Adjust influence brush objects have on this surface (in [0, 1], default 0.0)

Type:

float

brush_radius_scale

Adjust radius of proximity brushes or particles for this surface (in [0, 10], default 0.0)

Type:

float

color_dry_threshold

The wetness level when colors start to shift to the background (in [0, 1], default 0.0)

Type:

float

color_spread_speed

How fast colors get mixed within wet paint (in [0, 2], default 0.0)

Type:

float

depth_clamp

Maximum level of depth intersection in object space (use 0.0 to disable) (in [0, 50], default 0.0)

Type:

float

displace_factor

Strength of displace when applied to the mesh (in [-50, 50], default 0.0)

Type:

float

displace_type

(default 'DISPLACE')

Type:

Literal[‘DISPLACE’, ‘DEPTH’]

dissolve_speed

Approximately in how many frames should dissolve happen (in [1, 10000], default 0)

Type:

int

drip_acceleration

How much surface acceleration affects dripping (in [-200, 200], default 0.0)

Type:

float

drip_velocity

How much surface velocity affects dripping (in [-200, 200], default 0.0)

Type:

float

dry_speed

Approximately in how many frames should drying happen (in [1, 10000], default 0)

Type:

int

effect_ui

(default 'SPREAD')

Type:

Literal[‘SPREAD’, ‘DRIP’, ‘SHRINK’]

effector_weights

(readonly)

Type:

EffectorWeights

frame_end

Simulation end frame (in [1, 1048574], default 0)

Type:

int

frame_start

Simulation start frame (in [1, 1048574], default 0)

Type:

int

frame_substeps

Do extra frames between scene frames to ensure smooth motion (in [0, 20], default 0)

Type:

int

image_fileformat

(default 'PNG')

Type:

Literal[‘PNG’, ‘OPENEXR’]

image_output_path

Directory to save the textures (default “”, never None, blend relative // prefix supported)

Type:

str

image_resolution

Output image resolution (in [16, 4096], default 0)

Type:

int

init_color

Initial color of the surface (array of 4 items, in [0, inf], default (0.0, 0.0, 0.0, 0.0))

Type:

bpy_prop_array[float]

init_color_type

(default 'NONE')

Type:

Literal[‘NONE’, ‘COLOR’, ‘TEXTURE’, ‘VERTEX_COLOR’]

init_layername

(default “”, never None)

Type:

str

init_texture
Type:

Texture

is_active

Toggle whether surface is processed or ignored (default False)

Type:

bool

is_cache_user

(default False, readonly)

Type:

bool

name

Surface name (default “”, never None)

Type:

str

output_name_a

Name used to save output from this surface (default “”, never None)

Type:

str

output_name_b

Name used to save output from this surface (default “”, never None)

Type:

str

point_cache

(readonly, never None)

Type:

PointCache

shrink_speed

How fast shrink effect moves on the canvas surface (in [0.001, 10], default 0.0)

Type:

float

spread_speed

How fast spread effect moves on the canvas surface (in [0.001, 10], default 0.0)

Type:

float

surface_format

Surface Format (default 'VERTEX')

Type:

Literal[‘VERTEX’, ‘IMAGE’]

surface_type

Surface Type (default 'PAINT')

Type:

Literal[‘PAINT’]

use_antialiasing

Use 5× multisampling to smooth paint edges (default False)

Type:

bool

use_dissolve

Enable to make surface changes disappear over time (default False)

Type:

bool

use_dissolve_log

Use logarithmic dissolve (makes high values to fade faster than low values) (default False)

Type:

bool

use_drip

Process drip effect (drip wet paint to gravity direction) (default False)

Type:

bool

use_dry_log

Use logarithmic drying (makes high values to dry faster than low values) (default False)

Type:

bool

use_drying

Enable to make surface wetness dry over time (default False)

Type:

bool

use_incremental_displace

New displace is added cumulatively on top of existing (default False)

Type:

bool

use_output_a

Save this output layer (default False)

Type:

bool

use_output_b

Save this output layer (default False)

Type:

bool

use_premultiply

Multiply color by alpha (recommended for Blender input) (default False)

Type:

bool

use_shrink

Process shrink effect (shrink paint areas) (default False)

Type:

bool

use_spread

Process spread effect (spread wet paint around surface) (default False)

Type:

bool

use_wave_open_border

Pass waves through mesh edges (default False)

Type:

bool

uv_layer

UV map name (default “”, never None)

Type:

str

wave_damping

Wave damping factor (in [0, 1], default 0.0)

Type:

float

wave_smoothness

Limit maximum steepness of wave slope between simulation points (use higher values for smoother waves at expense of reduced detail) (in [0, 10], default 0.0)

Type:

float

wave_speed

Wave propagation speed (in [0.01, 5], default 0.0)

Type:

float

wave_spring

Spring force that pulls water level back to zero (in [0, 1], default 0.0)

Type:

float

wave_timescale

Wave time scaling factor (in [0.01, 3], default 0.0)

Type:

float

output_exists(object, index)

Checks if surface output layer of given name exists

Parameters:

  • object (Object) – (never None)

  • index (int) – Index, (in [0, 1])

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