color.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  4. <!-- This file is generated by Nim. -->
  5. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  9. <!-- Favicon -->
  10. <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=="/>
  11. <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=">
  12. <!-- Google fonts -->
  13. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  14. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  15. <!-- CSS -->
  16. <title>color</title>
  17. <link rel="stylesheet" type="text/css" href="nimdoc.out.css">
  18. <script type="text/javascript" src="dochack.js"></script>
  19. <script type="text/javascript">
  20. function main() {
  21. var pragmaDots = document.getElementsByClassName("pragmadots");
  22. for (var i = 0; i < pragmaDots.length; i++) {
  23. pragmaDots[i].onclick = function(event) {
  24. // Hide tease
  25. event.target.parentNode.style.display = "none";
  26. // Show actual
  27. event.target.parentNode.nextElementSibling.style.display = "inline";
  28. }
  29. }
  30. const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
  31. function switchTheme(e) {
  32. if (e.target.checked) {
  33. document.documentElement.setAttribute('data-theme', 'dark');
  34. localStorage.setItem('theme', 'dark');
  35. } else {
  36. document.documentElement.setAttribute('data-theme', 'light');
  37. localStorage.setItem('theme', 'light');
  38. }
  39. }
  40. toggleSwitch.addEventListener('change', switchTheme, false);
  41. if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
  42. document.documentElement.setAttribute('data-theme', "dark");
  43. toggleSwitch.checked = true;
  44. } else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
  45. document.documentElement.setAttribute('data-theme', "light");
  46. toggleSwitch.checked = false;
  47. } else {
  48. const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
  49. if (currentTheme) {
  50. document.documentElement.setAttribute('data-theme', currentTheme);
  51. if (currentTheme === 'dark') {
  52. toggleSwitch.checked = true;
  53. }
  54. }
  55. }
  56. }
  57. </script>
  58. </head>
  59. <body onload="main()">
  60. <div class="document" id="documentId">
  61. <div class="container">
  62. <h1 class="title">color</h1>
  63. <div class="row">
  64. <div class="three columns">
  65. <div class="theme-switch-wrapper">
  66. <label class="theme-switch" for="checkbox">
  67. <input type="checkbox" id="checkbox" />
  68. <div class="slider round"></div>
  69. </label>
  70. &nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
  71. </div>
  72. <div id="global-links">
  73. <ul class="simple">
  74. </ul>
  75. </div>
  76. <div id="searchInputDiv">
  77. Search: <input type="text" id="searchInput"
  78. onkeyup="search()" />
  79. </div>
  80. <div>
  81. Group by:
  82. <select onchange="groupBy(this.value)">
  83. <option value="section">Section</option>
  84. <option value="type">Type</option>
  85. </select>
  86. </div>
  87. <ul class="simple simple-toc" id="toc-list">
  88. <li>
  89. <a class="reference reference-toplevel" href="#7" id="57">Types</a>
  90. <ul class="simple simple-toc-section">
  91. <li><a class="reference" href="#ColorObj"
  92. title="ColorObj = object
  93. r*: float
  94. g*: float
  95. b*: float
  96. a*: float"><wbr />Color<wbr />Obj<span class="attachedType"></span></a></li>
  97. <li><a class="reference" href="#ColorRef"
  98. title="ColorRef = ref ColorObj"><wbr />Color<wbr />Ref<span class="attachedType"></span></a></li>
  99. </ul>
  100. </li>
  101. <li>
  102. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  103. <ul class="simple simple-toc-section">
  104. <li><a class="reference" href="#Color%2Cfloat%2Cfloat%2Cfloat%2Cfloat"
  105. title="Color(r, g, b, a: float): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  106. <li><a class="reference" href="#Color%2Cfloat%2Cfloat%2Cfloat"
  107. title="Color(r, g, b: float): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  108. <li><a class="reference" href="#Color%2Cuint8%2Cuint8%2Cuint8%2Cuint8"
  109. title="Color(r, g, b, a: uint8): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  110. <li><a class="reference" href="#Color%2Cuint8%2Cuint8%2Cuint8"
  111. title="Color(r, g, b: uint8): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  112. <li><a class="reference" href="#Color%2Cstring"
  113. title="Color(src: string): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  114. <li><a class="reference" href="#Color%2Cuint32"
  115. title="Color(src: uint32): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  116. <li><a class="reference" href="#Color"
  117. title="Color(): ColorRef"><wbr />Color<span class="attachedType">ColorRef</span></a></li>
  118. <li><a class="reference" href="#normalize%2Cfloat"
  119. title="normalize(n: float): uint32"><wbr />normalize<span class="attachedType"></span></a></li>
  120. <li><a class="reference" href="#normalize%2Cfloat%2Cfloat%2Cfloat"
  121. title="normalize(n, min, max: float): float"><wbr />normalize<span class="attachedType"></span></a></li>
  122. <li><a class="reference" href="#normalizeColor%2Cfloat"
  123. title="normalizeColor(color: float): float"><wbr />normalize<wbr />Color<span class="attachedType"></span></a></li>
  124. <li><a class="reference" href="#toUint32BE%2CColorRef"
  125. title="toUint32BE(color: ColorRef): uint32"><wbr />to<wbr />Uint32BE<span class="attachedType">ColorRef</span></a></li>
  126. <li><a class="reference" href="#toUint32LE%2CColorRef"
  127. title="toUint32LE(color: ColorRef): uint32"><wbr />to<wbr />Uint32LE<span class="attachedType">ColorRef</span></a></li>
  128. <li><a class="reference" href="#toFloatTuple%2CColorRef"
  129. title="toFloatTuple(color: ColorRef): tuple[r, g, b, a: float]"><wbr />to<wbr />Float<wbr />Tuple<span class="attachedType">ColorRef</span></a></li>
  130. <li><a class="reference" href="#toUint32Tuple%2CColorRef"
  131. title="toUint32Tuple(color: ColorRef): tuple[r, g, b, a: uint32]"><wbr />to<wbr />Uint32Tuple<span class="attachedType">ColorRef</span></a></li>
  132. <li><a class="reference" href="#toUint32BEWithoutAlpha%2CColorRef"
  133. title="toUint32BEWithoutAlpha(color: ColorRef): uint32"><wbr />to<wbr />Uint32BEWithout<wbr />Alpha<span class="attachedType">ColorRef</span></a></li>
  134. <li><a class="reference" href="#toUint32LEWithoutAlpha%2CColorRef"
  135. title="toUint32LEWithoutAlpha(color: ColorRef): uint32"><wbr />to<wbr />Uint32LEWithout<wbr />Alpha<span class="attachedType">ColorRef</span></a></li>
  136. <li><a class="reference" href="#lerp%2CColorRef%2CColorRef%2Cfloat"
  137. title="lerp(self, other: ColorRef; lerpv: float): uint32"><wbr />lerp<span class="attachedType">ColorRef</span></a></li>
  138. <li><a class="reference" href="#lerp%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cfloat"
  139. title="lerp(r1, g1, b1, a1, r2, g2, b2, a2: uint32; lerpv: float): uint32"><wbr />lerp<span class="attachedType"></span></a></li>
  140. <li><a class="reference" href="#%24%2CColorRef"
  141. title="`$`(color: ColorRef): string"><wbr />`$`<span class="attachedType">ColorRef</span></a></li>
  142. </ul>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="nine columns" id="content">
  147. <div id="tocRoot"></div>
  148. <p class="module-desc"></p>
  149. <div class="section" id="7">
  150. <h1><a class="toc-backref" href="#7">Types</a></h1>
  151. <dl class="item">
  152. <a id="ColorObj"></a>
  153. <dt><pre><a href="color.html#ColorObj"><span class="Identifier">ColorObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
  154. <span class="Identifier">r</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
  155. <span class="Identifier">g</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
  156. <span class="Identifier">b</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
  157. <span class="Identifier">a</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">float</span>
  158. </pre></dt>
  159. <dd>
  160. </dd>
  161. <a id="ColorRef"></a>
  162. <dt><pre><a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="color.html#ColorObj"><span class="Identifier">ColorObj</span></a></pre></dt>
  163. <dd>
  164. </dd>
  165. </dl></div>
  166. <div class="section" id="12">
  167. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  168. <dl class="item">
  169. <a id="Color,float,float,float,float"></a>
  170. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cfloat%2Cfloat%2Cfloat%2Cfloat"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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>
  171. <dd>
  172. Creates a new Color from RGBA. <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt>, <tt class="docutils literal"><span class="pre">b</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> is a numbers ranges <tt class="docutils literal"><span class="pre">0.0..1.0</span></tt>.
  173. </dd>
  174. <a id="Color,float,float,float"></a>
  175. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cfloat%2Cfloat%2Cfloat"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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">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>
  176. <dd>
  177. Creates a new Color from RGB. <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt> and <tt class="docutils literal"><span class="pre">b</span></tt> is a numbers ranges <tt class="docutils literal"><span class="pre">0.0..1.0</span></tt>.
  178. </dd>
  179. <a id="Color,uint8,uint8,uint8,uint8"></a>
  180. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cuint8%2Cuint8%2Cuint8%2Cuint8"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">uint8</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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>
  181. <dd>
  182. Creates a new Color from RGBA. <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt>, <tt class="docutils literal"><span class="pre">b</span></tt> and <tt class="docutils literal"><span class="pre">a</span></tt> is a numbers ranges <tt class="docutils literal"><span class="pre">0..255</span></tt>.
  183. </dd>
  184. <a id="Color,uint8,uint8,uint8"></a>
  185. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cuint8%2Cuint8%2Cuint8"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">uint8</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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">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>
  186. <dd>
  187. Creates a new Color from RGB. <tt class="docutils literal"><span class="pre">r</span></tt>, <tt class="docutils literal"><span class="pre">g</span></tt> and <tt class="docutils literal"><span class="pre">b</span></tt> is a numbers ranges <tt class="docutils literal"><span class="pre">0..255</span></tt>.
  188. </dd>
  189. <a id="Color,string"></a>
  190. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cstring"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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">ValueError</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>
  191. <dd>
  192. Parses color from string. <tt class="docutils literal"><span class="pre">src</span></tt> should be a string, begins with &quot;#&quot;, &quot;0x&quot; or &quot;0X&quot; and have a RRGGBBAA color value.
  193. <p><strong class="examples_text">Examples:</strong></p>
  194. <pre class="listing"><span class="Keyword">var</span>
  195. <span class="Identifier">clr1</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="StringLit">&quot;#FFCCAAFF&quot;</span><span class="Other">)</span>
  196. <span class="Identifier">clr2</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="StringLit">&quot;0xFFAACCFF&quot;</span><span class="Other">)</span>
  197. <span class="Identifier">clr3</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="StringLit">&quot;0XAACCFFFF&quot;</span><span class="Other">)</span>
  198. <span class="Identifier">clr4</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="StringLit">&quot;#AAFFCCFF&quot;</span><span class="Other">)</span>
  199. <span class="Identifier">echo</span> <span class="Identifier">clr1</span>
  200. <span class="Identifier">echo</span> <span class="Identifier">clr2</span>
  201. <span class="Identifier">echo</span> <span class="Identifier">clr3</span>
  202. <span class="Identifier">echo</span> <span class="Identifier">clr4</span></pre>
  203. </dd>
  204. <a id="Color,uint32"></a>
  205. <dt><pre><span class="Keyword">proc</span> <a href="#Color%2Cuint32"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Identifier">src</span><span class="Other">:</span> <span class="Identifier">uint32</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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>
  206. <dd>
  207. Translate uint32 color to the Color object.
  208. <p><strong class="examples_text">Examples:</strong></p>
  209. <pre class="listing"><span class="Keyword">var</span>
  210. <span class="Identifier">clr1</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="DecNumber">0xFFCCAAFF'u32</span><span class="Other">)</span>
  211. <span class="Identifier">clr2</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="DecNumber">0xFFAACCFF'u32</span><span class="Other">)</span>
  212. <span class="Identifier">clr3</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="DecNumber">0xAACCFFFF'u32</span><span class="Other">)</span>
  213. <span class="Identifier">clr4</span> <span class="Other">=</span> <span class="Identifier">Color</span><span class="Other">(</span><span class="DecNumber">0xAAFFCCFF'u32</span><span class="Other">)</span>
  214. <span class="Identifier">echo</span> <span class="Identifier">clr1</span>
  215. <span class="Identifier">echo</span> <span class="Identifier">clr2</span>
  216. <span class="Identifier">echo</span> <span class="Identifier">clr3</span>
  217. <span class="Identifier">echo</span> <span class="Identifier">clr4</span></pre>
  218. </dd>
  219. <a id="Color"></a>
  220. <dt><pre><span class="Keyword">proc</span> <a href="#Color"><span class="Identifier">Color</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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">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>
  221. <dd>
  222. Creates a new Color object with RGBA value (0, 0, 0, 0)
  223. </dd>
  224. <a id="normalize,float"></a>
  225. <dt><pre><span class="Keyword">proc</span> <a href="#normalize%2Cfloat"><span class="Identifier">normalize</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  226. <dd>
  227. </dd>
  228. <a id="normalize,float,float,float"></a>
  229. <dt><pre><span class="Keyword">proc</span> <a href="#normalize%2Cfloat%2Cfloat%2Cfloat"><span class="Identifier">normalize</span></a><span class="Other">(</span><span class="Identifier">n</span><span class="Other">,</span> <span class="Identifier">min</span><span class="Other">,</span> <span class="Identifier">max</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</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>
  230. <dd>
  231. Returns number in range <tt class="docutils literal"><span class="pre">0.0..1.0</span></tt>.
  232. </dd>
  233. <a id="normalizeColor,float"></a>
  234. <dt><pre><span class="Keyword">proc</span> <a href="#normalizeColor%2Cfloat"><span class="Identifier">normalizeColor</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</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>
  235. <dd>
  236. Returns number in range <tt class="docutils literal"><span class="pre">0..255</span></tt>.
  237. </dd>
  238. <a id="toUint32BE,ColorRef"></a>
  239. <dt><pre><span class="Keyword">proc</span> <a href="#toUint32BE%2CColorRef"><span class="Identifier">toUint32BE</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  240. <dd>
  241. Converts Color object to uint32 with <tt class="docutils literal"><span class="pre">big endian</span></tt>.
  242. </dd>
  243. <a id="toUint32LE,ColorRef"></a>
  244. <dt><pre><span class="Keyword">proc</span> <a href="#toUint32LE%2CColorRef"><span class="Identifier">toUint32LE</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  245. <dd>
  246. Converts Color object to uint32 with <tt class="docutils literal"><span class="pre">little endian</span></tt>.
  247. </dd>
  248. <a id="toFloatTuple,ColorRef"></a>
  249. <dt><pre><span class="Keyword">proc</span> <a href="#toFloatTuple%2CColorRef"><span class="Identifier">toFloatTuple</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float</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>
  250. <dd>
  251. Converts Color object to the tuple.
  252. </dd>
  253. <a id="toUint32Tuple,ColorRef"></a>
  254. <dt><pre><span class="Keyword">proc</span> <a href="#toUint32Tuple%2CColorRef"><span class="Identifier">toUint32Tuple</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">g</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  255. <dd>
  256. Converts Color object to the tuple.
  257. </dd>
  258. <a id="toUint32BEWithoutAlpha,ColorRef"></a>
  259. <dt><pre><span class="Keyword">proc</span> <a href="#toUint32BEWithoutAlpha%2CColorRef"><span class="Identifier">toUint32BEWithoutAlpha</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  260. <dd>
  261. Converts Color object to uint32 without alpha-channel with <tt class="docutils literal"><span class="pre">big endian</span></tt>.
  262. </dd>
  263. <a id="toUint32LEWithoutAlpha,ColorRef"></a>
  264. <dt><pre><span class="Keyword">proc</span> <a href="#toUint32LEWithoutAlpha%2CColorRef"><span class="Identifier">toUint32LEWithoutAlpha</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  265. <dd>
  266. Converts Color object to uint32 without alpha-channel with <tt class="docutils literal"><span class="pre">little endian</span></tt>.
  267. </dd>
  268. <a id="lerp,ColorRef,ColorRef,float"></a>
  269. <dt><pre><span class="Keyword">proc</span> <a href="#lerp%2CColorRef%2CColorRef%2Cfloat"><span class="Identifier">lerp</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">,</span> <span class="Identifier">other</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</span></a><span class="Other">;</span> <span class="Identifier">lerpv</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  270. <dd>
  271. <p>linear interpolate color.</p>
  272. <p>Arguments:</p>
  273. <ul class="simple"><li><tt class="docutils literal"><span class="pre">self</span></tt> and <tt class="docutils literal"><span class="pre">other</span></tt> - Color objects.</li>
  274. <li><tt class="docutils literal"><span class="pre">lerpv</span></tt> - linear interpolate value</li>
  275. </ul>
  276. </dd>
  277. <a id="lerp,uint32,uint32,uint32,uint32,uint32,uint32,uint32,uint32,float"></a>
  278. <dt><pre><span class="Keyword">proc</span> <a href="#lerp%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cuint32%2Cfloat"><span class="Identifier">lerp</span></a><span class="Other">(</span><span class="Identifier">r1</span><span class="Other">,</span> <span class="Identifier">g1</span><span class="Other">,</span> <span class="Identifier">b1</span><span class="Other">,</span> <span class="Identifier">a1</span><span class="Other">,</span> <span class="Identifier">r2</span><span class="Other">,</span> <span class="Identifier">g2</span><span class="Other">,</span> <span class="Identifier">b2</span><span class="Other">,</span> <span class="Identifier">a2</span><span class="Other">:</span> <span class="Identifier">uint32</span><span class="Other">;</span> <span class="Identifier">lerpv</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">uint32</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>
  279. <dd>
  280. </dd>
  281. <a id="$,ColorRef"></a>
  282. <dt><pre><span class="Keyword">proc</span> <a href="#%24%2CColorRef"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">color</span><span class="Other">:</span> <a href="color.html#ColorRef"><span class="Identifier">ColorRef</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>
  283. <dd>
  284. </dd>
  285. </dl></div>
  286. </div>
  287. </div>
  288. <div class="row">
  289. <div class="twelve-columns footer">
  290. <span class="nim-sprite"></span>
  291. <br/>
  292. <small style="color: var(--hint);">Made with Nim. Generated: 2020-05-19 14:44:30 UTC</small>
  293. </div>
  294. </div>
  295. </div>
  296. </div>
  297. </body>
  298. </html>