UNPKG

starling-framework

Version:

A fast, productive library for 2D cross-platform development.

423 lines 23.7 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>AssetType | 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.assets.html">assets</a> </li> <li> <a href="starling.assets.assettype.html">AssetType</a> </li> </ul> <h1>Class AssetType</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>An enumeration class containing all the asset types supported by the AssetManager.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">AssetType</span> </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>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#asset_manager" class="tsd-kind-icon">ASSET_<wbr>MANAGER</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#bitmap_font" class="tsd-kind-icon">BITMAP_<wbr>FONT</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#byte_array" class="tsd-kind-icon">BYTE_<wbr>ARRAY</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#object" class="tsd-kind-icon">OBJECT</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#sound" class="tsd-kind-icon">SOUND</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#texture" class="tsd-kind-icon">TEXTURE</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#texture_atlas" class="tsd-kind-icon">TEXTURE_<wbr>ATLAS</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.assets.assettype.html#xml_document" class="tsd-kind-icon">XML_<wbr>DOCUMENT</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-static tsd-is-external"><a href="starling.assets.assettype.html#fromasset" class="tsd-kind-icon">from<wbr>Asset</a></li> </ul> </section> </div> </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-static tsd-is-external"> <a name="asset_manager" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> ASSET_<wbr>MANAGER</h3> <div class="tsd-signature tsd-kind-icon">ASSET_<wbr>MANAGER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L23">lib/starling/assets/AssetType.d.ts:23</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="bitmap_font" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> BITMAP_<wbr>FONT</h3> <div class="tsd-signature tsd-kind-icon">BITMAP_<wbr>FONT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L22">lib/starling/assets/AssetType.d.ts:22</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="byte_array" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> BYTE_<wbr>ARRAY</h3> <div class="tsd-signature tsd-kind-icon">BYTE_<wbr>ARRAY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L21">lib/starling/assets/AssetType.d.ts:21</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="object" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> OBJECT</h3> <div class="tsd-signature tsd-kind-icon">OBJECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L20">lib/starling/assets/AssetType.d.ts:20</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="sound" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SOUND</h3> <div class="tsd-signature tsd-kind-icon">SOUND<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L18">lib/starling/assets/AssetType.d.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="texture" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> TEXTURE</h3> <div class="tsd-signature tsd-kind-icon">TEXTURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L16">lib/starling/assets/AssetType.d.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="texture_atlas" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> TEXTURE_<wbr>ATLAS</h3> <div class="tsd-signature tsd-kind-icon">TEXTURE_<wbr>ATLAS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L17">lib/starling/assets/AssetType.d.ts:17</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="xml_document" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> XML_<wbr>DOCUMENT</h3> <div class="tsd-signature tsd-kind-icon">XML_<wbr>DOCUMENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/assets/AssetType.d.ts#L19">lib/starling/assets/AssetType.d.ts:19</a></li> </ul> </aside> </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-static tsd-is-external"> <a name="fromasset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Asset</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"> <li class="tsd-signature tsd-kind-icon">from<wbr>Asset<span class="tsd-signature-symbol">(</span>asset<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">string</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/assets/AssetType.d.ts#L26">lib/starling/assets/AssetType.d.ts:26</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Figures out the asset type string from the type of the given instance.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>asset: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="label tsd-is-external"> <span>Externals</span> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.animation.html">starling.animation</a> </li> <li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.assets.html">starling.assets</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.core.html">starling.core</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.display.html">starling.display</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.errors.html">starling.errors</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.events.html">starling.events</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.extensions.html">starling.extensions</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.filters.html">starling.filters</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.geom.html">starling.geom</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.rendering.html">starling.rendering</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.styles.html">starling.styles</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.text.html">starling.text</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.textures.html">starling.textures</a> </li> <li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external"> <a href="../modules/starling.utils.html">starling.utils</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assetfactory.html" class="tsd-kind-icon">Asset<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assetfactoryhelper.html" class="tsd-kind-icon">Asset<wbr>Factory<wbr>Helper</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assetmanager.html" class="tsd-kind-icon">Asset<wbr>Manager</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assetpostprocessor.html" class="tsd-kind-icon">Asset<wbr>Post<wbr>Processor</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assetreference.html" class="tsd-kind-icon">Asset<wbr>Reference</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.assettype.html" class="tsd-kind-icon">Asset<wbr>Type</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#asset_manager" class="tsd-kind-icon">ASSET_<wbr>MANAGER</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#bitmap_font" class="tsd-kind-icon">BITMAP_<wbr>FONT</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#byte_array" class="tsd-kind-icon">BYTE_<wbr>ARRAY</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#object" class="tsd-kind-icon">OBJECT</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#sound" class="tsd-kind-icon">SOUND</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#texture" class="tsd-kind-icon">TEXTURE</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#texture_atlas" class="tsd-kind-icon">TEXTURE_<wbr>ATLAS</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#xml_document" class="tsd-kind-icon">XML_<wbr>DOCUMENT</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"> <a href="starling.assets.assettype.html#fromasset" class="tsd-kind-icon">from<wbr>Asset</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.atftexturefactory.html" class="tsd-kind-icon">Atf<wbr>Texture<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.bitmaptexturefactory.html" class="tsd-kind-icon">Bitmap<wbr>Texture<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.bytearrayfactory.html" class="tsd-kind-icon">Byte<wbr>Array<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.dataloader.html" class="tsd-kind-icon">Data<wbr>Loader</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.jsonfactory.html" class="tsd-kind-icon">Json<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.soundfactory.html" class="tsd-kind-icon">Sound<wbr>Factory</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.assets.xmlfactory.html" class="tsd-kind-icon">Xml<wbr>Factory</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>