@drincs/pixi-vn 1.9.4 → 1.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/canvas.d.cts CHANGED
@@ -1230,182 +1230,6 @@ declare namespace RegisteredEvents {
1230
1230
  function keys(): string[];
1231
1231
  }
1232
1232
 
1233
- /**
1234
- * @deprecated Use `effects.shakeEffect` instead.
1235
- */
1236
- declare function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1237
- declare namespace effects {
1238
- /**
1239
- * Shake the canvas element.
1240
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1241
- * @param alias The alias to identify the component.
1242
- * @param options Animation options, matching the `options` of animate function.
1243
- * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
1244
- * @returns
1245
- */
1246
- function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1247
- /**
1248
- * Bounce the canvas element: a one-directional displacement that repeatedly returns to rest, each
1249
- * bounce shrinking towards rest by {@link BounceEffectProps.decay}. Like a dropped ball settling.
1250
- * @param alias The alias to identify the component.
1251
- * @param options Animation options.
1252
- * @param priority The priority of the PixiJS ticker.
1253
- */
1254
- function bounceEffect(alias: string, options?: BounceEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1255
- /**
1256
- * Pulse the canvas element: a repeated, decaying scale bump away from its current scale and back.
1257
- * @param alias The alias to identify the component.
1258
- * @param options Animation options.
1259
- * @param priority The priority of the PixiJS ticker.
1260
- */
1261
- function pulseEffect(alias: string, options?: PulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1262
- /**
1263
- * Hop the canvas element: one deliberate displacement-and-return, optionally followed by smaller,
1264
- * decaying secondary hops.
1265
- * @param alias The alias to identify the component.
1266
- * @param options Animation options.
1267
- * @param priority The priority of the PixiJS ticker.
1268
- */
1269
- function hopEffect(alias: string, options?: HopEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1270
- /**
1271
- * Wiggle the canvas element: a decaying rotation oscillation around its current angle.
1272
- * @param alias The alias to identify the component.
1273
- * @param options Animation options.
1274
- * @param priority The priority of the PixiJS ticker.
1275
- */
1276
- function wiggleEffect(alias: string, options?: WiggleEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1277
- /**
1278
- * Nod the canvas element: a decaying positional oscillation along one axis.
1279
- * @param alias The alias to identify the component.
1280
- * @param options Animation options.
1281
- * @param priority The priority of the PixiJS ticker.
1282
- */
1283
- function nodEffect(alias: string, options?: NodEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1284
- /**
1285
- * Sway the canvas element: a smooth, optionally combined positional and rotational drift around its
1286
- * current state - a gentler, slower cousin of {@link nodEffect}/{@link wiggleEffect}.
1287
- * @param alias The alias to identify the component.
1288
- * @param options Animation options.
1289
- * @param priority The priority of the PixiJS ticker.
1290
- */
1291
- function swayEffect(alias: string, options?: SwayEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1292
- /**
1293
- * Punch the canvas element: a single fast impulse (position, rotation, or scale) with a strong
1294
- * attack and a short, slightly overshooting recovery back to rest - unlike every other effect here,
1295
- * this is a one-shot impact, not a repeated oscillation.
1296
- * @param alias The alias to identify the component.
1297
- * @param options Animation options.
1298
- * @param priority The priority of the PixiJS ticker.
1299
- */
1300
- function punchEffect(alias: string, options?: PunchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1301
- /**
1302
- * Glitch the canvas element: decaying, jittery bursts of digital-corruption slice displacement
1303
- * ({@link https://pixijs.io/filters/docs/GlitchFilter.html GlitchFilter}) - each burst snaps,
1304
- * kicks back the other way and settles - with a matching red/blue channel split layered on top
1305
- * ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}, see
1306
- * {@link GlitchEffectProps.rgbSplit}). Both filters are removed once done. Returns one ticker id
1307
- * per filter.
1308
- *
1309
- * Known cosmetic quirk: `GlitchFilter`'s own `destroy()` (called once this effect completes, to
1310
- * clean up its displacement texture) can log a harmless `PixiJS Warning: [BindGroup] a
1311
- * 'textureSource'/'textureSampler' was destroyed while still bound to a shader` in the console -
1312
- * this comes from `pixi-filters`' own implementation, not from this effect, doesn't affect the
1313
- * component's rendering or state, and every property is still correctly restored/detached.
1314
- * @param alias The alias to identify the component.
1315
- * @param options Animation options.
1316
- * @param priority The priority of the PixiJS ticker.
1317
- */
1318
- function glitchEffect(alias: string, options?: GlitchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1319
- /**
1320
- * Chromatic-aberration the canvas element: the red and blue color channels split apart in opposite
1321
- * directions and snap back, in a decaying burst
1322
- * ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}).
1323
- * @param alias The alias to identify the component.
1324
- * @param options Animation options.
1325
- * @param priority The priority of the PixiJS ticker.
1326
- */
1327
- function chromaticAberrationEffect(alias: string, options?: ChromaticAberrationEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1328
- /**
1329
- * Shockwave the canvas element: a single radial ripple distortion travels outward from an origin
1330
- * point and fades ({@link https://pixijs.io/filters/docs/ShockwaveFilter.html ShockwaveFilter}) -
1331
- * a one-shot impact, not a repeated oscillation.
1332
- * @param alias The alias to identify the component.
1333
- * @param options Animation options.
1334
- * @param priority The priority of the PixiJS ticker.
1335
- */
1336
- function shockwaveEffect(alias: string, options?: ShockwaveEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1337
- /**
1338
- * Radially blur the canvas element: a decaying burst of zoom-blur radiating from an origin point,
1339
- * settling back to no blur between and after each burst
1340
- * ({@link https://pixijs.io/filters/docs/ZoomBlurFilter.html ZoomBlurFilter}).
1341
- * @param alias The alias to identify the component.
1342
- * @param options Animation options.
1343
- * @param priority The priority of the PixiJS ticker.
1344
- */
1345
- function radialBlurEffect(alias: string, options?: RadialBlurEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1346
- /**
1347
- * Pulse a blur on the canvas element: a repeated, decaying blur bump that settles back to no blur
1348
- * between and after each pulse ({@link https://pixijs.io/filters/docs/BlurFilter.html BlurFilter}).
1349
- * @param alias The alias to identify the component.
1350
- * @param options Animation options.
1351
- * @param priority The priority of the PixiJS ticker.
1352
- */
1353
- function blurPulseEffect(alias: string, options?: BlurPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1354
- /**
1355
- * Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying
1356
- * pulse - built on {@link https://pixijs.io/filters/docs/CRTFilter.html CRTFilter} with its
1357
- * scanline/noise features turned off, isolating just the vignette.
1358
- *
1359
- * The vignette darkens the corners of the element's own bounding rectangle, so it's meant for
1360
- * backgrounds and other full-frame images; on a sprite with transparent corners (a character, a
1361
- * shape) there's little to darken and it barely shows.
1362
- * @param alias The alias to identify the component.
1363
- * @param options Animation options.
1364
- * @param priority The priority of the PixiJS ticker.
1365
- */
1366
- function vignettePulseEffect(alias: string, options?: VignettePulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1367
- /**
1368
- * Desaturate the canvas element: color drains out to {@link DesaturateEffectProps.amount} and
1369
- * recovers back to normal - a single dip, not a repeated oscillation
1370
- * ({@link https://pixijs.io/filters/docs/AdjustmentFilter.html AdjustmentFilter}).
1371
- * @param alias The alias to identify the component.
1372
- * @param options Animation options.
1373
- * @param priority The priority of the PixiJS ticker.
1374
- */
1375
- function desaturateEffect(alias: string, options?: DesaturateEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1376
- /**
1377
- * Pulse a glow on the canvas element: a repeated, decaying outward glow that settles back to no
1378
- * glow between and after each pulse ({@link https://pixijs.io/filters/docs/GlowFilter.html GlowFilter}).
1379
- * @param alias The alias to identify the component.
1380
- * @param options Animation options.
1381
- * @param priority The priority of the PixiJS ticker.
1382
- */
1383
- function glowPulseEffect(alias: string, options?: GlowPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1384
- }
1385
-
1386
- declare namespace CanvasPropertyUtility {
1387
- function calculatePositionByAlign(type: "width" | "height", align: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
1388
- function calculateAlignByPosition(type: "width" | "height", position: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
1389
- function calculatePositionByPercentagePosition(type: "width" | "height", percentage: number): number;
1390
- function calculatePercentagePositionByPosition(type: "width" | "height", position: number): number;
1391
- function getSuperPoint(point: {
1392
- x: number;
1393
- y: number;
1394
- }, angle: number): {
1395
- x: number;
1396
- y: number;
1397
- };
1398
- function getPointBySuperPoint(superPoint: {
1399
- x: number;
1400
- y: number;
1401
- }, angle: number): {
1402
- x: number;
1403
- y: number;
1404
- };
1405
- function getSuperWidth(canvasElement: Container$1): number;
1406
- function getSuperHeight(canvasElement: Container$1): number;
1407
- }
1408
-
1409
1233
  interface RgbColorType {
1410
1234
  r: number;
1411
1235
  g: number;
@@ -1453,11 +1277,24 @@ interface BaseTransitionProps {
1453
1277
  */
1454
1278
  completeOnContinue?: boolean;
1455
1279
  }
1280
+ /**
1281
+ * Shared by every `xIn` transition that can replace an existing component (same alias): whether the
1282
+ * replaced component leaves with its own out animation, started together with the new component's in.
1283
+ */
1284
+ interface OldComponentOutProps {
1285
+ /**
1286
+ * If true, the component being replaced leaves with the matching out animation (`moveOut`, `wipeOut`,
1287
+ * ...), started at the same time as the in animation. If false, it stays untouched under the new
1288
+ * component and is removed once the in animation is done.
1289
+ * The default depends on the transition: `false` for `moveIn`/`zoomIn`, `true` for the others.
1290
+ */
1291
+ animateOldComponentOut?: boolean;
1292
+ }
1456
1293
  interface ShowWithDissolveTransitionProps extends BaseTransitionProps, AnimationOptions {
1457
1294
  }
1458
1295
  interface ShowWithFadeTransitionProps extends BaseTransitionProps, AnimationOptions {
1459
1296
  }
1460
- interface MoveInOutProps extends BaseTransitionProps, AnimationOptions {
1297
+ interface MoveInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1461
1298
  /**
1462
1299
  * The direction of the movement.
1463
1300
  * @default "right"
@@ -1470,14 +1307,14 @@ interface MoveInOutProps extends BaseTransitionProps, AnimationOptions {
1470
1307
  */
1471
1308
  motionBlur?: boolean | number;
1472
1309
  }
1473
- interface ZoomInOutProps extends BaseTransitionProps, AnimationOptions {
1310
+ interface ZoomInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1474
1311
  /**
1475
1312
  * The direction of the zoom effect.
1476
1313
  * @default "right"
1477
1314
  */
1478
1315
  direction?: "up" | "down" | "left" | "right";
1479
1316
  }
1480
- interface PushInOutProps extends BaseTransitionProps, AnimationOptions {
1317
+ interface PushInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1481
1318
  /**
1482
1319
  * The direction of the push effect.
1483
1320
  * @default "right"
@@ -1494,7 +1331,7 @@ interface PushInOutProps extends BaseTransitionProps, AnimationOptions {
1494
1331
  * Shared options for the mask-based reveal/conceal transitions ({@link WipeInOutProps},
1495
1332
  * {@link IrisInOutProps}, {@link SplitInOutProps}).
1496
1333
  */
1497
- interface MaskTransitionProps extends BaseTransitionProps, AnimationOptions {
1334
+ interface MaskTransitionProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1498
1335
  /**
1499
1336
  * If true, the effect is inverted: a "reveal" mask conceals instead, and vice versa.
1500
1337
  * @default false
@@ -1527,8 +1364,22 @@ interface IrisInOutProps extends MaskTransitionProps {
1527
1364
  * @default 1
1528
1365
  */
1529
1366
  aspect?: number;
1367
+ /**
1368
+ * `"expand"`: the image is seen *through* the circle (`irisIn` grows it, `irisOut` shrinks it).
1369
+ * `"contract"`: the image is seen *around* the circle, which is a hole (`irisIn` shrinks it until the
1370
+ * whole image is shown, `irisOut` grows it until the image is gone).
1371
+ * @default "expand"
1372
+ */
1373
+ direction?: "expand" | "contract";
1530
1374
  }
1531
1375
  interface SplitInOutProps extends MaskTransitionProps {
1376
+ /**
1377
+ * `"inward"`: reveal from the edges towards the split line; conceal from the split line outwards.
1378
+ * `"outward"`: reveal from the split line towards the edges; conceal from the edges inwards.
1379
+ * During replacement, the old component uses the opposite mode so its conceal follows the reveal.
1380
+ * @default "inward"
1381
+ */
1382
+ direction?: "inward" | "outward";
1532
1383
  /**
1533
1384
  * The axis the two mask panels move apart on/towards.
1534
1385
  * @default "vertical"
@@ -1572,7 +1423,7 @@ interface FlashInOutProps extends BaseTransitionProps, AnimationOptions {
1572
1423
  */
1573
1424
  fadeComponent?: boolean;
1574
1425
  }
1575
- interface BlurInOutProps extends BaseTransitionProps, AnimationOptions {
1426
+ interface BlurInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1576
1427
  /**
1577
1428
  * The blur strength the effect starts from (`blurIn`) or ends at (`blurOut`).
1578
1429
  * @default 32
@@ -1591,12 +1442,19 @@ interface BlurInOutProps extends BaseTransitionProps, AnimationOptions {
1591
1442
  */
1592
1443
  fadeComponent?: boolean;
1593
1444
  }
1594
- interface PixelateInOutProps extends BaseTransitionProps, AnimationOptions {
1445
+ interface PixelateInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1595
1446
  /**
1596
1447
  * The pixel size the effect starts from (`pixelateIn`) or ends at (`pixelateOut`).
1597
1448
  * @default 32
1598
1449
  */
1599
1450
  pixelSize?: number;
1451
+ /**
1452
+ * The direction the pixel blocks drift as their size changes. Applies to both entering and
1453
+ * exiting components, including the old component during a replacement.
1454
+ * `"up-left"` moves from bottom-right towards top-left; the other values mirror either axis.
1455
+ * @default "up-left"
1456
+ */
1457
+ direction?: "up-left" | "up-right" | "down-left" | "down-right";
1600
1458
  /**
1601
1459
  * Whether the component itself also briefly fades in (`pixelateIn`) or out (`pixelateOut`) alongside
1602
1460
  * the pixelation, softening what would otherwise be an instant pop-in/pop-out - the fade runs at a
@@ -1612,7 +1470,7 @@ interface PixelateInOutProps extends BaseTransitionProps, AnimationOptions {
1612
1470
  * {@link TwistInOutProps}, {@link WarpInOutProps}, {@link RippleInOutProps},
1613
1471
  * {@link NoiseDissolveInOutProps}, {@link PinchInOutProps}).
1614
1472
  */
1615
- interface FilterFadeTransitionProps extends BaseTransitionProps, AnimationOptions {
1473
+ interface FilterFadeTransitionProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1616
1474
  /**
1617
1475
  * Whether the component itself also fades in (`xIn`) or out (`xOut`) alongside the filter effect,
1618
1476
  * at a quarter of the effect's own duration, mirrored to the start of `xIn` or the end of `xOut`
@@ -1646,6 +1504,8 @@ interface GlitchInOutProps extends FilterFadeTransitionProps {
1646
1504
  interface TwistInOutProps extends FilterFadeTransitionProps {
1647
1505
  /**
1648
1506
  * How far (degrees) the swirl is wound up - where `twistIn` starts and `twistOut` ends.
1507
+ * Negate the angle to reverse the rotation. During replacement the old component uses the
1508
+ * opposite angle, so it winds up in the same rotational sense as the new component unwinds.
1649
1509
  * @default 540
1650
1510
  */
1651
1511
  angle?: number;
@@ -1712,7 +1572,7 @@ interface NoiseDissolveInOutProps extends FilterFadeTransitionProps {
1712
1572
  */
1713
1573
  seed?: number;
1714
1574
  }
1715
- interface TvInOutProps extends BaseTransitionProps, AnimationOptions {
1575
+ interface TvInOutProps extends BaseTransitionProps, OldComponentOutProps, AnimationOptions {
1716
1576
  /**
1717
1577
  * The height of the collapsed bright line, as a fraction of the component's own height.
1718
1578
  * @default 0.02
@@ -1751,945 +1611,1170 @@ interface PinchInOutProps extends FilterFadeTransitionProps {
1751
1611
  origin?: Partial<PointData>;
1752
1612
  }
1753
1613
 
1754
- type TComponent = CanvasBaseInterface<any> | string | string[] | {
1755
- value: string;
1756
- options: ImageSpriteOptions;
1757
- } | {
1758
- value: string[];
1759
- options: ImageContainerOptions;
1760
- };
1761
- /**
1762
- * @deprecated Use `transitions.showWithDissolve` instead.
1763
- */
1764
- declare function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1765
- /**
1766
- * @deprecated Use `transitions.removeWithDissolve` instead.
1767
- */
1768
- declare function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1769
- /**
1770
- * @deprecated Use `transitions.showWithFade` instead.
1771
- */
1772
- declare function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1773
- /**
1774
- * @deprecated Use `transitions.removeWithFade` instead.
1775
- */
1776
- declare function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1777
- /**
1778
- * @deprecated Use `transitions.moveIn` instead.
1779
- */
1780
- declare function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
1614
+ interface ShakeEffectProps extends BaseTransitionProps, AnimationOptions {
1781
1615
  /**
1782
- * If true, then the old component is removed with a move out, after the new image is moved in.
1783
- * @default false
1616
+ * The number of shocks. **Must be at least 3**.
1617
+ * @default 10
1784
1618
  */
1785
- removeOldComponentWithMoveOut?: boolean;
1786
- }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1787
- /**
1788
- * @deprecated Use `transitions.moveOut` instead.
1789
- */
1790
- declare function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1791
- /**
1792
- * @deprecated Use `transitions.zoomIn` instead.
1793
- */
1794
- declare function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
1619
+ shocksNumber?: number;
1795
1620
  /**
1796
- * If true, then the old component is removed with a zoom out, after the new image is zoomed in.
1797
- * @default false
1621
+ * The type of the shake effect
1622
+ * @default "horizontal"
1798
1623
  */
1799
- removeOldComponentWithZoomOut?: boolean;
1800
- }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1801
- /**
1802
- * @deprecated Use `transitions.zoomOut` instead.
1803
- */
1804
- declare function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1805
- /**
1806
- * @deprecated Use `transitions.pushIn` instead.
1807
- */
1808
- declare function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1624
+ shakeType?: "horizontal" | "vertical";
1625
+ /**
1626
+ * The maximum size of the shock.
1627
+ * For horizontal type, it is the maximum size of the x axis.
1628
+ * For vertical type, it is the maximum size of the y axis.
1629
+ * @default 10
1630
+ */
1631
+ maxShockSize?: number;
1632
+ }
1809
1633
  /**
1810
- * @deprecated Use `transitions.pushOut` instead.
1634
+ * Shared options for the generic, repeated articulated-animation effects ({@link BounceEffectProps},
1635
+ * {@link HopEffectProps}, {@link WiggleEffectProps}, {@link NodEffectProps}, {@link SwayEffectProps}):
1636
+ * a number of cycles, each one shrinking towards rest by {@link decay}.
1811
1637
  */
1812
- declare function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1813
- declare namespace transitions {
1638
+ interface DecayingEffectProps extends BaseTransitionProps, AnimationOptions {
1814
1639
  /**
1815
- * Show a image in the canvas with a disolve effect.
1816
- * Disolve effect is a effect that the image is shown with a fade in.
1817
- * If exist a image with the same alias, then the image is replaced and the first image is removed after the effect is done.
1818
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1819
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1820
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1821
- * If you don't provide the component, then the alias is used as the url.
1822
- * @param props The properties of the effect
1823
- * @param priority The priority of the effect
1824
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1640
+ * How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
1641
+ * amplitude, `0` = the second cycle onward has no amplitude at all).
1642
+ * @default 0.5
1825
1643
  */
1826
- function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1644
+ decay?: number;
1645
+ }
1646
+ interface BounceEffectProps extends DecayingEffectProps {
1827
1647
  /**
1828
- * Remove a image from the canvas with a disolve effect.
1829
- * Disolve effect is a effect that the image is removed with a fade out.
1830
- * This function is equivalent to {@link removeWithFade}.
1831
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1832
- * @param props The properties of the effect
1833
- * @param priority The priority of the effect
1834
- * @returns The ids of the tickers that are used in the effect.
1648
+ * The direction the component displaces towards on each bounce, before returning to rest.
1649
+ * @default "up"
1835
1650
  */
1836
- function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1651
+ direction?: "up" | "down" | "left" | "right";
1837
1652
  /**
1838
- * Show a image in the canvas with a fade effect.
1839
- * Fade effect is a effect that the image is shown with a fade in.
1840
- * If exist a image with the same alias, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
1841
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1842
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1843
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1844
- * If you don't provide the component, then the alias is used as the url.
1845
- * @param props The properties of the effect
1846
- * @param priority The priority of the effect
1847
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1653
+ * The distance (in pixels) of the first, largest bounce.
1654
+ * @default 30
1848
1655
  */
1849
- function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1656
+ distance?: number;
1850
1657
  /**
1851
- * Remove a image from the canvas with a fade effect.
1852
- * Fade effect is a effect that the image is removed with a fade out.
1853
- * This function is equivalent to {@link removeWithDissolve}.
1854
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1855
- * @param props The properties of the effect
1856
- * @param priority The priority of the effect
1857
- * @returns The ids of the tickers that are used in the effect.
1658
+ * The number of bounces.
1659
+ * @default 4
1858
1660
  */
1859
- function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1661
+ bounces?: number;
1662
+ }
1663
+ interface PulseEffectProps extends DecayingEffectProps {
1860
1664
  /**
1861
- * Show a image in the canvas with a move effect. The image is moved from outside the canvas to the x and y position of the image.
1862
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1863
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1864
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1865
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1866
- * If you don't provide the component, then the alias is used as the url.
1867
- * @param props The properties of the effect
1868
- * @param priority The priority of the effect
1869
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1665
+ * The peak scale multiplier of the first, largest pulse (relative to the component's current
1666
+ * scale) - e.g. `1.2` grows the component 20% bigger at the peak of the first pulse.
1667
+ * @default 1.2
1870
1668
  */
1871
- function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
1872
- /**
1873
- * If true, then the old component is removed with a move out, after the new image is moved in.
1874
- * @default false
1875
- */
1876
- removeOldComponentWithMoveOut?: boolean;
1877
- }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1669
+ scale?: number;
1878
1670
  /**
1879
- * Remove a image from the canvas with a move effect. The image is moved from the x and y position of the image to outside the canvas.
1880
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1881
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1882
- * @param props The properties of the effect
1883
- * @param priority The priority of the effect
1884
- * @returns The ids of the tickers that are used in the effect.
1671
+ * The number of pulses.
1672
+ * @default 3
1885
1673
  */
1886
- function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1674
+ pulses?: number;
1675
+ }
1676
+ interface HopEffectProps extends DecayingEffectProps {
1887
1677
  /**
1888
- * Show a image in the canvas with a zoom effect. The image is zoomed in from the center of the canvas.
1889
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1890
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1891
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1892
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1893
- * If you don't provide the component, then the alias is used as the url.
1894
- * @param props The properties of the effect
1895
- * @param priority The priority of the effect
1896
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1678
+ * The direction of the (primary and any secondary) hops.
1679
+ * @default "up"
1897
1680
  */
1898
- function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
1899
- /**
1900
- * If true, then the old component is removed with a zoom out, after the new image is zoomed in.
1901
- * @default false
1902
- */
1903
- removeOldComponentWithZoomOut?: boolean;
1904
- }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1681
+ direction?: "up" | "down" | "left" | "right";
1905
1682
  /**
1906
- * Remove a image from the canvas with a zoom effect. The image is zoomed out to the center of the canvas.
1907
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1908
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1909
- * @param props The properties of the effect
1910
- * @param priority The priority of the effect
1911
- * @returns The ids of the tickers that are used in the effect.
1683
+ * The distance (in pixels) of the primary hop.
1684
+ * @default 40
1912
1685
  */
1913
- function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1686
+ distance?: number;
1914
1687
  /**
1915
- * Show a image in the canvas with a push effect. The new image is pushed in from the inside of the canvas and the old image is pushed out to the outside of the canvas.
1916
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1917
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1918
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1919
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1920
- * If you don't provide the component, then the alias is used as the url.
1921
- * @param props The properties of the effect
1922
- * @param priority The priority of the effect
1923
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1688
+ * The number of smaller, decaying hops to play after the primary one (`0` = just the one hop).
1689
+ * @default 0
1924
1690
  */
1925
- function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1691
+ secondaryHops?: number;
1692
+ }
1693
+ interface WiggleEffectProps extends DecayingEffectProps {
1926
1694
  /**
1927
- * Remove a image from the canvas with a push effect. The image is pushed out to the outside of the canvas.
1928
- * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1929
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1930
- * @param props The properties of the effect
1931
- * @param priority The priority of the effect
1932
- * @returns The ids of the tickers that are used in the effect.
1695
+ * The peak rotation (in degrees) away from the component's current angle, on the first repetition.
1696
+ * @default 15
1933
1697
  */
1934
- function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1698
+ angle?: number;
1935
1699
  /**
1936
- * Show a image in the canvas with a wipe effect: the image is progressively revealed by a moving
1937
- * boundary. The direction/angle and inversion are all configurable, so the same primitive can
1938
- * produce horizontal, vertical, or diagonal reveals - see {@link WipeInOutProps}.
1939
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1940
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1941
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1942
- * If you don't provide the component, then the alias is used as the url.
1943
- * @param props The properties of the effect
1944
- * @param priority The priority of the effect
1945
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1700
+ * The number of repetitions.
1701
+ * @default 3
1946
1702
  */
1947
- function wipeIn(alias: string, component?: TComponent, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1703
+ repetitions?: number;
1704
+ }
1705
+ interface NodEffectProps extends DecayingEffectProps {
1948
1706
  /**
1949
- * Remove a image from the canvas with a wipe effect: the image is progressively concealed by a
1950
- * moving boundary. See {@link wipeIn} and {@link WipeInOutProps}.
1951
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1952
- * @param props The properties of the effect
1953
- * @param priority The priority of the effect
1954
- * @returns The ids of the tickers that are used in the effect.
1707
+ * The axis the component oscillates along.
1708
+ * @default "horizontal"
1955
1709
  */
1956
- function wipeOut(alias: string, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1710
+ axis?: "horizontal" | "vertical";
1957
1711
  /**
1958
- * Show a image in the canvas with an iris effect: the image is progressively revealed by an
1959
- * expanding radial mask. Moving {@link IrisInOutProps.origin} off-center makes the same primitive
1960
- * useful as a focus/reveal effect (e.g. centered on a character).
1961
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1962
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1963
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1964
- * If you don't provide the component, then the alias is used as the url.
1965
- * @param props The properties of the effect
1966
- * @param priority The priority of the effect
1967
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1712
+ * The distance (in pixels) of the first, largest oscillation.
1713
+ * @default 15
1968
1714
  */
1969
- function irisIn(alias: string, component?: TComponent, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1715
+ distance?: number;
1970
1716
  /**
1971
- * Remove a image from the canvas with an iris effect: the image is progressively concealed by a
1972
- * contracting radial mask. See {@link irisIn} and {@link IrisInOutProps}.
1973
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1974
- * @param props The properties of the effect
1975
- * @param priority The priority of the effect
1976
- * @returns The ids of the tickers that are used in the effect.
1717
+ * The number of repetitions.
1718
+ * @default 3
1977
1719
  */
1978
- function irisOut(alias: string, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1720
+ repetitions?: number;
1721
+ }
1722
+ interface SwayEffectProps extends DecayingEffectProps {
1979
1723
  /**
1980
- * Show a image in the canvas with a split effect: two mask panels slide together from the edges to
1981
- * progressively reveal the image, meeting at the split line once fully shown. A configured
1982
- * {@link SplitInOutProps} covers "curtain"-like effects without a story-specific API.
1983
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1984
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
1985
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
1986
- * If you don't provide the component, then the alias is used as the url.
1987
- * @param props The properties of the effect
1988
- * @param priority The priority of the effect
1989
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1724
+ * The distance (in pixels) of the positional drift, on the first repetition.
1725
+ * @default 10
1990
1726
  */
1991
- function splitIn(alias: string, component?: TComponent, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1727
+ distance?: number;
1992
1728
  /**
1993
- * Remove a image from the canvas with a split effect: two mask panels retract apart toward the
1994
- * edges to progressively conceal the image. See {@link splitIn} and {@link SplitInOutProps}.
1995
- * @param alias The unique alias of the image. You can use this alias to refer to this image
1996
- * @param props The properties of the effect
1997
- * @param priority The priority of the effect
1998
- * @returns The ids of the tickers that are used in the effect.
1729
+ * The rotational drift (in degrees) away from the component's current angle, on the first
1730
+ * repetition.
1731
+ * @default 5
1999
1732
  */
2000
- function splitOut(alias: string, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1733
+ angle?: number;
2001
1734
  /**
2002
- * Show a image in the canvas with a blur effect: the image appears already blurred and sharpens
2003
- * into focus. A generic blur, not a "dream"/"flashback" transition specifically - combine it with
2004
- * {@link showWithFade} for that recipe. See {@link BlurInOutProps}.
2005
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2006
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2007
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2008
- * If you don't provide the component, then the alias is used as the url.
2009
- * @param props The properties of the effect
2010
- * @param priority The priority of the effect
2011
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1735
+ * The axis the positional drift moves along.
1736
+ * @default "horizontal"
2012
1737
  */
2013
- function blurIn(alias: string, component?: TComponent, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1738
+ axis?: "horizontal" | "vertical";
2014
1739
  /**
2015
- * Remove a image from the canvas with a blur effect: the image blurs out of focus before being
2016
- * removed. See {@link blurIn} and {@link BlurInOutProps}.
2017
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2018
- * @param props The properties of the effect
2019
- * @param priority The priority of the effect
2020
- * @returns The ids of the tickers that are used in the effect.
1740
+ * The number of repetitions.
1741
+ * @default 3
2021
1742
  */
2022
- function blurOut(alias: string, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1743
+ repetitions?: number;
1744
+ }
1745
+ interface PunchEffectProps extends BaseTransitionProps, AnimationOptions {
2023
1746
  /**
2024
- * Show a image in the canvas with a pixelate effect: the image appears pixelated and resolves into
2025
- * focus. Useful for retro effects, digital transitions, censorship/stylization, or scene changes -
2026
- * not only "glitch" scenes. See {@link PixelateInOutProps}.
2027
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2028
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2029
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2030
- * If you don't provide the component, then the alias is used as the url.
2031
- * @param props The properties of the effect
2032
- * @param priority The priority of the effect
2033
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1747
+ * Which property the punch animates.
1748
+ * @default "scale"
2034
1749
  */
2035
- function pixelateIn(alias: string, component?: TComponent, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1750
+ mode?: "x" | "y" | "rotation" | "scale";
2036
1751
  /**
2037
- * Remove a image from the canvas with a pixelate effect: the image pixelates before being removed.
2038
- * See {@link pixelateIn} and {@link PixelateInOutProps}.
2039
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2040
- * @param props The properties of the effect
2041
- * @param priority The priority of the effect
2042
- * @returns The ids of the tickers that are used in the effect.
1752
+ * The strength of the punch's attack - a pixel distance for `x`/`y`, degrees for `rotation`, or a
1753
+ * scale multiplier delta for `scale` (e.g. `0.3` peaks at 1.3x the current scale).
1754
+ * @default 0.3
2043
1755
  */
2044
- function pixelateOut(alias: string, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1756
+ strength?: number;
2045
1757
  /**
2046
- * Show a image in the canvas with a flash effect, with a configurable solid-color overlay (not
2047
- * limited to a white flash). White reads as a camera/explosion-like flash, black as a blink/cut, and
2048
- * arbitrary colors work for damage/magic/memory/UI transitions. See {@link FlashInOutProps}.
2049
- *
2050
- * If `alias` has no existing component, the new image appears immediately and the overlay fades in
2051
- * and back out over it. If `alias` already has a component, the *current* content fades up to
2052
- * `color` first, is swapped for the new content at the exact moment the screen is a solid `color`
2053
- * (so the content change itself is invisible), and the new content then fades back down from `color`
2054
- * to normal - see {@link flashReplace}.
2055
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2056
- * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2057
- * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2058
- * If you don't provide the component, then the alias is used as the url.
2059
- * @param props The properties of the effect
2060
- * @param priority The priority of the effect
2061
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1758
+ * How far the recovery overshoots past rest, in the opposite direction, as a fraction of
1759
+ * {@link strength} (`0` = no overshoot, settles straight back to rest).
1760
+ * @default 0.3
2062
1761
  */
2063
- function flashIn(alias: string, component?: TComponent, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1762
+ overshoot?: number;
1763
+ }
1764
+ interface GlitchEffectProps extends DecayingEffectProps {
2064
1765
  /**
2065
- * Remove a image from the canvas with a flash effect: a configurable solid-color overlay fades up to
2066
- * `color` and back down to normal, and the image is removed the instant that finishes - the removal
2067
- * itself is a hard cut, never an additional fade/dissolve. See {@link flashIn} and
2068
- * {@link FlashInOutProps}.
2069
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2070
- * @param props The properties of the effect
2071
- * @param priority The priority of the effect
2072
- * @returns The ids of the tickers that are used in the effect.
1766
+ * The peak slice-displacement amount (pixels) of the first, largest burst.
1767
+ * @default 40
2073
1768
  */
2074
- function flashOut(alias: string, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1769
+ strength?: number;
2075
1770
  /**
2076
- * Show a image in the canvas with a glitch effect: the image materializes out of jittery bursts of
2077
- * digital-corruption slices with red/blue fringing, which settle as it appears. See
2078
- * {@link GlitchInOutProps}.
2079
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2080
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2081
- * @param props The properties of the effect
2082
- * @param priority The priority of the effect
2083
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1771
+ * The number of glitch bursts.
1772
+ * @default 3
2084
1773
  */
2085
- function glitchIn(alias: string, component?: TComponent, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1774
+ bursts?: number;
2086
1775
  /**
2087
- * Remove a image from the canvas with a glitch effect: digital-corruption bursts build up until the
2088
- * image is removed. See {@link glitchIn} and {@link GlitchInOutProps}.
2089
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2090
- * @param props The properties of the effect
2091
- * @param priority The priority of the effect
2092
- * @returns The ids of the tickers that are used in the effect.
1776
+ * The number of glitch slices.
1777
+ * @default 8
2093
1778
  */
2094
- function glitchOut(alias: string, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1779
+ slices?: number;
2095
1780
  /**
2096
- * Show a image in the canvas with a twist effect: the image unwinds out of a swirl, like coming
2097
- * through a vortex or portal. See {@link TwistInOutProps}.
2098
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2099
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2100
- * @param props The properties of the effect
2101
- * @param priority The priority of the effect
2102
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1781
+ * The angle (in degrees) slices are displaced along.
1782
+ * @default 0
2103
1783
  */
2104
- function twistIn(alias: string, component?: TComponent, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1784
+ direction?: number;
2105
1785
  /**
2106
- * Remove a image from the canvas with a twist effect: the image winds up into a swirl before being
2107
- * removed. See {@link twistIn} and {@link TwistInOutProps}.
2108
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2109
- * @param props The properties of the effect
2110
- * @param priority The priority of the effect
2111
- * @returns The ids of the tickers that are used in the effect.
1786
+ * The peak red/blue channel separation (pixels) layered on top of the slice displacement,
1787
+ * following the same jittery envelope. `0` disables it.
1788
+ * @default 6
2112
1789
  */
2113
- function twistOut(alias: string, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1790
+ rgbSplit?: number;
1791
+ }
1792
+ interface ChromaticAberrationEffectProps extends DecayingEffectProps {
2114
1793
  /**
2115
- * Show a image in the canvas with a warp effect: the image arrives out of radial zoom-blur streaks,
2116
- * like dropping out of hyperspace. See {@link WarpInOutProps}.
2117
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2118
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2119
- * @param props The properties of the effect
2120
- * @param priority The priority of the effect
2121
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1794
+ * The peak red/blue channel pixel offset of the first, largest burst (channels split in opposite
1795
+ * directions, green stays centered).
1796
+ * @default 8
2122
1797
  */
2123
- function warpIn(alias: string, component?: TComponent, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1798
+ strength?: number;
2124
1799
  /**
2125
- * Remove a image from the canvas with a warp effect: the image streaks away in a radial zoom blur
2126
- * before being removed. See {@link warpIn} and {@link WarpInOutProps}.
2127
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2128
- * @param props The properties of the effect
2129
- * @param priority The priority of the effect
2130
- * @returns The ids of the tickers that are used in the effect.
1800
+ * The axis the channels split along.
1801
+ * @default "horizontal"
2131
1802
  */
2132
- function warpOut(alias: string, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1803
+ axis?: "horizontal" | "vertical";
2133
1804
  /**
2134
- * Show a image in the canvas with a ripple effect: the image fades in through a ring of water-like
2135
- * distortion spreading outward from an origin point - for dreams, magic or memories. See
2136
- * {@link RippleInOutProps}.
2137
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2138
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2139
- * @param props The properties of the effect
2140
- * @param priority The priority of the effect
2141
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1805
+ * The number of bursts.
1806
+ * @default 1
2142
1807
  */
2143
- function rippleIn(alias: string, component?: TComponent, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1808
+ bursts?: number;
1809
+ }
1810
+ interface ShockwaveEffectProps extends BaseTransitionProps, AnimationOptions {
2144
1811
  /**
2145
- * Remove a image from the canvas with a ripple effect: a ring of water-like distortion spreads over
2146
- * the image as it fades out and is removed. See {@link rippleIn} and {@link RippleInOutProps}.
2147
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2148
- * @param props The properties of the effect
2149
- * @param priority The priority of the effect
2150
- * @returns The ids of the tickers that are used in the effect.
1812
+ * The origin of the ripple, normalized (0-1) to the element's own bounds.
1813
+ * @default {x: 0.5, y: 0.5}
2151
1814
  */
2152
- function rippleOut(alias: string, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1815
+ origin?: {
1816
+ x: number;
1817
+ y: number;
1818
+ };
2153
1819
  /**
2154
- * Show a image in the canvas with a noise dissolve: the image appears in organic, noise-shaped
2155
- * blotches (or a cloudy fade with `edge: "soft"`) - the classic visual-novel image dissolve. See
2156
- * {@link NoiseDissolveInOutProps}.
2157
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2158
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2159
- * @param props The properties of the effect
2160
- * @param priority The priority of the effect
2161
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1820
+ * The amplitude of the ripple.
1821
+ * @default 30
2162
1822
  */
2163
- function noiseDissolveIn(alias: string, component?: TComponent, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1823
+ amplitude?: number;
2164
1824
  /**
2165
- * Remove a image from the canvas with a noise dissolve: the image disappears in noise-shaped
2166
- * blotches and is then removed. See {@link noiseDissolveIn} and {@link NoiseDissolveInOutProps}.
2167
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2168
- * @param props The properties of the effect
2169
- * @param priority The priority of the effect
2170
- * @returns The ids of the tickers that are used in the effect.
1825
+ * The wavelength of the ripple.
1826
+ * @default 160
2171
1827
  */
2172
- function noiseDissolveOut(alias: string, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1828
+ wavelength?: number;
2173
1829
  /**
2174
- * Show a image in the canvas like an old TV turning on: a bright dot stretches into a glowing
2175
- * horizontal line, which then opens up into the full image, with CRT scanlines. The scale animates
2176
- * around the component's own anchor/pivot, so a centered anchor looks best. See
2177
- * {@link TvInOutProps}.
2178
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2179
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2180
- * @param props The properties of the effect
2181
- * @param priority The priority of the effect
2182
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1830
+ * The brightness of the ripple.
1831
+ * @default 1
2183
1832
  */
2184
- function tvIn(alias: string, component?: TComponent, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1833
+ brightness?: number;
2185
1834
  /**
2186
- * Remove a image from the canvas like an old TV turning off: the image collapses into a glowing
2187
- * horizontal line, then into a dot, and is removed. The scale animates around the component's own
2188
- * anchor/pivot, so a centered anchor looks best. See {@link tvIn} and {@link TvInOutProps}.
2189
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2190
- * @param props The properties of the effect
2191
- * @param priority The priority of the effect
2192
- * @returns The ids of the tickers that are used in the effect.
1835
+ * The maximum radius (in pixels) the ripple travels before fading out. A value `<= 0` means the
1836
+ * ripple travels an infinite distance.
1837
+ * @default -1
2193
1838
  */
2194
- function tvOut(alias: string, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1839
+ radius?: number;
2195
1840
  /**
2196
- * Show a image in the canvas with a pinch effect: the image emerges from a single point, deforming
2197
- * outward as it settles (or puffs out of it with `mode: "bulge"`). See {@link PinchInOutProps}.
2198
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2199
- * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2200
- * @param props The properties of the effect
2201
- * @param priority The priority of the effect
2202
- * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
1841
+ * The speed (in pixels-per-second) the ripple travels outward.
1842
+ * @default 500
2203
1843
  */
2204
- function pinchIn(alias: string, component?: TComponent, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1844
+ speed?: number;
2205
1845
  /**
2206
- * Remove a image from the canvas with a pinch effect: the image is sucked into a single point (or
2207
- * puffs out with `mode: "bulge"`) and removed. See {@link pinchIn} and {@link PinchInOutProps}.
2208
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2209
- * @param props The properties of the effect
2210
- * @param priority The priority of the effect
2211
- * @returns The ids of the tickers that are used in the effect.
1846
+ * How far the ripple's own internal "time" advances by the end of the animation (the ring's
1847
+ * radius is `time * speed` pixels). By default it's just enough for the ring to fully leave the
1848
+ * component - origin to farthest corner plus half a {@link wavelength} - or {@link radius} when set,
1849
+ * divided by {@link speed}.
2212
1850
  */
2213
- function pinchOut(alias: string, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
1851
+ strength?: number;
2214
1852
  }
2215
-
2216
- /**
2217
- * Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
2218
- * draw a simple `ErrorGraphics` placeholder on the canvas so the scene
2219
- * remains visible and debuggable.
2220
- */
2221
- declare function drawCanvasErrorHandler(): OnErrorHandler;
2222
-
2223
- /**
2224
- * Add a list of images in the container, after that, the images are added to the canvas.
2225
- * Is the same that {@link showImageContainer}, but the image is not shown.
2226
- * If you want to show the container, then you need to use the function {@link ImageSprite.load()}.
2227
- * @param alias is the unique alias of the container. You can use this alias to refer to this container
2228
- * @param imageUrls is the url of the image. If you don't provide the url, then the alias is used as the url.
2229
- * @param options The options of the container.
2230
- * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
2231
- * @example
2232
- * ```ts
2233
- * let bunny = addImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
2234
- * await bunny.load()
2235
- * ```
2236
- */
2237
- declare function addImageCointainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): ImageContainer;
2238
- /**
2239
- * Add a list of images in the container, after that, the images are added and shown in the canvas.
2240
- * @param alias The unique alias of the container. You can use this alias to refer to this container
2241
- * @param imageUrls The url of the image.
2242
- * @param options The options of the container.
2243
- * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
2244
- * @example
2245
- * ```ts
2246
- * let bunny = showImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
2247
- * ```
2248
- */
2249
- declare function showImageContainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): Promise<ImageContainer>;
2250
-
2251
- /**
2252
- * Add a image in the canvas.
2253
- * Is the same that {@link showImage}, but the image is not shown.
2254
- * If you want to show the image, then you need to use the function {@link ImageSprite.load}.
2255
- * @param alias is the unique alias of the image. You can use this alias to refer to this image
2256
- * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
2257
- * @param options The options of the image.
2258
- * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
2259
- * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
2260
- * @example
2261
- * ```ts
2262
- * let bunny1 = addImage("bunny1", "https://pixijs.com/assets/bunny1.png")
2263
- * await bunny1.load()
2264
- * Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
2265
- * let bunny2 = addImage("bunny2")
2266
- * await bunny2.load()
2267
- * ```
2268
- */
2269
- declare function addImage(alias: string, imageUrl?: string, options?: ImageSpriteOptions): ImageSprite;
2270
- /**
2271
- * Add and show a image in the canvas. This function is a combination of {@link addImage}.
2272
- * @param alias The unique alias of the image. You can use this alias to refer to this image
2273
- * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
2274
- * @param options The options of the image.
2275
- * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
2276
- * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
2277
- * @example
2278
- * ```ts
2279
- * let bunny1 = showImage("bunny1", "https://pixijs.com/assets/bunny1.png")
2280
- * Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
2281
- * let bunny2 = showImage("bunny2")
2282
- * ```
2283
- */
2284
- declare function showImage(alias: string, imageUrl?: string, options?: ImageSpriteOptions): Promise<ImageSprite>;
2285
-
2286
- /**
2287
- * Add and show a text in the canvas.
2288
- * @param alias The unique alias of the text. You can use this alias to refer to this text.
2289
- * @param text
2290
- * @param options The options of the text.
2291
- * @returns This function returns an {@link Text} that you can use to manipulate the component.
2292
- * @example
2293
- * ```ts
2294
- * let text = showText("text", "Hello World", { fontSize: 24, fill: "white" })
2295
- * ```
2296
- */
2297
- declare function showText(alias: string, text: string, options?: Omit<TextOptions, "text">): Text;
2298
-
2299
- /**
2300
- * Get a texture from a url.
2301
- * @param textureAlias is the url of the file.
2302
- * @returns the texture of the image or video, or `undefined` when `textureAlias` is the `"EMPTY"` sentinel value.
2303
- * @throws {PixiError} when the alias is missing, the asset is not found in the cache/network, or the loaded resource is not a `Texture`.
2304
- */
2305
- declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefined>;
2306
-
2307
- /**
2308
- * Add a video in the canvas.
2309
- * Is the same that {@link showVideo}, but the video is not shown.
2310
- * If you want to show the video, then you need to use the function {@link VideoSprite.load()}.
2311
- * @param alias is the unique alias of the video. You can use this alias to refer to this video
2312
- * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
2313
- * @param options The options of the video.
2314
- * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
2315
- * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
2316
- * @example
2317
- * ```ts
2318
- * let video1 = addVideo("video1", "https://pixijs.com/assets/video1.mp4")
2319
- * await video1.load()
2320
- * Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
2321
- * let video2 = addVideo("video2")
2322
- * await video2.load()
2323
- * ```
2324
- */
2325
- declare function addVideo(alias: string, videoUrl?: string, options?: VideoSpriteOptions): VideoSprite;
2326
- /**
2327
- * Add and show a video in the canvas. This function is a combination of {@link addVideo}.
2328
- * @param alias The unique alias of the video. You can use this alias to refer to this video
2329
- * @param videoUrl The url of the video.
2330
- * @param options The options of the video.
2331
- * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
2332
- * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
2333
- * @example
2334
- * ```ts
2335
- * let video1 = showVideo("video1", "https://pixijs.com/assets/video1.mp4")
2336
- * Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
2337
- * let video2 = showVideo("video2")
2338
- * ```
2339
- */
2340
- declare function showVideo(alias: string, videoUrl?: string, options?: VideoSpriteOptions): Promise<VideoSprite>;
2341
-
2342
- interface ShakeEffectProps extends BaseTransitionProps, AnimationOptions {
1853
+ interface RadialBlurEffectProps extends DecayingEffectProps {
2343
1854
  /**
2344
- * The number of shocks. **Must be at least 3**.
2345
- * @default 10
1855
+ * The peak zoom-blur strength of the first, largest burst.
1856
+ * @default 0.5
2346
1857
  */
2347
- shocksNumber?: number;
1858
+ strength?: number;
2348
1859
  /**
2349
- * The type of the shake effect
2350
- * @default "horizontal"
1860
+ * The number of bursts.
1861
+ * @default 1
2351
1862
  */
2352
- shakeType?: "horizontal" | "vertical";
1863
+ bursts?: number;
2353
1864
  /**
2354
- * The maximum size of the shock.
2355
- * For horizontal type, it is the maximum size of the x axis.
2356
- * For vertical type, it is the maximum size of the y axis.
2357
- * @default 10
1865
+ * The origin the blur radiates from, normalized (0-1) to the element's own bounds.
1866
+ * @default {x: 0.5, y: 0.5}
2358
1867
  */
2359
- maxShockSize?: number;
2360
- }
2361
- /**
2362
- * Shared options for the generic, repeated articulated-animation effects ({@link BounceEffectProps},
2363
- * {@link HopEffectProps}, {@link WiggleEffectProps}, {@link NodEffectProps}, {@link SwayEffectProps}):
2364
- * a number of cycles, each one shrinking towards rest by {@link decay}.
2365
- */
2366
- interface DecayingEffectProps extends BaseTransitionProps, AnimationOptions {
1868
+ origin?: {
1869
+ x: number;
1870
+ y: number;
1871
+ };
2367
1872
  /**
2368
- * How much each successive cycle shrinks relative to the previous one (`1` = no decay/constant
2369
- * amplitude, `0` = the second cycle onward has no amplitude at all).
2370
- * @default 0.5
1873
+ * The inner radius (in pixels) excluded from the blur.
1874
+ * @default 0
2371
1875
  */
2372
- decay?: number;
1876
+ innerRadius?: number;
1877
+ /**
1878
+ * The outer radius (in pixels) of the blur. A value `< 0` means the blur extends infinitely.
1879
+ * @default -1
1880
+ */
1881
+ radius?: number;
2373
1882
  }
2374
- interface BounceEffectProps extends DecayingEffectProps {
1883
+ interface BlurPulseEffectProps extends DecayingEffectProps {
2375
1884
  /**
2376
- * The direction the component displaces towards on each bounce, before returning to rest.
2377
- * @default "up"
1885
+ * The peak blur strength of the first, largest pulse.
1886
+ * @default 8
2378
1887
  */
2379
- direction?: "up" | "down" | "left" | "right";
1888
+ strength?: number;
2380
1889
  /**
2381
- * The distance (in pixels) of the first, largest bounce.
2382
- * @default 30
1890
+ * The number of pulses.
1891
+ * @default 3
2383
1892
  */
2384
- distance?: number;
1893
+ pulses?: number;
2385
1894
  /**
2386
- * The number of bounces.
1895
+ * The blur filter's own render quality (number of blur passes). Higher looks smoother but costs
1896
+ * more to render.
2387
1897
  * @default 4
2388
1898
  */
2389
- bounces?: number;
1899
+ quality?: number;
2390
1900
  }
2391
- interface PulseEffectProps extends DecayingEffectProps {
1901
+ interface VignettePulseEffectProps extends DecayingEffectProps {
2392
1902
  /**
2393
- * The peak scale multiplier of the first, largest pulse (relative to the component's current
2394
- * scale) - e.g. `1.2` grows the component 20% bigger at the peak of the first pulse.
2395
- * @default 1.2
1903
+ * The peak vignette opacity of the first, largest pulse.
1904
+ * @default 1
2396
1905
  */
2397
- scale?: number;
1906
+ strength?: number;
2398
1907
  /**
2399
1908
  * The number of pulses.
2400
- * @default 3
1909
+ * @default 1
2401
1910
  */
2402
1911
  pulses?: number;
2403
- }
2404
- interface HopEffectProps extends DecayingEffectProps {
2405
1912
  /**
2406
- * The direction of the (primary and any secondary) hops.
2407
- * @default "up"
1913
+ * How far the darkening reaches in from the corners, from `0` (none) to `1` (the whole element) -
1914
+ * `0.5` darkens roughly the outer half.
1915
+ * @default 0.5
2408
1916
  */
2409
- direction?: "up" | "down" | "left" | "right";
1917
+ radius?: number;
2410
1918
  /**
2411
- * The distance (in pixels) of the primary hop.
2412
- * @default 40
1919
+ * How soft the transition from the clear center to the dark edges is (`0` = a hard edge).
1920
+ * @default 0.5
2413
1921
  */
2414
- distance?: number;
1922
+ blur?: number;
1923
+ }
1924
+ interface DesaturateEffectProps extends BaseTransitionProps, AnimationOptions {
2415
1925
  /**
2416
- * The number of smaller, decaying hops to play after the primary one (`0` = just the one hop).
1926
+ * The saturation floor reached at the trough (`0` = full grayscale, `1` = no desaturation at all).
2417
1927
  * @default 0
2418
1928
  */
2419
- secondaryHops?: number;
1929
+ amount?: number;
1930
+ /**
1931
+ * How long the component stays at {@link amount} before recovering back to normal saturation, on
1932
+ * top of the fade in/out (each {@link AnimationOptions.duration}).
1933
+ * @default 0
1934
+ */
1935
+ holdDuration?: number;
2420
1936
  }
2421
- interface WiggleEffectProps extends DecayingEffectProps {
1937
+ interface GlowPulseEffectProps extends DecayingEffectProps {
2422
1938
  /**
2423
- * The peak rotation (in degrees) away from the component's current angle, on the first repetition.
2424
- * @default 15
1939
+ * The peak outward glow strength of the first, largest pulse.
1940
+ * @default 4
2425
1941
  */
2426
- angle?: number;
1942
+ strength?: number;
2427
1943
  /**
2428
- * The number of repetitions.
1944
+ * The number of pulses.
2429
1945
  * @default 3
2430
1946
  */
2431
- repetitions?: number;
2432
- }
2433
- interface NodEffectProps extends DecayingEffectProps {
1947
+ pulses?: number;
2434
1948
  /**
2435
- * The axis the component oscillates along.
2436
- * @default "horizontal"
1949
+ * The color of the glow.
1950
+ * @default 0xffffff
2437
1951
  */
2438
- axis?: "horizontal" | "vertical";
1952
+ color?: number;
2439
1953
  /**
2440
- * The distance (in pixels) of the first, largest oscillation.
2441
- * @default 15
1954
+ * The distance (in pixels) the glow extends.
1955
+ * @default 10
2442
1956
  */
2443
1957
  distance?: number;
2444
1958
  /**
2445
- * The number of repetitions.
2446
- * @default 3
1959
+ * The strength of the glow inward from the edge of the component.
1960
+ * @default 0
2447
1961
  */
2448
- repetitions?: number;
1962
+ innerStrength?: number;
2449
1963
  }
2450
- interface SwayEffectProps extends DecayingEffectProps {
1964
+
1965
+ /**
1966
+ * @deprecated Use `effects.shakeEffect` instead.
1967
+ */
1968
+ declare function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
1969
+ declare namespace effects {
2451
1970
  /**
2452
- * The distance (in pixels) of the positional drift, on the first repetition.
2453
- * @default 10
1971
+ * Shake the canvas element.
1972
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
1973
+ * @param alias The alias to identify the component.
1974
+ * @param options Animation options, matching the `options` of animate function.
1975
+ * @param priority The priority of the PixiJS ticker. This parameter sets the ticker's priority.
1976
+ * @returns
2454
1977
  */
2455
- distance?: number;
1978
+ function shakeEffect(alias: string, options?: ShakeEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2456
1979
  /**
2457
- * The rotational drift (in degrees) away from the component's current angle, on the first
2458
- * repetition.
2459
- * @default 5
1980
+ * Bounce the canvas element: a one-directional displacement that repeatedly returns to rest, each
1981
+ * bounce shrinking towards rest by {@link BounceEffectProps.decay}. Like a dropped ball settling.
1982
+ * @param alias The alias to identify the component.
1983
+ * @param options Animation options.
1984
+ * @param priority The priority of the PixiJS ticker.
2460
1985
  */
2461
- angle?: number;
1986
+ function bounceEffect(alias: string, options?: BounceEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2462
1987
  /**
2463
- * The axis the positional drift moves along.
2464
- * @default "horizontal"
1988
+ * Pulse the canvas element: a repeated, decaying scale bump away from its current scale and back.
1989
+ * @param alias The alias to identify the component.
1990
+ * @param options Animation options.
1991
+ * @param priority The priority of the PixiJS ticker.
2465
1992
  */
2466
- axis?: "horizontal" | "vertical";
1993
+ function pulseEffect(alias: string, options?: PulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2467
1994
  /**
2468
- * The number of repetitions.
2469
- * @default 3
1995
+ * Hop the canvas element: one deliberate displacement-and-return, optionally followed by smaller,
1996
+ * decaying secondary hops.
1997
+ * @param alias The alias to identify the component.
1998
+ * @param options Animation options.
1999
+ * @param priority The priority of the PixiJS ticker.
2470
2000
  */
2471
- repetitions?: number;
2472
- }
2473
- interface PunchEffectProps extends BaseTransitionProps, AnimationOptions {
2001
+ function hopEffect(alias: string, options?: HopEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2474
2002
  /**
2475
- * Which property the punch animates.
2476
- * @default "scale"
2003
+ * Wiggle the canvas element: a decaying rotation oscillation around its current angle.
2004
+ * @param alias The alias to identify the component.
2005
+ * @param options Animation options.
2006
+ * @param priority The priority of the PixiJS ticker.
2477
2007
  */
2478
- mode?: "x" | "y" | "rotation" | "scale";
2008
+ function wiggleEffect(alias: string, options?: WiggleEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2479
2009
  /**
2480
- * The strength of the punch's attack - a pixel distance for `x`/`y`, degrees for `rotation`, or a
2481
- * scale multiplier delta for `scale` (e.g. `0.3` peaks at 1.3x the current scale).
2482
- * @default 0.3
2010
+ * Nod the canvas element: a decaying positional oscillation along one axis.
2011
+ * @param alias The alias to identify the component.
2012
+ * @param options Animation options.
2013
+ * @param priority The priority of the PixiJS ticker.
2483
2014
  */
2484
- strength?: number;
2015
+ function nodEffect(alias: string, options?: NodEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2485
2016
  /**
2486
- * How far the recovery overshoots past rest, in the opposite direction, as a fraction of
2487
- * {@link strength} (`0` = no overshoot, settles straight back to rest).
2488
- * @default 0.3
2017
+ * Sway the canvas element: a smooth, optionally combined positional and rotational drift around its
2018
+ * current state - a gentler, slower cousin of {@link nodEffect}/{@link wiggleEffect}.
2019
+ * @param alias The alias to identify the component.
2020
+ * @param options Animation options.
2021
+ * @param priority The priority of the PixiJS ticker.
2489
2022
  */
2490
- overshoot?: number;
2491
- }
2492
- interface GlitchEffectProps extends DecayingEffectProps {
2023
+ function swayEffect(alias: string, options?: SwayEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2493
2024
  /**
2494
- * The peak slice-displacement amount (pixels) of the first, largest burst.
2495
- * @default 40
2025
+ * Punch the canvas element: a single fast impulse (position, rotation, or scale) with a strong
2026
+ * attack and a short, slightly overshooting recovery back to rest - unlike every other effect here,
2027
+ * this is a one-shot impact, not a repeated oscillation.
2028
+ * @param alias The alias to identify the component.
2029
+ * @param options Animation options.
2030
+ * @param priority The priority of the PixiJS ticker.
2496
2031
  */
2497
- strength?: number;
2032
+ function punchEffect(alias: string, options?: PunchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2498
2033
  /**
2499
- * The number of glitch bursts.
2500
- * @default 3
2034
+ * Glitch the canvas element: decaying, jittery bursts of digital-corruption slice displacement
2035
+ * ({@link https://pixijs.io/filters/docs/GlitchFilter.html GlitchFilter}) - each burst snaps,
2036
+ * kicks back the other way and settles - with a matching red/blue channel split layered on top
2037
+ * ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}, see
2038
+ * {@link GlitchEffectProps.rgbSplit}). Both filters are removed once done. Returns one ticker id
2039
+ * per filter.
2040
+ *
2041
+ * Known cosmetic quirk: `GlitchFilter`'s own `destroy()` (called once this effect completes, to
2042
+ * clean up its displacement texture) can log a harmless `PixiJS Warning: [BindGroup] a
2043
+ * 'textureSource'/'textureSampler' was destroyed while still bound to a shader` in the console -
2044
+ * this comes from `pixi-filters`' own implementation, not from this effect, doesn't affect the
2045
+ * component's rendering or state, and every property is still correctly restored/detached.
2046
+ * @param alias The alias to identify the component.
2047
+ * @param options Animation options.
2048
+ * @param priority The priority of the PixiJS ticker.
2501
2049
  */
2502
- bursts?: number;
2050
+ function glitchEffect(alias: string, options?: GlitchEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2503
2051
  /**
2504
- * The number of glitch slices.
2505
- * @default 8
2052
+ * Chromatic-aberration the canvas element: the red and blue color channels split apart in opposite
2053
+ * directions and snap back, in a decaying burst
2054
+ * ({@link https://pixijs.io/filters/docs/RGBSplitFilter.html RGBSplitFilter}).
2055
+ * @param alias The alias to identify the component.
2056
+ * @param options Animation options.
2057
+ * @param priority The priority of the PixiJS ticker.
2506
2058
  */
2507
- slices?: number;
2059
+ function chromaticAberrationEffect(alias: string, options?: ChromaticAberrationEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2508
2060
  /**
2509
- * The angle (in degrees) slices are displaced along.
2510
- * @default 0
2061
+ * Shockwave the canvas element: a single radial ripple distortion travels outward from an origin
2062
+ * point and fades ({@link https://pixijs.io/filters/docs/ShockwaveFilter.html ShockwaveFilter}) -
2063
+ * a one-shot impact, not a repeated oscillation.
2064
+ * @param alias The alias to identify the component.
2065
+ * @param options Animation options.
2066
+ * @param priority The priority of the PixiJS ticker.
2511
2067
  */
2512
- direction?: number;
2068
+ function shockwaveEffect(alias: string, options?: ShockwaveEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2513
2069
  /**
2514
- * The peak red/blue channel separation (pixels) layered on top of the slice displacement,
2515
- * following the same jittery envelope. `0` disables it.
2516
- * @default 6
2070
+ * Radially blur the canvas element: a decaying burst of zoom-blur radiating from an origin point,
2071
+ * settling back to no blur between and after each burst
2072
+ * ({@link https://pixijs.io/filters/docs/ZoomBlurFilter.html ZoomBlurFilter}).
2073
+ * @param alias The alias to identify the component.
2074
+ * @param options Animation options.
2075
+ * @param priority The priority of the PixiJS ticker.
2517
2076
  */
2518
- rgbSplit?: number;
2519
- }
2520
- interface ChromaticAberrationEffectProps extends DecayingEffectProps {
2077
+ function radialBlurEffect(alias: string, options?: RadialBlurEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2521
2078
  /**
2522
- * The peak red/blue channel pixel offset of the first, largest burst (channels split in opposite
2523
- * directions, green stays centered).
2524
- * @default 8
2079
+ * Pulse a blur on the canvas element: a repeated, decaying blur bump that settles back to no blur
2080
+ * between and after each pulse ({@link https://pixijs.io/filters/docs/BlurFilter.html BlurFilter}).
2081
+ * @param alias The alias to identify the component.
2082
+ * @param options Animation options.
2083
+ * @param priority The priority of the PixiJS ticker.
2525
2084
  */
2526
- strength?: number;
2085
+ function blurPulseEffect(alias: string, options?: BlurPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2527
2086
  /**
2528
- * The axis the channels split along.
2529
- * @default "horizontal"
2087
+ * Pulse a vignette on the canvas element: the edges darken and recover, in a repeated, decaying
2088
+ * pulse - built on {@link https://pixijs.io/filters/docs/CRTFilter.html CRTFilter} with its
2089
+ * scanline/noise features turned off, isolating just the vignette.
2090
+ *
2091
+ * The vignette darkens the corners of the element's own bounding rectangle, so it's meant for
2092
+ * backgrounds and other full-frame images; on a sprite with transparent corners (a character, a
2093
+ * shape) there's little to darken and it barely shows.
2094
+ * @param alias The alias to identify the component.
2095
+ * @param options Animation options.
2096
+ * @param priority The priority of the PixiJS ticker.
2530
2097
  */
2531
- axis?: "horizontal" | "vertical";
2098
+ function vignettePulseEffect(alias: string, options?: VignettePulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2532
2099
  /**
2533
- * The number of bursts.
2534
- * @default 1
2100
+ * Desaturate the canvas element: color drains out to {@link DesaturateEffectProps.amount} and
2101
+ * recovers back to normal - a single dip, not a repeated oscillation
2102
+ * ({@link https://pixijs.io/filters/docs/AdjustmentFilter.html AdjustmentFilter}).
2103
+ * @param alias The alias to identify the component.
2104
+ * @param options Animation options.
2105
+ * @param priority The priority of the PixiJS ticker.
2535
2106
  */
2536
- bursts?: number;
2537
- }
2538
- interface ShockwaveEffectProps extends BaseTransitionProps, AnimationOptions {
2107
+ function desaturateEffect(alias: string, options?: DesaturateEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2539
2108
  /**
2540
- * The origin of the ripple, normalized (0-1) to the element's own bounds.
2541
- * @default {x: 0.5, y: 0.5}
2109
+ * Pulse a glow on the canvas element: a repeated, decaying outward glow that settles back to no
2110
+ * glow between and after each pulse ({@link https://pixijs.io/filters/docs/GlowFilter.html GlowFilter}).
2111
+ * @param alias The alias to identify the component.
2112
+ * @param options Animation options.
2113
+ * @param priority The priority of the PixiJS ticker.
2542
2114
  */
2543
- origin?: {
2115
+ function glowPulseEffect(alias: string, options?: GlowPulseEffectProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2116
+ }
2117
+
2118
+ declare namespace CanvasPropertyUtility {
2119
+ function calculatePositionByAlign(type: "width" | "height", align: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
2120
+ function calculateAlignByPosition(type: "width" | "height", position: number, value: number, pivot: number, negativeScale: boolean, anchor?: number): number;
2121
+ function calculatePositionByPercentagePosition(type: "width" | "height", percentage: number): number;
2122
+ function calculatePercentagePositionByPosition(type: "width" | "height", position: number): number;
2123
+ function getSuperPoint(point: {
2124
+ x: number;
2125
+ y: number;
2126
+ }, angle: number): {
2127
+ x: number;
2128
+ y: number;
2129
+ };
2130
+ function getPointBySuperPoint(superPoint: {
2131
+ x: number;
2132
+ y: number;
2133
+ }, angle: number): {
2544
2134
  x: number;
2545
2135
  y: number;
2546
2136
  };
2137
+ function getSuperWidth(canvasElement: Container$1): number;
2138
+ function getSuperHeight(canvasElement: Container$1): number;
2139
+ }
2140
+
2141
+ type TComponent = CanvasBaseInterface<any> | string | string[] | {
2142
+ value: string;
2143
+ options: ImageSpriteOptions;
2144
+ } | {
2145
+ value: string[];
2146
+ options: ImageContainerOptions;
2147
+ };
2148
+ /**
2149
+ * @deprecated Use `transitions.showWithDissolve` instead.
2150
+ */
2151
+ declare function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2152
+ /**
2153
+ * @deprecated Use `transitions.removeWithDissolve` instead.
2154
+ */
2155
+ declare function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2156
+ /**
2157
+ * @deprecated Use `transitions.showWithFade` instead.
2158
+ */
2159
+ declare function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2160
+ /**
2161
+ * @deprecated Use `transitions.removeWithFade` instead.
2162
+ */
2163
+ declare function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2164
+ /**
2165
+ * @deprecated Use `transitions.moveIn` instead.
2166
+ */
2167
+ declare function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
2547
2168
  /**
2548
- * The amplitude of the ripple.
2549
- * @default 30
2169
+ * @deprecated Use `animateOldComponentOut` instead.
2550
2170
  */
2551
- amplitude?: number;
2171
+ removeOldComponentWithMoveOut?: boolean;
2172
+ }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2173
+ /**
2174
+ * @deprecated Use `transitions.moveOut` instead.
2175
+ */
2176
+ declare function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2177
+ /**
2178
+ * @deprecated Use `transitions.zoomIn` instead.
2179
+ */
2180
+ declare function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
2552
2181
  /**
2553
- * The wavelength of the ripple.
2554
- * @default 160
2182
+ * @deprecated Use `animateOldComponentOut` instead.
2555
2183
  */
2556
- wavelength?: number;
2184
+ removeOldComponentWithZoomOut?: boolean;
2185
+ }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2186
+ /**
2187
+ * @deprecated Use `transitions.zoomOut` instead.
2188
+ */
2189
+ declare function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2190
+ /**
2191
+ * @deprecated Use `transitions.pushIn` instead.
2192
+ */
2193
+ declare function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2194
+ /**
2195
+ * @deprecated Use `transitions.pushOut` instead.
2196
+ */
2197
+ declare function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2198
+ declare namespace transitions {
2557
2199
  /**
2558
- * The brightness of the ripple.
2559
- * @default 1
2200
+ * Show a image in the canvas with a disolve effect.
2201
+ * Disolve effect is a effect that the image is shown with a fade in.
2202
+ * If exist a image with the same alias, then the image is replaced and the first image is removed after the effect is done.
2203
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2204
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2205
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2206
+ * If you don't provide the component, then the alias is used as the url.
2207
+ * @param props The properties of the effect
2208
+ * @param priority The priority of the effect
2209
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2560
2210
  */
2561
- brightness?: number;
2211
+ function showWithDissolve(alias: string, component?: TComponent, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2562
2212
  /**
2563
- * The maximum radius (in pixels) the ripple travels before fading out. A value `<= 0` means the
2564
- * ripple travels an infinite distance.
2565
- * @default -1
2213
+ * Remove a image from the canvas with a disolve effect.
2214
+ * Disolve effect is a effect that the image is removed with a fade out.
2215
+ * This function is equivalent to {@link removeWithFade}.
2216
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2217
+ * @param props The properties of the effect
2218
+ * @param priority The priority of the effect
2219
+ * @returns The ids of the tickers that are used in the effect.
2566
2220
  */
2567
- radius?: number;
2221
+ function removeWithDissolve(alias: string, props?: ShowWithDissolveTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2568
2222
  /**
2569
- * The speed (in pixels-per-second) the ripple travels outward.
2570
- * @default 500
2223
+ * Show a image in the canvas with a fade effect.
2224
+ * Fade effect is a effect that the image is shown with a fade in.
2225
+ * If exist a image with the same alias, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.
2226
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2227
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2228
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2229
+ * If you don't provide the component, then the alias is used as the url.
2230
+ * @param props The properties of the effect
2231
+ * @param priority The priority of the effect
2232
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2571
2233
  */
2572
- speed?: number;
2234
+ function showWithFade(alias: string, component?: TComponent, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2573
2235
  /**
2574
- * How far the ripple's own internal "time" advances by the end of the animation (the ring's
2575
- * radius is `time * speed` pixels). By default it's just enough for the ring to fully leave the
2576
- * component - origin to farthest corner plus half a {@link wavelength} - or {@link radius} when set,
2577
- * divided by {@link speed}.
2236
+ * Remove a image from the canvas with a fade effect.
2237
+ * Fade effect is a effect that the image is removed with a fade out.
2238
+ * This function is equivalent to {@link removeWithDissolve}.
2239
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2240
+ * @param props The properties of the effect
2241
+ * @param priority The priority of the effect
2242
+ * @returns The ids of the tickers that are used in the effect.
2578
2243
  */
2579
- strength?: number;
2580
- }
2581
- interface RadialBlurEffectProps extends DecayingEffectProps {
2244
+ function removeWithFade(alias: string, props?: ShowWithFadeTransitionProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2582
2245
  /**
2583
- * The peak zoom-blur strength of the first, largest burst.
2584
- * @default 0.5
2246
+ * Show a image in the canvas with a move effect. The image is moved from outside the canvas to the x and y position of the image.
2247
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2248
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2249
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2250
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2251
+ * If you don't provide the component, then the alias is used as the url.
2252
+ * @param props The properties of the effect
2253
+ * @param priority The priority of the effect
2254
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2585
2255
  */
2586
- strength?: number;
2256
+ function moveIn(alias: string, component?: TComponent, props?: MoveInOutProps & {
2257
+ /**
2258
+ * @deprecated Use `animateOldComponentOut` instead.
2259
+ */
2260
+ removeOldComponentWithMoveOut?: boolean;
2261
+ }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2587
2262
  /**
2588
- * The number of bursts.
2589
- * @default 1
2263
+ * Remove a image from the canvas with a move effect. The image is moved from the x and y position of the image to outside the canvas.
2264
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2265
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2266
+ * @param props The properties of the effect
2267
+ * @param priority The priority of the effect
2268
+ * @returns The ids of the tickers that are used in the effect.
2590
2269
  */
2591
- bursts?: number;
2270
+ function moveOut(alias: string, props?: MoveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2592
2271
  /**
2593
- * The origin the blur radiates from, normalized (0-1) to the element's own bounds.
2594
- * @default {x: 0.5, y: 0.5}
2272
+ * Show a image in the canvas with a zoom effect. The image is zoomed in from the center of the canvas.
2273
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2274
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2275
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2276
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2277
+ * If you don't provide the component, then the alias is used as the url.
2278
+ * @param props The properties of the effect
2279
+ * @param priority The priority of the effect
2280
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2595
2281
  */
2596
- origin?: {
2597
- x: number;
2598
- y: number;
2599
- };
2282
+ function zoomIn(alias: string, component?: TComponent, props?: ZoomInOutProps & {
2283
+ /**
2284
+ * @deprecated Use `animateOldComponentOut` instead.
2285
+ */
2286
+ removeOldComponentWithZoomOut?: boolean;
2287
+ }, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2600
2288
  /**
2601
- * The inner radius (in pixels) excluded from the blur.
2602
- * @default 0
2289
+ * Remove a image from the canvas with a zoom effect. The image is zoomed out to the center of the canvas.
2290
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2291
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2292
+ * @param props The properties of the effect
2293
+ * @param priority The priority of the effect
2294
+ * @returns The ids of the tickers that are used in the effect.
2603
2295
  */
2604
- innerRadius?: number;
2296
+ function zoomOut(alias: string, props?: ZoomInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2605
2297
  /**
2606
- * The outer radius (in pixels) of the blur. A value `< 0` means the blur extends infinitely.
2607
- * @default -1
2298
+ * Show a image in the canvas with a push effect. The new image is pushed in from the inside of the canvas and the old image is pushed out to the outside of the canvas.
2299
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2300
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2301
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2302
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2303
+ * If you don't provide the component, then the alias is used as the url.
2304
+ * @param props The properties of the effect
2305
+ * @param priority The priority of the effect
2306
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2608
2307
  */
2609
- radius?: number;
2610
- }
2611
- interface BlurPulseEffectProps extends DecayingEffectProps {
2308
+ function pushIn(alias: string, component?: TComponent, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2612
2309
  /**
2613
- * The peak blur strength of the first, largest pulse.
2614
- * @default 8
2310
+ * Remove a image from the canvas with a push effect. The image is pushed out to the outside of the canvas.
2311
+ * If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.
2312
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2313
+ * @param props The properties of the effect
2314
+ * @param priority The priority of the effect
2315
+ * @returns The ids of the tickers that are used in the effect.
2615
2316
  */
2616
- strength?: number;
2317
+ function pushOut(alias: string, props?: PushInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2617
2318
  /**
2618
- * The number of pulses.
2619
- * @default 3
2319
+ * Show a image in the canvas with a wipe effect: the image is progressively revealed by a moving
2320
+ * boundary. The direction/angle and inversion are all configurable, so the same primitive can
2321
+ * produce horizontal, vertical, or diagonal reveals - see {@link WipeInOutProps}.
2322
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2323
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2324
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2325
+ * If you don't provide the component, then the alias is used as the url.
2326
+ * @param props The properties of the effect
2327
+ * @param priority The priority of the effect
2328
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2620
2329
  */
2621
- pulses?: number;
2330
+ function wipeIn(alias: string, component?: TComponent, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2622
2331
  /**
2623
- * The blur filter's own render quality (number of blur passes). Higher looks smoother but costs
2624
- * more to render.
2625
- * @default 4
2332
+ * Remove a image from the canvas with a wipe effect: the image is progressively concealed by a
2333
+ * moving boundary. See {@link wipeIn} and {@link WipeInOutProps}.
2334
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2335
+ * @param props The properties of the effect
2336
+ * @param priority The priority of the effect
2337
+ * @returns The ids of the tickers that are used in the effect.
2626
2338
  */
2627
- quality?: number;
2628
- }
2629
- interface VignettePulseEffectProps extends DecayingEffectProps {
2339
+ function wipeOut(alias: string, props?: WipeInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2630
2340
  /**
2631
- * The peak vignette opacity of the first, largest pulse.
2632
- * @default 1
2341
+ * Show a image in the canvas with an iris effect: the image is progressively revealed by an
2342
+ * expanding radial mask. Moving {@link IrisInOutProps.origin} off-center makes the same primitive
2343
+ * useful as a focus/reveal effect (e.g. centered on a character).
2344
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2345
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2346
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2347
+ * If you don't provide the component, then the alias is used as the url.
2348
+ * @param props The properties of the effect
2349
+ * @param priority The priority of the effect
2350
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2633
2351
  */
2634
- strength?: number;
2352
+ function irisIn(alias: string, component?: TComponent, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2635
2353
  /**
2636
- * The number of pulses.
2637
- * @default 1
2354
+ * Remove a image from the canvas with an iris effect: the image is progressively concealed by a
2355
+ * contracting radial mask. See {@link irisIn} and {@link IrisInOutProps}.
2356
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2357
+ * @param props The properties of the effect
2358
+ * @param priority The priority of the effect
2359
+ * @returns The ids of the tickers that are used in the effect.
2638
2360
  */
2639
- pulses?: number;
2361
+ function irisOut(alias: string, props?: IrisInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2640
2362
  /**
2641
- * How far the darkening reaches in from the corners, from `0` (none) to `1` (the whole element) -
2642
- * `0.5` darkens roughly the outer half.
2643
- * @default 0.5
2363
+ * Show a image in the canvas with a split effect: two mask panels slide together from the edges to
2364
+ * progressively reveal the image, meeting at the split line once fully shown. With
2365
+ * `direction: "outward"`, the reveal grows from the split line towards the edges instead.
2366
+ * During replacement, the old component's conceal follows the new component's reveal.
2367
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2368
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2369
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2370
+ * If you don't provide the component, then the alias is used as the url.
2371
+ * @param props The properties of the effect
2372
+ * @param priority The priority of the effect
2373
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2644
2374
  */
2645
- radius?: number;
2375
+ function splitIn(alias: string, component?: TComponent, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2646
2376
  /**
2647
- * How soft the transition from the clear center to the dark edges is (`0` = a hard edge).
2648
- * @default 0.5
2377
+ * Remove a image from the canvas with a split effect: two mask panels retract apart toward the
2378
+ * edges to progressively conceal the image. With `direction: "outward"`, the visible region
2379
+ * shrinks from the edges towards the split line. See {@link splitIn} and {@link SplitInOutProps}.
2380
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2381
+ * @param props The properties of the effect
2382
+ * @param priority The priority of the effect
2383
+ * @returns The ids of the tickers that are used in the effect.
2649
2384
  */
2650
- blur?: number;
2651
- }
2652
- interface DesaturateEffectProps extends BaseTransitionProps, AnimationOptions {
2385
+ function splitOut(alias: string, props?: SplitInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2653
2386
  /**
2654
- * The saturation floor reached at the trough (`0` = full grayscale, `1` = no desaturation at all).
2655
- * @default 0
2387
+ * Show a image in the canvas with a blur effect: the image appears already blurred and sharpens
2388
+ * into focus. A generic blur, not a "dream"/"flashback" transition specifically - combine it with
2389
+ * {@link showWithFade} for that recipe. See {@link BlurInOutProps}.
2390
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2391
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2392
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2393
+ * If you don't provide the component, then the alias is used as the url.
2394
+ * @param props The properties of the effect
2395
+ * @param priority The priority of the effect
2396
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2656
2397
  */
2657
- amount?: number;
2398
+ function blurIn(alias: string, component?: TComponent, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2658
2399
  /**
2659
- * How long the component stays at {@link amount} before recovering back to normal saturation, on
2660
- * top of the fade in/out (each {@link AnimationOptions.duration}).
2661
- * @default 0
2400
+ * Remove a image from the canvas with a blur effect: the image blurs out of focus before being
2401
+ * removed. See {@link blurIn} and {@link BlurInOutProps}.
2402
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2403
+ * @param props The properties of the effect
2404
+ * @param priority The priority of the effect
2405
+ * @returns The ids of the tickers that are used in the effect.
2662
2406
  */
2663
- holdDuration?: number;
2664
- }
2665
- interface GlowPulseEffectProps extends DecayingEffectProps {
2407
+ function blurOut(alias: string, props?: BlurInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2666
2408
  /**
2667
- * The peak outward glow strength of the first, largest pulse.
2668
- * @default 4
2409
+ * Show a image in the canvas with a pixelate effect: the image appears pixelated and resolves into
2410
+ * focus. Useful for retro effects, digital transitions, censorship/stylization, or scene changes -
2411
+ * not only "glitch" scenes. See {@link PixelateInOutProps}.
2412
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2413
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2414
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2415
+ * If you don't provide the component, then the alias is used as the url.
2416
+ * @param props The properties of the effect
2417
+ * @param priority The priority of the effect
2418
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2669
2419
  */
2670
- strength?: number;
2420
+ function pixelateIn(alias: string, component?: TComponent, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2671
2421
  /**
2672
- * The number of pulses.
2673
- * @default 3
2422
+ * Remove a image from the canvas with a pixelate effect: the image pixelates before being removed.
2423
+ * See {@link pixelateIn} and {@link PixelateInOutProps}.
2424
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2425
+ * @param props The properties of the effect
2426
+ * @param priority The priority of the effect
2427
+ * @returns The ids of the tickers that are used in the effect.
2674
2428
  */
2675
- pulses?: number;
2429
+ function pixelateOut(alias: string, props?: PixelateInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2676
2430
  /**
2677
- * The color of the glow.
2678
- * @default 0xffffff
2431
+ * Show a image in the canvas with a flash effect, with a configurable solid-color overlay (not
2432
+ * limited to a white flash). White reads as a camera/explosion-like flash, black as a blink/cut, and
2433
+ * arbitrary colors work for damage/magic/memory/UI transitions. See {@link FlashInOutProps}.
2434
+ *
2435
+ * If `alias` has no existing component, the new image appears immediately and the overlay fades in
2436
+ * and back out over it. If `alias` already has a component, the *current* content fades up to
2437
+ * `color` first, is swapped for the new content at the exact moment the screen is a solid `color`
2438
+ * (so the content change itself is invisible), and the new content then fades back down from `color`
2439
+ * to normal - see {@link flashReplace}.
2440
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2441
+ * @param component The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the {@link VideoSprite} is added to the canvas.
2442
+ * If imageUrl is an array, then the {@link ImageContainer} is added to the canvas.
2443
+ * If you don't provide the component, then the alias is used as the url.
2444
+ * @param props The properties of the effect
2445
+ * @param priority The priority of the effect
2446
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2679
2447
  */
2680
- color?: number;
2448
+ function flashIn(alias: string, component?: TComponent, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2681
2449
  /**
2682
- * The distance (in pixels) the glow extends.
2683
- * @default 10
2450
+ * Remove a image from the canvas with a flash effect: a configurable solid-color overlay fades up to
2451
+ * `color` and back down to normal, and the image is removed the instant that finishes - the removal
2452
+ * itself is a hard cut, never an additional fade/dissolve. See {@link flashIn} and
2453
+ * {@link FlashInOutProps}.
2454
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2455
+ * @param props The properties of the effect
2456
+ * @param priority The priority of the effect
2457
+ * @returns The ids of the tickers that are used in the effect.
2684
2458
  */
2685
- distance?: number;
2459
+ function flashOut(alias: string, props?: FlashInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2686
2460
  /**
2687
- * The strength of the glow inward from the edge of the component.
2688
- * @default 0
2461
+ * Show a image in the canvas with a glitch effect: the image materializes out of jittery bursts of
2462
+ * digital-corruption slices with red/blue fringing, which settle as it appears. See
2463
+ * {@link GlitchInOutProps}.
2464
+ * When replacing an existing component, waits for its out animation before starting the entrance.
2465
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2466
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2467
+ * @param props The properties of the effect
2468
+ * @param priority The priority of the effect
2469
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2689
2470
  */
2690
- innerStrength?: number;
2471
+ function glitchIn(alias: string, component?: TComponent, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2472
+ /**
2473
+ * Remove a image from the canvas with a glitch effect: digital-corruption bursts build up until the
2474
+ * image is removed. See {@link glitchIn} and {@link GlitchInOutProps}.
2475
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2476
+ * @param props The properties of the effect
2477
+ * @param priority The priority of the effect
2478
+ * @returns The ids of the tickers that are used in the effect.
2479
+ */
2480
+ function glitchOut(alias: string, props?: GlitchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2481
+ /**
2482
+ * Show a image in the canvas with a twist effect: the image unwinds out of a swirl, like coming
2483
+ * through a vortex or portal. See {@link TwistInOutProps}.
2484
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2485
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2486
+ * @param props The properties of the effect
2487
+ * @param priority The priority of the effect
2488
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2489
+ */
2490
+ function twistIn(alias: string, component?: TComponent, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2491
+ /**
2492
+ * Remove a image from the canvas with a twist effect: the image winds up into a swirl before being
2493
+ * removed. See {@link twistIn} and {@link TwistInOutProps}.
2494
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2495
+ * @param props The properties of the effect
2496
+ * @param priority The priority of the effect
2497
+ * @returns The ids of the tickers that are used in the effect.
2498
+ */
2499
+ function twistOut(alias: string, props?: TwistInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2500
+ /**
2501
+ * Show a image in the canvas with a warp effect: the image arrives out of radial zoom-blur streaks,
2502
+ * like dropping out of hyperspace. See {@link WarpInOutProps}.
2503
+ * When replacing an existing component, waits for its out animation before starting the entrance.
2504
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2505
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2506
+ * @param props The properties of the effect
2507
+ * @param priority The priority of the effect
2508
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2509
+ */
2510
+ function warpIn(alias: string, component?: TComponent, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2511
+ /**
2512
+ * Remove a image from the canvas with a warp effect: the image streaks away in a radial zoom blur
2513
+ * before being removed. See {@link warpIn} and {@link WarpInOutProps}.
2514
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2515
+ * @param props The properties of the effect
2516
+ * @param priority The priority of the effect
2517
+ * @returns The ids of the tickers that are used in the effect.
2518
+ */
2519
+ function warpOut(alias: string, props?: WarpInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2520
+ /**
2521
+ * Show a image in the canvas with a ripple effect: the image fades in through a ring of water-like
2522
+ * distortion spreading outward from an origin point - for dreams, magic or memories. See
2523
+ * {@link RippleInOutProps}.
2524
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2525
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2526
+ * @param props The properties of the effect
2527
+ * @param priority The priority of the effect
2528
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2529
+ */
2530
+ function rippleIn(alias: string, component?: TComponent, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2531
+ /**
2532
+ * Remove a image from the canvas with a ripple effect: a ring of water-like distortion spreads over
2533
+ * the image as it fades out and is removed. See {@link rippleIn} and {@link RippleInOutProps}.
2534
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2535
+ * @param props The properties of the effect
2536
+ * @param priority The priority of the effect
2537
+ * @returns The ids of the tickers that are used in the effect.
2538
+ */
2539
+ function rippleOut(alias: string, props?: RippleInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2540
+ /**
2541
+ * Show a image in the canvas with a noise dissolve: the image appears in organic, noise-shaped
2542
+ * blotches (or a cloudy fade with `edge: "soft"`) - the classic visual-novel image dissolve. See
2543
+ * {@link NoiseDissolveInOutProps}.
2544
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2545
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2546
+ * @param props The properties of the effect
2547
+ * @param priority The priority of the effect
2548
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2549
+ */
2550
+ function noiseDissolveIn(alias: string, component?: TComponent, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2551
+ /**
2552
+ * Remove a image from the canvas with a noise dissolve: the image disappears in noise-shaped
2553
+ * blotches and is then removed. See {@link noiseDissolveIn} and {@link NoiseDissolveInOutProps}.
2554
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2555
+ * @param props The properties of the effect
2556
+ * @param priority The priority of the effect
2557
+ * @returns The ids of the tickers that are used in the effect.
2558
+ */
2559
+ function noiseDissolveOut(alias: string, props?: NoiseDissolveInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2560
+ /**
2561
+ * Show a image in the canvas like an old TV turning on: a bright dot stretches into a glowing
2562
+ * horizontal line, which then opens up into the full image, with CRT scanlines. The scale animates
2563
+ * around the component's own anchor/pivot, so a centered anchor looks best. See
2564
+ * {@link TvInOutProps}.
2565
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2566
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2567
+ * @param props The properties of the effect
2568
+ * @param priority The priority of the effect
2569
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2570
+ */
2571
+ function tvIn(alias: string, component?: TComponent, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2572
+ /**
2573
+ * Remove a image from the canvas like an old TV turning off: the image collapses into a glowing
2574
+ * horizontal line, then into a dot, and is removed. The scale animates around the component's own
2575
+ * anchor/pivot, so a centered anchor looks best. See {@link tvIn} and {@link TvInOutProps}.
2576
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2577
+ * @param props The properties of the effect
2578
+ * @param priority The priority of the effect
2579
+ * @returns The ids of the tickers that are used in the effect.
2580
+ */
2581
+ function tvOut(alias: string, props?: TvInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2582
+ /**
2583
+ * Show a image in the canvas with a pinch effect: the image emerges from a single point, deforming
2584
+ * outward as it settles (or puffs out of it with `mode: "bulge"`). See {@link PinchInOutProps}.
2585
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2586
+ * @param component The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.
2587
+ * @param props The properties of the effect
2588
+ * @param priority The priority of the effect
2589
+ * @returns A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.
2590
+ */
2591
+ function pinchIn(alias: string, component?: TComponent, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): Promise<string[] | undefined>;
2592
+ /**
2593
+ * Remove a image from the canvas with a pinch effect: the image is sucked into a single point (or
2594
+ * puffs out with `mode: "bulge"`) and removed. See {@link pinchIn} and {@link PinchInOutProps}.
2595
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2596
+ * @param props The properties of the effect
2597
+ * @param priority The priority of the effect
2598
+ * @returns The ids of the tickers that are used in the effect.
2599
+ */
2600
+ function pinchOut(alias: string, props?: PinchInOutProps, priority?: UPDATE_PRIORITY$1): string[] | undefined;
2691
2601
  }
2692
2602
 
2603
+ /**
2604
+ * Canvas error handler: when a `PixiError` contains `canvasElementInfo`,
2605
+ * draw a simple `ErrorGraphics` placeholder on the canvas so the scene
2606
+ * remains visible and debuggable.
2607
+ */
2608
+ declare function drawCanvasErrorHandler(): OnErrorHandler;
2609
+
2610
+ /**
2611
+ * Add a list of images in the container, after that, the images are added to the canvas.
2612
+ * Is the same that {@link showImageContainer}, but the image is not shown.
2613
+ * If you want to show the container, then you need to use the function {@link ImageSprite.load()}.
2614
+ * @param alias is the unique alias of the container. You can use this alias to refer to this container
2615
+ * @param imageUrls is the url of the image. If you don't provide the url, then the alias is used as the url.
2616
+ * @param options The options of the container.
2617
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
2618
+ * @example
2619
+ * ```ts
2620
+ * let bunny = addImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
2621
+ * await bunny.load()
2622
+ * ```
2623
+ */
2624
+ declare function addImageCointainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): ImageContainer;
2625
+ /**
2626
+ * Add a list of images in the container, after that, the images are added and shown in the canvas.
2627
+ * @param alias The unique alias of the container. You can use this alias to refer to this container
2628
+ * @param imageUrls The url of the image.
2629
+ * @param options The options of the container.
2630
+ * @returns This function returns an {@link ImageContainer} that you can use to manipulate the component.
2631
+ * @example
2632
+ * ```ts
2633
+ * let bunny = showImageContainer("bunny", ["https://pixijs.com/assets/bunny-body.png", "https://pixijs.com/assets/bunny-eyes.png"])
2634
+ * ```
2635
+ */
2636
+ declare function showImageContainer(alias: string, imageUrls: string[], options?: ImageContainerOptions<ImageSprite>): Promise<ImageContainer>;
2637
+
2638
+ /**
2639
+ * Add a image in the canvas.
2640
+ * Is the same that {@link showImage}, but the image is not shown.
2641
+ * If you want to show the image, then you need to use the function {@link ImageSprite.load}.
2642
+ * @param alias is the unique alias of the image. You can use this alias to refer to this image
2643
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
2644
+ * @param options The options of the image.
2645
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
2646
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
2647
+ * @example
2648
+ * ```ts
2649
+ * let bunny1 = addImage("bunny1", "https://pixijs.com/assets/bunny1.png")
2650
+ * await bunny1.load()
2651
+ * Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
2652
+ * let bunny2 = addImage("bunny2")
2653
+ * await bunny2.load()
2654
+ * ```
2655
+ */
2656
+ declare function addImage(alias: string, imageUrl?: string, options?: ImageSpriteOptions): ImageSprite;
2657
+ /**
2658
+ * Add and show a image in the canvas. This function is a combination of {@link addImage}.
2659
+ * @param alias The unique alias of the image. You can use this alias to refer to this image
2660
+ * @param imageUrl The url of the image. If you have initialized the "asset matrix", you can use the alias of the texture. If you don't provide the URL, then the alias is used as the URL.
2661
+ * @param options The options of the image.
2662
+ * @returns This function returns an {@link ImageSprite} that you can use to manipulate the component.
2663
+ * @throws {PixiError} when `imageUrl` is not provided and `alias` is not registered in the asset cache.
2664
+ * @example
2665
+ * ```ts
2666
+ * let bunny1 = showImage("bunny1", "https://pixijs.com/assets/bunny1.png")
2667
+ * Assets.add({ alias: "bunny2", src: "https://pixijs.com/assets/bunny2.png" })
2668
+ * let bunny2 = showImage("bunny2")
2669
+ * ```
2670
+ */
2671
+ declare function showImage(alias: string, imageUrl?: string, options?: ImageSpriteOptions): Promise<ImageSprite>;
2672
+
2673
+ /**
2674
+ * Add and show a text in the canvas.
2675
+ * @param alias The unique alias of the text. You can use this alias to refer to this text.
2676
+ * @param text
2677
+ * @param options The options of the text.
2678
+ * @returns This function returns an {@link Text} that you can use to manipulate the component.
2679
+ * @example
2680
+ * ```ts
2681
+ * let text = showText("text", "Hello World", { fontSize: 24, fill: "white" })
2682
+ * ```
2683
+ */
2684
+ declare function showText(alias: string, text: string, options?: Omit<TextOptions, "text">): Text;
2685
+
2686
+ /**
2687
+ * Get a texture from a url.
2688
+ * @param textureAlias is the url of the file.
2689
+ * @returns the texture of the image or video, or `undefined` when `textureAlias` is the `"EMPTY"` sentinel value.
2690
+ * @throws {PixiError} when the alias is missing, the asset is not found in the cache/network, or the loaded resource is not a `Texture`.
2691
+ */
2692
+ declare function getTexture(textureAlias?: string): Promise<Texture$1 | undefined>;
2693
+
2694
+ /**
2695
+ * Add a video in the canvas.
2696
+ * Is the same that {@link showVideo}, but the video is not shown.
2697
+ * If you want to show the video, then you need to use the function {@link VideoSprite.load()}.
2698
+ * @param alias is the unique alias of the video. You can use this alias to refer to this video
2699
+ * @param videoUrl is the url of the video. If you don't provide the url, then the alias is used as the url.
2700
+ * @param options The options of the video.
2701
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
2702
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
2703
+ * @example
2704
+ * ```ts
2705
+ * let video1 = addVideo("video1", "https://pixijs.com/assets/video1.mp4")
2706
+ * await video1.load()
2707
+ * Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
2708
+ * let video2 = addVideo("video2")
2709
+ * await video2.load()
2710
+ * ```
2711
+ */
2712
+ declare function addVideo(alias: string, videoUrl?: string, options?: VideoSpriteOptions): VideoSprite;
2713
+ /**
2714
+ * Add and show a video in the canvas. This function is a combination of {@link addVideo}.
2715
+ * @param alias The unique alias of the video. You can use this alias to refer to this video
2716
+ * @param videoUrl The url of the video.
2717
+ * @param options The options of the video.
2718
+ * @returns This function returns an {@link VideoSprite} that you can use to manipulate the component.
2719
+ * @throws {PixiError} when `videoUrl` is not provided and `alias` is not registered in the asset cache.
2720
+ * @example
2721
+ * ```ts
2722
+ * let video1 = showVideo("video1", "https://pixijs.com/assets/video1.mp4")
2723
+ * Assets.add({ alias: "video2", src: "https://pixijs.com/assets/video2.png" })
2724
+ * let video2 = showVideo("video2")
2725
+ * ```
2726
+ */
2727
+ declare function showVideo(alias: string, videoUrl?: string, options?: VideoSpriteOptions): Promise<VideoSprite>;
2728
+
2729
+ /**
2730
+ * A snapshot of a component's own (untransformed) bounds, captured once when a mask/filter transition
2731
+ * starts. Transitions don't expect the component to resize mid-effect, the same simplification the
2732
+ * existing move/zoom/push transitions already make by computing their destination once upfront.
2733
+ */
2734
+ interface BoundsSnapshot {
2735
+ x: number;
2736
+ y: number;
2737
+ width: number;
2738
+ height: number;
2739
+ }
2740
+ interface WipeFilterConfig {
2741
+ kind: "wipe";
2742
+ angle: number;
2743
+ invert: boolean;
2744
+ bounds: BoundsSnapshot;
2745
+ }
2746
+ interface IrisFilterConfig {
2747
+ kind: "iris";
2748
+ /** If true the image is seen around the circle (a hole in the mask) instead of through it. */
2749
+ outside?: boolean;
2750
+ originX: number;
2751
+ originY: number;
2752
+ aspect: number;
2753
+ invert: boolean;
2754
+ bounds: BoundsSnapshot;
2755
+ }
2756
+ interface SplitFilterConfig {
2757
+ kind: "split";
2758
+ /** Absent in older saves, which reveal from the edges inwards. */
2759
+ direction?: "inward" | "outward";
2760
+ orientation: "horizontal" | "vertical";
2761
+ origin: number;
2762
+ invert: boolean;
2763
+ bounds: BoundsSnapshot;
2764
+ }
2765
+ type FilterTransitionConfig = WipeFilterConfig | IrisFilterConfig | SplitFilterConfig;
2766
+ /**
2767
+ * Builds the `apply`/`cleanup` pair that drives a mask-based transition (wipe/iris/split) on the
2768
+ * component registered under `alias`, from nothing but plain, serializable data. It's the single place
2769
+ * both the live transition and a ticker reconstructed after a save/restore (or a step back) get their
2770
+ * callbacks from - which is what lets the animation resume instead of being lost. The mask `Graphics` is
2771
+ * lazily recreated on the first `apply()` call, so a restored ticker needs nothing else.
2772
+ */
2773
+ declare function createFilterTransitionApplier(alias: string, config: FilterTransitionConfig): {
2774
+ apply(value: number): void;
2775
+ cleanup(): void;
2776
+ };
2777
+
2693
2778
  /**
2694
2779
  * An empty interface that can be augmented via `declare module '@drincs/pixi-vn/canvas'`
2695
2780
  * to constrain the set of valid asset aliases to a known union of string literals.
@@ -2773,4 +2858,4 @@ declare const UPDATE_PRIORITY: typeof _drincs_pixi_vn_pixi_js.UPDATE_PRIORITY;
2773
2858
 
2774
2859
  declare const canvas: CanvasManagerInterface;
2775
2860
 
2776
- export { AdditionalPositionsExtension, AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetAliasIdType, type AssetMemory, Assets, type BlurInOutProps, type BlurPulseEffectProps, type BounceEffectProps, type BundleIdType, type CanvasBaseInterface, CanvasBaseItem, CanvasBaseItemMemory, CanvasGameState, type CanvasHtmlLayersInterface, type CanvasLayersInterface, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, type ChromaticAberrationEffectProps, Color, type ColorType, Container, ContainerChild$1 as ContainerChild, ContainerMemory, type ContainerOptions, type DecayingEffectProps, type DesaturateEffectProps, type FilterFadeTransitionProps, type FlashInOutProps, type GlitchEffectProps, type GlitchInOutProps, type GlowPulseEffectProps, type HopEffectProps, type HslColorType, type HslaColorType, type HsvColorType, type HsvaColorType, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type IrisInOutProps, type Layer, ListenerExtension, ListenerExtensionMemory, type MaskTransitionProps, type MoveInOutProps, type NodEffectProps, type NoiseDissolveInOutProps, OnEventsHandlers, type PinchInOutProps, type PixelateInOutProps, type PixivnAssetAliasIds, type PixivnBundleIds, type PulseEffectProps, type PunchEffectProps, type PushInOutProps, type RadialBlurEffectProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, type RgbColorType, type RgbaColorType, type RippleInOutProps, type ShakeEffectProps, type ShockwaveEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, type SplitInOutProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, type SwayEffectProps, Text, type TextMemory, type TextOptions, TextStyle, Texture, type TvInOutProps, type TwistInOutProps, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type VignettePulseEffectProps, type WarpInOutProps, type WiggleEffectProps, type WipeInOutProps, type ZoomInOutProps, addImage, addImageCointainer, addVideo, canvas, canvasComponentDecorator, drawCanvasErrorHandler, effects, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, transitions, zoomIn, zoomOut };
2861
+ export { AdditionalPositionsExtension, AdditionalPositionsExtensionProps, type AnchorExtension, type AnchorExtensionProps, type AssetAliasIdType, type AssetMemory, Assets, type BlurInOutProps, type BlurPulseEffectProps, type BounceEffectProps, type BundleIdType, type CanvasBaseInterface, CanvasBaseItem, CanvasBaseItemMemory, CanvasGameState, type CanvasHtmlLayersInterface, type CanvasLayersInterface, type CanvasManagerInterface, CanvasManagerStatic, CanvasPropertyUtility, type ChromaticAberrationEffectProps, Color, type ColorType, Container, ContainerChild$1 as ContainerChild, ContainerMemory, type ContainerOptions, type DecayingEffectProps, type DesaturateEffectProps, type FilterFadeTransitionProps, type FilterTransitionConfig, type FlashInOutProps, type GlitchEffectProps, type GlitchInOutProps, type GlowPulseEffectProps, type HopEffectProps, type HslColorType, type HslaColorType, type HsvColorType, type HsvaColorType, ImageContainer, type ImageContainerMemory, type ImageContainerOptions, ImageSprite, type ImageSpriteMemory, type ImageSpriteOptions, type IrisInOutProps, type Layer, ListenerExtension, ListenerExtensionMemory, type MaskTransitionProps, type MoveInOutProps, type NodEffectProps, type NoiseDissolveInOutProps, type OldComponentOutProps, OnEventsHandlers, type PinchInOutProps, type PixelateInOutProps, type PixivnAssetAliasIds, type PixivnBundleIds, type PulseEffectProps, type PunchEffectProps, type PushInOutProps, type RadialBlurEffectProps, Rectangle, RegisteredCanvasComponents, RegisteredEvents, type RgbColorType, type RgbaColorType, type RippleInOutProps, type ShakeEffectProps, type ShockwaveEffectProps, type ShowWithDissolveTransitionProps, type ShowWithFadeTransitionProps, type SplitInOutProps, Sprite, type SpriteBaseMemory, type SpriteMemory, type SpriteOptions, type SwayEffectProps, Text, type TextMemory, type TextOptions, TextStyle, Texture, type TvInOutProps, type TwistInOutProps, UPDATE_PRIORITY, VideoSprite, type VideoSpriteMemory, type VideoSpriteOptions, type VignettePulseEffectProps, type WarpInOutProps, type WiggleEffectProps, type WipeInOutProps, type ZoomInOutProps, addImage, addImageCointainer, addVideo, canvas, canvasComponentDecorator, createFilterTransitionApplier, drawCanvasErrorHandler, effects, eventDecorator, getTexture, moveIn, moveOut, pushIn, pushOut, removeWithDissolve, removeWithFade, setMemoryContainer, shakeEffect, showImage, showImageContainer, showText, showVideo, showWithDissolve, showWithFade, transitions, zoomIn, zoomOut };