psd_tools.api.effects¶

Effects module.

class psd_tools.api.effects.Effects(layer)[source]¶

List-like effects.

enabled¶

Whether if all the effects are enabled.

Return type:	bool

find(name)[source]¶: Iterate effect items by name.

scale¶: Scale value.

DropShadow¶

class psd_tools.api.effects.DropShadow(value, image_resources)[source]¶

angle¶: Angle value.

anti_aliased¶: Angi-aliased.

blend_mode¶: Effect blending mode.

choke¶: Choke level.

color¶: Color.

contour¶: Contour configuration.

distance¶: Distance.

enabled¶: Whether if the effect is enabled.

layer_knocks_out¶: Layers are knocking out.

noise¶: Noise level.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

shown¶: Whether if the effect is shown in dialog.

size¶: Size in pixels.

use_global_light¶: Using global light.

InnerShadow¶

class psd_tools.api.effects.InnerShadow(value, image_resources)[source]¶

angle¶: Angle value.

anti_aliased¶: Angi-aliased.

blend_mode¶: Effect blending mode.

choke¶: Choke level.

color¶: Color.

contour¶: Contour configuration.

distance¶: Distance.

enabled¶: Whether if the effect is enabled.

noise¶: Noise level.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

shown¶: Whether if the effect is shown in dialog.

size¶: Size in pixels.

use_global_light¶: Using global light.

OuterGlow¶

class psd_tools.api.effects.OuterGlow(value, image_resources)[source]¶

angle¶: Angle value.

anti_aliased¶: Angi-aliased.

blend_mode¶: Effect blending mode.

choke¶: Choke level.

color¶: Color.

contour¶: Contour configuration.

dithered¶: Dither flag.

enabled¶: Whether if the effect is enabled.

glow_type¶: Glow type.

gradient¶: Gradient configuration.

noise¶: Noise level.

offset¶: Offset value.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

quality_jitter¶: Quality jitter

quality_range¶: Quality range.

reversed¶: Reverse flag.

shown¶: Whether if the effect is shown in dialog.

size¶: Size in pixels.

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

InnerGlow¶

class psd_tools.api.effects.InnerGlow(value, image_resources)[source]¶

angle¶: Angle value.

anti_aliased¶: Angi-aliased.

blend_mode¶: Effect blending mode.

choke¶: Choke level.

color¶: Color.

contour¶: Contour configuration.

dithered¶: Dither flag.

enabled¶: Whether if the effect is enabled.

glow_source¶: Elements source.

glow_type¶: Glow type.

gradient¶: Gradient configuration.

noise¶: Noise level.

offset¶: Offset value.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

quality_jitter¶: Quality jitter

quality_range¶: Quality range.

reversed¶: Reverse flag.

shown¶: Whether if the effect is shown in dialog.

size¶: Size in pixels.

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

ColorOverlay¶

class psd_tools.api.effects.ColorOverlay(value, image_resources)[source]¶

blend_mode¶: Effect blending mode.

color¶: Color.

enabled¶: Whether if the effect is enabled.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

shown¶: Whether if the effect is shown in dialog.

GradientOverlay¶

class psd_tools.api.effects.GradientOverlay(value, image_resources)[source]¶

aligned¶: Aligned.

angle¶: Angle value.

blend_mode¶: Effect blending mode.

dithered¶: Dither flag.

enabled¶: Whether if the effect is enabled.

gradient¶: Gradient configuration.

offset¶: Offset value.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

reversed¶: Reverse flag.

scale¶: Scale value.

shown¶: Whether if the effect is shown in dialog.

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

PatternOverlay¶

class psd_tools.api.effects.PatternOverlay(value, image_resources)[source]¶

aligned¶: Aligned.

angle¶: Angle value.

blend_mode¶: Effect blending mode.

enabled¶: Whether if the effect is enabled.

linked¶: Linked.

opacity¶: Layer effect opacity in percentage.

pattern¶: Pattern config.

phase¶: Phase value in Point.

present¶: Whether if the effect is present in Photoshop UI.

scale¶: Scale value.

shown¶: Whether if the effect is shown in dialog.

Stroke¶

class psd_tools.api.effects.Stroke(value, image_resources)[source]¶

angle¶: Angle value.

blend_mode¶: Effect blending mode.

color¶: Color.

dithered¶: Dither flag.

enabled¶: Whether if the effect is enabled.

fill_type¶: Fill type, SolidColor, Gradient, or Pattern.

gradient¶: Gradient configuration.

linked¶: Linked.

offset¶: Offset value.

opacity¶: Layer effect opacity in percentage.

overprint¶: Overprint flag.

pattern¶: Pattern config.

phase¶: Phase value in Point.

position¶: Position of the stroke, InsetFrame, OutsetFrame, or CenteredFrame.

present¶: Whether if the effect is present in Photoshop UI.

reversed¶: Reverse flag.

shown¶: Whether if the effect is shown in dialog.

size¶: Size value.

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

BevelEmboss¶

class psd_tools.api.effects.BevelEmboss(value, image_resources)[source]¶

altitude¶: Altitude value.

angle¶: Angle value.

anti_aliased¶: Anti-aliased.

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

bevel_type¶: Bevel type, one of SoftMatte, HardLight, SoftLight.

contour¶: Contour configuration.

depth¶: Depth value.

direction¶: Direction, either StampIn or StampOut.

enabled¶: Whether if the effect is enabled.

highlight_color¶: Highlight color value.

highlight_mode¶: Highlight blending mode.

highlight_opacity¶: Highlight opacity value.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

shadow_color¶: Shadow color value.

shadow_mode¶: Shadow blending mode.

shadow_opacity¶: Shadow opacity value.

shown¶: Whether if the effect is shown in dialog.

size¶: Size value in pixel.

soften¶: Soften value.

use_global_light¶: Using global light.

use_shape¶: Using shape.

use_texture¶: Using texture.

Satin¶

class psd_tools.api.effects.Satin(value, image_resources)[source]¶

Satin effect

angle¶: Angle value.

anti_aliased¶: Anti-aliased.

blend_mode¶: Effect blending mode.

color¶: Color.

contour¶: Contour configuration.

distance¶: Distance value.

enabled¶: Whether if the effect is enabled.

inverted¶: Inverted.

opacity¶: Layer effect opacity in percentage.

present¶: Whether if the effect is present in Photoshop UI.

shown¶: Whether if the effect is shown in dialog.

size¶: Size value in pixel.