update doc

bogue.opam

@@ -1,6 +1,7 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
 build: [
+  ["dune" "subst"] {pinned}
   ["dune" "build" "-p" name "-j" jobs]
   ["dune" "runtest" "-p" name "-j" jobs] {with-test}
   ["dune" "build" "-p" name "@doc"] {with-doc}

docs/Bogue.Bogue.html

@@ -68,4 +68,9 @@ <h2 id="2_UsingBoguetogetherwithanothergraphicsloop">Using Bogue together with a
    <code class="code">fps()</code> was executed by <code class="code">one_step</code>. If not, you should handle the frame rate
    yourself.<br>
 </div>
+
+<pre><span id="VALquit"><span class="keyword">val</span> quit</span> : <code class="type">unit -> unit</code></pre><div class="info ">
+Use this to close SDL windows and cleanup memory, after <a href="Bogue.Main.html#VALrun"><code class="code"><span class="constructor">Main</span>.run</code></a> has
+   returned.<br>
+</div>
 </body></html>

docs/Bogue.Main.html

@@ -73,4 +73,9 @@ <h2 id="2_UsingBoguetogetherwithanothergraphicsloop">Using Bogue together with a
    <code class="code">fps()</code> was executed by <code class="code">one_step</code>. If not, you should handle the frame rate
    yourself.<br>
 </div>
+
+<pre><span id="VALquit"><span class="keyword">val</span> quit</span> : <code class="type">unit -> unit</code></pre><div class="info ">
+Use this to close SDL windows and cleanup memory, after <a href="Bogue.Main.html#VALrun"><code class="code"><span class="constructor">Main</span>.run</code></a> has
+   returned.<br>
+</div>
 </body></html>

docs/Bogue.Theme.html

@@ -97,4 +97,9 @@ <h2 id="2_AccessingThemevariables">Accessing Theme variables</h2>
      Theme variables are essentially for Bogue's internal use, but sometimes it
      can be useful to access their values. See above for their description.<br>
 
-<pre><span id="VALroom_margin"><span class="keyword">val</span> room_margin</span> : <code class="type">int</code></pre></body></html>
+<pre><span id="VALroom_margin"><span class="keyword">val</span> room_margin</span> : <code class="type">int</code></pre>
+<pre><span id="VALscale_int"><span class="keyword">val</span> scale_int</span> : <code class="type">int -> int</code></pre><div class="info ">
+Conversion: Bogue dimension -&gt; hardware pixel dimension. The latter is
+   obtained by multiplying by <code class="code"><span class="constructor">SCALE</span></code>.<br>
+</div>
+</body></html>

docs/Bogue.html

@@ -33,7 +33,7 @@ <h1>Module <a href="type_Bogue.html">Bogue</a></h1>
    Bogue is entirely written in <a href="https://ocaml.org/">ocaml</a> except for the
    hardware accelerated graphics library <a href="https://www.libsdl.org/">SDL2</a>.<br>
 <b>Author(s):</b> Vu Ngoc San<br>
-<b>Version:</b> 20190814<br>
+<b>Version:</b> 20190817<br>
 </div>
 <hr width="100%">
 <br>

docs/Principles.html

@@ -100,7 +100,7 @@ <h2 id="a-simple-example">A simple example</h2>
 <p>Here is what we want to program:</p>
 <p>We let the user enter her/his name on top of the window, for instance &quot;Audrey&quot;, and simultaneously there is a large greeting message in the center of the window saying &quot;Hello Audrey!&quot;.</p>
 <h3 id="the-standard-method-events-and-callbacks">The standard method (events and callbacks)</h3>
-<p>[examples/input]</p>
+<p><a href="https://github.com/sanette/bogue/blob/master/examples/input/input.ml">examples/input</a></p>
 <p>It's not the most natural way of programming if one is not used to event-driven GUIs (like GTK+), but it's a powerful method (and also quite efficient, for large programs).</p>
 <p>The program will look like the following.</p>
 <ol style="list-style-type: decimal">
@@ -121,7 +121,7 @@ <h3 id="the-standard-method-events-and-callbacks">The standard method (events an
 </ol>
 <p>Note that the order 1. and 2. can be swapped. In more complex examples, you cannot always separate all these steps like this, you may need to mix them, for instance because you want a widget action to modify a layout on the fly...</p>
 <h3 id="the-immediate-method">The &quot;immediate&quot; method</h3>
-<p>[examples/input-immediate]</p>
+<p><a href="https://github.com/sanette/bogue/blob/master/examples/input-immediate/input.ml">examples/input-immediate</a></p>
 <p>For simple programs like our example, when the action is fast and will not block the interface, one can use the immediate mode, which is easier to program and debug (no event, no callback).</p>
 <ol style="list-style-type: decimal">
 <li><p>We define the two widgets and the layout as in steps 2 and 4 in the standard method above:</p>
@@ -137,7 +137,7 @@ <h3 id="the-immediate-method">The &quot;immediate&quot; method</h3>
 Bogue.run ~before_display board</code></pre></div></li>
 </ol>
 <h3 id="the-embedded-method">The &quot;embedded&quot; method</h3>
-<p>[examples/embed]</p>
+<p><a href="https://github.com/sanette/bogue/blob/master/examples/embed/embed.ml">examples/embed</a></p>
 <p>This is only useful if you already have an application with an event/display loop (like a game) and you want to add some GUI on top of this.</p>
 <ol style="list-style-type: decimal">
 <li><p>use one of the methods above to create your board</p></li>

docs/index_values.html

@@ -638,6 +638,12 @@ <h1>Index of values</h1>
 </div>
 </td></tr>
 <tr><td align="left"><br>Q</td></tr>
+<tr><td><a href="Bogue.Main.html#VALquit">quit</a> [<a href="Bogue.Main.html">Bogue.Main</a>]</td>
+<td><div class="info">
+Use this to close SDL windows and cleanup memory, after <a href="Bogue.Main.html#VALrun"><code class="code"><span class="constructor">Main</span>.run</code></a> has
+   returned.
+</div>
+</td></tr>
 <tr><td><a href="Bogue.Draw.html#VALquit">quit</a> [<a href="Bogue.Draw.html">Bogue.Draw</a>]</td>
 <td><div class="info">
 Cleanup and quit SDL.
@@ -692,6 +698,11 @@ <h1>Index of values</h1>
 </div>
 </td></tr>
 <tr><td align="left"><br>S</td></tr>
+<tr><td><a href="Bogue.Theme.html#VALscale_int">scale_int</a> [<a href="Bogue.Theme.html">Bogue.Theme</a>]</td>
+<td><div class="info">
+Conversion: Bogue dimension -&gt; hardware pixel dimension.
+</div>
+</td></tr>
 <tr><td><a href="Bogue.Select.html#VALselected">selected</a> [<a href="Bogue.Select.html">Bogue.Select</a>]</td>
 <td><div class="info">
 The index (starting from 0) of the selected item.

docs/type_Bogue.Main.html

@@ -26,4 +26,5 @@
 &nbsp;&nbsp;&nbsp;&nbsp;bool&nbsp;<span class="keywordsign">-&gt;</span><br>
 &nbsp;&nbsp;&nbsp;&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit)&nbsp;*&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit)&nbsp;<span class="keywordsign">-&gt;</span><br>
 &nbsp;&nbsp;&nbsp;&nbsp;?clear:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Bogue</span>.<span class="constructor">Main</span>.board&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;bool<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;quit&nbsp;:&nbsp;unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
 <span class="keyword">end</span></pre></body></html>

docs/type_Bogue.Theme.html

@@ -10,4 +10,4 @@
 <link title="Bogue" rel="Chapter" href="Bogue.html"><title>Bogue.Theme</title>
 </head>
 <body>
-<pre class="code"><span class="keyword">sig</span>&nbsp;<span class="keyword">val</span>&nbsp;room_margin&nbsp;:&nbsp;int&nbsp;<span class="keyword">end</span></pre></body></html>
+<pre class="code"><span class="keyword">sig</span>&nbsp;<span class="keyword">val</span>&nbsp;room_margin&nbsp;:&nbsp;int&nbsp;<span class="keyword">val</span>&nbsp;scale_int&nbsp;:&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keyword">end</span></pre></body></html>

docs/type_Bogue.html

@@ -37,7 +37,7 @@
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;remove_option&nbsp;:&nbsp;<span class="keywordsign">'</span>a&nbsp;option&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;run&nbsp;:&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
-&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">Theme</span>&nbsp;:&nbsp;<span class="keyword">sig</span>&nbsp;<span class="keyword">val</span>&nbsp;room_margin&nbsp;:&nbsp;int&nbsp;<span class="keyword">end</span><br>
+&nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">Theme</span>&nbsp;:&nbsp;<span class="keyword">sig</span>&nbsp;<span class="keyword">val</span>&nbsp;room_margin&nbsp;:&nbsp;int&nbsp;<span class="keyword">val</span>&nbsp;scale_int&nbsp;:&nbsp;int&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;int&nbsp;<span class="keyword">end</span><br>
 &nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">Time</span>&nbsp;:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">sig</span><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;t&nbsp;=&nbsp;int<br>
@@ -831,6 +831,7 @@
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;bool&nbsp;<span class="keywordsign">-&gt;</span><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit)&nbsp;*&nbsp;(unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit)&nbsp;<span class="keywordsign">-&gt;</span><br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;?clear:bool&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Bogue</span>.<span class="constructor">Main</span>.board&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;bool<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;quit&nbsp;:&nbsp;unit&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;unit<br>
 &nbsp;&nbsp;&nbsp;&nbsp;<span class="keyword">end</span><br>
 &nbsp;&nbsp;<span class="keyword">module</span>&nbsp;<span class="constructor">Bogue</span>&nbsp;=&nbsp;<span class="constructor">Main</span><br>
 <span class="keyword">end</span></pre></body></html>