MyouProject/pixie
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

generate docs

Browse source
This commit is contained in:
Ryan Oldenburg 2021-02-25 11:48:34 -06:00
parent 751b804679
commit 3c3cd499ea
17 changed files with 1468 additions and 1439 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2479
docs/dochack.js
View file

File diff suppressed because it is too large Load diff

34
docs/nimdoc.out.css
View file

@ -14,9 +14,6 @@ Modified by Boyd Greenfield and narimiran
--primary-background: #fff;
--secondary-background: ghostwhite;
--third-background: #e8e8e8;
--info-background: #50c050;
--warning-background: #c0a000;
--error-background: #e04040;
--border: #dde;
--text: #222;
--anchor: #07b;
@ -42,9 +39,6 @@ Modified by Boyd Greenfield and narimiran
--primary-background: #171921;
--secondary-background: #1e202a;
--third-background: #2b2e3b;
--info-background: #008000;
--warning-background: #807000;
--error-background: #c03000;
--border: #0e1014;
--text: #fff;
--anchor: #8be9fd;
@ -615,34 +609,6 @@ table.borderless td, table.borderless th {
The right padding separates the table cells. */
padding: 0 0.5em 0 0 !important; }
.admonition {
padding: 0.3em;
background-color: var(--secondary-background);
border-left: 0.4em solid #7f7f84;
margin-bottom: 0.5em;
-webkit-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2);
-moz-box-shadow: 0 5px 8px -6px rgba(0,0,0,.2);
box-shadow: 0 5px 8px -6px rgba(0,0,0,.2);
}
.admonition-info {
border-color: var(--info-background);
}
.admonition-info-text {
color: var(--info-background);
}
.admonition-warning {
border-color: var(--warning-background);
}
.admonition-warning-text {
color: var(--warning-background);
}
.admonition-error {
border-color: var(--error-background);
}
.admonition-error-text {
color: var(--error-background);
}
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 !important; }

87
docs/pixie.html
View file

File diff suppressed because one or more lines are too long

7
docs/pixie/blends.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/blends</h1>
@ -176,7 +174,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -310,7 +307,7 @@ Is there a blend masking function with SIMD support?
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:20 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

39
docs/pixie/common.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/common</h1>
@ -109,8 +107,6 @@ window.addEventListener('DOMContentLoaded', main);
title="lerp(a, b: uint8; t: float32): uint8">lerp,<wbr>uint8,<wbr>uint8,<wbr>float32</a></li>
<li><a class="reference" href="#lerp%2CColorRGBA%2CColorRGBA%2Cfloat32"
title="lerp(a, b: ColorRGBA; t: float32): ColorRGBA">lerp,<wbr>ColorRGBA,<wbr>ColorRGBA,<wbr>float32</a></li>
<li><a class="reference" href="#lerp%2CColor%2CColor%2Cfloat32"
title="lerp(a, b: Color; v: float32): Color">lerp,<wbr>Color,<wbr>Color,<wbr>float32</a></li>
</ul>
<ul class="simple nested-toc-section">toPremultipliedAlpha
@ -135,11 +131,21 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#13" id="63">Funcs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">lerp
<li><a class="reference" href="#lerp%2CColor%2CColor%2Cfloat32"
title="lerp(a, b: Color; v: float32): Color">lerp,<wbr>Color,<wbr>Color,<wbr>float32</a></li>
</ul>
</ul>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -181,13 +187,6 @@ Linearly interpolate between a and b using t.
Linearly interpolate between a and b using t.
</dd>
<a id="lerp,Color,Color,float32"></a>
<dt><pre><span class="Keyword">func</span> <a href="#lerp%2CColor%2CColor%2Cfloat32"><span class="Identifier">lerp</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">Color</span><span class="Other">;</span> <span class="Identifier">v</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Color</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>
Linearly interpolate between a and b using t.
</dd>
<a id="toPremultipliedAlpha,ColorRGBA"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#toPremultipliedAlpha%2CColorRGBA"><span class="Identifier">toPremultipliedAlpha</span></a><span class="Other">(</span><span class="Identifier">c</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</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>
@ -219,6 +218,18 @@ Converts a color from premultiplied alpha to straight alpha.
</dd>
</dl></div>
<div class="section" id="13">
<h1><a class="toc-backref" href="#13">Funcs</a></h1>
<dl class="item">
<a id="lerp,Color,Color,float32"></a>
<dt><pre><span class="Keyword">func</span> <a href="#lerp%2CColor%2CColor%2Cfloat32"><span class="Identifier">lerp</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">Color</span><span class="Other">;</span> <span class="Identifier">v</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Color</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>
Linearly interpolate between a and b using t.
</dd>
</dl></div>
</div>
@ -228,7 +239,7 @@ Converts a color from premultiplied alpha to straight alpha.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:20 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

7
docs/pixie/fileformats/bmp.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/fileformats/bmp</h1>
@ -129,7 +127,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -185,7 +182,7 @@ Encodes an image into the BMP file format.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:21 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

7
docs/pixie/fileformats/jpg.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/fileformats/jpg</h1>
@ -129,7 +127,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -185,7 +182,7 @@ Encodes Image into a JPEG data string.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:21 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

7
docs/pixie/fileformats/png.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/fileformats/png</h1>
@ -133,7 +131,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -204,7 +201,7 @@ Encodes the mask data into the PNG file format.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:21 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

11
docs/pixie/fileformats/svg.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/fileformats/svg</h1>
@ -124,7 +122,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -158,10 +155,10 @@ window.addEventListener('DOMContentLoaded', main);
<dl class="item">
<a id="decodeSvg,string,int,int"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#decodeSvg%2Cstring%2Cint%2Cint"><span class="Identifier">decodeSvg</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">width</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">height</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="../images.html#Image"><span class="Identifier">Image</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="Identifier">WriteIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<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="Identifier">ReadIOEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">,</span> <span class="Identifier">WriteIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Render SVG file and return the image.
Render SVG file and return the image. Defaults to the SVG's view box size.
</dd>
@ -174,7 +171,7 @@ Render SVG file and return the image.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:22 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:09 UTC</small>
</div>
</div>
</div>

66
docs/pixie/images.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/images</h1>
@ -155,11 +153,6 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#shift%2C%2CVec2"
title="shift(target: Image | Mask; offset: Vec2)">shift,<wbr>,<wbr>Vec2</a></li>
</ul>
<ul class="simple nested-toc-section">getRgbaSmoothWrapped
<li><a class="reference" href="#getRgbaSmoothWrapped%2CImage%2Cfloat32%2Cfloat32"
title="getRgbaSmoothWrapped(image: Image; x, y: float32): ColorRGBA">getRgbaSmoothWrapped,<wbr>Image,<wbr>float32,<wbr>float32</a></li>
</ul>
<ul class="simple nested-toc-section">[]=
<li><a class="reference" href="#%5B%5D%3D%2CImage%2Cint%2Cint%2CColorRGBA"
@ -205,6 +198,11 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#magnifyBy2%2CImage%2Cint"
title="magnifyBy2(image: Image; power = 1): Image">magnifyBy2,<wbr>Image,<wbr>int</a></li>
</ul>
<ul class="simple nested-toc-section">shadow
<li><a class="reference" href="#shadow%2CImage%2CVec2%2Cfloat32%2Cfloat32%2CColorRGBA"
title="shadow(image: Image; offset: Vec2; spread, blur: float32; color: ColorRGBA): Image">shadow,<wbr>Image,<wbr>Vec2,<wbr>float32,<wbr>float32,<wbr>ColorRGBA</a></li>
</ul>
<ul class="simple nested-toc-section">newMask
<li><a class="reference" href="#newMask%2CImage"
@ -225,6 +223,11 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#minifyBy2%2CImage%2Cint"
title="minifyBy2(image: Image; power = 1): Image">minifyBy2,<wbr>Image,<wbr>int</a></li>
</ul>
<ul class="simple nested-toc-section">drawTiled
<li><a class="reference" href="#drawTiled%2CImage%2CImage%2CMat3"
title="drawTiled(dest, src: Image; mat: Mat3; blendMode = bmNormal)">drawTiled,<wbr>Image,<wbr>Image,<wbr>Mat3</a></li>
</ul>
<ul class="simple nested-toc-section">subImage
<li><a class="reference" href="#subImage%2CImage%2Cint%2Cint%2Cint%2Cint"
@ -235,6 +238,11 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#blur%2C%2Cfloat32%2Cuint32"
title="blur(target: Image | Mask; radius: float32; offBounds: uint32 = 0)">blur,<wbr>,<wbr>float32,<wbr>uint32</a></li>
</ul>
<ul class="simple nested-toc-section">toStraightAlpha
<li><a class="reference" href="#toStraightAlpha%2CImage"
title="toStraightAlpha(image: Image)">toStraightAlpha,<wbr>Image</a></li>
</ul>
<ul class="simple nested-toc-section">dataIndex
<li><a class="reference" href="#dataIndex%2CImage%2Cint%2Cint"
@ -243,7 +251,7 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
<ul class="simple nested-toc-section">getRgbaSmooth
<li><a class="reference" href="#getRgbaSmooth%2CImage%2Cfloat32%2Cfloat32"
title="getRgbaSmooth(image: Image; x, y: float32): ColorRGBA">getRgbaSmooth,<wbr>Image,<wbr>float32,<wbr>float32</a></li>
title="getRgbaSmooth(image: Image; x, y: float32; wrapped = false): ColorRGBA">getRgbaSmooth,<wbr>Image,<wbr>float32,<wbr>float32</a></li>
</ul>
<ul class="simple nested-toc-section">inside
@ -273,7 +281,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -436,7 +443,7 @@ Scales the image down by an integer scale.
<dt><pre><span class="Keyword">proc</span> <a href="#magnifyBy2%2CImage%2Cint"><span class="Identifier">magnifyBy2</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">power</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</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>
Scales image image up by 2 ^ power.
Scales image up by 2 ^ power.
</dd>
<a id="toPremultipliedAlpha,Image"></a>
@ -445,6 +452,13 @@ Scales image image up by 2 ^ power.
Converts an image to premultiplied alpha from straight alpha.
</dd>
<a id="toStraightAlpha,Image"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#toStraightAlpha%2CImage"><span class="Identifier">toStraightAlpha</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">)</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>
Converts an image from premultiplied alpha to straight alpha. This is expensive for large images.
</dd>
<a id="applyOpacity,,float32"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#applyOpacity%2C%2Cfloat32"><span class="Identifier">applyOpacity</span></a><span class="Other">(</span><span class="Identifier">target</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a> <span class="Operator">|</span> <a href="masks.html#Mask"><span class="Identifier">Mask</span></a><span class="Other">;</span> <span class="Identifier">opacity</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span></pre></dt>
@ -475,20 +489,12 @@ Returns a new mask using the alpha values of the parameter image.
</dd>
<a id="getRgbaSmooth,Image,float32,float32"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getRgbaSmooth%2CImage%2Cfloat32%2Cfloat32"><span class="Identifier">getRgbaSmooth</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</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>
<dt><pre><span class="Keyword">proc</span> <a href="#getRgbaSmooth%2CImage%2Cfloat32%2Cfloat32"><span class="Identifier">getRgbaSmooth</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">;</span> <span class="Identifier">wrapped</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</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>
Gets a interpolated color with float point coordinates. Pixes outside the image are transparent.
</dd>
<a id="getRgbaSmoothWrapped,Image,float32,float32"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getRgbaSmoothWrapped%2CImage%2Cfloat32%2Cfloat32"><span class="Identifier">getRgbaSmoothWrapped</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</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>
Gets a interpolated color with float point coordinates. Pixes outside the image are repeated.
</dd>
<a id="draw,Image,Image,Mat3"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#draw%2CImage%2CImage%2CMat3"><span class="Identifier">draw</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">mat</span><span class="Other">:</span> <span class="Identifier">Mat3</span><span class="Other">;</span> <span class="Identifier">blendMode</span> <span class="Other">=</span> <span class="Identifier">bmNormal</span><span class="Other">)</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>
@ -553,6 +559,14 @@ Draws a image onto a mask using a matrix with color blending.
Draws a image onto a mask using a position offset with color blending.
</dd>
<a id="drawTiled,Image,Image,Mat3"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#drawTiled%2CImage%2CImage%2CMat3"><span class="Identifier">drawTiled</span></a><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">,</span> <span class="Identifier">src</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">mat</span><span class="Other">:</span> <span class="Identifier">Mat3</span><span class="Other">;</span> <span class="Identifier">blendMode</span> <span class="Other">=</span> <span class="Identifier">bmNormal</span><span class="Other">)</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="Identifier">PixieError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
</dd>
<a id="resize,Image,int,int"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#resize%2CImage%2Cint%2Cint"><span class="Identifier">resize</span></a><span class="Other">(</span><span class="Identifier">srcImage</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">width</span><span class="Other">,</span> <span class="Identifier">height</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</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">
@ -568,6 +582,14 @@ Resize an image to a given hight and width.
Shifts the target by offset.
</dd>
<a id="shadow,Image,Vec2,float32,float32,ColorRGBA"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#shadow%2CImage%2CVec2%2Cfloat32%2Cfloat32%2CColorRGBA"><span class="Identifier">shadow</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">offset</span><span class="Other">:</span> <span class="Identifier">Vec2</span><span class="Other">;</span> <span class="Identifier">spread</span><span class="Other">,</span> <span class="Identifier">blur</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">;</span> <span class="Identifier">color</span><span class="Other">:</span> <span class="Identifier">ColorRGBA</span><span class="Other">)</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</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="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Create a shadow of the image with the offset, spread and blur.
</dd>
</dl></div>
@ -579,7 +601,7 @@ Shifts the target by offset.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:21 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

6
docs/pixie/images.idx
View file

@ -18,12 +18,12 @@ superImage pixie/images.html#superImage,Image,int,int,int,int images: superImage
minifyBy2 pixie/images.html#minifyBy2,Image,int images: minifyBy2(image: Image; power = 1): Image
magnifyBy2 pixie/images.html#magnifyBy2,Image,int images: magnifyBy2(image: Image; power = 1): Image
toPremultipliedAlpha pixie/images.html#toPremultipliedAlpha,Image images: toPremultipliedAlpha(image: Image)
toStraightAlpha pixie/images.html#toStraightAlpha,Image images: toStraightAlpha(image: Image)
applyOpacity pixie/images.html#applyOpacity,,float32 images: applyOpacity(target: Image | Mask; opacity: float32)
invert pixie/images.html#invert images: invert(target: Image | Mask)
blur pixie/images.html#blur,,float32,uint32 images: blur(target: Image | Mask; radius: float32; offBounds: uint32 = 0)
newMask pixie/images.html#newMask,Image images: newMask(image: Image): Mask
getRgbaSmooth pixie/images.html#getRgbaSmooth,Image,float32,float32 images: getRgbaSmooth(image: Image; x, y: float32): ColorRGBA
getRgbaSmoothWrapped pixie/images.html#getRgbaSmoothWrapped,Image,float32,float32 images: getRgbaSmoothWrapped(image: Image; x, y: float32): ColorRGBA
getRgbaSmooth pixie/images.html#getRgbaSmooth,Image,float32,float32 images: getRgbaSmooth(image: Image; x, y: float32; wrapped = false): ColorRGBA
draw pixie/images.html#draw,Image,Image,Mat3 images: draw(a, b: Image; mat: Mat3; blendMode = bmNormal)
draw pixie/images.html#draw,Image,Image images: draw(a, b: Image; pos = vec2(0, 0); blendMode = bmNormal)
draw pixie/images.html#draw,Image,Mask,Mat3 images: draw(image: Image; mask: Mask; mat: Mat3; blendMode = bmMask)
@ -32,5 +32,7 @@ draw pixie/images.html#draw,Mask,Mask,Mat3 images: draw(a, b: Mask; mat: Mat3; b
draw pixie/images.html#draw,Mask,Mask images: draw(a, b: Mask; pos = vec2(0, 0); blendMode = bmMask)
draw pixie/images.html#draw,Mask,Image,Mat3 images: draw(mask: Mask; image: Image; mat: Mat3; blendMode = bmMask)
draw pixie/images.html#draw,Mask,Image images: draw(mask: Mask; image: Image; pos = vec2(0, 0); blendMode = bmMask)
drawTiled pixie/images.html#drawTiled,Image,Image,Mat3 images: drawTiled(dest, src: Image; mat: Mat3; blendMode = bmNormal)
resize pixie/images.html#resize,Image,int,int images: resize(srcImage: Image; width, height: int): Image
shift pixie/images.html#shift,,Vec2 images: shift(target: Image | Mask; offset: Vec2)
shadow pixie/images.html#shadow,Image,Vec2,float32,float32,ColorRGBA images: shadow(image: Image; offset: Vec2; spread, blur: float32; color: ColorRGBA): Image

7
docs/pixie/masks.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/masks</h1>
@ -199,7 +197,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -357,7 +354,7 @@ A value of 0 stays 0. Anything else turns into 255.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:20 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:08 UTC</small>
</div>
</div>
</div>

35
docs/pixie/paints.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/paints</h1>
@ -131,11 +129,6 @@ window.addEventListener('DOMContentLoaded', main);
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">fillImage
<li><a class="reference" href="#fillImage%2CImage%2CImage%2CMat3"
title="fillImage(dest: Image; src: Image; mat: Mat3)">fillImage,<wbr>Image,<wbr>Image,<wbr>Mat3</a></li>
</ul>
<ul class="simple nested-toc-section">fillAngularGradient
<li><a class="reference" href="#fillAngularGradient%2CImage%2CVec2%2CVec2%2CVec2%2Cseq%5BColorStop%5D"
title="fillAngularGradient(image: Image; center, edge, skew: Vec2;
@ -151,11 +144,6 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#fillRadialGradient%2CImage%2CVec2%2CVec2%2CVec2%2Cseq%5BColorStop%5D"
title="fillRadialGradient(image: Image; center, edge, skew: Vec2; stops: seq[ColorStop])">fillRadialGradient,<wbr>Image,<wbr>Vec2,<wbr>Vec2,<wbr>Vec2,<wbr>seq[ColorStop]</a></li>
</ul>
<ul class="simple nested-toc-section">fillImageTiled
<li><a class="reference" href="#fillImageTiled%2CImage%2CImage%2CMat3"
title="fillImageTiled(dest: Image; src: Image; mat: Mat3)">fillImageTiled,<wbr>Image,<wbr>Image,<wbr>Mat3</a></li>
</ul>
</ul>
@ -164,7 +152,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -172,7 +159,7 @@ window.addEventListener('DOMContentLoaded', main);
<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>, <a class="reference external" href="images.html">images</a>, <a class="reference external" href="blends.html">blends</a>
<a class="reference external" href="blends.html">blends</a>, <a class="reference external" href="common.html">common</a>, <a class="reference external" href="images.html">images</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
@ -222,22 +209,6 @@ Color stop on a gradient curve.
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="fillImage,Image,Image,Mat3"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#fillImage%2CImage%2CImage%2CMat3"><span class="Identifier">fillImage</span></a><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">mat</span><span class="Other">:</span> <span class="Identifier">Mat3</span><span class="Other">)</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="Identifier">PixieError</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Draws and basic image fill.
</dd>
<a id="fillImageTiled,Image,Image,Mat3"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#fillImageTiled%2CImage%2CImage%2CMat3"><span class="Identifier">fillImageTiled</span></a><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">mat</span><span class="Other">:</span> <span class="Identifier">Mat3</span><span class="Other">)</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="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>
Draws a tiled image fill.
</dd>
<a id="fillLinearGradient,Image,Vec2,Vec2,seq[ColorStop]"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#fillLinearGradient%2CImage%2CVec2%2CVec2%2Cseq%5BColorStop%5D"><span class="Identifier">fillLinearGradient</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="images.html#Image"><span class="Identifier">Image</span></a><span class="Other">;</span> <span class="Identifier">at</span><span class="Other">,</span> <span class="Identifier">to</span><span class="Other">:</span> <span class="Identifier">Vec2</span><span class="Other">;</span> <span class="Identifier">stops</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="paints.html#ColorStop"><span class="Identifier">ColorStop</span></a><span class="Other">]</span><span class="Other">)</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>
@ -272,7 +243,7 @@ Angular gradient.
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:21 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:09 UTC</small>
</div>
</div>
</div>

2
docs/pixie/paints.idx
View file

@ -7,8 +7,6 @@ pkGradientAngular pixie/paints.html#pkGradientAngular PaintKind.pkGradientAngula
PaintKind pixie/paints.html#PaintKind paints: PaintKind
Paint pixie/paints.html#Paint paints: Paint
ColorStop pixie/paints.html#ColorStop paints: ColorStop
fillImage pixie/paints.html#fillImage,Image,Image,Mat3 paints: fillImage(dest: Image; src: Image; mat: Mat3)
fillImageTiled pixie/paints.html#fillImageTiled,Image,Image,Mat3 paints: fillImageTiled(dest: Image; src: Image; mat: Mat3)
fillLinearGradient pixie/paints.html#fillLinearGradient,Image,Vec2,Vec2,seq[ColorStop] paints: fillLinearGradient(image: Image; at, to: Vec2; stops: seq[ColorStop])
fillRadialGradient pixie/paints.html#fillRadialGradient,Image,Vec2,Vec2,Vec2,seq[ColorStop] paints: fillRadialGradient(image: Image; center, edge, skew: Vec2; stops: seq[ColorStop])
fillAngularGradient pixie/paints.html#fillAngularGradient,Image,Vec2,Vec2,Vec2,seq[ColorStop] paints: fillAngularGradient(image: Image; center, edge, skew: Vec2;\n stops: seq[ColorStop])

68
docs/pixie/paths.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">pixie/paths</h1>
@ -137,11 +135,21 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#bezierCurveTo%2CPath%2CVec2%2CVec2%2CVec2"
title="bezierCurveTo(path: var Path; ctrl1, ctrl2, to: Vec2)">bezierCurveTo,<wbr>Path,<wbr>Vec2,<wbr>Vec2,<wbr>Vec2</a></li>
</ul>
<ul class="simple nested-toc-section">transform
<li><a class="reference" href="#transform%2CPath%2CMat3"
title="transform(path: var Path; mat: Mat3)">transform,<wbr>Path,<wbr>Mat3</a></li>
</ul>
<ul class="simple nested-toc-section">addPath
<li><a class="reference" href="#addPath%2CPath%2CPath"
title="addPath(path: var Path; other: Path)">addPath,<wbr>Path,<wbr>Path</a></li>
</ul>
<ul class="simple nested-toc-section">$
<li><a class="reference" href="#%24%2CPath"
title="`$`(path: Path): string">$,<wbr>Path</a></li>
</ul>
<ul class="simple nested-toc-section">strokePath
<li><a class="reference" href="#strokePath%2CImage%2CSomePath%2CColorRGBA%2Cfloat"
@ -214,6 +222,11 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference" href="#arcTo%2CPath%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32"
title="arcTo(path: var Path; x1, y1, x2, y2, radius: float32)">arcTo,<wbr>Path,<wbr>float32,<wbr>float32,<wbr>float32,<wbr>float32,<wbr>float32</a></li>
</ul>
<ul class="simple nested-toc-section">commandsToShapes
<li><a class="reference" href="#commandsToShapes%2CPath%2Cfloat32"
title="commandsToShapes(path: Path; pixelScale: float32 = 1.0): seq[seq[Vec2]]">commandsToShapes,<wbr>Path,<wbr>float32</a></li>
</ul>
<ul class="simple nested-toc-section">rect
<li><a class="reference" href="#rect%2CPath%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32"
@ -269,7 +282,6 @@ window.addEventListener('DOMContentLoaded', main);
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
@ -347,11 +359,25 @@ Used to hold paths and create paths.
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="$,Path"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CPath"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
Turn path int into a string.
</dd>
<a id="parsePath,string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#parsePath%2Cstring"><span class="Identifier">parsePath</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</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>
Converts a SVG style path into seq of commands.
Converts a SVG style path string into seq of commands.
</dd>
<a id="transform,Path,Mat3"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#transform%2CPath%2CMat3"><span class="Identifier">transform</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">mat</span><span class="Other">:</span> <span class="Identifier">Mat3</span><span class="Other">)</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>
Apply a matrix transform to a path.
</dd>
<a id="addPath,Path,Path"></a>
@ -437,11 +463,11 @@ Adds a circular arc to the current sub-path, using the given control points and
</dd>
<a id="arcTo,Path,float32,float32,float32,float32,float32"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#arcTo%2CPath%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32"><span class="Identifier">arcTo</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">x1</span><span class="Other">,</span> <span class="Identifier">y1</span><span class="Other">,</span> <span class="Identifier">x2</span><span class="Other">,</span> <span class="Identifier">y2</span><span class="Other">,</span> <span class="Identifier">radius</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</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>
<dt><pre><span class="Keyword">proc</span> <a href="#arcTo%2CPath%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32"><span class="Identifier">arcTo</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">x1</span><span class="Other">,</span> <span class="Identifier">y1</span><span class="Other">,</span> <span class="Identifier">x2</span><span class="Other">,</span> <span class="Identifier">y2</span><span class="Other">,</span> <span class="Identifier">radius</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</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>
Adds a circular arc to the current sub-path, using the given control points and radius.
</dd>
<a id="ellipticalArcTo,Path,float32,float32,float32,bool,bool,float32,float32"></a>
@ -458,7 +484,7 @@ Adds an elliptical arc to the current sub-path, using the given radius ratios, s
<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>
Adds a rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="rect,Path,Vec2,Vec2"></a>
@ -466,7 +492,7 @@ Adds an elliptical arc to the current sub-path, using the given radius ratios, s
<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>
Adds a rectangle. Clockwise param can be used to subtract a rect from a path using even-odd.
Adds a rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="rect,Path,Rect"></a>
@ -474,7 +500,7 @@ Adds a rectangle. Clockwise param can be used to subtract a rect from a path usi
<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>
Adds a rectangle. Clockwise param can be used to subtract a rect from a path using even-odd.
Adds a rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="roundedRect,Path,float32,float32,float32,float32,float32,float32,float32,float32"></a>
@ -482,7 +508,7 @@ Adds a rectangle. Clockwise param can be used to subtract a rect from a path usi
<span class="Identifier">clockwise</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</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>
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path using even-odd.
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="roundedRect,Path,Vec2,Vec2,float32,float32,float32,float32"></a>
@ -490,7 +516,7 @@ Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a
<span class="Identifier">clockwise</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</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>
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path using even-odd.
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="roundedRect,Path,Rect,float32,float32,float32,float32"></a>
@ -498,7 +524,7 @@ Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a
<span class="Identifier">clockwise</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</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>
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path using even-odd.
Adds a rounded rectangle. Clockwise param can be used to subtract a rect from a path when using even-odd winding rule.
</dd>
<a id="ellipse,Path,float32,float32,float32,float32"></a>
@ -521,7 +547,7 @@ Adds a ellipse.
<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>
Draws a n-sided regular polygon at (x, y) with a size.
Draws an n-sided regular polygon at (x, y) with the parameter size.
</dd>
<a id="polygon,Path,Vec2,float32,int"></a>
@ -529,7 +555,15 @@ Draws a n-sided regular polygon at (x, y) with a size.
<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>
Draws a n-sided regular polygon at (x, y) with a size.
Draws a n-sided regular polygon at (x, y) with the parameter size.
</dd>
<a id="commandsToShapes,Path,float32"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#commandsToShapes%2CPath%2Cfloat32"><span class="Identifier">commandsToShapes</span></a><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <a href="paths.html#Path"><span class="Identifier">Path</span></a><span class="Other">;</span> <span class="Identifier">pixelScale</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other">=</span> <span class="FloatNumber">1.0</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">Vec2</span><span class="Other">]</span><span class="Other">]</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="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>
Converts SVG-like commands to line segments.
</dd>
<a id="fillPath,Image,SomePath,ColorRGBA"></a>
@ -628,7 +662,7 @@ Return elements in pairs: (1st, 2nd), (2nd, 3rd) ... (n - 1, last).
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:22 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:09 UTC</small>
</div>
</div>
</div>

3
docs/pixie/paths.idx
View file

@ -32,7 +32,9 @@ PathCommandKind pixie/paths.html#PathCommandKind paths: PathCommandKind
PathCommand pixie/paths.html#PathCommand paths: PathCommand
Path pixie/paths.html#Path paths: Path
SomePath pixie/paths.html#SomePath paths: SomePath
`$` pixie/paths.html#$,Path paths: `$`(path: Path): string
parsePath pixie/paths.html#parsePath,string paths: parsePath(path: string): Path
transform pixie/paths.html#transform,Path,Mat3 paths: transform(path: var Path; mat: Mat3)
addPath pixie/paths.html#addPath,Path,Path paths: addPath(path: var Path; other: Path)
closePath pixie/paths.html#closePath,Path paths: closePath(path: var Path)
moveTo pixie/paths.html#moveTo,Path,float32,float32 paths: moveTo(path: var Path; x, y: float32)
@ -56,6 +58,7 @@ ellipse pixie/paths.html#ellipse,Path,float32,float32,float32,float32 paths: ell
ellipse pixie/paths.html#ellipse,Path,Vec2,float32,float32 paths: ellipse(path: var Path; center: Vec2; rx, ry: float32)
polygon pixie/paths.html#polygon,Path,float32,float32,float32,int paths: polygon(path: var Path; x, y, size: float32; sides: int)
polygon pixie/paths.html#polygon,Path,Vec2,float32,int paths: polygon(path: var Path; pos: Vec2; size: float32; sides: int)
commandsToShapes pixie/paths.html#commandsToShapes,Path,float32 paths: commandsToShapes(path: Path; pixelScale: float32 = 1.0): seq[seq[Vec2]]
segments pixie/paths.html#segments.i,seq[Vec2] paths: segments(s: seq[Vec2]): Segment
fillPath pixie/paths.html#fillPath,Image,SomePath,ColorRGBA paths: fillPath(image: Image; path: SomePath; color: ColorRGBA;\n windingRule = wrNonZero; blendMode = bmNormal)
fillPath pixie/paths.html#fillPath,Image,SomePath,ColorRGBA, paths: fillPath(image: Image; path: SomePath; color: ColorRGBA; transform: Vec2 | Mat3;\n windingRule = wrNonZero; blendMode = bmNormal)

40
docs/theindex.html
View file

@ -56,12 +56,10 @@ function main() {
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">Index</h1>
@ -71,6 +69,8 @@ window.addEventListener('DOMContentLoaded', main);
data-doc-search-tag="images: `$`(image: Image): string" href="pixie/images.html#%24%2CImage">images: `$`(image: Image): string</a></li>
<li><a class="reference external"
data-doc-search-tag="masks: `$`(mask: Mask): string" href="pixie/masks.html#%24%2CMask">masks: `$`(mask: Mask): string</a></li>
<li><a class="reference external"
data-doc-search-tag="paths: `$`(path: Path): string" href="pixie/paths.html#%24%2CPath">paths: `$`(path: Path): string</a></li>
</ul></dd>
<dt><a name="%60%5B%5D%3D%60" href="#%60%5B%5D%3D%60"><span>`[]=`:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
@ -240,6 +240,10 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference external"
data-doc-search-tag="paints: ColorStop" href="pixie/paints.html#ColorStop">paints: ColorStop</a></li>
</ul></dd>
<dt><a name="commandsToShapes" href="#commandsToShapes"><span>commandsToShapes:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paths: commandsToShapes(path: Path; pixelScale: float32 = 1.0): seq[seq[Vec2]]" href="pixie/paths.html#commandsToShapes%2CPath%2Cfloat32">paths: commandsToShapes(path: Path; pixelScale: float32 = 1.0): seq[seq[Vec2]]</a></li>
</ul></dd>
<dt><a name="copy" href="#copy"><span>copy:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: copy(image: Image): Image" href="pixie/images.html#copy%2CImage">images: copy(image: Image): Image</a></li>
@ -300,6 +304,10 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference external"
data-doc-search-tag="images: draw(a, b: Mask; mat: Mat3; blendMode = bmMask)" href="pixie/images.html#draw%2CMask%2CMask%2CMat3">images: draw(a, b: Mask; mat: Mat3; blendMode = bmMask)</a></li>
</ul></dd>
<dt><a name="drawTiled" href="#drawTiled"><span>drawTiled:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: drawTiled(dest, src: Image; mat: Mat3; blendMode = bmNormal)" href="pixie/images.html#drawTiled%2CImage%2CImage%2CMat3">images: drawTiled(dest, src: Image; mat: Mat3; blendMode = bmNormal)</a></li>
</ul></dd>
<dt><a name="ellipse" href="#ellipse"><span>ellipse:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paths: ellipse(path: var Path; cx, cy, rx, ry: float32)" href="pixie/paths.html#ellipse%2CPath%2Cfloat32%2Cfloat32%2Cfloat32%2Cfloat32">paths: ellipse(path: var Path; cx, cy, rx, ry: float32)</a></li>
@ -374,14 +382,6 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference external"
data-doc-search-tag="pixie: fillEllipse(mask: Mask; center: Vec2; rx, ry: float32)" href="pixie.html#fillEllipse%2CMask%2CVec2%2Cfloat32%2Cfloat32">pixie: fillEllipse(mask: Mask; center: Vec2; rx, ry: float32)</a></li>
</ul></dd>
<dt><a name="fillImage" href="#fillImage"><span>fillImage:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paints: fillImage(dest: Image; src: Image; mat: Mat3)" href="pixie/paints.html#fillImage%2CImage%2CImage%2CMat3">paints: fillImage(dest: Image; src: Image; mat: Mat3)</a></li>
</ul></dd>
<dt><a name="fillImageTiled" href="#fillImageTiled"><span>fillImageTiled:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paints: fillImageTiled(dest: Image; src: Image; mat: Mat3)" href="pixie/paints.html#fillImageTiled%2CImage%2CImage%2CMat3">paints: fillImageTiled(dest: Image; src: Image; mat: Mat3)</a></li>
</ul></dd>
<dt><a name="fillLinearGradient" href="#fillLinearGradient"><span>fillLinearGradient:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paints: fillLinearGradient(image: Image; at, to: Vec2; stops: seq[ColorStop])" href="pixie/paints.html#fillLinearGradient%2CImage%2CVec2%2CVec2%2Cseq%5BColorStop%5D">paints: fillLinearGradient(image: Image; at, to: Vec2; stops: seq[ColorStop])</a></li>
@ -452,11 +452,7 @@ window.addEventListener('DOMContentLoaded', main);
</ul></dd>
<dt><a name="getRgbaSmooth" href="#getRgbaSmooth"><span>getRgbaSmooth:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: getRgbaSmooth(image: Image; x, y: float32): ColorRGBA" href="pixie/images.html#getRgbaSmooth%2CImage%2Cfloat32%2Cfloat32">images: getRgbaSmooth(image: Image; x, y: float32): ColorRGBA</a></li>
</ul></dd>
<dt><a name="getRgbaSmoothWrapped" href="#getRgbaSmoothWrapped"><span>getRgbaSmoothWrapped:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: getRgbaSmoothWrapped(image: Image; x, y: float32): ColorRGBA" href="pixie/images.html#getRgbaSmoothWrapped%2CImage%2Cfloat32%2Cfloat32">images: getRgbaSmoothWrapped(image: Image; x, y: float32): ColorRGBA</a></li>
data-doc-search-tag="images: getRgbaSmooth(image: Image; x, y: float32; wrapped = false): ColorRGBA" href="pixie/images.html#getRgbaSmooth%2CImage%2Cfloat32%2Cfloat32">images: getRgbaSmooth(image: Image; x, y: float32; wrapped = false): ColorRGBA</a></li>
</ul></dd>
<dt><a name="getRgbaUnsafe" href="#getRgbaUnsafe"><span>getRgbaUnsafe:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
@ -758,6 +754,10 @@ window.addEventListener('DOMContentLoaded', main);
<li><a class="reference external"
data-doc-search-tag="masks: setValueUnsafe(mask: Mask; x, y: int; value: uint8)" href="pixie/masks.html#setValueUnsafe%2CMask%2Cint%2Cint%2Cuint8">masks: setValueUnsafe(mask: Mask; x, y: int; value: uint8)</a></li>
</ul></dd>
<dt><a name="shadow" href="#shadow"><span>shadow:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: shadow(image: Image; offset: Vec2; spread, blur: float32; color: ColorRGBA): Image" href="pixie/images.html#shadow%2CImage%2CVec2%2Cfloat32%2Cfloat32%2CColorRGBA">images: shadow(image: Image; offset: Vec2; spread, blur: float32; color: ColorRGBA): Image</a></li>
</ul></dd>
<dt><a name="shift" href="#shift"><span>shift:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="images: shift(target: Image | Mask; offset: Vec2)" href="pixie/images.html#shift%2C%2CVec2">images: shift(target: Image | Mask; offset: Vec2)</a></li>
@ -871,11 +871,17 @@ window.addEventListener('DOMContentLoaded', main);
data-doc-search-tag="common: toStraightAlpha(c: Color): Color" href="pixie/common.html#toStraightAlpha%2CColor">common: toStraightAlpha(c: Color): Color</a></li>
<li><a class="reference external"
data-doc-search-tag="common: toStraightAlpha(c: ColorRGBA): ColorRGBA" href="pixie/common.html#toStraightAlpha%2CColorRGBA">common: toStraightAlpha(c: ColorRGBA): ColorRGBA</a></li>
<li><a class="reference external"
data-doc-search-tag="images: toStraightAlpha(image: Image)" href="pixie/images.html#toStraightAlpha%2CImage">images: toStraightAlpha(image: Image)</a></li>
</ul></dd>
<dt><a name="TQuad" href="#TQuad"><span>TQuad:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="PathCommandKind.TQuad" href="pixie/paths.html#TQuad">PathCommandKind.TQuad</a></li>
</ul></dd>
<dt><a name="transform" href="#transform"><span>transform:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="paths: transform(path: var Path; mat: Mat3)" href="pixie/paths.html#transform%2CPath%2CMat3">paths: transform(path: var Path; mat: Mat3)</a></li>
</ul></dd>
<dt><a name="unpackAlphaValues" href="#unpackAlphaValues"><span>unpackAlphaValues:</span></a></dt><dd><ul class="simple">
<li><a class="reference external"
data-doc-search-tag="blends: unpackAlphaValues(v: M128i): M128i" href="pixie/blends.html#unpackAlphaValues%2CM128i">blends: unpackAlphaValues(v: M128i): M128i</a></li>
@ -917,7 +923,7 @@ window.addEventListener('DOMContentLoaded', main);
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 15:26:22 UTC</small>
<small style="color: var(--hint);">Made with Nim. Generated: 2021-02-25 17:48:09 UTC</small>
</div>
</div>
</div>