starling-framework
Version:
A fast, productive library for 2D cross-platform development.
681 lines • 174 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DistanceFieldStyle | 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.distancefieldstyle.html">DistanceFieldStyle</a>
</li>
</ul>
<h1>Class DistanceFieldStyle</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>Provides support for signed distance fields to Starling meshes.</p>
</div>
<p>Signed distance field rendering allows bitmap fonts and other single colored shapes to
be drawn without jagged edges, even at high magnifications. The technique was introduced in
the SIGGRAPH paper <a href="http://tinyurl.com/AlphaTestedMagnification">Improved
Alpha-Tested Magnification for Vector Textures and Special Effects</a> by Valve Software.
</p>
<p>While bitmap fonts are a great solution to render text in a GPU-friendly way, they
don't scale well. For best results, one has to embed the font in all the sizes used within
the app. The distance field style solves this issue: instead of providing a standard
black and white image of the font, it uses a <em>signed distance field texture</em> as
its input (a texture that encodes, for each pixel, the distance to the closest edge of a
vector shape). With this data, the shape can be rendered smoothly at almost any scale.</p>
<p>Here are some tools that support creation of such distance field textures:</p>
<ul>
<li>Field Agent - a Ruby script that uses ImageMagick to create single-channel distance
field textures. Part of the Starling download ('util' directory).</li>
<li><a href="https://github.com/Chlumsky/msdfgen">msdfgen</a> - an excellent and fast
open source command line tool that creates multi- and single-channel distance field
textures.</li>
</ul>
<p>The former tools convert arbitrary SVG or PNG images to distance field textures.
To create distance field <em>fonts</em>, have a look at the following alternatives:</p>
<ul>
<li><a href="https://github.com/soimy/msdf-bmfont-xml/">msdf-bmfont-xml</a> - a command
line tool powered by msdf and thus producing excellent multi-channel output.</li>
<li><a href="http://kvazars.com/littera/">Littera</a> - a free online bitmap font
generator.</li>
<li><a href="http://github.com/libgdx/libgdx/wiki/Hiero">Hiero</a> - a cross platform
tool.</li>
<li><a href="http://www.angelcode.com/products/bmfont/">BMFont</a> - Windows-only, from
AngelCode.</li>
</ul>
<p> <strong>Single-Channel vs. Multi-Channel</strong></p>
<p>The original approach for distance field textures uses just a single channel (encoding
the distance of each pixel to the shape that's being represented). By utilizing
all three color channels, however, the results can be greatly enhanced - a technique
developed by Viktor Chlumský.</p>
<p>Starling supports such multi-channel DF textures, as well. When using an appropriate
texture, don't forget to enable the style's <code>multiChannel</code> property.</p>
<p> <strong>Special effects</strong></p>
<p>Another advantage of this rendering technique: it supports very efficient rendering of
some popular filter effects, in just one pass, directly on the GPU. You can add an
<em>outline</em> around the shape, let it <em>glow</em> in an arbitrary color, or add
a <em>drop shadow</em>.</p>
<p>The type of effect currently used is called the 'mode'.
Meshes with the same mode will be batched together on rendering.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.styles.meshstyle.html" class="tsd-signature-type">MeshStyle</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DistanceFieldStyle</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.distancefieldstyle.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.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.styles.distancefieldstyle.html#indexdata" class="tsd-kind-icon">index<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.html#multichannel" class="tsd-kind-icon">multi<wbr>Channel</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#outeralphaend" class="tsd-kind-icon">outer<wbr>Alpha<wbr>End</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#outeralphastart" class="tsd-kind-icon">outer<wbr>Alpha<wbr>Start</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#outercolor" class="tsd-kind-icon">outer<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#outerthreshold" class="tsd-kind-icon">outer<wbr>Threshold</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#shadowoffsetx" class="tsd-kind-icon">shadow<wbr>OffsetX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#shadowoffsety" class="tsd-kind-icon">shadow<wbr>OffsetY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#softness" class="tsd-kind-icon">softness</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#target" class="tsd-kind-icon">target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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.distancefieldstyle.html#texturesmoothing" class="tsd-kind-icon">texture<wbr>Smoothing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#threshold" class="tsd-kind-icon">threshold</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#vertexdata" class="tsd-kind-icon">vertex<wbr>Data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.html#mode_basic" class="tsd-kind-icon">MODE_<wbr>BASIC</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldstyle.html#mode_glow" class="tsd-kind-icon">MODE_<wbr>GLOW</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldstyle.html#mode_outline" class="tsd-kind-icon">MODE_<wbr>OUTLINE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldstyle.html#mode_shadow" class="tsd-kind-icon">MODE_<wbr>SHADOW</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-static tsd-is-external"><a href="starling.styles.distancefieldstyle.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-overwrite tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.html#batchindexdata" class="tsd-kind-icon">batch<wbr>Index<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#batchvertexdata" class="tsd-kind-icon">batch<wbr>Vertex<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#canbatchwith" class="tsd-kind-icon">can<wbr>Batch<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#copyfrom" class="tsd-kind-icon">copy<wbr>From</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#createeffect" class="tsd-kind-icon">create<wbr>Effect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.html#dispatcheventwith" class="tsd-kind-icon">dispatch<wbr>Event<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.html#getvertexalpha" class="tsd-kind-icon">get<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#getvertexcolor" class="tsd-kind-icon">get<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#getvertexposition" class="tsd-kind-icon">get<wbr>Vertex<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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.styles.distancefieldstyle.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-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_outeralphaend" class="tsd-kind-icon">get_<wbr>outer<wbr>Alpha<wbr>End</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_outeralphastart" class="tsd-kind-icon">get_<wbr>outer<wbr>Alpha<wbr>Start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_outercolor" class="tsd-kind-icon">get_<wbr>outer<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_outerthreshold" class="tsd-kind-icon">get_<wbr>outer<wbr>Threshold</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_shadowoffsetx" class="tsd-kind-icon">get_<wbr>shadow<wbr>OffsetX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_shadowoffsety" class="tsd-kind-icon">get_<wbr>shadow<wbr>OffsetY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_softness" class="tsd-kind-icon">get_<wbr>softness</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_target" class="tsd-kind-icon">get_<wbr>target</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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.distancefieldstyle.html#get_texturesmoothing" class="tsd-kind-icon">get_<wbr>texture<wbr>Smoothing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_threshold" class="tsd-kind-icon">get_<wbr>threshold</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_type" class="tsd-kind-icon">get_<wbr>type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#get_vertexdata" class="tsd-kind-icon">get_<wbr>vertex<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.html#settexcoords" class="tsd-kind-icon">set<wbr>Tex<wbr>Coords</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setvertexalpha" class="tsd-kind-icon">set<wbr>Vertex<wbr>Alpha</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setvertexcolor" class="tsd-kind-icon">set<wbr>Vertex<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setvertexposition" class="tsd-kind-icon">set<wbr>Vertex<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.styles.distancefieldstyle.html#set_color" class="tsd-kind-icon">set_<wbr>color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_outeralphaend" class="tsd-kind-icon">set_<wbr>outer<wbr>Alpha<wbr>End</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_outeralphastart" class="tsd-kind-icon">set_<wbr>outer<wbr>Alpha<wbr>Start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_outercolor" class="tsd-kind-icon">set_<wbr>outer<wbr>Color</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_outerthreshold" class="tsd-kind-icon">set_<wbr>outer<wbr>Threshold</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_shadowoffsetx" class="tsd-kind-icon">set_<wbr>shadow<wbr>OffsetX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_shadowoffsety" class="tsd-kind-icon">set_<wbr>shadow<wbr>OffsetY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_softness" class="tsd-kind-icon">set_<wbr>softness</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.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.distancefieldstyle.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.distancefieldstyle.html#set_texturesmoothing" class="tsd-kind-icon">set_<wbr>texture<wbr>Smoothing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#set_threshold" class="tsd-kind-icon">set_<wbr>threshold</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setupbasic" class="tsd-kind-icon">setup<wbr>Basic</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setupdropshadow" class="tsd-kind-icon">setup<wbr>Drop<wbr>Shadow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setupglow" class="tsd-kind-icon">setup<wbr>Glow</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.styles.distancefieldstyle.html#setupoutline" class="tsd-kind-icon">setup<wbr>Outline</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected tsd-is-external"><a href="starling.styles.distancefieldstyle.html#updateeffect" class="tsd-kind-icon">update<wbr>Effect</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>Style<span class="tsd-signature-symbol">(</span>softness<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, threshold<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.styles.distancefieldstyle.html" class="tsd-signature-type">DistanceFieldStyle</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L86">lib/starling/styles/DistanceFieldStyle.d.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new distance field style.</p>
</div>
<p> @param softness adds a soft transition between the inside and the outside.
This should typically be 1.0 divided by the spread (in points)
used when creating the distance field texture.
@param threshold the value separating the inside from the outside of the shape.
Range: 0 - 1.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> softness: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> threshold: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.styles.distancefieldstyle.html" class="tsd-signature-type">DistanceFieldStyle</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="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">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/DistanceFieldStyle.d.ts#L172">lib/starling/styles/DistanceFieldStyle.d.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The alpha value with which the inner area (what's rendered in 'basic' mode) is drawn.
@default 1.0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="color" class="tsd-anchor"></a>
<h3>color</h3>
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L201">lib/starling/styles/MeshStyle.d.ts:201</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="indexdata" class="tsd-anchor"></a>
<h3>index<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">index<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.indexdata.html" class="tsd-signature-type">IndexData</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#indexdata">indexData</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L192">lib/starling/styles/MeshStyle.d.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a reference to the index data of the assigned target (or <code>null</code>
if there is no target). Beware: the style itself does not own any indices;
it is limited to manipulating those of the target mesh.</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#L145">lib/starling/styles/DistanceFieldStyle.d.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current render mode. It's recommended to use one of the 'setup...'-methods to
change the mode, as those provide useful standard settings, as well. @default basic</p>
</div>
</div>
</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#L151">lib/starling/styles/DistanceFieldStyle.d.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the distance field texture utilizes multiple channels. This improves
render quality, but requires specially created DF textures. @default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="outeralphaend" class="tsd-anchor"></a>
<h3>outer<wbr>Alpha<wbr>End</h3>
<div class="tsd-signature tsd-kind-icon">outer<wbr>Alpha<wbr>End<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#L190">lib/starling/styles/DistanceFieldStyle.d.ts:190</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The alpha value on the outer side of the outer area's gradient.
Used for outline, glow, and drop shadow modes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="outeralphastart" class="tsd-anchor"></a>
<h3>outer<wbr>Alpha<wbr>Start</h3>
<div class="tsd-signature tsd-kind-icon">outer<wbr>Alpha<wbr>Start<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#L184">lib/starling/styles/DistanceFieldStyle.d.ts:184</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The alpha value on the inner side of the outer area's gradient.
Used for outline, glow, and drop shadow modes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="outercolor" class="tsd-anchor"></a>
<h3>outer<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">outer<wbr>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/styles/DistanceFieldStyle.d.ts#L196">lib/starling/styles/DistanceFieldStyle.d.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The color with which the outer area (outline, glow, or drop shadow) will be filled.
Ignored in 'basic' mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="outerthreshold" class="tsd-anchor"></a>
<h3>outer<wbr>Threshold</h3>
<div class="tsd-signature tsd-kind-icon">outer<wbr>Threshold<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#L178">lib/starling/styles/DistanceFieldStyle.d.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The threshold that determines where the outer area (outline, glow, or drop shadow)
ends. Ignored in 'basic' mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="shadowoffsetx" class="tsd-anchor"></a>
<h3>shadow<wbr>OffsetX</h3>
<div class="tsd-signature tsd-kind-icon">shadow<wbr>OffsetX<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#L203">lib/starling/styles/DistanceFieldStyle.d.ts:203</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The x-offset of the shadow in points. Note that certain combinations of offset and
blur value can lead the shadow to be cut off at the edges. Reduce blur or offset to
counteract.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="shadowoffsety" class="tsd-anchor"></a>
<h3>shadow<wbr>OffsetY</h3>
<div class="tsd-signature tsd-kind-icon">shadow<wbr>OffsetY<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#L210">lib/starling/styles/DistanceFieldStyle.d.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The y-offset of the shadow in points. Note that certain combinations of offset and
blur value can lead the shadow to be cut off at the edges. Reduce blur or offset to
counteract.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="softness" class="tsd-anchor"></a>
<h3>softness</h3>
<div class="tsd-signature tsd-kind-icon">softness<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#L166">lib/starling/styles/DistanceFieldStyle.d.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates how soft the transition between inside and outside should be rendered.
A value of '0' will lead to a hard, jagged edge; '1' will be just as blurry as the
actual distance field texture. The recommend value should be <code>1.0 / spread</code>
(you determine the spread when creating the distance field texture). @default 0.125</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="target" class="tsd-anchor"></a>
<h3>target</h3>
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="starling.display.mesh.html" class="tsd-signature-type">Mesh</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#target">target</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L226">lib/starling/styles/MeshStyle.d.ts:226</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The target the style is currently assigned to.</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="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.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#texture">texture</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L210">lib/starling/styles/MeshStyle.d.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The texture that is mapped to the mesh (or <code>null</code>, if there is none).</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.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#texturerepeat">textureRepeat</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L221">lib/starling/styles/MeshStyle.d.ts:221</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.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#texturesmoothing">textureSmoothing</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L215">lib/starling/styles/MeshStyle.d.ts:215</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-external">
<a name="threshold" class="tsd-anchor"></a>
<h3>threshold</h3>
<div class="tsd-signature tsd-kind-icon">threshold<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#L158">lib/starling/styles/DistanceFieldStyle.d.ts:158</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The threshold that will separate the inside from the outside of the shape. On the
distance field texture, '0' means completely outside, '1' completely inside; the
actual edge runs along '0.5'. @default 0.5</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="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L196">lib/starling/styles/MeshStyle.d.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The actual class of this style.</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="vertexdata" class="tsd-anchor"></a>
<h3>vertex<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">vertex<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="starling.rendering.vertexdata.html" class="tsd-signature-type">VertexData</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#vertexdata">vertexData</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L186">lib/starling/styles/MeshStyle.d.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a reference to the vertex data of the assigned target (or <code>null</code>
if there is no target). Beware: the style itself does not own any vertices;
it is limited to manipulating those of the target mesh.</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.styles.meshstyle.html">MeshStyle</a>.<a href="starling.styles.meshstyle.html#vertexformat">vertexFormat</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/styles/MeshStyle.d.ts#L206">lib/starling/styles/MeshStyle.d.ts:206</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The format used to store the vertices.</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="mode_basic" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MODE_<wbr>BASIC</h3>
<div class="tsd-signature tsd-kind-icon">MODE_<wbr>BASIC<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#L77">lib/starling/styles/DistanceFieldStyle.d.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Basic distance field rendering, without additional effects.</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="mode_glow" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MODE_<wbr>GLOW</h3>
<div class="tsd-signature tsd-kind-icon">MODE_<wbr>GLOW<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#L83">lib/starling/styles/DistanceFieldStyle.d.ts:83</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a smooth glow effect around the shape.</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="mode_outline" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MODE_<wbr>OUTLINE</h3>
<div class="tsd-signature tsd-kind-icon">MODE_<wbr>OUTLINE<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#L80">lib/starling/styles/DistanceFieldStyle.d.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds an outline around the edge of the shape.</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="mode_shadow" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MODE_<wbr>SHADOW</h3>
<div class="tsd-signature tsd-kind-icon">MODE_<wbr>SHADOW<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#L86">lib/starling/styles/DistanceFieldStyle.d.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a drop shadow behind the shape.</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">:</