ShaderFx(bpy_struct)

base class — bpy_struct

subclasses — ShaderFxBlur, ShaderFxColorize, ShaderFxFlip, ShaderFxGlow, ShaderFxPixel, ShaderFxRim, ShaderFxShadow, ShaderFxSwirl, ShaderFxWave

class bpy.types.ShaderFx.ShaderFx(bpy_struct)

Effect affecting the grease pencil object

name

Effect name

Type

string, default “”, (never None)

show_expanded

Set effect expansion in the user interface

Type

boolean, default False

show_in_editmode

Display effect in Edit mode

Type

boolean, default False

show_render

Use effect during render

Type

boolean, default False

show_viewport

Display effect in viewport

Type

boolean, default False

type
  • FX_BLUR Blur, Apply Gaussian Blur to object.

  • FX_COLORIZE Colorize, Apply different tint effects.

  • FX_FLIP Flip, Flip image.

  • FX_GLOW Glow, Create a glow effect.

  • FX_PIXEL Pixelate, Pixelate image.

  • FX_RIM Rim, Add a rim to the image.

  • FX_SHADOW Shadow, Create a shadow effect.

  • FX_SWIRL Swirl, Create a rotation distortion.

  • FX_WAVE Wave Distortion, Apply sinusoidal deformation.

Type

enum in [‘FX_BLUR’, ‘FX_COLORIZE’, ‘FX_FLIP’, ‘FX_GLOW’, ‘FX_PIXEL’, ‘FX_RIM’, ‘FX_SHADOW’, ‘FX_SWIRL’, ‘FX_WAVE’], default ‘FX_BLUR’, (readonly)

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • Object.shader_effects

  • ObjectShaderFx.new

  • ObjectShaderFx.remove