IrisOptions
Defined in: renderer/src/transitions/iris.ts:6
Properties
Section titled “Properties”center?
Section titled “center?”
optionalcenter?:object
Defined in: renderer/src/transitions/iris.ts:19
Iris center in virtual-space pixels — the same coord system you
use for game logic. Default: virtual-space center. The maximum radius
is the distance from this point to the farthest corner of whatever
the overlay covers (virtual rect by default, full canvas under
coverScreen: true), so the iris always fully covers its target at
the mid-point.
x:
number
y:
number
color?
Section titled “color?”
optionalcolor?:number
Defined in: renderer/src/transitions/iris.ts:10
Fill color visible outside the iris. Default: 0x000000.
coverScreen?
Section titled “coverScreen?”
optionalcoverScreen?:boolean
Defined in: renderer/src/transitions/iris.ts:25
When true, the dip-to-color overlay covers the full canvas
including letterbox / expand bars. When false (default), it covers
only the virtual play area — bars stay visible during the dip.
duration?
Section titled “duration?”
optionalduration?:number
Defined in: renderer/src/transitions/iris.ts:8
Iris duration in ms. Default: 600.