<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>pixie/blends</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
<script type="text/javascript" src="../dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
toggleSwitch.addEventListener('change', switchTheme, false);
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark') {
toggleSwitch.checked = true;
}
}
}
</script>
</head>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/blends</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
<em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#BlendMode"
title="BlendMode = enum
bmNormal, bmDarken, bmMultiply, bmColorBurn, bmLighten, bmScreen,
bmColorDodge, bmOverlay, bmSoftLight, bmHardLight, bmDifference, bmExclusion,
bmHue, bmSaturation, bmColor, bmLuminosity, bmMask, ## Special blend mode that is used for masking
bmOverwrite, ## Special blend mode that just copies pixels
bmSubtractMask, ## Inverse mask
bmIntersectMask, bmExcludeMask">BlendMode</a></li>
<li><a class="reference" href="#Blender"
title="Blender = proc (backdrop, source: ColorRGBX): ColorRGBX">Blender</a></li>
<li><a class="reference" href="#Masker"
title="Masker = proc (backdrop, source: uint8): uint8">Masker</a></li>
<li><a class="reference" href="#BlenderSimd"
title="BlenderSimd = proc (blackdrop, source: M128i): M128i">BlenderSimd</a></li>
<li><a class="reference" href="#MaskerSimd"
title="MaskerSimd = proc (blackdrop, source: M128i): M128i">MaskerSimd</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">blender
<li><a class="reference" href="#blender%2CBlendMode"
title="blender(blendMode: BlendMode): Blender">blender,<wbr>BlendMode</a></li>
</ul>
<ul class="simple nested-toc-section">blendAlpha
<li><a class="reference" href="#blendAlpha%2Cuint8%2Cuint8"
title="blendAlpha(backdrop, source: uint8): uint8">blendAlpha,<wbr>uint8,<wbr>uint8</a></li>
</ul>
<ul class="simple nested-toc-section">hasSimdMasker
<li><a class="reference" href="#hasSimdMasker%2CBlendMode"
title="hasSimdMasker(blendMode: BlendMode): bool">hasSimdMasker,<wbr>BlendMode</a></li>
</ul>
<ul class="simple nested-toc-section">blenderSimd
<li><a class="reference" href="#blenderSimd%2CBlendMode"
title="blenderSimd(blendMode: BlendMode): BlenderSimd">blenderSimd,<wbr>BlendMode</a></li>
</ul>
<ul class="simple nested-toc-section">hasSimdBlender
<li><a class="reference" href="#hasSimdBlender%2CBlendMode"
title="hasSimdBlender(blendMode: BlendMode): bool">hasSimdBlender,<wbr>BlendMode</a></li>
</ul>
<ul class="simple nested-toc-section">masker
<li><a class="reference" href="#masker%2CBlendMode"
title="masker(blendMode: BlendMode): Masker">masker,<wbr>BlendMode</a></li>
</ul>
<ul class="simple nested-toc-section">maskerSimd
<li><a class="reference" href="#maskerSimd%2CBlendMode"
title="maskerSimd(blendMode: BlendMode): MaskerSimd">maskerSimd,<wbr>BlendMode</a></li>
</ul>
</ul>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">Blending modes.</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="common.html">common</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<a id="BlendMode"></a>
<dt><pre><a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">bmNormal</span><span class="Other">,</span> <span class="Identifier">bmDarken</span><span class="Other">,</span> <span class="Identifier">bmMultiply</span><span class="Other">,</span> <span class="Identifier">bmColorBurn</span><span class="Other">,</span> <span class="Identifier">bmLighten</span><span class="Other">,</span> <span class="Identifier">bmScreen</span><span class="Other">,</span>
<span class="Identifier">bmColorDodge</span><span class="Other">,</span> <span class="Identifier">bmOverlay</span><span class="Other">,</span> <span class="Identifier">bmSoftLight</span><span class="Other">,</span> <span class="Identifier">bmHardLight</span><span class="Other">,</span> <span class="Identifier">bmDifference</span><span class="Other">,</span> <span class="Identifier">bmExclusion</span><span class="Other">,</span>
<span class="Identifier">bmHue</span><span class="Other">,</span> <span class="Identifier">bmSaturation</span><span class="Other">,</span> <span class="Identifier">bmColor</span><span class="Other">,</span> <span class="Identifier">bmLuminosity</span><span class="Other">,</span> <span class="Identifier">bmMask</span><span class="Other">,</span> <span class="Comment">## Special blend mode that is used for masking</span>
<span class="Identifier">bmOverwrite</span><span class="Other">,</span> <span class="Comment">## Special blend mode that just copies pixels</span>
<span class="Identifier">bmSubtractMask</span><span class="Other">,</span> <span class="Comment">## Inverse mask</span>
<span class="Identifier">bmIntersectMask</span><span class="Other">,</span> <span class="Identifier">bmExcludeMask</span></pre></dt>
<dd>
</dd>
<a id="Blender"></a>
<dt><pre><a href="blends.html#Blender"><span class="Identifier">Blender</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">backdrop</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">ColorRGBX</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ColorRGBX</span></pre></dt>
<dd>
Function signature returned by blender.
</dd>
<a id="Masker"></a>
<dt><pre><a href="blends.html#Masker"><span class="Identifier">Masker</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">backdrop</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">uint8</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint8</span></pre></dt>
<dd>
Function signature returned by masker.
</dd>
<a id="BlenderSimd"></a>
<dt><pre><a href="blends.html#BlenderSimd"><span class="Identifier">BlenderSimd</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">blackdrop</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">M128i</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">M128i</span></pre></dt>
<dd>
Function signature returned by blenderSimd.
</dd>
<a id="MaskerSimd"></a>
<dt><pre><a href="blends.html#MaskerSimd"><span class="Identifier">MaskerSimd</span></a> <span class="Other">=</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">blackdrop</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">M128i</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">M128i</span></pre></dt>
<dd>
Function signature returned by maskerSimd.
</dd>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="blendAlpha,uint8,uint8"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#blendAlpha%2Cuint8%2Cuint8"><span class="Identifier">blendAlpha</span></a><span class="Other">(</span><span class="Identifier">backdrop</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <span class="Identifier">uint8</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint8</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Blends alphas of backdrop, source.
</dd>
<a id="blender,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#blender%2CBlendMode"><span class="Identifier">blender</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="blends.html#Blender"><span class="Identifier">Blender</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="masker,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#masker%2CBlendMode"><span class="Identifier">masker</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="blends.html#Masker"><span class="Identifier">Masker</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">PixieError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="blenderSimd,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#blenderSimd%2CBlendMode"><span class="Identifier">blenderSimd</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="blends.html#BlenderSimd"><span class="Identifier">BlenderSimd</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">PixieError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="hasSimdBlender,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#hasSimdBlender%2CBlendMode"><span class="Identifier">hasSimdBlender</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Is there a blend function for a given blend mode with SIMD support?
</dd>
<a id="maskerSimd,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#maskerSimd%2CBlendMode"><span class="Identifier">maskerSimd</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <a href="blends.html#MaskerSimd"><span class="Identifier">MaskerSimd</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">PixieError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="hasSimdMasker,BlendMode"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#hasSimdMasker%2CBlendMode"><span class="Identifier">hasSimdMasker</span></a><span class="Other">(</span><span class="Identifier">blendMode</span><span class="Other">:</span> <a href="blends.html#BlendMode"><span class="Identifier">BlendMode</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Is there a blend masking function with SIMD support?
</dd>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-03-12 03:47:39 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>