minor changes and documentation update

Vladar4 · Nov 11, 2012 · e67806b · e67806b
1 parent f991345
commit e67806b
Show file tree

Hide file tree

Showing 32 changed files with 1,554 additions and 207 deletions.
diff --git a/doc/audio.html b/doc/audio.html
diff --git a/doc/collider.html b/doc/collider.html
@@ -663,7 +663,7 @@ <h1><a class="toc-backref" href="#63">Methods</a></h1>
 
 </div>
 
-<small>Generated: 2012-11-10 16:16:03 UTC</small>
+<small>Generated: 2012-11-11 20:09:27 UTC</small>
 </div>
 </body>
 </html>
diff --git a/doc/common.html b/doc/common.html
@@ -348,11 +348,11 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
 <dl class="item">
 <dt id="107"><pre><span class="Keyword">proc</span> <span class="Identifier">distance</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">TPoint</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">TPoint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</span></pre></dt>
 <dd>
-
+<strong>Return</strong> distance between two points.
 </dd>
 <dt id="112"><pre><span class="Keyword">proc</span> <span class="Identifier">direction</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">TPoint</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">TPoint</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</span></pre></dt>
 <dd>
-
+<strong>Return</strong> angle direction from one to other point.
 </dd>
 <dt id="119"><pre><span class="Keyword">proc</span> <span class="Identifier">vector</span><span class="Other">(</span><span class="Identifier">angle</span><span class="Other">:</span> <span class="Identifier">float</span><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">=</span> <span class="FloatNumber">1.0000000000000000e+00</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">TVector</span> <span class="Other">{.</span>
     <span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
@@ -369,31 +369,31 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
 </dd>
 <dt id="122"><pre><span class="Keyword">proc</span> <span class="Identifier">absVector</span><span class="Other">(</span><span class="Identifier">vector</span><span class="Other">:</span> <span class="Identifier">TVector</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">{.</span><span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
 <dd>
-
+Get absolute size of vector.
 </dd>
 <dt id="123"><pre><span class="Keyword">proc</span> <span class="Identifier">absVector</span><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">float</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">{.</span><span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
 <dd>
 
 </dd>
 <dt id="124"><pre><span class="Keyword">proc</span> <span class="Identifier">color</span><span class="Other">(</span><span class="Identifier">r</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">g</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">TColor</span> <span class="Other">{.</span><span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
 <dd>
-
+<strong>Return</strong> <tt class="docutils literal"><span class="pre">TColor</span></tt> created from given <cite>r</cite>, <cite>g</cite>, <cite>b</cite> components.
 </dd>
 <dt id="125"><pre><span class="Keyword">proc</span> <span class="Identifier">check</span><span class="Other">(</span><span class="Identifier">ret</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">void</span></pre></dt>
 <dd>
-
+SDL errors handling wrapper.
 </dd>
 <dt id="126"><pre><span class="Keyword">proc</span> <span class="Identifier">check</span><span class="Other">(</span><span class="Identifier">ret</span><span class="Other">:</span> <span class="Identifier">TBool</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">void</span></pre></dt>
 <dd>
-
+SDL errors handling wrapper.
 </dd>
 <dt id="127"><pre><span class="Keyword">proc</span> <span class="Identifier">check</span><span class="Other">(</span><span class="Identifier">ret</span><span class="Other">:</span> <span class="Identifier">PSurface</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PSurface</span></pre></dt>
 <dd>
-
+SDL errors handling wrapper.
 </dd>
 <dt id="128"><pre><span class="Keyword">proc</span> <span class="Identifier">check</span><span class="Other">(</span><span class="Identifier">ret</span><span class="Other">:</span> <span class="Identifier">PFont</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PFont</span></pre></dt>
 <dd>
-
+SDL TTF errors handling wrapper.
 </dd>
 
 </dl></div>
@@ -445,7 +445,7 @@ <h1><a class="toc-backref" href="#67">Templates</a></h1>
 
 </div>
 
-<small>Generated: 2012-11-10 16:16:03 UTC</small>
+<small>Generated: 2012-11-11 20:09:27 UTC</small>
 </div>
 </body>
 </html>
diff --git a/doc/engine.html b/doc/engine.html
@@ -341,19 +341,33 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
                <span class="Identifier">audioChannels</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Other">=</span> <span class="Identifier">DEFAULT_CHANNELS</span><span class="Other">;</span> 
                <span class="Identifier">audioChunkSize</span><span class="Other">:</span> <span class="Identifier">cint</span> <span class="Other">=</span> <span class="DecNumber">1024</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PEngine</span></pre></dt>
 <dd>
+<p><tt class="docutils literal"><span class="pre">width</span></tt>: screen width.</p>
+<p><tt class="docutils literal"><span class="pre">height</span></tt>: screen height.</p>
+<p><tt class="docutils literal"><span class="pre">flags</span></tt>: init flags.</p>
+<p><tt class="docutils literal"><span class="pre">scale</span></tt>: screen scale rate (1 for no-scaling).</p>
+<p><tt class="docutils literal"><span class="pre">title</span></tt>: window caption.</p>
+<p><tt class="docutils literal"><span class="pre">updateInterval</span></tt>: interval of update event in ms.</p>
+<p><tt class="docutils literal"><span class="pre">info</span></tt>: <strong>true</strong> to show info panel.</p>
+<p><tt class="docutils literal"><span class="pre">infobg</span></tt>: <strong>true</strong> to show info on black background.</p>
+<p><tt class="docutils literal"><span class="pre">bgColor</span></tt>: screen background color.</p>
+<p><tt class="docutils literal"><span class="pre">audio</span></tt>: <strong>true</strong> to use audio system.</p>
+<p><tt class="docutils literal"><span class="pre">audioFrequency</span></tt>: audio sampling frequency in samples per second (Hz).</p>
+<p><tt class="docutils literal"><span class="pre">audioFromat</span></tt>: audio sample format.</p>
+<p><tt class="docutils literal"><span class="pre">audioChannels</span></tt>: number of sound channels (2 for stereo, 1 for mono).</p>
+<p><tt class="docutils literal"><span class="pre">audioChunkSize</span></tt>: bytes used per sample.</p>
 
 </dd>
 <dt id="109"><pre><span class="Keyword">proc</span> <span class="Identifier">switchInfo</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">PEngine</span><span class="Other">)</span> <span class="Other">{.</span><span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
 <dd>
-
+Turn on/off info panel.
 </dd>
 <dt id="110"><pre><span class="Keyword">proc</span> <span class="Identifier">flip</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">PEngine</span><span class="Other">)</span> <span class="Other">{.</span><span class="Identifier">inline</span><span class="Other">.}</span></pre></dt>
 <dd>
 
 </dd>
 <dt id="111"><pre><span class="Keyword">proc</span> <span class="Identifier">start</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">PEngine</span><span class="Other">)</span></pre></dt>
 <dd>
-
+Start main cycle.
 </dd>
 
 </dl></div>
@@ -381,7 +395,7 @@ <h1><a class="toc-backref" href="#63">Methods</a></h1>
 
 </div>
 
-<small>Generated: 2012-11-10 16:16:03 UTC</small>
+<small>Generated: 2012-11-11 20:09:27 UTC</small>
 </div>
 </body>
 </html>
diff --git a/doc/entity.html b/doc/entity.html
@@ -415,7 +415,7 @@ <h1><a class="toc-backref" href="#63">Methods</a></h1>
 
 </div>
 
-<small>Generated: 2012-11-10 16:16:03 UTC</small>
+<small>Generated: 2012-11-11 20:09:27 UTC</small>
 </div>
 </body>
 </html>
diff --git a/doc/font.html b/doc/font.html
@@ -330,13 +330,13 @@ <h1><a class="toc-backref" href="#57">Types</a></h1>
 <dt id="105"><pre><span class="Identifier">TTTFFont</span> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">TFontObject</span>
   <span class="Identifier">fFont</span><span class="Other">:</span> <span class="Identifier">PFont</span>
   <span class="Identifier">size</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
-  <span class="Identifier">color</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TColor</span>
-  <span class="Identifier">background</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TColor</span>
-  <span class="Identifier">mode</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TTTFRenderMode</span>
-  <span class="Identifier">utf8</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
-</pre></dt>
+  <span class="Identifier">color</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TColor</span>              <span class="Comment">## font color</span>
+  <span class="Identifier">background</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TColor</span>         <span class="Comment">## background color (only for shaded render mode).</span>
+  <span class="Identifier">mode</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">TTTFRenderMode</span>       <span class="Comment">## TTF render mode (solid, shaded, blended)</span>
+  <span class="Identifier">utf8</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>                 <span class="Comment">## use UTF-8</span>
+  </pre></dt>
 <dd>
-
+font size
 </dd>
 <dt id="106"><pre><span class="Identifier">PBitmapFont</span> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">TBitmapFont</span></pre></dt>
 <dd>
@@ -373,6 +373,12 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
                 <span class="Identifier">mode</span><span class="Other">:</span> <span class="Identifier">TTTFRenderMode</span> <span class="Other">=</span> <span class="Identifier">solid</span><span class="Other">;</span> 
                 <span class="Identifier">utf8</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PTTFFont</span></pre></dt>
 <dd>
+<p><tt class="docutils literal"><span class="pre">filename</span></tt>: ttf file to load from.</p>
+<p><tt class="docutils literal"><span class="pre">size</span></tt>: font size.</p>
+<p><tt class="docutils literal"><span class="pre">color</span></tt>: font color.</p>
+<p><tt class="docutils literal"><span class="pre">background</span></tt>: background color (only for <tt class="docutils literal"><span class="pre">shaded</span></tt> render mode).</p>
+<p><tt class="docutils literal"><span class="pre">mode</span></tt>: TTF render mode (solid, shaded, blended).</p>
+<p><tt class="docutils literal"><span class="pre">utf8</span></tt>: <strong>true</strong> to use UTF-8.</p>
 
 </dd>
 <dt id="123"><pre><span class="Keyword">proc</span> <span class="Identifier">init</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">PBitmapFont</span><span class="Other">;</span> <span class="Identifier">filename</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">h</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span></pre></dt>
@@ -398,6 +404,9 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
 <dt id="128"><pre><span class="Keyword">proc</span> <span class="Identifier">newBitmapFont</span><span class="Other">(</span><span class="Identifier">filename</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">h</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PBitmapFont</span></pre></dt>
 <dd>
+<p><tt class="docutils literal"><span class="pre">filename</span></tt>: image (charmap) to load from.</p>
+<p><tt class="docutils literal"><span class="pre">w</span></tt>: width of single char in pixels.</p>
+<p><tt class="docutils literal"><span class="pre">h</span></tt>: height of single char in pixels.</p>
 
 </dd>
 <dt id="129"><pre><span class="Keyword">proc</span> <span class="Identifier">newBitmapFont</span><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Identifier">PSurface</span><span class="Other">;</span> 
@@ -409,6 +418,10 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
                    <span class="Identifier">w</span><span class="Other">,</span> <span class="Identifier">h</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> 
                    <span class="Identifier">color</span><span class="Other">:</span> <span class="Identifier">TColor</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PBitmapFont</span></pre></dt>
 <dd>
+<p><tt class="docutils literal"><span class="pre">filename</span></tt>: image (charmap) to load from.</p>
+<p><tt class="docutils literal"><span class="pre">w</span></tt>: width of single char in pixels.</p>
+<p><tt class="docutils literal"><span class="pre">h</span></tt>: height of single char in pixels.</p>
+<p><tt class="docutils literal"><span class="pre">color</span></tt>: font color.</p>
 
 </dd>
 <dt id="131"><pre><span class="Keyword">proc</span> <span class="Identifier">newBitmapFont</span><span class="Other">(</span><span class="Identifier">surface</span><span class="Other">:</span> <span class="Identifier">PSurface</span><span class="Other">;</span> 
@@ -419,7 +432,7 @@ <h1><a class="toc-backref" href="#62">Procs</a></h1>
 </dd>
 <dt id="132"><pre><span class="Keyword">proc</span> <span class="Identifier">render</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">PFontObject</span><span class="Other">;</span> <span class="Identifier">text</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">PSurface</span></pre></dt>
 <dd>
-
+Render multiple lines of text.
 </dd>
 
 </dl></div>
@@ -479,7 +492,7 @@ <h1><a class="toc-backref" href="#63">Methods</a></h1>
 
 </div>
 
-<small>Generated: 2012-11-10 16:16:03 UTC</small>
+<small>Generated: 2012-11-11 20:09:27 UTC</small>
 </div>
 </body>
 </html>