MaterialGPencilStyle(bpy_struct)

base class — bpy_struct

class bpy.types.MaterialGPencilStyle(bpy_struct)
alignment_mode

Defines how align Dots and Boxes with drawing path and object rotation (default 'PATH')

  • PATH Path – Follow stroke drawing path and object rotation.

  • OBJECT Object – Follow object rotation only.

  • FIXED Fixed – Do not follow drawing path or object rotation and keeps aligned with viewport.

Type:

Literal[‘PATH’, ‘OBJECT’, ‘FIXED’]

alignment_rotation

Additional rotation applied to dots and square texture of strokes. Only applies in texture shading mode. (in [-1.5708, 1.5708], default 0.0)

Type:

float

color

(array of 4 items, in [0, 1], default (0.0, 0.0, 0.0, 0.0))

Type:

bpy_prop_array[float]

fill_color

Color for filling region bounded by each stroke (array of 4 items, in [0, 1], default (0.0, 0.0, 0.0, 0.0))

Type:

bpy_prop_array[float]

fill_image
Type:

Image

fill_style

Select style used to fill strokes (default 'SOLID')

  • SOLID Solid – Fill area with solid color.

  • GRADIENT Gradient – Fill area with gradient color.

  • TEXTURE Texture – Fill area with image texture.

Type:

Literal[‘SOLID’, ‘GRADIENT’, ‘TEXTURE’]

flip

Flip filling colors (default False)

Type:

bool

ghost

Display strokes using this color when showing onion skins (default False)

Type:

bool

gradient_type

Select type of gradient used to fill strokes (default 'LINEAR')

  • LINEAR Linear – Fill area with gradient color.

  • RADIAL Radial – Fill area with radial gradient.

Type:

Literal[‘LINEAR’, ‘RADIAL’]

hide

Set color Visibility (default False)

Type:

bool

is_fill_visible

True when opacity of fill is set high enough to be visible (default False, readonly)

Type:

bool

is_stroke_visible

True when opacity of stroke is set high enough to be visible (default False, readonly)

Type:

bool

lock

Protect color from further editing and/or frame changes (default False)

Type:

bool

mix_color

Color for mixing with primary filling color (array of 4 items, in [0, 1], default (0.0, 0.0, 0.0, 0.0))

Type:

bpy_prop_array[float]

mix_factor

Mix Factor (in [0, 1], default 0.0)

Type:

float

mix_stroke_factor

Mix Stroke Factor (in [0, 1], default 0.0)

Type:

float

mode

Select line type for strokes (default 'LINE')

  • LINE Line – Draw strokes using a continuous line.

  • DOTS Dots – Draw strokes using separated dots.

  • BOX Squares – Draw strokes using separated squares.

Type:

Literal[‘LINE’, ‘DOTS’, ‘BOX’]

pass_index

Index number for the “Color Index” pass (in [0, 32767], default 0)

Type:

int

pixel_size

Texture Pixel Size factor along the stroke (in [1, 5000], default 0.0)

Type:

float

show_fill

Show stroke fills of this material (default False)

Deprecated since version 5.10: removal planned in version 6.0

Unused but kept for compatibility with older versions of Blender.

Type:

bool

show_stroke

Show stroke lines of this material (default False)

Deprecated since version 5.10: removal planned in version 6.0

Unused but kept for compatibility with older versions of Blender.

Type:

bool

stroke_image
Type:

Image

stroke_style

Select style used to draw strokes (default 'SOLID')

  • SOLID Solid – Draw strokes with solid color.

  • TEXTURE Texture – Draw strokes using texture.

Type:

Literal[‘SOLID’, ‘TEXTURE’]

texture_angle

Texture Orientation Angle (in [-inf, inf], default 0.0)

Type:

float

texture_clamp

Do not repeat texture and clamp to one instance only (default False)

Type:

bool

texture_offset

Shift Texture in 2d Space (array of 2 items, in [-inf, inf], default (0.0, 0.0))

Type:

mathutils.Vector

texture_scale

Scale Factor for Texture (array of 2 items, in [-inf, inf], default (0.0, 0.0))

Type:

mathutils.Vector

use_fill_holdout

Remove the color from underneath this stroke by using it as a mask (default False)

Type:

bool

use_overlap_strokes

Disable stencil and overlap self intersections with alpha materials (default False)

Type:

bool

use_stroke_holdout

Remove the color from underneath this stroke by using it as a mask (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