psd_tools.api.effects
Effects module.
- class psd_tools.api.effects.Effects(layer: Any)[source]
List-like effects.
- property enabled: bool
Whether if all the effects are enabled.
- Return type:
bool
- property scale
Scale value.
DropShadow
- class psd_tools.api.effects.DropShadow(value: Descriptor, image_resources: ImageResources)[source]
- property angle
Angle value.
- property anti_aliased: bool
Angi-aliased.
- property blend_mode
Effect blending mode.
- property choke
Choke level.
- property color
Color.
- property contour
Contour configuration.
- property distance
Distance.
- property enabled: bool
Whether if the effect is enabled.
- property layer_knocks_out: bool
Layers are knocking out.
- property noise
Noise level.
- 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
Size in pixels.
- property use_global_light: bool
Using global light.
InnerShadow
- class psd_tools.api.effects.InnerShadow(value: Descriptor, image_resources: ImageResources)[source]
- property angle
Angle value.
- property anti_aliased: bool
Angi-aliased.
- property blend_mode
Effect blending mode.
- property choke
Choke level.
- property color
Color.
- property contour
Contour configuration.
- property distance
Distance.
- property enabled: bool
Whether if the effect is enabled.
- property noise
Noise level.
- 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
Size in pixels.
- property use_global_light: bool
Using global light.
OuterGlow
- class psd_tools.api.effects.OuterGlow(value: Descriptor, image_resources: ImageResources)[source]
- property angle
Angle value.
- property anti_aliased: bool
Angi-aliased.
- property blend_mode
Effect blending mode.
- property choke
Choke level.
- property color
Color.
- property contour
Contour configuration.
- property dithered
Dither flag.
- property enabled: bool
Whether if the effect is enabled.
- property glow_type
Glow type.
- property gradient
Gradient configuration.
- property noise
Noise level.
- property offset
Offset value.
- property opacity: float
Layer effect opacity in percentage.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property quality_jitter
Quality jitter
- property quality_range
Quality range.
- property reversed
Reverse flag.
- property shown: bool
Whether if the effect is shown in dialog.
- property size
Size in pixels.
- property type
Gradient type, one of linear, radial, angle, reflected, or diamond.
InnerGlow
- class psd_tools.api.effects.InnerGlow(value: Descriptor, image_resources: ImageResources)[source]
- property angle
Angle value.
- property anti_aliased: bool
Angi-aliased.
- property blend_mode
Effect blending mode.
- property choke
Choke level.
- property color
Color.
- property contour
Contour configuration.
- property dithered
Dither flag.
- property enabled: bool
Whether if the effect is enabled.
- property glow_source
Elements source.
- property glow_type
Glow type.
- property gradient
Gradient configuration.
- property noise
Noise level.
- property offset
Offset value.
- property opacity: float
Layer effect opacity in percentage.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property quality_jitter
Quality jitter
- property quality_range
Quality range.
- property reversed
Reverse flag.
- property shown: bool
Whether if the effect is shown in dialog.
- property size
Size in pixels.
- property type
Gradient type, one of linear, radial, angle, reflected, or diamond.
ColorOverlay
- class psd_tools.api.effects.ColorOverlay(value: Descriptor, image_resources: ImageResources)[source]
- property blend_mode
Effect blending mode.
- property color
Color.
- property enabled: bool
Whether if the effect is enabled.
- 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.
GradientOverlay
- class psd_tools.api.effects.GradientOverlay(value: Descriptor, image_resources: ImageResources)[source]
- property aligned: bool
Aligned.
- property angle
Angle value.
- property blend_mode
Effect blending mode.
- property dithered
Dither flag.
- property enabled: bool
Whether if the effect is enabled.
- property gradient
Gradient configuration.
- property offset
Offset value.
- property opacity: float
Layer effect opacity in percentage.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property reversed
Reverse flag.
- property scale
Scale value.
- property shown: bool
Whether if the effect is shown in dialog.
- property type
Gradient type, one of linear, radial, angle, reflected, or diamond.
PatternOverlay
- class psd_tools.api.effects.PatternOverlay(value: Descriptor, image_resources: ImageResources)[source]
- property aligned: bool
Aligned.
- property angle
Angle value.
- property blend_mode
Effect blending mode.
- property enabled: bool
Whether if the effect is enabled.
- property linked
Linked.
- property opacity: float
Layer effect opacity in percentage.
- property pattern
Pattern config.
- property phase
Phase value in Point.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property scale
Scale value.
- property shown: bool
Whether if the effect is shown in dialog.
Stroke
- class psd_tools.api.effects.Stroke(value: Descriptor, image_resources: ImageResources)[source]
- property angle
Angle value.
- property blend_mode
Effect blending mode.
- property color
Color.
- property dithered
Dither flag.
- property enabled: bool
Whether if the effect is enabled.
- property fill_type
Fill type, SolidColor, Gradient, or Pattern.
- property gradient
Gradient configuration.
- property linked
Linked.
- property offset
Offset value.
- property opacity: float
Layer effect opacity in percentage.
- property overprint
Overprint flag.
- property pattern
Pattern config.
- property phase
Phase value in Point.
- property position
Position of the stroke, InsetFrame, OutsetFrame, or CenteredFrame.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property reversed
Reverse flag.
- property shown: bool
Whether if the effect is shown in dialog.
- property size
Size value.
- property type
Gradient type, one of linear, radial, angle, reflected, or diamond.
BevelEmboss
- class psd_tools.api.effects.BevelEmboss(value: Descriptor, image_resources: ImageResources)[source]
- property altitude
Altitude value.
- property angle
Angle value.
- property anti_aliased: bool
Anti-aliased.
- property bevel_style
Bevel style, one of OuterBevel, InnerBevel, Emboss, PillowEmboss, or StrokeEmboss.
- property bevel_type
Bevel type, one of SoftMatte, HardLight, SoftLight.
- property contour
Contour configuration.
- property depth
Depth value.
- property direction
Direction, either StampIn or StampOut.
- property enabled: bool
Whether if the effect is enabled.
- property highlight_color
Highlight color value.
- property highlight_mode
Highlight blending mode.
- property highlight_opacity
Highlight opacity value.
- property opacity: float
Layer effect opacity in percentage.
- property present: bool
Whether if the effect is present in Photoshop UI.
- property shadow_color
Shadow color value.
- property shadow_mode
Shadow blending mode.
- property shadow_opacity
Shadow opacity value.
- property shown: bool
Whether if the effect is shown in dialog.
- property size
Size value in pixel.
- property soften
Soften value.
- property use_global_light: bool
Using global light.
- property use_shape: bool
Using shape.
- property use_texture: bool
Using texture.
Satin
- class psd_tools.api.effects.Satin(value: Descriptor, image_resources: ImageResources)[source]
Satin effect
- property angle
Angle value.
- property anti_aliased: bool
Anti-aliased.
- property blend_mode
Effect blending mode.
- property color
Color.
- property contour
Contour configuration.
- property distance
Distance value.
- property enabled: bool
Whether if the effect is enabled.
- property inverted: bool
Inverted.
- 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
Size value in pixel.