Determines if textures loaded from URLs are uploaded asynchronously or not.

Note: depending on the version of AIR and the platform it is running on, textures may be uploaded synchronously, even when this property is true.

In the following example, the texture will be uploaded synchronously:

loader.asyncTextureUpload = false;

The default value is true.

Determines if a loaded bitmap may be converted to a texture immediately after loading. If true, the loaded bitmap will be saved until this property is set to false, and only then it will be used to create the texture.

This property is intended to be used while a parent container, such as a List, is scrolling in order to keep scrolling as smooth as possible. Creating textures is expensive and performance can be affected by it. Set this property to true when the List dispatches FeathersEventType.SCROLL_START and set back to false when the List dispatches FeathersEventType.SCROLL_COMPLETE. You may also need to set to false if the isScrolling property of the List is true before you listen to those events.

In the following example, the image loader's texture creation is delayed:

loader.delayTextureCreation = true;

The default value is false.

See also

The default IStyleProvider for all ImageLoader components.

The default value is null.

See also

The internal starling.display.Image child.

Indicates if the source has completed loading, if the source is a URL. Always returns true when the source is a texture.

In the following example, we check if the image loader's source has finished loading:

if( loader.isLoaded )
{
    //do something
}

The internal flash.display.Loader used to load textures from URLs.

If the texture is loaded using flash.display.Loader, a custom flash.system.LoaderContext may optionally be provided.

In the following example, a custom loader context is provided:

var context:LoaderContext = new LoaderContext();
context.loadPolicyFile = true;
loader.loaderContext = context;

See also

The original height of the source content, in pixels. This value will be 0 until the source content finishes loading. If the source is a texture, this value will be 0 until the ImageLoader validates.

The original width of the source content, in pixels. This value will be 0 until the source content finishes loading. If the source is a texture, this value will be 0 until the ImageLoader validates.

The scale factor value to pass to Texture.fromBitmapData() when creating a texture loaded from a URL.

In the following example, the image loader's scale factor is customized:

loader.scaleFactor = 2;

The default value is 1.

The Texture to display, or a URL pointing to an image file. Supported image files include ATF format and any bitmap formats that may be loaded by flash.display.Loader, including JPG, GIF, and PNG.

In the following example, the image loader's source is set to a texture:

loader.source = Texture.fromBitmap( bitmap );

In the following example, the image loader's source is set to the URL of a PNG image:

loader.source = "http://example.com/example.png";

The default value is null.

See also

The style that is used to render the loader's image.

In the following example, the loader uses a custom style:

loader.style = new CustomMeshStyle();

The default value is null.

An optional cache for textures.

In the following example, a cache is provided for textures:

var cache:TextureCache = new TextureCache(30);
loader1.textureCache = cache;
loader2.textureCache = cache;

Warning: the textures in the cache will not be disposed automatically. When the cache is no longer needed (such as when the ImageLoader components have all been disposed), you must call the dispose() method on the TextureCache. Failing to do so will result in a serious memory leak.

The default value is null.

The texture format to use when creating a texture loaded from a URL.

In the following example, the image loader's texture format is set to a custom value:

loader.textureFormat = Context3DTextureFormat.BGRA_PACKED;

The default value is flash.display3d.Context3DTextureFormat.BGRA.

See also

If delayTextureCreation is true and the duration is not Number.POSITIVE_INFINITY, the loader will be added to a queue where the textures are uploaded to the GPU in sequence to avoid significantly affecting performance. Useful for lists where many textures may need to be uploaded during scrolling.

If the duration is Number.POSITIVE_INFINITY, the default value, the texture will not be uploaded until delayTextureCreation is set to false. In this situation, the loader will not be added to the queue, and other loaders with a duration won't be affected.

In the following example, the image loader's texture creation is delayed by half a second:

loader.delayTextureCreation = true;
loader.textureQueueDuration = 0.5;

The default value is Number.POSITIVE_INFINITY.

See also

Scales the texture dimensions during measurement, but does not set the texture's scale factor. Useful for UI that should scale based on screen density or resolution without accounting for contentScaleFactor.

In the following example, the image loader's texture scale is customized:

loader.textureScale = 0.5;

The default value is 1.

The internal flash.net.URLLoader used to load raw data from URLs.

Constructor.

If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself. If the explicitWidth or explicitHeight member variables are set, those value will be used without additional measurement. If one is set, but not the other, the dimension with the explicit value will not be measured, but the other non-explicit dimension will still need measurement.

Calls saveMeasurements() to set up the actualWidth and actualHeight member variables used for layout.

Meant for internal use, and subclasses may override this function with a custom implementation.

Dispatched when the source finishes loading, if the source is a URL. This event is not dispatched when the source is a texture.

The properties of the event object have the following values:

Dispatched if an IO error occurs while loading the source content.

The properties of the event object have the following values:

Dispatched periodically as the source loads, if the source is a URL. This event is not dispatched when the source is a texture.

The properties of the event object have the following values:

Dispatched if a security error occurs while loading the source content.

The properties of the event object have the following values:

The location where the content is aligned vertically (on the y-axis) when its height is larger or smaller than the height of the ImageLoader.

If the scaleContent property is set to true, the verticalAlign property is ignored.

The following example aligns the content to the bottom:

loader.verticalAlign = VerticalAlign.BOTTOM;

Note: The VerticalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.VerticalAlign.TOP.

See also

The tileGrid value to use on the internal starling.display.Image.

In the following example, the image loader's tileGrid is set to a custom value:

loader.tileGrid = Rectangle();

The default value is null.

See also

The texture smoothing value to use on the internal starling.display.Image.

In the following example, the image loader's smoothing is set to a custom value:

loader.textureSmoothing = TextureSmoothing.NONE;

The default value is starling.textures.TextureSmoothing.BILINEAR.

See also

Determines how the texture is scaled if scaleContent and maintainAspectRatio are both set to true. See the starling.utils.ScaleMode class for details about each scaling mode.

If the scaleContent property is set to false, or the maintainAspectRatio property is set to false, the scaleMode property is ignored.

In the following example, the image loader's scale mode is changed:

loader.scaleMode = ScaleMode.NO_BORDER;

The default value is starling.utils.ScaleMode.SHOW_ALL.

See also

Determines if the content will be scaled if the dimensions of the ImageLoader are changed.

In the following example, the image loader's content is not scaled:

loader.scaleContent = false;

The default value is true.

See also

The scale9Grid value to use on the internal starling.display.Image.

If this property is not null, the maintainAspectRatio property will be ignored.

In the following example, the image loader's scale9Grid is set to a custom value:

loader.scale9Grid = Rectangle(2, 3, 7, 12);

The default value is null.

See also

The pixelSnapping value to use on the internal starling.display.Image.

In the following example, the image loader's pixelSnapping is disabled:

loader.pixelSnapping = false;

The default value is true.

See also

The minimum space, in pixels, between the control's left edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning.

In the following example, the image loader's left padding is set to 20 pixels:

loader.paddingLeft = 20;

The default value is 0.

See also

The minimum space, in pixels, between the control's bottom edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning.

In the following example, the image loader's bottom padding is set to 20 pixels:

loader.paddingBottom = 20;

The default value is 0.

See also

The minimum space, in pixels, between the control's right edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning.

In the following example, the image loader's right padding is set to 20 pixels:

loader.paddingRight = 20;

The default value is 0.

See also

The minimum space, in pixels, between the control's top edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning.

In the following example, the image loader's top padding is set to 20 pixels:

loader.paddingTop = 20;

The default value is 0.

See also

Quickly sets all padding properties to the same value. The padding getter always returns the value of paddingTop, but the other padding values may be different.

In the following example, the image loader's padding is set to 20 pixels on all sides:

loader.padding = 20;

The default value is 0.

See also

Determines if the aspect ratio of the texture is maintained when the dimensions of the ImageLoader are changed manually and the new dimensions have a different aspect ratio than the texture.

If the scaleContent property is set to false or if the scale9Grid property is not null, the maintainAspectRatio property is ignored.

In the following example, the image loader's aspect ratio is not maintained:

loader.maintainAspectRatio = false;

The default value is true.

See also

The location where the content is aligned horizontally (on the x-axis) when its width is larger or smaller than the width of the ImageLoader.

If the scaleContent property is set to true, the horizontalAlign property is ignored.

The following example aligns the content to the right:

loader.horizontalAlign = HorizontalAlign.RIGHT;

Note: The HorizontalAlign.JUSTIFY constant is not supported.

The default value is feathers.layout.HorizontalAlign.LEFT.

See also

A texture to display when a URL source cannot be loaded for any reason.

In the following example, the image loader's error texture is customized:

loader.source = "http://example.com/example.png";
loader.errorTexture = texture;

The default value is null.

See also

A texture to display while a URL source is loading.

In the following example, the image loader's loading texture is customized:

loader.source = "http://example.com/example.png";
loader.loadingTexture = texture;

The default value is null.

See also

The tint value to use on the internal starling.display.Image.

In the following example, the image loader's texture color is customized:

loader.color = 0xff00ff;

The default value is 0xffffff.

See also