irisReveal
irisReveal(
opts?):SceneTransition
Defined in: renderer/src/transitions/irisReveal.ts:37
Reveal the destination scene through an expanding circular mask. The incoming scene’s container is masked by a circle that grows from radius 0 to a radius covering the canvas, so the new scene “blooms” over the previous one from the chosen center point. The previous scene stays visible outside the iris until the circle fully covers it — no color overlay, no mid-point swap.
Pairs with iris() (the symmetric close-then-open variant): pick
iris for retro Zelda-style dip-to-black handoffs, irisReveal for
a one-way reveal where the new scene grows over the old.
On pop the destination scene is brought to the front of the scene
stack so the same mechanic applies — without it the outgoing scene
would render over the masked destination.
Parameters
Section titled “Parameters”IrisRevealOptions = {}
Returns
Section titled “Returns”SceneTransition