592 lines
32 KiB
HTML
592 lines
32 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>BlendMode | openfl</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">openfl</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">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.display.html">display</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.display.blendmode.html">BlendMode</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Enumeration 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. These
|
|
constants are used in the following:</p>
|
|
</div>
|
|
<ul>
|
|
<li>The <code>blendMode</code> property of the
|
|
openfl.display.DisplayObject class.</li>
|
|
<li>The <code>blendMode</code> parameter of the <code>draw()</code>
|
|
method of the openfl.display.BitmapData class</li>
|
|
</ul>
|
|
</div>
|
|
</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>Enumeration members</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#add" class="tsd-kind-icon">ADD</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#alpha" class="tsd-kind-icon">ALPHA</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#darken" class="tsd-kind-icon">DARKEN</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#difference" class="tsd-kind-icon">DIFFERENCE</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#erase" class="tsd-kind-icon">ERASE</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#hardlight" class="tsd-kind-icon">HARDLIGHT</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#invert" class="tsd-kind-icon">INVERT</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#layer" class="tsd-kind-icon">LAYER</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#lighten" class="tsd-kind-icon">LIGHTEN</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#multiply" class="tsd-kind-icon">MULTIPLY</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#normal" class="tsd-kind-icon">NORMAL</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#overlay" class="tsd-kind-icon">OVERLAY</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#screen" class="tsd-kind-icon">SCREEN</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#shader" class="tsd-kind-icon">SHADER</a></li>
|
|
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="openfl.display.blendmode.html#subtract" class="tsd-kind-icon">SUBTRACT</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Enumeration members</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="add" class="tsd-anchor"></a>
|
|
<h3>ADD</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ADD<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "add"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L25">lib/openfl/display/BlendMode.d.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Adds the values of the constituent colors of the display object to the
|
|
colors of its background, applying a ceiling of 0xFF. This setting is
|
|
commonly used for animating a lightening dissolve between two objects.</p>
|
|
</div>
|
|
<p>For example, if the display object has a pixel with an RGB value of
|
|
0xAAA633, and the background pixel has an RGB value of 0xDD2200, the
|
|
resulting RGB value for the displayed pixel is 0xFFC833(because 0xAA +
|
|
0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum 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-symbol"> = "alpha"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L35">lib/openfl/display/BlendMode.d.ts:35</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Applies the alpha value of each pixel of the display object to the
|
|
background. This requires the <code>blendMode</code> property of the
|
|
parent display object be set to
|
|
<code>openfl.display.BlendMode.LAYER</code>.</p>
|
|
</div>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="darken" class="tsd-anchor"></a>
|
|
<h3>DARKEN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DARKEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "darken"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L49">lib/openfl/display/BlendMode.d.ts:49</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Selects the darker of the constituent colors of the display object and the
|
|
colors of the background(the colors with the smaller values). This
|
|
setting is commonly used for superimposing type.</p>
|
|
</div>
|
|
<p>For example, if the display object has a pixel with an RGB value of
|
|
0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the
|
|
resulting RGB value for the displayed pixel is 0xDDCC00(because 0xFF >
|
|
0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33).</p>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="difference" class="tsd-anchor"></a>
|
|
<h3>DIFFERENCE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">DIFFERENCE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "difference"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L62">lib/openfl/display/BlendMode.d.ts:62</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Compares the constituent colors of the display object with the colors of
|
|
its background, and subtracts the darker of the values of the two
|
|
constituent colors from the lighter value. This setting is commonly used
|
|
for more vibrant colors.</p>
|
|
</div>
|
|
<p>For example, if the display object has a pixel with an RGB value of
|
|
0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the
|
|
resulting RGB value for the displayed pixel is 0x222C33(because 0xFF -
|
|
0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="erase" class="tsd-anchor"></a>
|
|
<h3>ERASE</h3>
|
|
<div class="tsd-signature tsd-kind-icon">ERASE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "erase"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L71">lib/openfl/display/BlendMode.d.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Erases the background based on the alpha value of the display object. This
|
|
process requires that the <code>blendMode</code> property of the parent
|
|
display object be set to <code>openfl.display.BlendMode.LAYER</code>.</p>
|
|
</div>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="hardlight" class="tsd-anchor"></a>
|
|
<h3>HARDLIGHT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">HARDLIGHT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "hardlight"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L83">lib/openfl/display/BlendMode.d.ts:83</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Adjusts the color of each pixel based on the darkness of the display
|
|
object. If the display object is lighter than 50% gray, the display object
|
|
and background colors are screened, which results in a lighter color. If
|
|
the display object is darker than 50% gray, the colors are multiplied,
|
|
which results in a darker color. This setting is commonly used for shading
|
|
effects.</p>
|
|
</div>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="invert" class="tsd-anchor"></a>
|
|
<h3>INVERT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">INVERT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "invert"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L88">lib/openfl/display/BlendMode.d.ts:88</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Inverts the background.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="layer" class="tsd-anchor"></a>
|
|
<h3>LAYER</h3>
|
|
<div class="tsd-signature tsd-kind-icon">LAYER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "layer"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L100">lib/openfl/display/BlendMode.d.ts:100</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Forces the creation of a transparency group for the display object. This
|
|
means that the display object is precomposed in a temporary buffer before
|
|
it is processed further. The precomposition is done automatically if the
|
|
display object is precached by means of bitmap caching or if the display
|
|
object is a display object container that has at least one child object
|
|
with a <code>blendMode</code> setting other than <code>"normal"</code>.</p>
|
|
</div>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="lighten" class="tsd-anchor"></a>
|
|
<h3>LIGHTEN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">LIGHTEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "lighten"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L114">lib/openfl/display/BlendMode.d.ts:114</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Selects the lighter of the constituent colors of the display object and
|
|
the colors of the background(the colors with the larger values). This
|
|
setting is commonly used for superimposing type.</p>
|
|
</div>
|
|
<p>For example, if the display object has a pixel with an RGB value of
|
|
0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the
|
|
resulting RGB value for the displayed pixel is 0xFFF833(because 0xFF >
|
|
0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33).</p>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="multiply" class="tsd-anchor"></a>
|
|
<h3>MULTIPLY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">MULTIPLY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "multiply"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L129">lib/openfl/display/BlendMode.d.ts:129</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Multiplies the values of the display object constituent colors by the
|
|
constituent colors of the background color, and normalizes by dividing by
|
|
0xFF, resulting in darker colors. This setting is commonly used for
|
|
shadows and depth effects.</p>
|
|
</div>
|
|
<p>For example, if a constituent color(such as red) of one pixel in the
|
|
display object and the corresponding color of the pixel in the background
|
|
both have the value 0x88, the multiplied result is 0x4840. Dividing by
|
|
0xFF yields a value of 0x48 for that constituent color, which is a darker
|
|
shade than the color of the display object or the color of the
|
|
background.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="normal" class="tsd-anchor"></a>
|
|
<h3>NORMAL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">NORMAL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "normal"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L136">lib/openfl/display/BlendMode.d.ts:136</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The display object appears in front of the background. Pixel values of the
|
|
display object override the pixel values of the background. Where the
|
|
display object is transparent, the background is visible.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="overlay" class="tsd-anchor"></a>
|
|
<h3>OVERLAY</h3>
|
|
<div class="tsd-signature tsd-kind-icon">OVERLAY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "overlay"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L148">lib/openfl/display/BlendMode.d.ts:148</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Adjusts the color of each pixel based on the darkness of the background.
|
|
If the background is lighter than 50% gray, the display object and
|
|
background colors are screened, which results in a lighter color. If the
|
|
background is darker than 50% gray, the colors are multiplied, which
|
|
results in a darker color. This setting is commonly used for shading
|
|
effects.</p>
|
|
</div>
|
|
<p>Not supported under GPU rendering.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="screen" class="tsd-anchor"></a>
|
|
<h3>SCREEN</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SCREEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "screen"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L156">lib/openfl/display/BlendMode.d.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Multiplies the complement(inverse) of the display object color by the
|
|
complement of the background color, resulting in a bleaching effect. This
|
|
setting is commonly used for highlights or to remove black areas of the
|
|
display object.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="shader" class="tsd-anchor"></a>
|
|
<h3>SHADER</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SHADER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "shader"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L158">lib/openfl/display/BlendMode.d.ts:158</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a name="subtract" class="tsd-anchor"></a>
|
|
<h3>SUBTRACT</h3>
|
|
<div class="tsd-signature tsd-kind-icon">SUBTRACT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "subtract"</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/BlendMode.d.ts#L170">lib/openfl/display/BlendMode.d.ts:170</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Subtracts the values of the constituent colors in the display object from
|
|
the values of the background color, applying a floor of 0. This setting is
|
|
commonly used for animating a darkening dissolve between two objects.</p>
|
|
</div>
|
|
<p>For example, if the display object has a pixel with an RGB value of
|
|
0xAA2233, and the background pixel has an RGB value of 0xDDA600, the
|
|
resulting RGB value for the displayed pixel is 0x338400(because 0xDD -
|
|
0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).</p>
|
|
</div>
|
|
</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/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.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-enum tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.display.blendmode.html" class="tsd-kind-icon">Blend<wbr>Mode</a>
|
|
<ul>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#add" class="tsd-kind-icon">ADD</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#alpha" class="tsd-kind-icon">ALPHA</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#darken" class="tsd-kind-icon">DARKEN</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#difference" class="tsd-kind-icon">DIFFERENCE</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#erase" class="tsd-kind-icon">ERASE</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#hardlight" class="tsd-kind-icon">HARDLIGHT</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#invert" class="tsd-kind-icon">INVERT</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#layer" class="tsd-kind-icon">LAYER</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#lighten" class="tsd-kind-icon">LIGHTEN</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#multiply" class="tsd-kind-icon">MULTIPLY</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#normal" class="tsd-kind-icon">NORMAL</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#overlay" class="tsd-kind-icon">OVERLAY</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#screen" class="tsd-kind-icon">SCREEN</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#shader" class="tsd-kind-icon">SHADER</a>
|
|
</li>
|
|
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
|
|
<a href="openfl.display.blendmode.html#subtract" class="tsd-kind-icon">SUBTRACT</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</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> |