Class: Iris

rune.transition.Iris(optionsopt)

Closes a circular window over the old image and opens it over the new image.

Constructor

new Iris(optionsopt)

Closes a circular window over the old image and opens it over the new image.
Parameters:
Name Type Attributes Description
options Object <optional>
Effect settings; duration defaults to 600 milliseconds.
Source:

Extends

Members

(nullable) centerX :number

Horizontal center in internal pixels; null centers it.
Type:
  • number
Source:

(nullable) centerY :number

Vertical center in internal pixels; null centers it.
Type:
  • number
Source:

color :string

Color outside the window.
Type:
  • string
Source:

duration :number

Effect duration in milliseconds, excluding scene initialization. Configure before starting an effect; must be finite and greater than zero.
Type:
  • number
Inherited From:
Default Value:
  • 600
Source:

Methods

render(canvas, from, to, progress) → {undefined}

Draws an effect frame. The target is cleared before each call.
Parameters:
Name Type Description
canvas rune.display.Canvas Output canvas.
from rune.display.Canvas Frozen previous image.
to rune.display.Canvas Frozen next image.
progress number Normalized progress from zero to one.
Overrides:
Source:
Returns:
Type
undefined