starling-framework
Version:
A fast, productive library for 2D cross-platform development.
732 lines • 173 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AssetManager | starling-framework</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">starling-framework</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">starling</a>
</li>
<li>
<a href="../modules/starling.utils.html">utils</a>
</li>
<li>
<a href="starling.utils.assetmanager.html">AssetManager</a>
</li>
</ul>
<h1>Class AssetManager</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The AssetManager handles loading and accessing a variety of asset types. You can
add assets directly (via the 'add...' methods) or asynchronously via a queue. This allows
you to deal with assets in a unified way, no matter if they are loaded from a file,
directory, URL, or from an embedded object.</p>
</div>
<p>The class can deal with the following media types:
<ul>
<li>Textures, either from Bitmaps or ATF data</li>
<li>Texture atlases</li>
<li>Bitmap Fonts</li>
<li>Sounds</li>
<li>XML data</li>
<li>JSON data</li>
<li>ByteArrays</li>
</ul>
</p>
<p>For more information on how to add assets from different sources, read the documentation
of the "enqueue()" method.</p>
<p> <strong>Context Loss</strong></p>
<p>When the stage3D context is lost (and you have enabled 'Starling.handleLostContext'),
the AssetManager will automatically restore all loaded textures. To save memory, it will
get them from their original sources. Since this is done asynchronously, your images might
not reappear all at once, but during a timeframe of several seconds. If you want, you can
pause your game during that time; the AssetManager dispatches an "Event.TEXTURES_RESTORED"
event when all textures have been restored.</p>
<p> <strong>Error handling</strong></p>
<p>Loading of some assets may fail while the queue is being processed. In that case, the
AssetManager will dispatch events of type "IO_ERROR", "SECURITY_ERROR" or "PARSE_ERROR".
You can listen to those events and handle the errors manually (e.g., you could enqueue
them once again and retry, or provide placeholder textures). Queue processing will
continue even when those events are dispatched.</p>
<p> <strong>Using variable texture formats</strong></p>
<p>When you enqueue a texture, its properties for "format", "scale", "mipMapping", and
"repeat" will reflect the settings of the AssetManager at the time they were enqueued.
This means that you can enqueue a bunch of textures, then change the settings and enqueue
some more. Like this:</p>
<listing>
appDir:File = File.applicationDirectory;
assets:AssetManager = new AssetManager();
assets.textureFormat = Context3DTextureFormat.BGRA;
assets.enqueue(appDir.resolvePath("textures/32bit"));
assets.textureFormat = Context3DTextureFormat.BGRA_PACKED;
assets.enqueue(appDir.resolvePath("textures/16bit"));
assets.loadQueue(...);</listing>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">AssetManager</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.utils.assetmanager.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#checkpolicyfile" class="tsd-kind-icon">check<wbr>Policy<wbr>File</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#forcepottextures" class="tsd-kind-icon">force<wbr>Pot<wbr>Textures</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#isloading" class="tsd-kind-icon">is<wbr>Loading</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#keepatlasxmls" class="tsd-kind-icon">keep<wbr>Atlas<wbr>Xmls</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#keepfontxmls" class="tsd-kind-icon">keep<wbr>Font<wbr>Xmls</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#numconnections" class="tsd-kind-icon">num<wbr>Connections</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#numqueuedassets" class="tsd-kind-icon">num<wbr>Queued<wbr>Assets</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#queue" class="tsd-kind-icon">queue</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#registerbitmapfontswithfontface" class="tsd-kind-icon">register<wbr>Bitmap<wbr>Fonts<wbr>With<wbr>Font<wbr>Face</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#scalefactor" class="tsd-kind-icon">scale<wbr>Factor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#textureformat" class="tsd-kind-icon">texture<wbr>Format</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#usemipmaps" class="tsd-kind-icon">use<wbr>Mip<wbr>Maps</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#verbose" class="tsd-kind-icon">verbose</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addbitmapfont" class="tsd-kind-icon">add<wbr>Bitmap<wbr>Font</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addbytearray" class="tsd-kind-icon">add<wbr>Byte<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addobject" class="tsd-kind-icon">add<wbr>Object</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addsound" class="tsd-kind-icon">add<wbr>Sound</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addtexture" class="tsd-kind-icon">add<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addtextureatlas" class="tsd-kind-icon">add<wbr>Texture<wbr>Atlas</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#addxml" class="tsd-kind-icon">add<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#dispatcheventwith" class="tsd-kind-icon">dispatch<wbr>Event<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#enqueue" class="tsd-kind-icon">enqueue</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#enqueuewithname" class="tsd-kind-icon">enqueue<wbr>With<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getbitmapfont" class="tsd-kind-icon">get<wbr>Bitmap<wbr>Font</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getbitmapfontnames" class="tsd-kind-icon">get<wbr>Bitmap<wbr>Font<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getbytearray" class="tsd-kind-icon">get<wbr>Byte<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getbytearraynames" class="tsd-kind-icon">get<wbr>Byte<wbr>Array<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getobject" class="tsd-kind-icon">get<wbr>Object</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getobjectnames" class="tsd-kind-icon">get<wbr>Object<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getsound" class="tsd-kind-icon">get<wbr>Sound</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getsoundnames" class="tsd-kind-icon">get<wbr>Sound<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#gettexture" class="tsd-kind-icon">get<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#gettextureatlas" class="tsd-kind-icon">get<wbr>Texture<wbr>Atlas</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#gettextureatlasnames" class="tsd-kind-icon">get<wbr>Texture<wbr>Atlas<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#gettexturenames" class="tsd-kind-icon">get<wbr>Texture<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#gettextures" class="tsd-kind-icon">get<wbr>Textures</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getxml" class="tsd-kind-icon">get<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#getxmlnames" class="tsd-kind-icon">get<wbr>Xml<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_checkpolicyfile" class="tsd-kind-icon">get_<wbr>check<wbr>Policy<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_forcepottextures" class="tsd-kind-icon">get_<wbr>force<wbr>Pot<wbr>Textures</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_isloading" class="tsd-kind-icon">get_<wbr>is<wbr>Loading</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_keepatlasxmls" class="tsd-kind-icon">get_<wbr>keep<wbr>Atlas<wbr>Xmls</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_keepfontxmls" class="tsd-kind-icon">get_<wbr>keep<wbr>Font<wbr>Xmls</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_numconnections" class="tsd-kind-icon">get_<wbr>num<wbr>Connections</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_numqueuedassets" class="tsd-kind-icon">get_<wbr>num<wbr>Queued<wbr>Assets</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_queue" class="tsd-kind-icon">get_<wbr>queue</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#get_registerbitmapfontswithfontface" class="tsd-kind-icon">get_<wbr>register<wbr>Bitmap<wbr>Fonts<wbr>With<wbr>Font<wbr>Face</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_scalefactor" class="tsd-kind-icon">get_<wbr>scale<wbr>Factor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_textureformat" class="tsd-kind-icon">get_<wbr>texture<wbr>Format</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_usemipmaps" class="tsd-kind-icon">get_<wbr>use<wbr>Mip<wbr>Maps</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#get_verbose" class="tsd-kind-icon">get_<wbr>verbose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#loadqueue" class="tsd-kind-icon">load<wbr>Queue</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#playsound" class="tsd-kind-icon">play<wbr>Sound</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#purge" class="tsd-kind-icon">purge</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#purgequeue" class="tsd-kind-icon">purge<wbr>Queue</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removebitmapfont" class="tsd-kind-icon">remove<wbr>Bitmap<wbr>Font</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removebytearray" class="tsd-kind-icon">remove<wbr>Byte<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.utils.assetmanager.html#removeeventlisteners" class="tsd-kind-icon">remove<wbr>Event<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removeobject" class="tsd-kind-icon">remove<wbr>Object</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removesound" class="tsd-kind-icon">remove<wbr>Sound</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removetexture" class="tsd-kind-icon">remove<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removetextureatlas" class="tsd-kind-icon">remove<wbr>Texture<wbr>Atlas</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#removexml" class="tsd-kind-icon">remove<wbr>Xml</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_checkpolicyfile" class="tsd-kind-icon">set_<wbr>check<wbr>Policy<wbr>File</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_forcepottextures" class="tsd-kind-icon">set_<wbr>force<wbr>Pot<wbr>Textures</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_keepatlasxmls" class="tsd-kind-icon">set_<wbr>keep<wbr>Atlas<wbr>Xmls</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_keepfontxmls" class="tsd-kind-icon">set_<wbr>keep<wbr>Font<wbr>Xmls</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_numconnections" class="tsd-kind-icon">set_<wbr>num<wbr>Connections</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.utils.assetmanager.html#set_registerbitmapfontswithfontface" class="tsd-kind-icon">set_<wbr>register<wbr>Bitmap<wbr>Fonts<wbr>With<wbr>Font<wbr>Face</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_scalefactor" class="tsd-kind-icon">set_<wbr>scale<wbr>Factor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_textureformat" class="tsd-kind-icon">set_<wbr>texture<wbr>Format</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_usemipmaps" class="tsd-kind-icon">set_<wbr>use<wbr>Mip<wbr>Maps</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.utils.assetmanager.html#set_verbose" class="tsd-kind-icon">set_<wbr>verbose</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Asset<wbr>Manager<span class="tsd-signature-symbol">(</span>scaleFactor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, useMipmaps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.utils.assetmanager.html" class="tsd-signature-type">AssetManager</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L98">lib/starling/utils/AssetManager.d.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a new AssetManager. The 'scaleFactor' and 'useMipmaps' parameters define
how enqueued bitmaps will be converted to textures.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scaleFactor: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useMipmaps: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.utils.assetmanager.html" class="tsd-signature-type">AssetManager</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="checkpolicyfile" class="tsd-anchor"></a>
<h3>check<wbr>Policy<wbr>File</h3>
<div class="tsd-signature tsd-kind-icon">check<wbr>Policy<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L347">lib/starling/utils/AssetManager.d.ts:347</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies whether a check should be made for the existence of a URL policy file before
loading an object from a remote server. More information about this topic can be found
in the 'flash.system.LoaderContext' documentation. @default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="forcepottextures" class="tsd-anchor"></a>
<h3>force<wbr>Pot<wbr>Textures</h3>
<div class="tsd-signature tsd-kind-icon">force<wbr>Pot<wbr>Textures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L340">lib/starling/utils/AssetManager.d.ts:340</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the underlying Stage3D textures should be created as the power-of-two based
<code>Texture</code> class instead of the more memory efficient <code>RectangleTexture</code>.
@default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="isloading" class="tsd-anchor"></a>
<h3>is<wbr>Loading</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Loading<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L315">lib/starling/utils/AssetManager.d.ts:315</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if a queue is currently being loaded.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="keepatlasxmls" class="tsd-anchor"></a>
<h3>keep<wbr>Atlas<wbr>Xmls</h3>
<div class="tsd-signature tsd-kind-icon">keep<wbr>Atlas<wbr>Xmls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L354">lib/starling/utils/AssetManager.d.ts:354</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if atlas XML data should be stored for access via the 'getXml' method.
If true, you can access an XML under the same name as the atlas.
If false, XMLs will be disposed when the atlas was created. @default false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="keepfontxmls" class="tsd-anchor"></a>
<h3>keep<wbr>Font<wbr>Xmls</h3>
<div class="tsd-signature tsd-kind-icon">keep<wbr>Font<wbr>Xmls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L361">lib/starling/utils/AssetManager.d.ts:361</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if bitmap font XML data should be stored for access via the 'getXml' method.
If true, you can access an XML under the same name as the bitmap font.
If false, XMLs will be disposed when the font was created. @default false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="numconnections" class="tsd-anchor"></a>
<h3>num<wbr>Connections</h3>
<div class="tsd-signature tsd-kind-icon">num<wbr>Connections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L367">lib/starling/utils/AssetManager.d.ts:367</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The maximum number of parallel connections that are spawned when loading the queue.
More connections can reduce loading times, but require more memory. @default 3.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="numqueuedassets" class="tsd-anchor"></a>
<h3>num<wbr>Queued<wbr>Assets</h3>
<div class="tsd-signature tsd-kind-icon">num<wbr>Queued<wbr>Assets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L305">lib/starling/utils/AssetManager.d.ts:305</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the number of raw assets that have been enqueued, but not yet loaded.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a name="queue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> queue</h3>
<div class="tsd-signature tsd-kind-icon">queue<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L301">lib/starling/utils/AssetManager.d.ts:301</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The queue contains one 'Object' for each enqueued asset. Each object has 'asset'
and 'name' properties, pointing to the raw asset and its name, respectively.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="registerbitmapfontswithfontface" class="tsd-anchor"></a>
<h3>register<wbr>Bitmap<wbr>Fonts<wbr>With<wbr>Font<wbr>Face</h3>
<div class="tsd-signature tsd-kind-icon">register<wbr>Bitmap<wbr>Fonts<wbr>With<wbr>Font<wbr>Face<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L374">lib/starling/utils/AssetManager.d.ts:374</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if bitmap fonts should be registered with their "face" attribute from the
font XML file. Per default, they are registered with the name of the texture file.
@default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="scalefactor" class="tsd-anchor"></a>
<h3>scale<wbr>Factor</h3>
<div class="tsd-signature tsd-kind-icon">scale<wbr>Factor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L327">lib/starling/utils/AssetManager.d.ts:327</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Textures that are created from Bitmaps or ATF files will have the scale factor
assigned here. @default 1</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="textureformat" class="tsd-anchor"></a>
<h3>texture<wbr>Format</h3>
<div class="tsd-signature tsd-kind-icon">texture<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context3DTextureFormat</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L333">lib/starling/utils/AssetManager.d.ts:333</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Textures that are created from Bitmaps will be uploaded to the GPU with the
<code>Context3DTextureFormat</code> assigned to this property. @default "bgra"</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="usemipmaps" class="tsd-anchor"></a>
<h3>use<wbr>Mip<wbr>Maps</h3>
<div class="tsd-signature tsd-kind-icon">use<wbr>Mip<wbr>Maps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L321">lib/starling/utils/AssetManager.d.ts:321</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>For bitmap textures, this flag indicates if mip maps should be generated when they
are loaded; for ATF textures, it indicates if mip maps are valid and should be
used. @default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="verbose" class="tsd-anchor"></a>
<h3>verbose</h3>
<div class="tsd-signature tsd-kind-icon">verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L310">lib/starling/utils/AssetManager.d.ts:310</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When activated, the class will trace information about added/enqueued assets.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>true</p>
</dd>
</dl>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addbitmapfont" class="tsd-anchor"></a>
<h3>add<wbr>Bitmap<wbr>Font</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Bitmap<wbr>Font<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, font<span class="tsd-signature-symbol">: </span><a href="starling.text.bitmapfont.html" class="tsd-signature-type">BitmapFont</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L210">lib/starling/utils/AssetManager.d.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a bitmap font under a certain name. It will be available right away.
If the name was already taken, the existing font will be disposed and replaced
by the new one.</p>
</div>
<p>Note that the font is <strong>not</strong> registered at the TextField class.
This only happens when a bitmap font is loaded via the asset queue.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>font: <a href="starling.text.bitmapfont.html" class="tsd-signature-type">BitmapFont</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addbytearray" class="tsd-anchor"></a>
<h3>add<wbr>Byte<wbr>Array</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Byte<wbr>Array<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, byteArray<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ByteArray</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L201">lib/starling/utils/AssetManager.d.ts:201</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a byte array under a certain name. It will be available right away.
If the name was already taken, the existing byte array will be cleared and replaced
by the new one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>byteArray: <span class="tsd-signature-type">ByteArray</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="addeventlistener" class="tsd-anchor"></a>
<h3>add<wbr>Event<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EventDispatcher.d.ts#L32">lib/starling/events/EventDispatcher.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers an event listener at a certain object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addobject" class="tsd-anchor"></a>
<h3>add<wbr>Object</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Object<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L196">lib/starling/utils/AssetManager.d.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register an arbitrary object under a certain name. It will be available right away.
If the name was already taken, the existing object will be replaced by the new one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>object: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addsound" class="tsd-anchor"></a>
<h3>add<wbr>Sound</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Sound<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sound<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Sound</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L187">lib/starling/utils/AssetManager.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a sound under a certain name. It will be available right away.
If the name was already taken, the existing sound will be replaced by the new one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>sound: <span class="tsd-signature-type">Sound</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addtexture" class="tsd-anchor"></a>
<h3>add<wbr>Texture</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Texture<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, texture<span class="tsd-signature-symbol">: </span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L178">lib/starling/utils/AssetManager.d.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a texture under a certain name. It will be available right away.
If the name was already taken, the existing texture will be disposed and replaced
by the new one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>texture: <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addtextureatlas" class="tsd-anchor"></a>
<h3>add<wbr>Texture<wbr>Atlas</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Texture<wbr>Atlas<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, atlas<span class="tsd-signature-symbol">: </span><a href="starling.textures.textureatlas.html" class="tsd-signature-type">TextureAtlas</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/utils/AssetManager.d.ts#L183">lib/starling/utils/AssetManager.d.ts:183</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a texture atlas under a certain name. It will be available right away.
If the name was already taken, the existing atlas will be disposed and replaced
by the new one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>atlas: <a href="starling.textures.textureatlas.html" class="tsd-signature-type">TextureAtlas</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addxml" class="tsd-anchor"></a>
<h3>add<wbr>Xml</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Xml<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, xml<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/sta