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
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]
anti_aliased

Angi-aliased.

blend_mode

Effect blending mode.

choke

Choke level.

color

Color.

contour

Contour configuration.

enabled

Whether if the effect is enabled.

glow_type

Glow type. ‘softer’ or ‘precise’.

gradient

Gradient configuration.

noise

Noise level.

opacity

Layer effect opacity in percentage.

present

Whether if the effect is present in Photoshop UI.

quality_jitter

Quality jitter

quality_range

Quality range.

shown

Whether if the effect is shown in dialog.

size

Size in pixels.

InnerGlow

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

Angi-aliased.

blend_mode

Effect blending mode.

choke

Choke level.

color

Color.

contour

Contour configuration.

enabled

Whether if the effect is enabled.

glow_source

Elements source, ‘edge’ or ‘center’.

glow_type

Glow type. ‘softer’ or ‘precise’.

gradient

Gradient configuration.

noise

Noise level.

opacity

Layer effect opacity in percentage.

present

Whether if the effect is present in Photoshop UI.

quality_jitter

Quality jitter

quality_range

Quality range.

shown

Whether if the effect is shown in dialog.

size

Size in pixels.

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.

blend_mode

Effect blending mode.

enabled

Whether if the effect is enabled.

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]
blend_mode

Effect blending mode.

color

Color.

enabled

Whether if the effect is enabled.

fill_type

Fill type, solid-color, gradient, or pattern.

gradient

Gradient configuration.

opacity

Layer effect opacity in percentage.

overprint

Overprint flag.

pattern

Pattern config.

position

Position of the stroke, inner, outer, or center.

present

Whether if the effect is present in Photoshop UI.

shown

Whether if the effect is shown in dialog.

size

Size value.

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 outer, inner, emboss, pillow-emboss, or stroke-emboss.

bevel_type

Bevel type, one of smooth, chiesel-hard, chiesel-soft.

contour

Contour configuration.

depth

Depth value.

direction

Direction, either in or out.

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.