starling-framework
Version:
A fast, productive library for 2D cross-platform development.
499 lines • 338 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Image | 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.display.html">display</a>
</li>
<li>
<a href="starling.display.image.html">Image</a>
</li>
</ul>
<h1>Class Image</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 Image is a quad with a texture mapped onto it.</p>
</div>
<p>Typically, the Image class will act as an equivalent of Flash's Bitmap class. Instead
of BitmapData, Starling uses textures to represent the pixels of an image. To display a
texture, you have to map it onto a quad - and that's what the Image class is for.</p>
<p>While the base class <code>Quad</code> already supports textures, the <code>Image</code>
class adds some additional functionality.</p>
<p>First of all, it provides a convenient constructor that will automatically synchronize
the size of the image with the displayed texture.</p>
<p>Furthermore, it adds support for a "Scale9" grid. This splits up the image into
nine regions, the corners of which will always maintain their original size.
The center region stretches in both directions to fill the remaining space; the side
regions will stretch accordingly in either horizontal or vertical direction.</p>
<p>Finally, you can repeat a texture horizontally and vertically within the image's region,
just like the tiles of a wallpaper. Use the <code>tileGrid</code> property to do that.</p>
<p> @see starling.textures.Texture
@see Quad</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.display.quad.html" class="tsd-signature-type">Quad</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Image</span>
<ul class="tsd-hierarchy">
<li>
<a href="starling.display.movieclip.html" class="tsd-signature-type">MovieClip</a>
</li>
</ul>
</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.display.image.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-inherited tsd-is-external"><a href="starling.display.image.html#alpha" class="tsd-kind-icon">alpha</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#base" class="tsd-kind-icon">base</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#blendmode" class="tsd-kind-icon">blend<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#bounds" class="tsd-kind-icon">bounds</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#color" class="tsd-kind-icon">color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#filter" class="tsd-kind-icon">filter</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#indexdata" class="tsd-kind-icon">index<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#is3d" class="tsd-kind-icon">is3D</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#mask" class="tsd-kind-icon">mask</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#maskinverted" class="tsd-kind-icon">mask<wbr>Inverted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#numindices" class="tsd-kind-icon">num<wbr>Indices</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#numtriangles" class="tsd-kind-icon">num<wbr>Triangles</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#numvertices" class="tsd-kind-icon">num<wbr>Vertices</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#parent" class="tsd-kind-icon">parent</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#pivotx" class="tsd-kind-icon">pivotX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#pivoty" class="tsd-kind-icon">pivotY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#pixelsnapping" class="tsd-kind-icon">pixel<wbr>Snapping</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#requiresredraw" class="tsd-kind-icon">requires<wbr>Redraw</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#root" class="tsd-kind-icon">root</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#rotation" class="tsd-kind-icon">rotation</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#scale" class="tsd-kind-icon">scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.image.html#scale9grid" class="tsd-kind-icon">scale9<wbr>Grid</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#scalex" class="tsd-kind-icon">scaleX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#scaley" class="tsd-kind-icon">scaleY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#skewx" class="tsd-kind-icon">skewX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#skewy" class="tsd-kind-icon">skewY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#stage" class="tsd-kind-icon">stage</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#style" class="tsd-kind-icon">style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#texture" class="tsd-kind-icon">texture</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#texturerepeat" class="tsd-kind-icon">texture<wbr>Repeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#texturesmoothing" class="tsd-kind-icon">texture<wbr>Smoothing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.image.html#tilegrid" class="tsd-kind-icon">tile<wbr>Grid</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#touchable" class="tsd-kind-icon">touchable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#transformationmatrix" class="tsd-kind-icon">transformation<wbr>Matrix</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#transformationmatrix3d" class="tsd-kind-icon">transformation<wbr>Matrix3D</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#usehandcursor" class="tsd-kind-icon">use<wbr>Hand<wbr>Cursor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#vertexdata" class="tsd-kind-icon">vertex<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#vertexformat" class="tsd-kind-icon">vertex<wbr>Format</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#visible" class="tsd-kind-icon">visible</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#width" class="tsd-kind-icon">width</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#y" class="tsd-kind-icon">y</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.display.image.html#defaultstyle" class="tsd-kind-icon">default<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.display.image.html#defaultstylefactory" class="tsd-kind-icon">default<wbr>Style<wbr>Factory</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-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#alignpivot" class="tsd-kind-icon">align<wbr>Pivot</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.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.display.image.html#dispatcheventwith" class="tsd-kind-icon">dispatch<wbr>Event<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#drawtobitmapdata" class="tsd-kind-icon">draw<wbr>ToBitmap<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#getbounds" class="tsd-kind-icon">get<wbr>Bounds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#gettexcoords" class="tsd-kind-icon">get<wbr>Tex<wbr>Coords</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#gettransformationmatrix" class="tsd-kind-icon">get<wbr>Transformation<wbr>Matrix</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#gettransformationmatrix3d" class="tsd-kind-icon">get<wbr>Transformation<wbr>Matrix3D</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#getvertexalpha" class="tsd-kind-icon">get<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#getvertexcolor" class="tsd-kind-icon">get<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#getvertexposition" class="tsd-kind-icon">get<wbr>Vertex<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_alpha" class="tsd-kind-icon">get_<wbr>alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_base" class="tsd-kind-icon">get_<wbr>base</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_blendmode" class="tsd-kind-icon">get_<wbr>blend<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_bounds" class="tsd-kind-icon">get_<wbr>bounds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_color" class="tsd-kind-icon">get_<wbr>color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_filter" class="tsd-kind-icon">get_<wbr>filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_height" class="tsd-kind-icon">get_<wbr>height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_indexdata" class="tsd-kind-icon">get_<wbr>index<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_is3d" class="tsd-kind-icon">get_<wbr>is3D</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_mask" class="tsd-kind-icon">get_<wbr>mask</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_maskinverted" class="tsd-kind-icon">get_<wbr>mask<wbr>Inverted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_name" class="tsd-kind-icon">get_<wbr>name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_numindices" class="tsd-kind-icon">get_<wbr>num<wbr>Indices</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_numtriangles" class="tsd-kind-icon">get_<wbr>num<wbr>Triangles</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_numvertices" class="tsd-kind-icon">get_<wbr>num<wbr>Vertices</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_parent" class="tsd-kind-icon">get_<wbr>parent</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_pivotx" class="tsd-kind-icon">get_<wbr>pivotX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_pivoty" class="tsd-kind-icon">get_<wbr>pivotY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_pixelsnapping" class="tsd-kind-icon">get_<wbr>pixel<wbr>Snapping</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_requiresredraw" class="tsd-kind-icon">get_<wbr>requires<wbr>Redraw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_root" class="tsd-kind-icon">get_<wbr>root</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_rotation" class="tsd-kind-icon">get_<wbr>rotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_scale" class="tsd-kind-icon">get_<wbr>scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_scale9grid" class="tsd-kind-icon">get_<wbr>scale9<wbr>Grid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_scalex" class="tsd-kind-icon">get_<wbr>scaleX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_scaley" class="tsd-kind-icon">get_<wbr>scaleY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_skewx" class="tsd-kind-icon">get_<wbr>skewX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_skewy" class="tsd-kind-icon">get_<wbr>skewY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_stage" class="tsd-kind-icon">get_<wbr>stage</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_style" class="tsd-kind-icon">get_<wbr>style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_texture" class="tsd-kind-icon">get_<wbr>texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_texturerepeat" class="tsd-kind-icon">get_<wbr>texture<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_texturesmoothing" class="tsd-kind-icon">get_<wbr>texture<wbr>Smoothing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_tilegrid" class="tsd-kind-icon">get_<wbr>tile<wbr>Grid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_touchable" class="tsd-kind-icon">get_<wbr>touchable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_transformationmatrix" class="tsd-kind-icon">get_<wbr>transformation<wbr>Matrix</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_transformationmatrix3d" class="tsd-kind-icon">get_<wbr>transformation<wbr>Matrix3D</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_usehandcursor" class="tsd-kind-icon">get_<wbr>use<wbr>Hand<wbr>Cursor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_vertexdata" class="tsd-kind-icon">get_<wbr>vertex<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_vertexformat" class="tsd-kind-icon">get_<wbr>vertex<wbr>Format</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_visible" class="tsd-kind-icon">get_<wbr>visible</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_width" class="tsd-kind-icon">get_<wbr>width</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_x" class="tsd-kind-icon">get_<wbr>x</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#get_y" class="tsd-kind-icon">get_<wbr>y</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#globaltolocal" class="tsd-kind-icon">global<wbr>ToLocal</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#globaltolocal3d" class="tsd-kind-icon">global<wbr>ToLocal3D</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#hittest" class="tsd-kind-icon">hit<wbr>Test</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#hittestmask" class="tsd-kind-icon">hit<wbr>Test<wbr>Mask</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#local3dtoglobal" class="tsd-kind-icon">local3DTo<wbr>Global</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#localtoglobal" class="tsd-kind-icon">local<wbr>ToGlobal</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#readjustsize" class="tsd-kind-icon">readjust<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#removeeventlisteners" class="tsd-kind-icon">remove<wbr>Event<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#removefromparent" class="tsd-kind-icon">remove<wbr>From<wbr>Parent</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setindexdatachanged" class="tsd-kind-icon">set<wbr>Index<wbr>Data<wbr>Changed</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setrequiresredraw" class="tsd-kind-icon">set<wbr>Requires<wbr>Redraw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setstyle" class="tsd-kind-icon">set<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#settexcoords" class="tsd-kind-icon">set<wbr>Tex<wbr>Coords</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setvertexalpha" class="tsd-kind-icon">set<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setvertexcolor" class="tsd-kind-icon">set<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setvertexdatachanged" class="tsd-kind-icon">set<wbr>Vertex<wbr>Data<wbr>Changed</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.image.html#setvertexposition" class="tsd-kind-icon">set<wbr>Vertex<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_alpha" class="tsd-kind-icon">set_<wbr>alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_blendmode" class="tsd-kind-icon">set_<wbr>blend<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_color" class="tsd-kind-icon">set_<wbr>color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_filter" class="tsd-kind-icon">set_<wbr>filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_height" class="tsd-kind-icon">set_<wbr>height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_mask" class="tsd-kind-icon">set_<wbr>mask</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_maskinverted" class="tsd-kind-icon">set_<wbr>mask<wbr>Inverted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_name" class="tsd-kind-icon">set_<wbr>name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_pivotx" class="tsd-kind-icon">set_<wbr>pivotX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_pivoty" class="tsd-kind-icon">set_<wbr>pivotY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_pixelsnapping" class="tsd-kind-icon">set_<wbr>pixel<wbr>Snapping</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_rotation" class="tsd-kind-icon">set_<wbr>rotation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_scale" class="tsd-kind-icon">set_<wbr>scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_scale9grid" class="tsd-kind-icon">set_<wbr>scale9<wbr>Grid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_scalex" class="tsd-kind-icon">set_<wbr>scaleX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_scaley" class="tsd-kind-icon">set_<wbr>scaleY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_skewx" class="tsd-kind-icon">set_<wbr>skewX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_skewy" class="tsd-kind-icon">set_<wbr>skewY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_style" class="tsd-kind-icon">set_<wbr>style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_texture" class="tsd-kind-icon">set_<wbr>texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_texturerepeat" class="tsd-kind-icon">set_<wbr>texture<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_texturesmoothing" class="tsd-kind-icon">set_<wbr>texture<wbr>Smoothing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_tilegrid" class="tsd-kind-icon">set_<wbr>tile<wbr>Grid</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_touchable" class="tsd-kind-icon">set_<wbr>touchable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_transformationmatrix" class="tsd-kind-icon">set_<wbr>transformation<wbr>Matrix</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_usehandcursor" class="tsd-kind-icon">set_<wbr>use<wbr>Hand<wbr>Cursor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_visible" class="tsd-kind-icon">set_<wbr>visible</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_width" class="tsd-kind-icon">set_<wbr>width</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_x" class="tsd-kind-icon">set_<wbr>x</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.image.html#set_y" class="tsd-kind-icon">set_<wbr>y</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.image.html#automatesetupfortexture" class="tsd-kind-icon">automate<wbr>Setup<wbr>For<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.image.html#bindpivotpointtotexture" class="tsd-kind-icon">bind<wbr>Pivot<wbr>Point<wbr>ToTexture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.image.html#bindscale9gridtotexture" class="tsd-kind-icon">bind<wbr>Scale9<wbr>Grid<wbr>ToTexture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.display.image.html#frompolygon" class="tsd-kind-icon">from<wbr>Polygon</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.display.image.html#fromtexture" class="tsd-kind-icon">from<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.display.image.html#get_defaultstyle" class="tsd-kind-icon">get_<wbr>default<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.display.image.html#get_defaultstylefactory" class="tsd-kind-icon">get_<wbr>default<wbr>Style<wbr>Factory</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.image.html#removesetupfortexture" class="tsd-kind-icon">remove<wbr>Setup<wbr>For<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.image.html#resetsetupfortexture" class="tsd-kind-icon">reset<wbr>Setup<wbr>For<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.display.image.html#set_defaultstyle" class="tsd-kind-icon">set_<wbr>default<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.display.image.html#set_defaultstylefactory" class="tsd-kind-icon">set_<wbr>default<wbr>Style<wbr>Factory</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>Image<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.image.html" class="tsd-signature-type">Image</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.display.quad.html">Quad</a>.<a href="starling.display.quad.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/Image.d.ts#L31">lib/starling/display/Image.d.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an image with a texture mapped onto it.</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>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.display.image.html" class="tsd-signature-type">Image</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-inherited tsd-is-external">
<a name="alpha" class="tsd-anchor"></a>
<h3>alpha</h3>
<div class="tsd-signature tsd-kind-icon">alpha<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#alpha">alpha</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L331">lib/starling/display/DisplayObject.d.ts:331</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The opacity of the object. 0 = transparent, 1 = opaque. @default 1</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="base" class="tsd-anchor"></a>
<h3>base</h3>
<div class="tsd-signature tsd-kind-icon">base<span class="tsd-signature-symbol">:</span> <a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#base">base</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L417">lib/starling/display/DisplayObject.d.ts:417</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The topmost object in the display tree the object is part of.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="blendmode" class="tsd-anchor"></a>
<h3>blend<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">blend<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#blendmode">blendMode</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L348">lib/starling/display/DisplayObject.d.ts:348</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The blend mode determines how the object is blended with the objects underneath.</p>
</div>
<dl class="tsd-comment-tags">
<dt>default</dt>
<dd><p>auto</p>
</dd>
<dt>see</dt>
<dd><p>starling.display.BlendMode</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="bounds" class="tsd-anchor"></a>
<h3>bounds</h3>
<div class="tsd-signature tsd-kind-icon">bounds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Rectangle</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#bounds">bounds</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L259">lib/starling/display/DisplayObject.d.ts:259</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The bounds of the object relative to the local coordinates of the parent.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="color" class="tsd-anchor"></a>
<h3>color</h3>
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.mesh.html">Mesh</a>.<a href="starling.display.mesh.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/Mesh.d.ts#L140">lib/starling/display/Mesh.d.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Changes the color of all vertices to the same value.
The getter simply returns the color of the first vertex.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="filter" class="tsd-anchor"></a>
<h3>filter</h3>
<div class="tsd-signature tsd-kind-icon">filter<span class="tsd-signature-symbol">:</span> <a href="starling.filters.fragmentfilter.html" class="tsd-signature-type">FragmentFilter</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#filter">filter</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L371">lib/starling/display/DisplayObject.d.ts:371</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The filter that is attached to the display object. The <code>starling.filters</code>
package contains several classes that define specific filters you can use. To combine
several filters, assign an instance of the <code>FilterChain</code> class; to remove
all filters, assign <code>null</code>.</p>
</div>
<p>Beware that a filter instance may only be used on one object at a time! Furthermore,
when you remove or replace a filter, it is NOT disposed automatically (since you might
want to reuse it on a different object).</p>
<p> @default null
@see starling.filters.FragmentFilter
@see starling.filters.FilterChain</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="height" class="tsd-anchor"></a>
<h3>height</h3>
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#height">height</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L272">lib/starling/display/DisplayObject.d.ts:272</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The height of the object in pixels.
Note that for objects in a 3D space (connected to a Sprite3D), this value might not
be accurate until the object is part of the display list.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="indexdata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> index<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.indexdata.html" class="tsd-signature-type">IndexData</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.mesh.html">Mesh</a>.<a href="starling.display.mesh.html#indexdata">indexData</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/Mesh.d.ts#L118">lib/starling/display/Mesh.d.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The index data describing how the vertices are interconnected.
Any change requires a call to <code>setRequiresRedraw</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="is3d" class="tsd-anchor"></a>
<h3>is3D</h3>
<div class="tsd-signature tsd-kind-icon">is3D<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.display.displayobject.html">DisplayObject</a>.<a href="starling.display.displayobject.html#is3d">is3D</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L249">lib/starling/display/DisplayObject.d.ts:249</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if this object or any of its parents is a 'Sprite3D' object.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="mask" class="tsd-anchor"><