FreestyleSettings(bpy_struct)

base class — bpy_struct

class bpy.types.FreestyleSettings(bpy_struct)

Freestyle settings for a ViewLayer data-block

as_render_pass

Renders Freestyle output to a separate pass instead of overlaying it on the Combined pass (default False)

Type:

bool

crease_angle

Angular threshold for detecting crease edges (in [0, 3.14159], default 0.0)

Type:

float

kr_derivative_epsilon

Kr derivative epsilon for computing suggestive contours (in [-1000, 1000], default 0.0)

Type:

float

linesets

(default None, readonly)

Type:

Linesets[FreestyleLineSet]

mode

Select the Freestyle control mode (default 'SCRIPT')

  • SCRIPT Python Scripting – Advanced mode for using style modules written in Python.

  • EDITOR Parameter Editor – Basic mode for interactive style parameter editing.

Type:

Literal[‘SCRIPT’, ‘EDITOR’]

modules

A list of style modules (to be applied from top to bottom) (default None, readonly)

Type:

FreestyleModules[FreestyleModuleSettings]

sphere_radius

Sphere radius for computing curvatures (in [0, 1000], default 1.0)

Type:

float

use_culling

If enabled, out-of-view edges are ignored (default False)

Type:

bool

use_material_boundaries

Enable material boundaries (default False)

Type:

bool

use_ridges_and_valleys

Enable ridges and valleys (default False)

Type:

bool

use_smoothness

Take face smoothness into account in view map calculation (default False)

Type:

bool

use_suggestive_contours

Enable suggestive contours (default False)

Type:

bool

use_view_map_cache

Keep the computed view map and avoid recalculating it if mesh geometry is unchanged (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

References