window.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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>window</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">window</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="#6" id="56">Imports</a>
  90. <ul class="simple simple-toc-section">
  91. </ul>
  92. </li>
  93. <li>
  94. <a class="reference reference-toplevel" href="#8" id="58">Vars</a>
  95. <ul class="simple simple-toc-section">
  96. <li><a class="reference" href="#env"
  97. title="env: EnvironmentRef = newEnvironment()"><wbr />env<span class="attachedType"></span></a></li>
  98. <li><a class="reference" href="#main_scene"
  99. title="main_scene: ScenePtr = nil"><wbr />main_<wbr />scene<span class="attachedType"></span></a></li>
  100. <li><a class="reference" href="#current_scene"
  101. title="current_scene: ScenePtr = nil"><wbr />current_<wbr />scene<span class="attachedType"></span></a></li>
  102. <li><a class="reference" href="#scenes"
  103. title="scenes: seq[ScenePtr] = @[]"><wbr />scenes<span class="attachedType"></span></a></li>
  104. <li><a class="reference" href="#paused"
  105. title="paused: bool = false"><wbr />paused<span class="attachedType"></span></a></li>
  106. </ul>
  107. </li>
  108. <li>
  109. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  110. <ul class="simple simple-toc-section">
  111. <li><a class="reference" href="#addScene%2CScenePtr"
  112. title="addScene(scene: ScenePtr)"><wbr />add<wbr />Scene<span class="attachedType"></span></a></li>
  113. <li><a class="reference" href="#changeScene%2Cstring"
  114. title="changeScene(name: string): bool"><wbr />change<wbr />Scene<span class="attachedType"></span></a></li>
  115. <li><a class="reference" href="#setMainScene%2Cstring"
  116. title="setMainScene(name: string)"><wbr />set<wbr />Main<wbr />Scene<span class="attachedType"></span></a></li>
  117. <li><a class="reference" href="#setTitle%2Ccstring"
  118. title="setTitle(title: cstring)"><wbr />set<wbr />Title<span class="attachedType"></span></a></li>
  119. <li><a class="reference" href="#Window%2Ccstring%2Ccint%2Ccint"
  120. title="Window(title: cstring; w: cint = 640; h: cint = 360)"><wbr />Window<span class="attachedType"></span></a></li>
  121. <li><a class="reference" href="#windowLaunch"
  122. title="windowLaunch()"><wbr />window<wbr />Launch<span class="attachedType"></span></a></li>
  123. </ul>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="nine columns" id="content">
  128. <div id="tocRoot"></div>
  129. <p class="module-desc"></p>
  130. <div class="section" id="6">
  131. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  132. <dl class="item">
  133. <a class="reference external" href="opengl.html">opengl</a>, <a class="reference external" href="glut.html">glut</a>, <a class="reference external" href="color.html">color</a>, <a class="reference external" href="exceptions.html">exceptions</a>, <a class="reference external" href="input.html">input</a>, <a class="reference external" href="node.html">node</a>, <a class="reference external" href="scene.html">scene</a>, <a class="reference external" href="environment.html">environment</a>
  134. </dl></div>
  135. <div class="section" id="8">
  136. <h1><a class="toc-backref" href="#8">Vars</a></h1>
  137. <dl class="item">
  138. <a id="env"></a>
  139. <dt><pre><a href="window.html#env"><span class="Identifier">env</span></a><span class="Other">:</span> <a href="environment.html#EnvironmentRef"><span class="Identifier">EnvironmentRef</span></a> <span class="Other">=</span> <span class="Identifier">newEnvironment</span><span class="Other">(</span><span class="Other">)</span></pre></dt>
  140. <dd>
  141. </dd>
  142. <a id="main_scene"></a>
  143. <dt><pre><a href="window.html#main_scene"><span class="Identifier">main_scene</span></a><span class="Other">:</span> <a href="scene.html#ScenePtr"><span class="Identifier">ScenePtr</span></a> <span class="Other">=</span> <span class="Keyword">nil</span></pre></dt>
  144. <dd>
  145. </dd>
  146. <a id="current_scene"></a>
  147. <dt><pre><a href="window.html#current_scene"><span class="Identifier">current_scene</span></a><span class="Other">:</span> <a href="scene.html#ScenePtr"><span class="Identifier">ScenePtr</span></a> <span class="Other">=</span> <span class="Keyword">nil</span></pre></dt>
  148. <dd>
  149. </dd>
  150. <a id="scenes"></a>
  151. <dt><pre><a href="window.html#scenes"><span class="Identifier">scenes</span></a><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="scene.html#ScenePtr"><span class="Identifier">ScenePtr</span></a><span class="Other">]</span> <span class="Other">=</span> <span class="Operator">@</span><span class="Other">[</span><span class="Other">]</span></pre></dt>
  152. <dd>
  153. </dd>
  154. <a id="paused"></a>
  155. <dt><pre><a href="window.html#paused"><span class="Identifier">paused</span></a><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span></pre></dt>
  156. <dd>
  157. </dd>
  158. </dl></div>
  159. <div class="section" id="12">
  160. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  161. <dl class="item">
  162. <a id="addScene,ScenePtr"></a>
  163. <dt><pre><span class="Keyword">proc</span> <a href="#addScene%2CScenePtr"><span class="Identifier">addScene</span></a><span class="Other">(</span><span class="Identifier">scene</span><span class="Other">:</span> <a href="scene.html#ScenePtr"><span class="Identifier">ScenePtr</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>
  164. <dd>
  165. <p>Adds a new scenes in app.</p>
  166. <p>Arguments:</p>
  167. <ul class="simple"><li><tt class="docutils literal"><span class="pre">scene</span></tt> - pointer to the Scene object.</li>
  168. </ul>
  169. </dd>
  170. <a id="changeScene,string"></a>
  171. <dt><pre><span class="Keyword">proc</span> <a href="#changeScene%2Cstring"><span class="Identifier">changeScene</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">discardable</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span>
  172. <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>
  173. <dd>
  174. <p>Changes current scene.</p>
  175. <p>Arguments:</p>
  176. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> - name of the added scene.</li>
  177. </ul>
  178. </dd>
  179. <a id="setMainScene,string"></a>
  180. <dt><pre><span class="Keyword">proc</span> <a href="#setMainScene%2Cstring"><span class="Identifier">setMainScene</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</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>
  181. <dd>
  182. <p>Set up main scene.</p>
  183. <p>Arguments:</p>
  184. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> - name of the added scene.</li>
  185. </ul>
  186. </dd>
  187. <a id="setTitle,cstring"></a>
  188. <dt><pre><span class="Keyword">proc</span> <a href="#setTitle%2Ccstring"><span class="Identifier">setTitle</span></a><span class="Other">(</span><span class="Identifier">title</span><span class="Other">:</span> <span class="Identifier">cstring</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">WindowNotCreatedError</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>
  189. <dd>
  190. Changes window title.
  191. </dd>
  192. <a id="Window,cstring,cint,cint"></a>
  193. <dt><pre><span class="Keyword">proc</span> <a href="#Window%2Ccstring%2Ccint%2Ccint"><span class="Identifier">Window</span></a><span class="Other">(</span><span class="Identifier">title</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Other">=</span> <span class="DecNumber">640</span><span class="Other">;</span> <span class="Identifier">h</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Other">=</span> <span class="DecNumber">360</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">cdecl</span><span class="Other">,</span>
  194. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">GLerror</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>
  195. <dd>
  196. <p>Creates a new window pointer</p>
  197. <p>Arguments:</p>
  198. <ul class="simple"><li><tt class="docutils literal"><span class="pre">title</span></tt> - window title.</li>
  199. </ul>
  200. </dd>
  201. <a id="windowLaunch"></a>
  202. <dt><pre><span class="Keyword">proc</span> <a href="#windowLaunch"><span class="Identifier">windowLaunch</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="Identifier">GLerror</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">MainSceneNotLoadedError</span><span class="Other">]</span><span class="Other">,</span>
  203. <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>
  204. <dd>
  205. Start main window loop.
  206. </dd>
  207. </dl></div>
  208. </div>
  209. </div>
  210. <div class="row">
  211. <div class="twelve-columns footer">
  212. <span class="nim-sprite"></span>
  213. <br/>
  214. <small style="color: var(--hint);">Made with Nim. Generated: 2020-05-19 14:47:10 UTC</small>
  215. </div>
  216. </div>
  217. </div>
  218. </div>
  219. </body>
  220. </html>