# psd_tools.api.effects

Effects module.

class psd_tools.api.effects.Effects(layer: LayerProtocol)

  List-like effects.

  Only present effects are kept.

  property enabled: bool

    Whether if all the effects are enabled.

    Return type:

      bool

  find(name: str, enabled: bool = True) → Iterator[_Effect]

    Iterate effect items by name.

    Parameters:

      - name – Effect name, e.g. DropShadow, InnerShadow, OuterGlow, InnerGlow, ColorOverlay, GradientOverlay, PatternOverlay, Stroke, BevelEmboss, or Satin.

      - enabled – If true, only return enabled effects.

    Return type:

      Iterator[Effect]

  property scale: float

    Scale value.

## DropShadow

class psd_tools.api.effects.DropShadow(descriptor: Descriptor, image_resources: ImageResources)
  property angle: float

    Angle value.

  property anti_aliased: bool

    Angi-aliased.

  property blend_mode: bytes

    Effect blending mode.

  property choke: float

    Choke level in pixels.

  property color: Descriptor

    Color.

  property contour: Descriptor

    Contour configuration.

  property distance: float

    Distance in pixels.

  property enabled: bool

    Whether if the effect is enabled.

  property layer_knocks_out: bool

    Layers are knocking out.

  property name: str

    Effect name.

  property noise: float

    Noise level in percent.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size in pixels.

  property use_global_light: bool

    Using global light.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## InnerShadow

class psd_tools.api.effects.InnerShadow(descriptor: Descriptor, image_resources: ImageResources)
  property angle: float

    Angle value.

  property anti_aliased: bool

    Angi-aliased.

  property blend_mode: bytes

    Effect blending mode.

  property choke: float

    Choke level in pixels.

  property color: Descriptor

    Color.

  property contour: Descriptor

    Contour configuration.

  property distance: float

    Distance in pixels.

  property enabled: bool

    Whether if the effect is enabled.

  property name: str

    Effect name.

  property noise: float

    Noise level in percent.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size in pixels.

  property use_global_light: bool

    Using global light.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## OuterGlow

class psd_tools.api.effects.OuterGlow(descriptor: Descriptor, image_resources: ImageResources)
  property angle: float

    Angle value.

  property anti_aliased: bool

    Angi-aliased.

  property blend_mode: bytes

    Effect blending mode.

  property choke: float

    Choke level in pixels.

  property color: Descriptor

    Color.

  property contour: Descriptor

    Contour configuration.

  property dithered: bool

    Dither flag.

  property enabled: bool

    Whether if the effect is enabled.

  property glow_type: bytes

    Glow type.

  property gradient: Descriptor

    Gradient configuration.

  property name: str

    Effect name.

  property noise: float

    Noise level in percent.

  property offset: Descriptor

    Offset value in Pnt descriptor.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property quality_jitter: float

    Quality jitter in percent.

  property quality_range: float

    Quality range in percent.

  property reversed: bool

    Reverse flag.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size in pixels.

  property spread: float

    Spread level in percent.

  property type: bytes

    Gradient type, one of linear, radial, angle, reflected, or diamond.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## InnerGlow

class psd_tools.api.effects.InnerGlow(descriptor: Descriptor, image_resources: ImageResources)
  property angle: float

    Angle value.

  property anti_aliased: bool

    Angi-aliased.

  property blend_mode: bytes

    Effect blending mode.

  property choke: float

    Choke level in pixels.

  property color: Descriptor

    Color.

  property contour: Descriptor

    Contour configuration.

  property dithered: bool

    Dither flag.

  property enabled: bool

    Whether if the effect is enabled.

  property glow_source: bytes

    Elements source.

  property glow_type: bytes

    Glow type.

  property gradient: Descriptor

    Gradient configuration.

  property name: str

    Effect name.

  property noise: float

    Noise level in percent.

  property offset: Descriptor

    Offset value in Pnt descriptor.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property quality_jitter: float

    Quality jitter in percent.

  property quality_range: float

    Quality range in percent.

  property reversed: bool

    Reverse flag.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size in pixels.

  property type: bytes

    Gradient type, one of linear, radial, angle, reflected, or diamond.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## ColorOverlay

class psd_tools.api.effects.ColorOverlay(descriptor: Descriptor, image_resources: ImageResources)
  property blend_mode: bytes

    Effect blending mode.

  property color: Descriptor

    Color.

  property enabled: bool

    Whether if the effect is enabled.

  property name: str

    Effect name.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property shown: bool

    Whether if the effect is shown in dialog.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## GradientOverlay

class psd_tools.api.effects.GradientOverlay(descriptor: Descriptor, image_resources: ImageResources)
  property aligned: bool

    Aligned.

  property angle: float

    Angle value.

  property blend_mode: bytes

    Effect blending mode.

  property dithered: bool

    Dither flag.

  property enabled: bool

    Whether if the effect is enabled.

  property gradient: Descriptor

    Gradient configuration.

  property name: str

    Effect name.

  property offset: Descriptor

    Offset value in Pnt descriptor.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property reversed: bool

    Reverse flag.

  property scale: float

    Scale value.

  property shown: bool

    Whether if the effect is shown in dialog.

  property type: bytes

    Gradient type, one of linear, radial, angle, reflected, or diamond.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## PatternOverlay

class psd_tools.api.effects.PatternOverlay(descriptor: Descriptor, image_resources: ImageResources)
  property aligned: bool

    Aligned.

  property angle: float

    Angle value.

  property blend_mode: bytes

    Effect blending mode.

  property enabled: bool

    Whether if the effect is enabled.

  property linked: bool

    Linked.

  property name: str

    Effect name.

  property opacity: float

    Layer effect opacity in percentage.

  property pattern: Descriptor

    Pattern config.

  property phase: Descriptor

    Phase value in Point.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property scale: float

    Scale value.

  property shown: bool

    Whether if the effect is shown in dialog.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## Stroke

class psd_tools.api.effects.Stroke(descriptor: Descriptor, image_resources: ImageResources)
  property angle: float

    Angle value.

  property blend_mode: bytes

    Effect blending mode.

  property color: Descriptor

    Color.

  property dithered: bool

    Dither flag.

  property enabled: bool

    Whether if the effect is enabled.

  property fill_type: bytes

    Fill type, SolidColor, Gradient, or Pattern.

  property gradient: Descriptor

    Gradient configuration.

  property linked: bool

    Linked.

  property name: str

    Effect name.

  property offset: Descriptor

    Offset value in Pnt descriptor.

  property opacity: float

    Layer effect opacity in percentage.

  property overprint: bool

    Overprint flag.

  property pattern: Descriptor

    Pattern config.

  property phase: Descriptor

    Phase value in Point.

  property position: bytes

    Position of the stroke, InsetFrame, OutsetFrame, or CenteredFrame.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property reversed: bool

    Reverse flag.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size value.

  property type: bytes

    Gradient type, one of linear, radial, angle, reflected, or diamond.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## BevelEmboss

class psd_tools.api.effects.BevelEmboss(descriptor: Descriptor, image_resources: ImageResources)
  property altitude: float

    Altitude value in angle.

  property angle: float

    Angle value.

  property anti_aliased: bool

    Anti-aliased.

  property bevel_style: bytes

    Bevel style, one of OuterBevel, InnerBevel, Emboss, PillowEmboss, or StrokeEmboss.

  property bevel_type: bytes

    Bevel type, one of SoftMatte, HardLight, SoftLight.

  property contour: Descriptor

    Contour configuration.

  property depth: float

    Depth value in percentage.

  property direction: bytes

    Direction, either StampIn or StampOut.

  property enabled: bool

    Whether if the effect is enabled.

  property highlight_color: Descriptor

    Highlight color value.

  property highlight_mode: bytes

    Highlight blending mode.

  property highlight_opacity: float

    Highlight opacity value in percentage.

  property name: str

    Effect name.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property shadow_color: Descriptor

    Shadow color value.

  property shadow_mode: bytes

    Shadow blending mode.

  property shadow_opacity: float

    Shadow opacity value in percentage.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size value in pixel.

  property soften: float

    Soften value in pixels.

  property use_global_light: bool

    Using global light.

  property use_shape: bool

    Using shape.

  property use_texture: bool

    Using texture.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.

## Satin

class psd_tools.api.effects.Satin(descriptor: Descriptor, image_resources: ImageResources)

  Satin effect

  property angle: float

    Angle value in degrees.

  property anti_aliased: bool

    Anti-aliased.

  property blend_mode: bytes

    Effect blending mode.

  property color: Descriptor

    Color.

  property contour: Descriptor

    Contour configuration.

  property distance: float

    Distance value in pixels.

  property enabled: bool

    Whether if the effect is enabled.

  property inverted: bool

    Inverted.

  property name: str

    Effect name.

  property opacity: float

    Layer effect opacity in percentage.

  property present: bool

    Whether if the effect is present in Photoshop UI.

  property shown: bool

    Whether if the effect is shown in dialog.

  property size: float

    Size value in pixel.

  property value: Descriptor

    Deprecated

    Effect descriptor value. Use descriptor property instead.