starling-framework
Version:
A fast, productive library for 2D cross-platform development.
697 lines • 117 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DistanceFieldEffect | 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.styles.html">styles</a>
</li>
<li>
<a href="starling.styles.distancefieldeffect.html">DistanceFieldEffect</a>
</li>
</ul>
<h1>Class DistanceFieldEffect</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.rendering.mesheffect.html" class="tsd-signature-type">MeshEffect</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DistanceFieldEffect</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.styles.distancefieldeffect.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.styles.distancefieldeffect.html#alpha" class="tsd-kind-icon">alpha</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#indexbuffer" class="tsd-kind-icon">index<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#indexbuffersize" class="tsd-kind-icon">index<wbr>Buffer<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldeffect.html#mode" class="tsd-kind-icon">mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldeffect.html#multichannel" class="tsd-kind-icon">multi<wbr>Channel</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#mvpmatrix3d" class="tsd-kind-icon">mvp<wbr>Matrix3D</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#onrestore" class="tsd-kind-icon">on<wbr>Restore</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#program" class="tsd-kind-icon">program</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#programbasename" class="tsd-kind-icon">program<wbr>Base<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#programname" class="tsd-kind-icon">program<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#programvariantname" class="tsd-kind-icon">program<wbr>Variant<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.html#tinted" class="tsd-kind-icon">tinted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#vertexbuffer" class="tsd-kind-icon">vertex<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#vertexbuffersize" class="tsd-kind-icon">vertex<wbr>Buffer<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#vertexformat" class="tsd-kind-icon">vertex<wbr>Format</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldeffect.html#max_outer_offset" class="tsd-kind-icon">MAX_<wbr>OUTER_<wbr>OFFSET</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldeffect.html#max_scale" class="tsd-kind-icon">MAX_<wbr>SCALE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldeffect.html#std_vertex_shader" class="tsd-kind-icon">STD_<wbr>VERTEX_<wbr>SHADER</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldeffect.html#vertex_format" class="tsd-kind-icon">VERTEX_<wbr>FORMAT</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-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#dispose" class="tsd-kind-icon">dispose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.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.styles.distancefieldeffect.html#get_indexbuffer" class="tsd-kind-icon">get_<wbr>index<wbr>Buffer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_indexbuffersize" class="tsd-kind-icon">get_<wbr>index<wbr>Buffer<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_mode" class="tsd-kind-icon">get_<wbr>mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_multichannel" class="tsd-kind-icon">get_<wbr>multi<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_mvpmatrix3d" class="tsd-kind-icon">get_<wbr>mvp<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.styles.distancefieldeffect.html#get_onrestore" class="tsd-kind-icon">get_<wbr>on<wbr>Restore</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_program" class="tsd-kind-icon">get_<wbr>program</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_programbasename" class="tsd-kind-icon">get_<wbr>program<wbr>Base<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.styles.distancefieldeffect.html#get_programname" class="tsd-kind-icon">get_<wbr>program<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.styles.distancefieldeffect.html#get_programvariantname" class="tsd-kind-icon">get_<wbr>program<wbr>Variant<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.html#get_tinted" class="tsd-kind-icon">get_<wbr>tinted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_vertexbuffer" class="tsd-kind-icon">get_<wbr>vertex<wbr>Buffer</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#get_vertexbuffersize" class="tsd-kind-icon">get_<wbr>vertex<wbr>Buffer<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.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-external"><a href="starling.styles.distancefieldeffect.html#purgebuffers" class="tsd-kind-icon">purge<wbr>Buffers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#set_alpha" class="tsd-kind-icon">set_<wbr>alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#set_mode" class="tsd-kind-icon">set_<wbr>mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#set_multichannel" class="tsd-kind-icon">set_<wbr>multi<wbr>Channel</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#set_mvpmatrix3d" class="tsd-kind-icon">set_<wbr>mvp<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.styles.distancefieldeffect.html#set_onrestore" class="tsd-kind-icon">set_<wbr>on<wbr>Restore</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.html#set_programbasename" class="tsd-kind-icon">set_<wbr>program<wbr>Base<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.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.styles.distancefieldeffect.html#set_tinted" class="tsd-kind-icon">set_<wbr>tinted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#uploadindexdata" class="tsd-kind-icon">upload<wbr>Index<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldeffect.html#uploadvertexdata" class="tsd-kind-icon">upload<wbr>Vertex<wbr>Data</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>Distance<wbr>Field<wbr>Effect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.styles.distancefieldeffect.html" class="tsd-signature-type">DistanceFieldEffect</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.rendering.mesheffect.html">MeshEffect</a>.<a href="starling.rendering.mesheffect.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L219">lib/starling/styles/DistanceFieldStyle.d.ts:219</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="starling.styles.distancefieldeffect.html" class="tsd-signature-type">DistanceFieldEffect</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.rendering.mesheffect.html">MeshEffect</a>.<a href="starling.rendering.mesheffect.html#alpha">alpha</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/MeshEffect.d.ts#L30">lib/starling/rendering/MeshEffect.d.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The alpha value of the object rendered by the effect. Must be taken into account
by all subclasses.</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="indexbuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> index<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IndexBuffer3D</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#indexbuffer">indexBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L182">lib/starling/rendering/Effect.d.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The internally used index buffer used on rendering.</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="indexbuffersize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> index<wbr>Buffer<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Buffer<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#indexbuffersize">indexBufferSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L186">lib/starling/rendering/Effect.d.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current size of the index buffer (in number of indices).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="mode" class="tsd-anchor"></a>
<h3>mode</h3>
<div class="tsd-signature tsd-kind-icon">mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L227">lib/starling/styles/DistanceFieldStyle.d.ts:227</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="multichannel" class="tsd-anchor"></a>
<h3>multi<wbr>Channel</h3>
<div class="tsd-signature tsd-kind-icon">multi<wbr>Channel<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L231">lib/starling/styles/DistanceFieldStyle.d.ts:231</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="mvpmatrix3d" class="tsd-anchor"></a>
<h3>mvp<wbr>Matrix3D</h3>
<div class="tsd-signature tsd-kind-icon">mvp<wbr>Matrix3D<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Matrix3D</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#mvpmatrix3d">mvpMatrix3D</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L177">lib/starling/rendering/Effect.d.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The MVP (modelview-projection) matrix transforms vertices into clipspace.</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="onrestore" class="tsd-anchor"></a>
<h3>on<wbr>Restore</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Restore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#onrestore">onRestore</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L167">lib/starling/rendering/Effect.d.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The that you provide here will be called after a context loss.
Call both "upload..." methods from within the callback to restore any vertex or
index buffers. The callback will be executed with the effect as its sole parameter.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>Effect<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>Effect: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</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="program" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.program.html" class="tsd-signature-type">Program</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#program">program</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L159">lib/starling/rendering/Effect.d.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the current program, either by creating a new one (via
<code>createProgram</code>) or by getting it from the <code>Painter</code>.
Do not override this method! Instead, implement <code>createProgram</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="programbasename" class="tsd-anchor"></a>
<h3>program<wbr>Base<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">program<wbr>Base<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#programbasename">programBaseName</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L142">lib/starling/rendering/Effect.d.ts:142</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the base name for the program.
@default the fully qualified class name</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="programname" class="tsd-anchor"></a>
<h3>program<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">program<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#programname">programName</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L153">lib/starling/rendering/Effect.d.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the full name of the program, which is used to register it at the current
<code>Painter</code>.</p>
</div>
<p>The default implementation efficiently combines the program's base and variant
names (e.g. <code>LightEffect#42</code>). It shouldn't be necessary to override
this method.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="programvariantname" class="tsd-anchor"></a>
<h3>program<wbr>Variant<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">program<wbr>Variant<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#programvariantname">programVariantName</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L136">lib/starling/rendering/Effect.d.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Override this method if the effect requires a different program depending on the
current settings. Ideally, you do this by creating a bit mask encoding all the options.
This method is called often, so do not allocate any temporary objects when overriding.</p>
</div>
<p> @default 0</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="scale" class="tsd-anchor"></a>
<h3>scale</h3>
<div class="tsd-signature tsd-kind-icon">scale<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/styles/DistanceFieldStyle.d.ts#L223">lib/starling/styles/DistanceFieldStyle.d.ts:223</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="texture" class="tsd-anchor"></a>
<h3>texture</h3>
<div class="tsd-signature tsd-kind-icon">texture<span class="tsd-signature-symbol">:</span> <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.filtereffect.html">FilterEffect</a>.<a href="starling.rendering.filtereffect.html#texture">texture</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/FilterEffect.d.ts#L35">lib/starling/rendering/FilterEffect.d.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The texture to be mapped onto the vertices.</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="texturerepeat" class="tsd-anchor"></a>
<h3>texture<wbr>Repeat</h3>
<div class="tsd-signature tsd-kind-icon">texture<wbr>Repeat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.filtereffect.html">FilterEffect</a>.<a href="starling.rendering.filtereffect.html#texturerepeat">textureRepeat</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/FilterEffect.d.ts#L46">lib/starling/rendering/FilterEffect.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if pixels at the edges will be repeated or clamped.
Only works for power-of-two textures. @default false</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="texturesmoothing" class="tsd-anchor"></a>
<h3>texture<wbr>Smoothing</h3>
<div class="tsd-signature tsd-kind-icon">texture<wbr>Smoothing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.filtereffect.html">FilterEffect</a>.<a href="starling.rendering.filtereffect.html#texturesmoothing">textureSmoothing</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/FilterEffect.d.ts#L40">lib/starling/rendering/FilterEffect.d.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The smoothing filter that is used for the texture. @default bilinear</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="tinted" class="tsd-anchor"></a>
<h3>tinted</h3>
<div class="tsd-signature tsd-kind-icon">tinted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.mesheffect.html">MeshEffect</a>.<a href="starling.rendering.mesheffect.html#tinted">tinted</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/MeshEffect.d.ts#L38">lib/starling/rendering/MeshEffect.d.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the rendered vertices are tinted in any way, i.e. if there are vertices
that have a different color than fully opaque white. The base <code>MeshEffect</code>
class uses this information to simplify the fragment shader if possible. May be
ignored by subclasses.</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="vertexbuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> vertex<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">vertex<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">VertexBuffer3D</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#vertexbuffer">vertexBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L190">lib/starling/rendering/Effect.d.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The internally used vertex buffer used on rendering.</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="vertexbuffersize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> vertex<wbr>Buffer<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">vertex<wbr>Buffer<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#vertexbuffersize">vertexBufferSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L194">lib/starling/rendering/Effect.d.ts:194</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current size of the vertex buffer (in blocks of 32 bits).</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="vertexformat" class="tsd-anchor"></a>
<h3>vertex<wbr>Format</h3>
<div class="tsd-signature tsd-kind-icon">vertex<wbr>Format<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.vertexdataformat.html" class="tsd-signature-type">VertexDataFormat</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#vertexformat">vertexFormat</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L173">lib/starling/rendering/Effect.d.ts:173</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The data format that this effect requires from the VertexData that it renders:
<code>"position:number2"</code></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="max_outer_offset" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MAX_<wbr>OUTER_<wbr>OFFSET</h3>
<div class="tsd-signature tsd-kind-icon">MAX_<wbr>OUTER_<wbr>OFFSET<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/styles/DistanceFieldStyle.d.ts#L218">lib/starling/styles/DistanceFieldStyle.d.ts:218</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="max_scale" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MAX_<wbr>SCALE</h3>
<div class="tsd-signature tsd-kind-icon">MAX_<wbr>SCALE<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/styles/DistanceFieldStyle.d.ts#L219">lib/starling/styles/DistanceFieldStyle.d.ts:219</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="std_vertex_shader" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> STD_<wbr>VERTEX_<wbr>SHADER</h3>
<div class="tsd-signature tsd-kind-icon">STD_<wbr>VERTEX_<wbr>SHADER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.filtereffect.html">FilterEffect</a>.<a href="starling.rendering.filtereffect.html#std_vertex_shader">STD_VERTEX_SHADER</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/FilterEffect.d.ts#L29">lib/starling/rendering/FilterEffect.d.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The AGAL code for the standard vertex shader that most filters will use.
It simply transforms the vertex coordinates to clip-space and passes the texture
coordinates to the fragment program (as 'v0').</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-static tsd-is-external">
<a name="vertex_format" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> VERTEX_<wbr>FORMAT</h3>
<div class="tsd-signature tsd-kind-icon">VERTEX_<wbr>FORMAT<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.vertexdataformat.html" class="tsd-signature-type">VertexDataFormat</a></div>
<aside class="tsd-sources">
<p>Overrides <a href="starling.rendering.mesheffect.html">MeshEffect</a>.<a href="starling.rendering.mesheffect.html#vertex_format">VERTEX_FORMAT</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L217">lib/starling/styles/DistanceFieldStyle.d.ts:217</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L96">lib/starling/rendering/Effect.d.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Purges the index- and vertex-buffers.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="get_alpha" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>alpha</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>alpha<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.mesheffect.html">MeshEffect</a>.<a href="starling.rendering.mesheffect.html#get_alpha">get_alpha</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/MeshEffect.d.ts#L31">lib/starling/rendering/MeshEffect.d.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="get_indexbuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>index<wbr>Buffer</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>index<wbr>Buffer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IndexBuffer3D</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#get_indexbuffer">get_indexBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L183">lib/starling/rendering/Effect.d.ts:183</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IndexBuffer3D</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="get_indexbuffersize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>index<wbr>Buffer<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>index<wbr>Buffer<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#get_indexbuffersize">get_indexBufferSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L187">lib/starling/rendering/Effect.d.ts:187</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a name="get_mode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>mode</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>mode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L228">lib/starling/styles/DistanceFieldStyle.d.ts:228</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a name="get_multichannel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>multi<wbr>Channel</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>multi<wbr>Channel<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L232">lib/starling/styles/DistanceFieldStyle.d.ts:232</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="get_mvpmatrix3d" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>mvp<wbr>Matrix3D</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>mvp<wbr>Matrix3D<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Matrix3D</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.rendering.effect.html">Effect</a>.<a href="starling.rendering.effect.html#get_mvpmatrix3d">get_mvpMatrix3D</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/rendering/Effect.d.ts#L178">lib/starling/rendering/Effect.d.ts:178</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Matrix3D</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="get_onrestore" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected