Functions
src.helpers.effects.set_fill_opacity(opacity: float, layer: Optional[Union[ArtLayer, LayerSet]]) -> None
Sets the fill opacity of a given layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
opacity | float | Fill opacity to set. | required |
layer | ArtLayer | LayerSet | None | ArtLayer or LayerSet object. | required |
Source code in src\helpers\effects.py
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
|
src.helpers.effects.set_layer_fx_visibility(layer: Optional[Union[ArtLayer, LayerSet]] = None, visible: bool = True) -> None
Shows or hides the layer effects on a given layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | LayerSet | None | ArtLayer or LayerSet, use active if not provided. | None |
visible | bool | Make visible if True, otherwise hide. | True |
Source code in src\helpers\effects.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
|
src.helpers.effects.enable_layer_fx(layer: Optional[Union[ArtLayer, LayerSet]] = None) -> None
Utility definition for change_fx_visibility
to enable effects on layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | LayerSet | None | ArtLayer or LayerSet, will use active if not provided. | None |
Source code in src\helpers\effects.py
152 153 154 155 156 157 158 |
|
src.helpers.effects.disable_layer_fx(layer: Optional[Union[ArtLayer, LayerSet]] = None) -> None
Utility definition for change_fx_visibility
to disable effects on layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | LayerSet | None | ArtLayer or LayerSet, will use active if not provided. | None |
Source code in src\helpers\effects.py
161 162 163 164 165 166 167 |
|
src.helpers.effects.clear_layer_fx(layer: Union[ArtLayer, LayerSet, None]) -> None
Removes all layer style effects.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | LayerSet | None | Layer object | required |
Source code in src\helpers\effects.py
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
src.helpers.effects.rasterize_layer_fx(layer: ArtLayer) -> None
Rasterizes a layer including its style.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | Layer object | required |
Source code in src\helpers\effects.py
188 189 190 191 192 193 194 195 196 197 198 199 |
|
src.helpers.effects.copy_layer_fx(from_layer: Union[ArtLayer, LayerSet], to_layer: Union[ArtLayer, LayerSet]) -> None
Copies the layer effects from one layer to another layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
from_layer | ArtLayer | LayerSet | Layer to copy effects from. | required |
to_layer | ArtLayer | LayerSet | Layer to apply effects to. | required |
Source code in src\helpers\effects.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
|
src.helpers.effects.apply_fx(layer: Union[ArtLayer, LayerSet], effects: list[LayerEffects]) -> None
Apply multiple layer effects to a layer.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
layer | ArtLayer | LayerSet | Layer or Layer Set object. | required |
effects | list[LayerEffects] | List of effects to apply. | required |
Source code in src\helpers\effects.py
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
|
src.helpers.effects.apply_fx_stroke(action: ActionDescriptor, fx: EffectStroke) -> None
Adds stroke effect to layer effects action.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
action | ActionDescriptor | Pending layer effects action descriptor. | required |
fx | EffectStroke | Stroke effect properties. | required |
Source code in src\helpers\effects.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
|
src.helpers.effects.apply_fx_drop_shadow(action: ActionDescriptor, fx: EffectDropShadow) -> None
Adds drop shadow effect to layer effects action.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
action | ActionDescriptor | Pending layer effects action descriptor. | required |
fx | EffectDropShadow | Drop Shadow effect properties. | required |
Source code in src\helpers\effects.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
src.helpers.effects.apply_fx_gradient_overlay(action: ActionDescriptor, fx: EffectGradientOverlay) -> None
Adds gradient effect to layer effects action.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
action | ActionDescriptor | Pending layer effects action descriptor. | required |
fx | EffectGradientOverlay | Gradient Overlay effect properties. | required |
Source code in src\helpers\effects.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
src.helpers.effects.apply_fx_color_overlay(action: ActionDescriptor, fx: EffectColorOverlay) -> None
Adds a solid color overlay to layer effects action.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
action | ActionDescriptor | Pending layer effects action descriptor. | required |
fx | EffectColorOverlay | Color Overlay effect properties. | required |
Source code in src\helpers\effects.py
357 358 359 360 361 362 363 364 365 366 367 368 |
|
src.helpers.effects.apply_fx_bevel(action: ActionDescriptor, fx: EffectBevel) -> None
Adds a bevel to layer effects action.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
action | ActionDescriptor | Pending layer effects action descriptor. | required |
fx | EffectBevel | Bevel effect properties. | required |
Source code in src\helpers\effects.py
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
|