starling-framework
Version:
A fast, productive library for 2D cross-platform development.
797 lines • 46 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BlendMode | starling-framework</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">starling-framework</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">starling</a>
</li>
<li>
<a href="../modules/starling.display.html">display</a>
</li>
<li>
<a href="starling.display.blendmode.html">BlendMode</a>
</li>
</ul>
<h1>Class BlendMode</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>A class that provides constant values for visual blend mode effects.</p>
</div>
<p>A blend mode is always defined by two 'Context3DBlendFactor' values. A blend factor
represents a particular four-value vector that is multiplied with the source or destination
color in the blending formula. The blending formula is:</p>
<pre>result = source � sourceFactor + destination � destinationFactor</pre>
<p>In the formula, the source color is the output color of the pixel shader program. The
destination color is the color that currently exists in the color buffer, as set by
previous clear and draw operations.</p>
<p>Beware that blending factors produce different output depending on the texture type.
Textures may contain 'premultiplied alpha' (pma), which means that their RGB values were
multiplied with their alpha value (to save processing time). Textures based on 'BitmapData'
objects have premultiplied alpha values, while ATF textures haven't. For this reason,
a blending mode may have different factors depending on the pma value.</p>
<p> @see openfl.display3D.Context3DBlendFactor</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BlendMode</span>
</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-external"><a href="starling.display.blendmode.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.display.blendmode.html#destinationfactor" class="tsd-kind-icon">destination<wbr>Factor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.blendmode.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.display.blendmode.html#sourcefactor" class="tsd-kind-icon">source<wbr>Factor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#add" class="tsd-kind-icon">ADD</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#auto" class="tsd-kind-icon">AUTO</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#below" class="tsd-kind-icon">BELOW</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#erase" class="tsd-kind-icon">ERASE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#mask" class="tsd-kind-icon">MASK</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#multiply" class="tsd-kind-icon">MULTIPLY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#none" class="tsd-kind-icon">NONE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#normal" class="tsd-kind-icon">NORMAL</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#screen" class="tsd-kind-icon">SCREEN</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-external"><a href="starling.display.blendmode.html#activate" class="tsd-kind-icon">activate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.blendmode.html#get_destinationfactor" class="tsd-kind-icon">get_<wbr>destination<wbr>Factor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.blendmode.html#get_name" class="tsd-kind-icon">get_<wbr>name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.display.blendmode.html#get_sourcefactor" class="tsd-kind-icon">get_<wbr>source<wbr>Factor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.display.blendmode.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#getbyfactors" class="tsd-kind-icon">get<wbr>ByFactors</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="starling.display.blendmode.html#register" class="tsd-kind-icon">register</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-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Blend<wbr>Mode<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sourceFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span>, destinationFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a></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/display/BlendMode.d.ts#L36">lib/starling/display/BlendMode.d.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new BlendMode instance. Don't call this method directly; instead,
register a new blend mode using <code>BlendMode.register</code>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>sourceFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
<li>
<h5>destinationFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</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="destinationfactor" class="tsd-anchor"></a>
<h3>destination<wbr>Factor</h3>
<div class="tsd-signature tsd-kind-icon">destination<wbr>Factor<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/display/BlendMode.d.ts#L96">lib/starling/display/BlendMode.d.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The destination blend factor of this blend mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<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/display/BlendMode.d.ts#L100">lib/starling/display/BlendMode.d.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the name of the blend mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="sourcefactor" class="tsd-anchor"></a>
<h3>source<wbr>Factor</h3>
<div class="tsd-signature tsd-kind-icon">source<wbr>Factor<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/display/BlendMode.d.ts#L92">lib/starling/display/BlendMode.d.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The source blend factor of this blend mode.</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="add" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ADD</h3>
<div class="tsd-signature tsd-kind-icon">ADD<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/display/BlendMode.d.ts#L51">lib/starling/display/BlendMode.d.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds the values of the colors of the display object to the colors of its background.</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="auto" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> AUTO</h3>
<div class="tsd-signature tsd-kind-icon">AUTO<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/display/BlendMode.d.ts#L42">lib/starling/display/BlendMode.d.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Inherits the blend mode from this display object's parent.</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="below" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> BELOW</h3>
<div class="tsd-signature tsd-kind-icon">BELOW<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/display/BlendMode.d.ts#L68">lib/starling/display/BlendMode.d.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Draws under/below existing objects; useful especially on RenderTextures.</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="erase" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ERASE</h3>
<div class="tsd-signature tsd-kind-icon">ERASE<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/display/BlendMode.d.ts#L61">lib/starling/display/BlendMode.d.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Erases the background when drawn on a RenderTexture.</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="mask" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MASK</h3>
<div class="tsd-signature tsd-kind-icon">MASK<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/display/BlendMode.d.ts#L65">lib/starling/display/BlendMode.d.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When used on a RenderTexture, the drawn object will act as a mask for the current
content, i.e. the source alpha overwrites the destination alpha.</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="multiply" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> MULTIPLY</h3>
<div class="tsd-signature tsd-kind-icon">MULTIPLY<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/display/BlendMode.d.ts#L54">lib/starling/display/BlendMode.d.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Multiplies the values of the display object colors with the the background color.</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="none" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> NONE</h3>
<div class="tsd-signature tsd-kind-icon">NONE<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/display/BlendMode.d.ts#L45">lib/starling/display/BlendMode.d.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Deactivates blending, i.e. disabling any transparency.</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="normal" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> NORMAL</h3>
<div class="tsd-signature tsd-kind-icon">NORMAL<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/display/BlendMode.d.ts#L48">lib/starling/display/BlendMode.d.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The display object appears in front of the background.</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="screen" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> SCREEN</h3>
<div class="tsd-signature tsd-kind-icon">SCREEN<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/display/BlendMode.d.ts#L58">lib/starling/display/BlendMode.d.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Multiplies the complement (inverse) of the display object color with the complement of
the background color, resulting in a bleaching effect.</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-external">
<a name="activate" class="tsd-anchor"></a>
<h3>activate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">activate<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">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/display/BlendMode.d.ts#L86">lib/starling/display/BlendMode.d.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the appropriate blend factors for source and destination on the current context.</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-protected tsd-is-external">
<a name="get_destinationfactor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>destination<wbr>Factor</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>destination<wbr>Factor<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/display/BlendMode.d.ts#L97">lib/starling/display/BlendMode.d.ts:97</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_name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>name</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>name<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/display/BlendMode.d.ts#L101">lib/starling/display/BlendMode.d.ts:101</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_sourcefactor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>source<wbr>Factor</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>source<wbr>Factor<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/display/BlendMode.d.ts#L93">lib/starling/display/BlendMode.d.ts:93</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-external">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<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/display/BlendMode.d.ts#L89">lib/starling/display/BlendMode.d.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the name of the blend mode.</p>
</div>
</div>
<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-static tsd-is-external">
<a name="get" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>modeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a></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/display/BlendMode.d.ts#L74">lib/starling/display/BlendMode.d.ts:74</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the blend mode with the given name.
Throws an ArgumentError if the mode does not exist.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>modeName: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="getbyfactors" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>ByFactors</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get<wbr>ByFactors<span class="tsd-signature-symbol">(</span>srcFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span>, dstFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Null</span><span class="tsd-signature-symbol"><</span><a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a><span class="tsd-signature-symbol">></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/display/BlendMode.d.ts#L78">lib/starling/display/BlendMode.d.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns allready registered blend mode by
given blend mode factors. Returns null if not exist.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>srcFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
<li>
<h5>dstFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Null</span><span class="tsd-signature-symbol"><</span><a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a name="register" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> register</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, srcFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span>, dstFactor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Context3DBlendFactor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a></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/display/BlendMode.d.ts#L81">lib/starling/display/BlendMode.d.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers a blending mode under a certain name.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>srcFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
<li>
<h5>dstFactor: <span class="tsd-signature-type">Context3DBlendFactor</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.display.blendmode.html" class="tsd-signature-type">BlendMode</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.animation.html">starling.animation</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.assets.html">starling.assets</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.core.html">starling.core</a>
</li>
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.display.html">starling.display</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.errors.html">starling.errors</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.events.html">starling.events</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.extensions.html">starling.extensions</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.filters.html">starling.filters</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.geom.html">starling.geom</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.rendering.html">starling.rendering</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.styles.html">starling.styles</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.text.html">starling.text</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.textures.html">starling.textures</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.utils.html">starling.utils</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.blendmode.html" class="tsd-kind-icon">Blend<wbr>Mode</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#destinationfactor" class="tsd-kind-icon">destination<wbr>Factor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#sourcefactor" class="tsd-kind-icon">source<wbr>Factor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#add" class="tsd-kind-icon">ADD</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#auto" class="tsd-kind-icon">AUTO</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#below" class="tsd-kind-icon">BELOW</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#erase" class="tsd-kind-icon">ERASE</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#mask" class="tsd-kind-icon">MASK</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#multiply" class="tsd-kind-icon">MULTIPLY</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#none" class="tsd-kind-icon">NONE</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#normal" class="tsd-kind-icon">NORMAL</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#screen" class="tsd-kind-icon">SCREEN</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#activate" class="tsd-kind-icon">activate</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a href="starling.display.blendmode.html#get_destinationfactor" class="tsd-kind-icon">get_<wbr>destination<wbr>Factor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a href="starling.display.blendmode.html#get_name" class="tsd-kind-icon">get_<wbr>name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<a href="starling.display.blendmode.html#get_sourcefactor" class="tsd-kind-icon">get_<wbr>source<wbr>Factor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a href="starling.display.blendmode.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#getbyfactors" class="tsd-kind-icon">get<wbr>ByFactors</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external">
<a href="starling.display.blendmode.html#register" class="tsd-kind-icon">register</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.button.html" class="tsd-kind-icon">Button</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.buttonstate.html" class="tsd-kind-icon">Button<wbr>State</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.canvas.html" class="tsd-kind-icon">Canvas</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.displayobject.html" class="tsd-kind-icon">Display<wbr>Object</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.displayobjectcontainer.html" class="tsd-kind-icon">Display<wbr>Object<wbr>Container</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.image.html" class="tsd-kind-icon">Image</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.mesh.html" class="tsd-kind-icon">Mesh</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.meshbatch.html" class="tsd-kind-icon">Mesh<wbr>Batch</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.movieclip.html" class="tsd-kind-icon">Movie<wbr>Clip</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.quad.html" class="tsd-kind-icon">Quad</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.setupautomator.html" class="tsd-kind-icon">Setup<wbr>Automator</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.sprite.html" class="tsd-kind-icon">Sprite</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.sprite3d.html" class="tsd-kind-icon">Sprite3D</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="starling.display.stage.html" class="tsd-kind-icon">Stage</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>