starling-framework
Version:
A fast, productive library for 2D cross-platform development.
704 lines • 129 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DisplacementMapFilter | 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.filters.html">filters</a>
</li>
<li>
<a href="starling.filters.displacementmapfilter.html">DisplacementMapFilter</a>
</li>
</ul>
<h1>Class DisplacementMapFilter</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 DisplacementMapFilter class uses the pixel values from the specified texture (called
the map texture) to perform a displacement of an object. You can use this filter
to apply a warped or mottled effect to any object that inherits from the DisplayObject
class.</p>
</div>
<p>The filter uses the following formula:</p>
<listing>dstPixel[x, y] = srcPixel[x + ((componentX(x, y) - 128) * scaleX) / 256,
y + ((componentY(x, y) - 128) * scaleY) / 256]
</listing>
<p>Where <code>componentX(x, y)</code> gets the componentX property color value from the
map texture at <code>(x - mapX, y - mapY)</code>.</p>
<p> <strong>Clamping to the Edges</strong></p>
<p>Per default, the filter allows the object to grow beyond its actual bounds to make
room for the displacement (depending on <code>scaleX/Y</code>). If you want to clamp the
displacement to the actual object bounds, set all margins to zero via a call to
<code>filter.padding.setTo()</code>. This works only with rectangular, stage-aligned
objects, though.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.filters.fragmentfilter.html" class="tsd-signature-type">FragmentFilter</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DisplacementMapFilter</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.filters.displacementmapfilter.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.filters.displacementmapfilter.html#alwaysdrawtobackbuffer" class="tsd-kind-icon">always<wbr>Draw<wbr>ToBack<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#antialiasing" class="tsd-kind-icon">anti<wbr>Aliasing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#componentx" class="tsd-kind-icon">componentX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#componenty" class="tsd-kind-icon">componentY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#dispeffect" class="tsd-kind-icon">disp<wbr>Effect</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#iscached" class="tsd-kind-icon">is<wbr>Cached</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#maintainresolutionacrosspasses" class="tsd-kind-icon">maintain<wbr>Resolution<wbr>Across<wbr>Passes</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#maprepeat" class="tsd-kind-icon">map<wbr>Repeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#maptexture" class="tsd-kind-icon">map<wbr>Texture</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#mapx" class="tsd-kind-icon">mapX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#mapy" class="tsd-kind-icon">mapY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#padding" class="tsd-kind-icon">padding</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#resolution" class="tsd-kind-icon">resolution</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.html#scalex" class="tsd-kind-icon">scaleX</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.html#textureformat" class="tsd-kind-icon">texture<wbr>Format</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#texturesmoothing" class="tsd-kind-icon">texture<wbr>Smoothing</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-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.html#cache" class="tsd-kind-icon">cache</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.html#clearcache" class="tsd-kind-icon">clear<wbr>Cache</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.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.filters.displacementmapfilter.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.filters.displacementmapfilter.html#get_alwaysdrawtobackbuffer" class="tsd-kind-icon">get_<wbr>always<wbr>Draw<wbr>ToBack<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.filters.displacementmapfilter.html#get_antialiasing" class="tsd-kind-icon">get_<wbr>anti<wbr>Aliasing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_componentx" class="tsd-kind-icon">get_<wbr>componentX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_componenty" class="tsd-kind-icon">get_<wbr>componentY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_dispeffect" class="tsd-kind-icon">get_<wbr>disp<wbr>Effect</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_iscached" class="tsd-kind-icon">get_<wbr>is<wbr>Cached</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_maintainresolutionacrosspasses" class="tsd-kind-icon">get_<wbr>maintain<wbr>Resolution<wbr>Across<wbr>Passes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_maprepeat" class="tsd-kind-icon">get_<wbr>map<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_maptexture" class="tsd-kind-icon">get_<wbr>map<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_mapx" class="tsd-kind-icon">get_<wbr>mapX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_mapy" class="tsd-kind-icon">get_<wbr>mapY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_padding" class="tsd-kind-icon">get_<wbr>padding</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_resolution" class="tsd-kind-icon">get_<wbr>resolution</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#get_scalex" class="tsd-kind-icon">get_<wbr>scaleX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.html#get_textureformat" class="tsd-kind-icon">get_<wbr>texture<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.filters.displacementmapfilter.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-external"><a href="starling.filters.displacementmapfilter.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-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#process" class="tsd-kind-icon">process</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.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.filters.displacementmapfilter.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.filters.displacementmapfilter.html#set_alwaysdrawtobackbuffer" class="tsd-kind-icon">set_<wbr>always<wbr>Draw<wbr>ToBack<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.filters.displacementmapfilter.html#set_antialiasing" class="tsd-kind-icon">set_<wbr>anti<wbr>Aliasing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_componentx" class="tsd-kind-icon">set_<wbr>componentX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_componenty" class="tsd-kind-icon">set_<wbr>componentY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_maintainresolutionacrosspasses" class="tsd-kind-icon">set_<wbr>maintain<wbr>Resolution<wbr>Across<wbr>Passes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_maprepeat" class="tsd-kind-icon">set_<wbr>map<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_maptexture" class="tsd-kind-icon">set_<wbr>map<wbr>Texture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_mapx" class="tsd-kind-icon">set_<wbr>mapX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_mapy" class="tsd-kind-icon">set_<wbr>mapY</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_padding" class="tsd-kind-icon">set_<wbr>padding</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_resolution" class="tsd-kind-icon">set_<wbr>resolution</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.html#set_scalex" class="tsd-kind-icon">set_<wbr>scaleX</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.filters.displacementmapfilter.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.filters.displacementmapfilter.html#set_textureformat" class="tsd-kind-icon">set_<wbr>texture<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.filters.displacementmapfilter.html#set_texturesmoothing" class="tsd-kind-icon">set_<wbr>texture<wbr>Smoothing</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>Displacement<wbr>Map<wbr>Filter<span class="tsd-signature-symbol">(</span>mapTexture<span class="tsd-signature-symbol">: </span><a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a>, componentX<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, componentY<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, scaleX<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, scaleY<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.filters.displacementmapfilter.html" class="tsd-signature-type">DisplacementMapFilter</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/DisplacementMapFilter.d.ts#L34">lib/starling/filters/DisplacementMapFilter.d.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new displacement map filter that uses the provided map texture.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mapTexture: <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> componentX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> componentY: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scaleX: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scaleY: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.filters.displacementmapfilter.html" class="tsd-signature-type">DisplacementMapFilter</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="alwaysdrawtobackbuffer" class="tsd-anchor"></a>
<h3>always<wbr>Draw<wbr>ToBack<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">always<wbr>Draw<wbr>ToBack<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#alwaysdrawtobackbuffer">alwaysDrawToBackBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L214">lib/starling/filters/FragmentFilter.d.ts:214</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the last filter pass is always drawn directly to the back buffer.</p>
</div>
<p>Per default, the filter tries to automatically render in a smart way: objects that
are currently moving are rendered to the back buffer, objects that are static are
rendered into a texture first, which allows the filter to be drawn directly from the
render cache in the next frame (in case the object remains static).</p>
<p>However, this fails when filters are added to an object that does not support the
render cache, or to a container with such a child (e.g. a Sprite3D object or a masked
display object). In such a case, enable this property for maximum performance.</p>
<p> @default false</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="antialiasing" class="tsd-anchor"></a>
<h3>anti<wbr>Aliasing</h3>
<div class="tsd-signature tsd-kind-icon">anti<wbr>Aliasing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#antialiasing">antiAliasing</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L187">lib/starling/filters/FragmentFilter.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The anti-aliasing level. This is only used for rendering the target object
into a texture, not for the filter passes. 0 - none, 4 - maximum. @default 0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="componentx" class="tsd-anchor"></a>
<h3>componentX</h3>
<div class="tsd-signature tsd-kind-icon">componentX<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/filters/DisplacementMapFilter.d.ts#L49">lib/starling/filters/DisplacementMapFilter.d.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Describes which color channel to use in the map image to displace the x result.
Possible values are constants from the BitmapDataChannel class.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="componenty" class="tsd-anchor"></a>
<h3>componentY</h3>
<div class="tsd-signature tsd-kind-icon">componentY<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/filters/DisplacementMapFilter.d.ts#L55">lib/starling/filters/DisplacementMapFilter.d.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Describes which color channel to use in the map image to displace the y result.
Possible values are constants from the BitmapDataChannel class.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="dispeffect" class="tsd-anchor"></a>
<h3>disp<wbr>Effect</h3>
<div class="tsd-signature tsd-kind-icon">disp<wbr>Effect<span class="tsd-signature-symbol">:</span> <a href="starling.filters.displacementmapeffect.html" class="tsd-signature-type">DisplacementMapEffect</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/DisplacementMapFilter.d.ts#L91">lib/starling/filters/DisplacementMapFilter.d.ts:91</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="iscached" class="tsd-anchor"></a>
<h3>is<wbr>Cached</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Cached<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#iscached">isCached</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L158">lib/starling/filters/FragmentFilter.d.ts:158</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the filter is cached (via the <code>cache</code> method).</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="maintainresolutionacrosspasses" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> maintain<wbr>Resolution<wbr>Across<wbr>Passes</h3>
<div class="tsd-signature tsd-kind-icon">maintain<wbr>Resolution<wbr>Across<wbr>Passes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#maintainresolutionacrosspasses">maintainResolutionAcrossPasses</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L181">lib/starling/filters/FragmentFilter.d.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the filter requires all passes to be processed with the exact same
resolution.</p>
</div>
<p>Some filters must use the same resolution for input and output; e.g. the blur filter
is very sensitive to changes of pixel / texel sizes. When the filter is used as part
of a filter chain, or if its last pass is drawn directly to the back buffer, such a
filter produces artifacts. In that case, the filter author must set this property
to <code>true</code>.</p>
<p> @default false</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="maprepeat" class="tsd-anchor"></a>
<h3>map<wbr>Repeat</h3>
<div class="tsd-signature tsd-kind-icon">map<wbr>Repeat<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/filters/DisplacementMapFilter.d.ts#L87">lib/starling/filters/DisplacementMapFilter.d.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if pixels at the edge of the map texture will be repeated.
Note that this only works if the map texture is a power-of-two texture!</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="maptexture" class="tsd-anchor"></a>
<h3>map<wbr>Texture</h3>
<div class="tsd-signature tsd-kind-icon">map<wbr>Texture<span class="tsd-signature-symbol">:</span> <a href="starling.textures.texture.html" class="tsd-signature-type">Texture</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/DisplacementMapFilter.d.ts#L80">lib/starling/filters/DisplacementMapFilter.d.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The texture that will be used to calculate displacement.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="mapx" class="tsd-anchor"></a>
<h3>mapX</h3>
<div class="tsd-signature tsd-kind-icon">mapX<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/filters/DisplacementMapFilter.d.ts#L70">lib/starling/filters/DisplacementMapFilter.d.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The horizontal offset of the map texture relative to the origin. @default 0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="mapy" class="tsd-anchor"></a>
<h3>mapY</h3>
<div class="tsd-signature tsd-kind-icon">mapY<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/filters/DisplacementMapFilter.d.ts#L75">lib/starling/filters/DisplacementMapFilter.d.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The vertical offset of the map texture relative to the origin. @default 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="padding" class="tsd-anchor"></a>
<h3>padding</h3>
<div class="tsd-signature tsd-kind-icon">padding<span class="tsd-signature-symbol">:</span> <a href="starling.utils.padding.html" class="tsd-signature-type">Padding</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#padding">padding</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L152">lib/starling/filters/FragmentFilter.d.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Padding can extend the size of the filter texture in all directions.
That's useful when the filter "grows" the bounds of the object in any direction.</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="resolution" class="tsd-anchor"></a>
<h3>resolution</h3>
<div class="tsd-signature tsd-kind-icon">resolution<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#resolution">resolution</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L166">lib/starling/filters/FragmentFilter.d.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resolution of the filter texture. "1" means stage resolution, "0.5" half the stage
resolution. A lower resolution saves memory and execution time, but results in a lower
output quality. Values greater than 1 are allowed; such values might make sense for a
cached filter when it is scaled up. @default 1</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="scalex" class="tsd-anchor"></a>
<h3>scaleX</h3>
<div class="tsd-signature tsd-kind-icon">scaleX<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/filters/DisplacementMapFilter.d.ts#L60">lib/starling/filters/DisplacementMapFilter.d.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The multiplier used to scale the x displacement result from the map calculation.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="scaley" class="tsd-anchor"></a>
<h3>scaleY</h3>
<div class="tsd-signature tsd-kind-icon">scaleY<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/filters/DisplacementMapFilter.d.ts#L65">lib/starling/filters/DisplacementMapFilter.d.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The multiplier used to scale the y displacement result from the map calculation.</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="textureformat" class="tsd-anchor"></a>
<h3>texture<wbr>Format</h3>
<div class="tsd-signature tsd-kind-icon">texture<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#textureformat">textureFormat</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L197">lib/starling/filters/FragmentFilter.d.ts:197</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The format of the filter texture. @default BGRA</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.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#texturesmoothing">textureSmoothing</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L192">lib/starling/filters/FragmentFilter.d.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The smoothing mode of the filter texture. @default bilinear</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-protected tsd-is-external">
<a name="addeventlistener" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> add<wbr>Event<wbr>Listener</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</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.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#addeventlistener">addEventListener</a></p>
<p>Overrides <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L143">lib/starling/filters/FragmentFilter.d.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="cache" class="tsd-anchor"></a>
<h3>cache</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">cache<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.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#cache">cache</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L134">lib/starling/filters/FragmentFilter.d.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Caches the filter output into a texture.</p>
</div>
<p>An uncached filter is rendered every frame (except if it can be rendered from the
global render cache, which happens if the target object does not change its appearance
or location relative to the stage). A cached filter is only rendered once; the output
stays unchanged until you call <code>cache</code> again or change the filter settings.
</p>
<p>Beware: you cannot cache filters on 3D objects; if the object the filter is attached
to is a Sprite3D or has a Sprite3D as (grand-) parent, the request will be silently
ignored. However, you <em>can</em> cache a 2D object that has 3D children!</p>
</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-external">
<a name="clearcache" class="tsd-anchor"></a>
<h3>clear<wbr>Cache</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">clear<wbr>Cache<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.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#clearcache">clearCache</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L138">lib/starling/filters/FragmentFilter.d.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Clears the cached output of the filter. After calling this method, the filter will be
processed once per frame again.</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-external">
<a name="dispatchevent" class="tsd-anchor"></a>
<h3>dispatch<wbr>Event</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">dispatch<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="starling.events.event.html" class="tsd-signature-type">Event</a><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.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#dispatchevent">dispatchEvent</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EventDispatcher.d.ts#L45">lib/starling/events/EventDispatcher.d.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispatches an event to all objects that have registered listeners for its type.
If an event with enabled 'bubble' property is dispatched to a display object, it will
travel up along the line of parents, until it either hits the root object or someone
stops its propagation manually.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <a href="starling.events.event.html" class="tsd-signature-type">Event</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="dispatcheventwith" class="tsd-anchor"></a>
<h3>dispatch<wbr>Event<wbr>With</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">dispatch<wbr>Event<wbr>With<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bubbles<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#dispatcheventwith">dispatchEventWith</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EventDispatcher.d.ts#L50">lib/starling/events/EventDispatcher.d.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. The method uses an internal pool of event objects to
avoid allocations.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> bubbles: <span class="tsd-signature-type">boolean</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <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-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.filters.fragmentfilter.html">FragmentFilter</a>.<a href="starling.filters.fragmentfilter.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/filters/FragmentFilter.d.ts#L94">lib/starling/filters/FragmentFilter.d.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Disposes all resources that have been created by the filter.</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_alwaysdrawtobackbuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>always<wbr>Draw<wbr>ToBack<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>always<wbr>Draw<wbr>ToBack<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li