API Documentation

for 0.0.1
Show:

ImageSequenceTexture Class

The ImageSequenceTexture represents a special kind of 2D Texture that is built from a sequence of pictures that you can play at a given rate and with a given play mode.

Methods

constructor

(
  • context
)

Parameters:

  • context Object

    The Mobilizing Context.

getCurrentTexture

() Texture

Get the current Image Sequence frame Texture.

Returns:

Texture:

the texture

load

(
  • urlbase
  • min
  • max
)

Load an image sequence from a wild card URL (the * sign will be replaced by an index starting from min and ending at max).

Parameters:

  • urlbase String

    wild card base URL. This can be a relative or absolute URL, and can be local or online, depending on your Browser cross domain policies.

  • min Integer

    starting index.

  • max Integer

    ending index.

loop

(
  • count
)

Loop the image sequence for a given number of iterations (once play() is called).

Parameters:

  • count Number

    : -1 means infinity.

pause

()

pause the Image Sequence.

play

()

play the Image Sequence.

setEnterFrame

(
  • frame
)

Set the starting frame of the current loaded sequence.

Parameters:

  • frame Integer

    starting frame.

setMode

(
  • mode
)

Set the sequence playing mode.

Parameters:

  • mode String

    playing mode : "FORWARD", BACKWARD", "PINGPONG", "RANDOM".

setOutFrame

(
  • frame
)

Set the ending frame of the current loaded sequence.

Parameters:

  • frame Integer

    ending frame.

stop

()

stop the Image Sequence. The image frame is resetted.

update

()

update the Image sequence. You have to call this once per frame for the Image sequence Texture to update and run its own logic.