springroll.easeljs.TextureAtlasTask Class

Extends springroll.Task
Defined in: springroll.easeljs.TextureAtlasTask:12
Module: EaselJS Display

Internal class for loading a texture atlas, creating a 'springroll.easeljs.TextureAtlas'.

Constructor

springroll.easeljs.TextureAtlasTask

(
  • asset
)
private

Defined in springroll.easeljs.TextureAtlasTask:12

Parameters:

  • asset Object

    The data properties

    • type String

      The asset type must be "easeljs".

    • atlas String

      The TextureAtlas source data

    • [cache=false] Boolean optional

      If we should cache the result

    • [image] String optional

      The atlas image path

    • [color] String optional

      The color image path, if not using image property

    • [alpha] String optional

      The alpha image path, if not using image property

    • [id] String optional

      Id of asset

    • [complete] Function optional

      The event to call when done

    • [sizes=null] Object optional

      Define if certain sizes are not supported

destroy

()

Inherited from springroll.Task: destroy:202

Destroy this and discard

filter

(
  • url
)
protected

Inherited from springroll.Task: filter:151

Add the sizing to each filter

Parameters:

  • url String
    The url to filter

load

(
  • source
  • [options]
)
protected

Inherited from springroll.Task: load:176

Pass-through to the Application load method

Parameters:

loadAtlas

(
  • assets
  • done
)

Defined in loadAtlas:87

Load a texture atlas from the properties

Parameters:

  • assets Object

    The assets object to load

  • done Function

    Callback when complete, returns new TextureAtlas

simpleLoad

(
  • url
  • complete
  • [progress]
  • [data]
)
protected

Inherited from springroll.Task: simpleLoad:188

Pass-through to the Application Loader.load

Parameters:

  • url String
    Path to file to load
  • complete Function
    The callback
  • [progress] Function optional
    The load progress
  • [data] Object optional
    Additiona data

start

(
  • callback
)

Inherited from springroll.Task but overwritten in start:76

Start the task

Parameters:

  • callback Function

    Callback when finished

test

(
  • asset
)
Boolean
static

Defined in test:61

Test if we should run this task

Parameters:

  • asset Object

    The asset to check

Returns:

Boolean:

If the asset is compatible with this asset

alpha

String

Defined in alpha:51

The atlas alpha source path

atlas

String

Defined in atlas:33

The TextureAtlas data source path

cache

Boolean

Inherited from springroll.Task: cache:46

If we should cache the load and use later

Default: false

color

String

Defined in color:45

The atlas color source path

complete

Function

Inherited from springroll.Task: complete:37

The user call to fire when completed, returns the arguments result, original, and additionalAssets

Default: null

id

String

Inherited from springroll.Task: id:54

The task id

image

String

Defined in image:39

The atlas source path

original

Object

Inherited from springroll.Task: original:66

Reference to the original asset data

status

Int

Inherited from springroll.Task: status:30

The current status of the task (waiting, running, etc)

Default: 0

type

String

Inherited from springroll.Task: type:60

The task type for display filter