starling-framework
Version:
A fast, productive library for 2D cross-platform development.
546 lines • 294 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Mesh | 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.mesh.html">Mesh</a>
</li>
</ul>
<h1>Class Mesh</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The base class for all tangible (non-container) display objects, spawned up by a number
of triangles.</p>
</div>
<p>Since Starling uses Stage3D for rendering, all rendered objects must be constructed
from triangles. A mesh stores the information of its triangles through VertexData and
IndexData structures. The default format stores position, color and texture coordinates
for each vertex.</p>
<p>How a mesh is rendered depends on its style. Per default, this is an instance
of the <code>MeshStyle</code> base class; however, subclasses may extend its behavior
to add support for color transformations, normal mapping, etc.</p>
<p> @see MeshBatch
@see starling.styles.MeshStyle
@see starling.rendering.VertexData
@see starling.rendering.IndexData</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.display.displayobject.html" class="tsd-signature-type">DisplayObject</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Mesh</span>
<ul class="tsd-hierarchy">
<li>
<a href="starling.display.quad.html" class="tsd-signature-type">Quad</a>
</li>
<li>
<a href="starling.display.meshbatch.html" class="tsd-signature-type">MeshBatch</a>
</li>
<li>
<a href="starling.filters.filterquad.html" class="tsd-signature-type">FilterQuad</a>
</li>
<li>
<a href="starling.extensions.particlesystem.html" class="tsd-signature-type">ParticleSystem</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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#bounds" class="tsd-kind-icon">bounds</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#numindices" class="tsd-kind-icon">num<wbr>Indices</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#numtriangles" class="tsd-kind-icon">num<wbr>Triangles</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.html#pivoty" class="tsd-kind-icon">pivotY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#scale" class="tsd-kind-icon">scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#stage" class="tsd-kind-icon">stage</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#style" class="tsd-kind-icon">style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#texture" class="tsd-kind-icon">texture</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#texturerepeat" class="tsd-kind-icon">texture<wbr>Repeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#texturesmoothing" class="tsd-kind-icon">texture<wbr>Smoothing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.html#usehandcursor" class="tsd-kind-icon">use<wbr>Hand<wbr>Cursor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.html#vertexdata" class="tsd-kind-icon">vertex<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#y" class="tsd-kind-icon">y</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.mesh.html#defaultstyle" class="tsd-kind-icon">default<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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-external"><a href="starling.display.mesh.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.mesh.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-external"><a href="starling.display.mesh.html#getbounds" class="tsd-kind-icon">get<wbr>Bounds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.html#gettransformationmatrix3d" class="tsd-kind-icon">get<wbr>Transformation<wbr>Matrix3D</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#getvertexalpha" class="tsd-kind-icon">get<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#getvertexcolor" class="tsd-kind-icon">get<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#get_bounds" class="tsd-kind-icon">get_<wbr>bounds</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.html#get_height" class="tsd-kind-icon">get_<wbr>height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#get_name" class="tsd-kind-icon">get_<wbr>name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.html#get_pivoty" class="tsd-kind-icon">get_<wbr>pivotY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#get_scale" class="tsd-kind-icon">get_<wbr>scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#get_stage" class="tsd-kind-icon">get_<wbr>stage</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.html#get_style" class="tsd-kind-icon">get_<wbr>style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.html#get_texture" class="tsd-kind-icon">get_<wbr>texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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-inherited tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.html#localtoglobal" class="tsd-kind-icon">local<wbr>ToGlobal</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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-external"><a href="starling.display.mesh.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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.mesh.html#setrequiresredraw" class="tsd-kind-icon">set<wbr>Requires<wbr>Redraw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#setstyle" class="tsd-kind-icon">set<wbr>Style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#settexcoords" class="tsd-kind-icon">set<wbr>Tex<wbr>Coords</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#setvertexalpha" class="tsd-kind-icon">set<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.html#setvertexcolor" class="tsd-kind-icon">set<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.mesh.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-external"><a href="starling.display.mesh.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.mesh.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.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#set_pivoty" class="tsd-kind-icon">set_<wbr>pivotY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.html#set_scale" class="tsd-kind-icon">set_<wbr>scale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.html#set_skewy" class="tsd-kind-icon">set_<wbr>skewY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.html#set_style" class="tsd-kind-icon">set_<wbr>style</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.html#set_texture" class="tsd-kind-icon">set_<wbr>texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-external"><a href="starling.display.mesh.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-inherited tsd-is-protected tsd-is-external"><a href="starling.display.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.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.mesh.html#frompolygon" class="tsd-kind-icon">from<wbr>Polygon</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-static tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-static tsd-is-external"><a href="starling.display.mesh.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-protected tsd-is-static tsd-is-external"><a href="starling.display.mesh.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>Mesh<span class="tsd-signature-symbol">(</span>vertexData<span class="tsd-signature-symbol">: </span><a href="starling.rendering.vertexdata.html" class="tsd-signature-type">VertexData</a>, indexData<span class="tsd-signature-symbol">: </span><a href="starling.rendering.indexdata.html" class="tsd-signature-type">IndexData</a>, style<span class="tsd-signature-symbol">?: </span><a href="starling.styles.meshstyle.html" class="tsd-signature-type">MeshStyle</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.mesh.html" class="tsd-signature-type">Mesh</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/Mesh.d.ts#L32">lib/starling/display/Mesh.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new mesh with the given vertices and indices.
If you don't pass a style, an instance of <code>MeshStyle</code> will be created
for you. Note that the format of the vertex data will be matched to the
given style right away.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertexData: <a href="starling.rendering.vertexdata.html" class="tsd-signature-type">VertexData</a></h5>
</li>
<li>
<h5>indexData: <a href="starling.rendering.indexdata.html" class="tsd-signature-type">IndexData</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> style: <a href="starling.styles.meshstyle.html" class="tsd-signature-type">MeshStyle</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.display.mesh.html" class="tsd-signature-type">Mesh</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-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">
<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-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">
<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"></a>
<h3>mask</h3>
<div class="tsd-signature tsd-kind-icon">mask<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#mask">mask</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L403">lib/starling/display/DisplayObject.d.ts:403</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The display object that acts as a mask for the current object.
Assign <code>null</code> to remove it.</p>
</div>
<p>A pixel of the masked display object will only be drawn if it is within one of the
mask's polygons. Texture pixels and alpha values of the mask are not taken into
account. The mask object itself is never visible.</p>
<p>If the mask is part of the display list, masking will occur at exactly the
location it occupies on the stage. If it is not, the mask will be placed in the local
coordinate system of the target object (as if it was one of its children).</p>
<p>For rectangular masks, you can use simple quads; for other forms (like circles
or arbitrary shapes) it is recommended to use a 'Canvas' instance.</p>
<p><strong>Note:</strong> a mask will typically cause at least two additional draw
calls: one to draw the mask to the stencil buffer and one to erase it. However, if the
mask object is an instance of <code>starling.display.Quad</code> and is aligned
parallel to the stage axes, rendering will be optimized: instead of using the
stencil buffer, the object will be clipped using the scissor rectangle. That's
faster and reduces the number of draw calls, so make use of this when possible.</p>
<p><strong>Note:</strong> AIR apps require the <code>depthAndStencil</code> node
in the application descriptor XMLs to be enabled! Otherwise, stencil masking won't
work.</p>
<p> @see Canvas
@default null</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="maskinverted" class="tsd-anchor"></a>
<h3>mask<wbr>Inverted</h3>
<div class="tsd-signature tsd-kind-icon">mask<wbr>Inverted<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#maskinverted">maskInverted</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/DisplayObject.d.ts#L408">lib/starling/display/DisplayObject.d.ts:408</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>I