Pixi’VN
indexNamespacestransitionsFunctions

Function: warpIn()

pixi-vn on GitHub

> warpIn(alias, component?, props?, priority?): Promise<string[] | undefined>

Defined in: src/canvas/functions/canvas-transition.ts:2794

Show a image in the canvas with a warp effect: the image arrives out of radial zoom-blur streaks, like dropping out of hyperspace. See WarpInOutProps. When replacing an existing component, waits for its out animation before starting the entrance.

Parameters

alias

string

The unique alias of the image. You can use this alias to refer to this image

component?

TComponent

The imageUrl, array of imageUrl or the canvas component. If you don't provide the component, then the alias is used as the url.

props?

WarpInOutProps = {}

The properties of the effect

priority?

UPDATE_PRIORITY

The priority of the effect

Returns

Promise<string[] | undefined>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.

On this page