starling-framework

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>TextureAtlas | 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.textures.html">textures</a> </li> <li> <a href="starling.textures.textureatlas.html">TextureAtlas</a> </li> </ul> <h1>Class TextureAtlas</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>A texture atlas is a collection of many smaller textures in one big image. This class is used to access textures from such an atlas.</p> </div> <p>Using a texture atlas for your textures solves two problems:</p> <ul> <li>Whenever you switch between textures, the batching of image objects is disrupted.</li> <li>Any Stage3D texture has to have side lengths that are powers of two. Starling hides this limitation from you, but at the cost of additional graphics memory.</li> </ul> <p>By using a texture atlas, you avoid both texture switches and the power-of-two limitation. All textures are within one big "super-texture", and Starling takes care that the correct part of this texture is displayed.</p> <p>There are several ways to create a texture atlas. One is to use the atlas generator script that is bundled with Starling's sibling, the <a href="http://www.sparrow-framework.org"> Sparrow framework</a>. It was only tested in Mac OS X, though. A great multi-platform alternative is the commercial tool <a href="http://www.texturepacker.com"> Texture Packer</a>.</p> <p>Whatever tool you use, Starling expects the following file format:</p> <listing> <TextureAtlas imagePath='atlas.png'> <SubTexture name='texture_1' x='0' y='0' width='50' height='50'/> <SubTexture name='texture_2' x='50' y='0' width='20' height='30'/> </TextureAtlas> </listing> <p> <strong>Texture Frame</strong></p> <p>If your images have transparent areas at their edges, you can make use of the <code>frame</code> property of the Texture class. Trim the texture by removing the transparent edges and specify the original texture size like this:</p> <listing> <SubTexture name='trimmed' x='0' y='0' height='10' width='10' frameX='-10' frameY='-10' frameWidth='30' frameHeight='30'/> </listing> <p> <strong>Texture Rotation</strong></p> <p>Some atlas generators can optionally rotate individual textures to optimize the texture distribution. This is supported via the boolean attribute "rotated". If it is set to <code>true</code> for a certain subtexture, this means that the texture on the atlas has been rotated by 90 degrees, clockwise. Starling will undo that rotation by rotating it counter-clockwise.</p> <p>In this case, the positional coordinates (<code>x, y, width, height</code>) are expected to point at the subtexture as it is present on the atlas (in its rotated form), while the "frame" properties must describe the texture in its upright form.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">TextureAtlas</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.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.textures.textureatlas.html#texture" class="tsd-kind-icon">texture</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.textures.textureatlas.html#addregion" class="tsd-kind-icon">add<wbr>Region</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#dispose" class="tsd-kind-icon">dispose</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#getframe" class="tsd-kind-icon">get<wbr>Frame</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#getnames" class="tsd-kind-icon">get<wbr>Names</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#getregion" class="tsd-kind-icon">get<wbr>Region</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#getrotation" class="tsd-kind-icon">get<wbr>Rotation</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.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.textures.textureatlas.html#gettextures" class="tsd-kind-icon">get<wbr>Textures</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.textures.textureatlas.html#get_texture" class="tsd-kind-icon">get_<wbr>texture</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.textures.textureatlas.html#removeregion" class="tsd-kind-icon">remove<wbr>Region</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-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new <wbr>Texture<wbr>Atlas<span class="tsd-signature-symbol">(</span>texture<span class="tsd-signature-symbol">: </span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a>, data<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><a href="starling.textures.textureatlas.html" class="tsd-signature-type">TextureAtlas</a></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/textures/TextureAtlas.d.ts#L64">lib/starling/textures/TextureAtlas.d.ts:64</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create a texture atlas from a texture and atlas data. The second argument typically points to an XML file.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>texture: <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="starling.textures.textureatlas.html" class="tsd-signature-type">TextureAtlas</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="texture" class="tsd-anchor"></a> <h3>texture</h3> <div class="tsd-signature tsd-kind-icon">texture<span class="tsd-signature-symbol">:</span> <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/textures/TextureAtlas.d.ts#L103">lib/starling/textures/TextureAtlas.d.ts:103</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The base texture that makes up the atlas.</p> </div> </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="addregion" class="tsd-anchor"></a> <h3>add<wbr>Region</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">add<wbr>Region<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, region<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Rectangle</span>, frame<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Rectangle</span>, rotated<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><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/textures/TextureAtlas.d.ts#L96">lib/starling/textures/TextureAtlas.d.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Adds a named region for a SubTexture (described by rectangle with coordinates in points) with an optional frame.</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>region: <span class="tsd-signature-type">Rectangle</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> frame: <span class="tsd-signature-type">Rectangle</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> rotated: <span class="tsd-signature-type">boolean</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="dispose" class="tsd-anchor"></a> <h3>dispose</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</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/textures/TextureAtlas.d.ts#L70">lib/starling/textures/TextureAtlas.d.ts:70</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disposes the atlas texture.</p> </div> </div> <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="getframe" class="tsd-anchor"></a> <h3>get<wbr>Frame</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Frame<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Rectangle</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/textures/TextureAtlas.d.ts#L88">lib/starling/textures/TextureAtlas.d.ts:88</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the frame rectangle of a specific region, or <code>null</code> if that region has no frame.</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> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Rectangle</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="getnames" class="tsd-anchor"></a> <h3>get<wbr>Names</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Names<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, result<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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/textures/TextureAtlas.d.ts#L80">lib/starling/textures/TextureAtlas.d.ts:80</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns all texture names that start with a certain string, sorted alphabetically.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="getregion" class="tsd-anchor"></a> <h3>get<wbr>Region</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Region<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Rectangle</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/textures/TextureAtlas.d.ts#L84">lib/starling/textures/TextureAtlas.d.ts:84</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns the region rectangle associated with a specific name, or <code>null</code> if no region with that name has been registered.</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> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Rectangle</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="getrotation" class="tsd-anchor"></a> <h3>get<wbr>Rotation</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Rotation<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/textures/TextureAtlas.d.ts#L92">lib/starling/textures/TextureAtlas.d.ts:92</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>If true, the specified region in the atlas is rotated by 90 degrees (clockwise). The SubTexture is thus rotated counter-clockwise to cancel out that transformation.</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> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="gettexture" class="tsd-anchor"></a> <h3>get<wbr>Texture</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Texture<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></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/textures/TextureAtlas.d.ts#L73">lib/starling/textures/TextureAtlas.d.ts:73</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Retrieves a SubTexture by name. Returns <code>null</code> if it is not found.</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> </ul> <h4 class="tsd-returns-title">Returns <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="gettextures" class="tsd-anchor"></a> <h3>get<wbr>Textures</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Textures<span class="tsd-signature-symbol">(</span>prefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, result<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Vector</span><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-symbol">: </span><span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a><span class="tsd-signature-symbol">></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/textures/TextureAtlas.d.ts#L77">lib/starling/textures/TextureAtlas.d.ts:77</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns all textures that start with a certain string, sorted alphabetically (especially useful for "MovieClip").</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> prefix: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector</span><span class="tsd-signature-symbol"><</span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a name="get_texture" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>texture</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get_<wbr>texture<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></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/textures/TextureAtlas.d.ts#L104">lib/starling/textures/TextureAtlas.d.ts:104</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="removeregion" class="tsd-anchor"></a> <h3>remove<wbr>Region</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Region<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/textures/TextureAtlas.d.ts#L100">lib/starling/textures/TextureAtlas.d.ts:100</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Removes a region with a certain name.</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> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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=" 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="current 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.textures.atfdata.html" class="tsd-kind-icon">Atf<wbr>Data</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.concretetexture.html" class="tsd-kind-icon">Concrete<wbr>Texture</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.rendertexture.html" class="tsd-kind-icon">Render<wbr>Texture</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.subtexture.html" class="tsd-kind-icon">Sub<wbr>Texture</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.texture.html" class="tsd-kind-icon">Texture</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.textureatlas.html" class="tsd-kind-icon">Texture<wbr>Atlas</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#texture" class="tsd-kind-icon">texture</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#addregion" class="tsd-kind-icon">add<wbr>Region</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#dispose" class="tsd-kind-icon">dispose</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#getframe" class="tsd-kind-icon">get<wbr>Frame</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#getnames" class="tsd-kind-icon">get<wbr>Names</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#getregion" class="tsd-kind-icon">get<wbr>Region</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#getrotation" class="tsd-kind-icon">get<wbr>Rotation</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.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.textures.textureatlas.html#gettextures" class="tsd-kind-icon">get<wbr>Textures</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"> <a href="starling.textures.textureatlas.html#get_texture" class="tsd-kind-icon">get_<wbr>texture</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="starling.textures.textureatlas.html#removeregion" class="tsd-kind-icon">remove<wbr>Region</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="starling.textures.texturesmoothing.html" class="tsd-kind-icon">Texture<wbr>Smoothing</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>