View source

class ImageParser

package away3d.loaders.parsers

extends ParserBase

@:directlyUsed

Available on all platforms

ImageParser provides a "parser" for natively supported image types (jpg, png). While it simply loads bytes into a loader object, it wraps it in a BitmapDataResource so resource management can happen consistently without exception cases.

Static methods

staticsupportsData(data:Dynamic):Bool

Tests whether a data block can be parsed by the parser.

Parameters:

data

The data block to potentially be parsed.

Returns:

Whether or not the given data is supported.

staticsupportsType(extension:String):Bool

Indicates whether or not a given file extension is supported by the parser.

Parameters:

extension

The file extension of a potential file to be parsed.

Returns:

Whether or not the given file type is supported.

Constructor

new()

Creates a new ImageParser object.

Parameters:

uri

The url or id of the data or file to be parsed.

extra

The holder for extra contextual data that the parser might need.

Inherited Variables

Defined by ParserBase

read onlydataFormat:String

The data format of the file data to be parsed. Can be either ParserDataFormat.BINARY or ParserDataFormat.PLAIN_TEXT.

read onlydependencies:Vector<ResourceDependency>

A list of dependencies that need to be loaded and resolved for the object being parsed.

materialMode:UInt

MaterialMode defines, if the Parser should create SinglePass or MultiPass Materials Options: 0 (Default / undefined) - All Parsers will create SinglePassMaterials, but the AWD2.1parser will create Materials as they are defined in the file 1 (Force SinglePass) - All Parsers create SinglePassMaterials 2 (Force MultiPass) - All Parsers will create MultiPassMaterials

read onlyparsingComplete:Bool

parsingFailure:Bool

read onlyparsingPaused:Bool

parsingPaused will be true, if the parser is paused (e.g. it is waiting for dependencys to be loadet and parsed before it will continue)

Inherited Methods

Defined by ParserBase

isBitmapDataValid(bitmapData:BitmapData):Bool

Validates a bitmapData loaded before assigning to a default BitmapMaterial

@:value({ frameLimit : 30 })parseAsync(data:Dynamic, frameLimit:UInt = 30):Void

Parse data (possibly containing bytearry, plain text or BitmapAsset) asynchronously, meaning that the parser will periodically stop parsing so that the AVM may proceed to the next frame.

Parameters:

data

The untyped data object in which the loaded data resides.

frameLimit

number of milliseconds of parsing allowed per frame. The actual time spent on a frame can exceed this number since time-checks can only be performed between logical sections of the parsing procedure.