ObjectShaderFx(bpy_struct)

base class — bpy_struct

class bpy.types.ObjectShaderFx(bpy_struct)

Collection of object effects

new(name, type)

Add a new shader fx

Parameters:
  • name (string, (never None)) – New name for the effect
  • type (enum in ['FX_BLUR', 'FX_COLORIZE', 'FX_FLIP', 'FX_GLOW', 'FX_PIXEL', 'FX_RIM', 'FX_SHADOW', 'FX_SWIRL', 'FX_WAVE']) –

    Effect type to add

    • 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.
Returns:

Newly created effect

Return type:

ShaderFx

remove(shader_fx)

Remove an existing effect from the object

Parameters:shader_fx (ShaderFx, (never None)) – Effect to remove
clear()

Remove all effects from the object

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

Inherited Functions

References