doc update

durkisneer1 · Jan 8, 2024 · dbb43d8 · dbb43d8
1 parent e011900
commit dbb43d8
Show file tree

Hide file tree

Showing 111 changed files with 14,566 additions and 37 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/getting_started.doctree b/docs/build/doctrees/getting_started.doctree
diff --git a/docs/build/doctrees/reference/draw.doctree b/docs/build/doctrees/reference/draw.doctree
diff --git a/docs/build/doctrees/reference/font.doctree b/docs/build/doctrees/reference/font.doctree
diff --git a/docs/build/doctrees/reference/input.doctree b/docs/build/doctrees/reference/input.doctree
diff --git a/docs/build/doctrees/reference/math.doctree b/docs/build/doctrees/reference/math.doctree
diff --git a/docs/build/doctrees/reference/rect.doctree b/docs/build/doctrees/reference/rect.doctree
diff --git a/docs/build/doctrees/reference/ref_main.doctree b/docs/build/doctrees/reference/ref_main.doctree
diff --git a/docs/build/doctrees/reference/render_window.doctree b/docs/build/doctrees/reference/render_window.doctree
diff --git a/docs/build/doctrees/reference/sprite.doctree b/docs/build/doctrees/reference/sprite.doctree
diff --git a/docs/build/doctrees/reference/texture.doctree b/docs/build/doctrees/reference/texture.doctree
diff --git a/docs/build/doctrees/reference/texture_cache.doctree b/docs/build/doctrees/reference/texture_cache.doctree
diff --git a/docs/build/doctrees/reference/tile_map.doctree b/docs/build/doctrees/reference/tile_map.doctree
diff --git a/docs/build/doctrees/reference/time.doctree b/docs/build/doctrees/reference/time.doctree
diff --git a/docs/build/html/_sources/getting_started.rst.txt b/docs/build/html/_sources/getting_started.rst.txt
@@ -16,7 +16,7 @@ After following the :doc:`installation` guide, you are ready for your first Krak
 
 
     int main() {
-        kn::RenderWindow window("Hello World");
+        kn::RenderWindow window;
         kn::time::Clock clock;
 
         bool done = false;

diff --git a/docs/build/html/_sources/reference/draw.rst.txt b/docs/build/html/_sources/reference/draw.rst.txt
@@ -0,0 +1,5 @@
+====
+draw
+====
+
+.. doxygenfunction:: kn::draw::rect
diff --git a/docs/build/html/_sources/reference/font.rst.txt b/docs/build/html/_sources/reference/font.rst.txt
@@ -0,0 +1,6 @@
+====
+Font
+====
+
+.. doxygenclass:: kn::Font
+    :members:
diff --git a/docs/build/html/_sources/reference/input.rst.txt b/docs/build/html/_sources/reference/input.rst.txt
@@ -0,0 +1,11 @@
+=====
+input
+=====
+
+.. doxygenfunction:: kn::input::getMousePos
+
+.. doxygenfunction:: kn::input::getMouseButtonPressed
+
+.. doxygenfunction:: kn::input::getKeysPressed
+
+.. doxygenfunction:: kn::input::getVector
diff --git a/docs/build/html/_sources/reference/math.rst.txt b/docs/build/html/_sources/reference/math.rst.txt
@@ -0,0 +1,12 @@
+====
+math
+====
+
+.. doxygenstruct:: kn::math::Vec2
+    :members:
+
+.. doxygenfunction:: kn::math::clampVec
+
+.. doxygenfunction:: kn::math::lerpVec
+
+.. doxygenfunction:: kn::math::clamp
diff --git a/docs/build/html/_sources/reference/rect.rst.txt b/docs/build/html/_sources/reference/rect.rst.txt
@@ -0,0 +1,6 @@
+====
+Rect
+====
+
+.. doxygenstruct:: kn::Rect
+    :members:
diff --git a/docs/build/html/_sources/reference/ref_main.rst.txt b/docs/build/html/_sources/reference/ref_main.rst.txt
@@ -3,4 +3,16 @@ API Reference
 =============
 
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 1
+
+    draw.rst
+    font.rst
+    input.rst
+    math.rst
+    rect.rst
+    render_window.rst
+    sprite.rst
+    texture_cache.rst
+    texture.rst
+    tile_map.rst
+    time.rst
diff --git a/docs/build/html/_sources/reference/render_window.rst.txt b/docs/build/html/_sources/reference/render_window.rst.txt
@@ -0,0 +1,6 @@
+============
+RenderWindow
+============
+
+.. doxygenclass:: kn::RenderWindow
+    :members:
diff --git a/docs/build/html/_sources/reference/sprite.rst.txt b/docs/build/html/_sources/reference/sprite.rst.txt
@@ -0,0 +1,6 @@
+======
+Sprite
+======
+
+.. doxygenclass:: kn::Sprite
+    :members:
diff --git a/docs/build/html/_sources/reference/texture.rst.txt b/docs/build/html/_sources/reference/texture.rst.txt
@@ -0,0 +1,6 @@
+=======
+Texture
+=======
+
+.. doxygenclass:: kn::Texture
+    :members:
diff --git a/docs/build/html/_sources/reference/texture_cache.rst.txt b/docs/build/html/_sources/reference/texture_cache.rst.txt
@@ -0,0 +1,6 @@
+============
+TextureCache
+============
+
+.. doxygenclass:: kn::TextureCache
+    :members:
diff --git a/docs/build/html/_sources/reference/tile_map.rst.txt b/docs/build/html/_sources/reference/tile_map.rst.txt
@@ -0,0 +1,6 @@
+=======
+TileMap
+=======
+
+.. doxygenclass:: kn::TileMap
+    :members:
diff --git a/docs/build/html/_sources/reference/time.rst.txt b/docs/build/html/_sources/reference/time.rst.txt
@@ -0,0 +1,6 @@
+====
+time
+====
+
+.. doxygenclass:: kn::time::Clock
+    :members:
diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -155,7 +155,18 @@
   <ul>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="reference/ref_main.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
+<li class="toctree-l1 has-children"><a class="reference internal" href="reference/ref_main.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/draw.html">draw</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/font.html">Font</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/input.html">input</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/math.html">math</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/rect.html">Rect</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/render_window.html">RenderWindow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/sprite.html">Sprite</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/texture_cache.html">TextureCache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/texture.html">Texture</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/tile_map.html">TileMap</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/time.html">time</a></li>
 </ul>
 </li>
 </ul>
@@ -194,8 +205,142 @@
 
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"></div>
+  <div class="genindex-jumpbox"><a href="#K"><strong>K</strong></a></div>
 </section>
+<section id="K" class="genindex-section">
+  <h2>K</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference/draw.html#_CPPv4N2kn4draw4rectER12RenderWindowR4RectK9SDL_Colori">kn::draw::rect (C++ function)</a>
+</li>
+        <li><a href="reference/font.html#_CPPv4N2kn4FontE">kn::Font (C++ class)</a>
+</li>
+        <li><a href="reference/font.html#_CPPv4N2kn4Font4FontER12RenderWindowRKNSt6stringEi">kn::Font::Font (C++ function)</a>
+</li>
+        <li><a href="reference/font.html#_CPPv4N2kn4Font6renderERKNSt6stringEb9SDL_Colori">kn::Font::render (C++ function)</a>
+</li>
+        <li><a href="reference/input.html#_CPPv4N2kn5input14getKeysPressedEv">kn::input::getKeysPressed (C++ function)</a>
+</li>
+        <li><a href="reference/input.html#_CPPv4N2kn5input21getMouseButtonPressedEv">kn::input::getMouseButtonPressed (C++ function)</a>
+</li>
+        <li><a href="reference/input.html#_CPPv4N2kn5input11getMousePosEi">kn::input::getMousePos (C++ function)</a>
+</li>
+        <li><a href="reference/input.html#_CPPv4N2kn5input9getVectorERKNSt6vectorI12SDL_ScancodeEERKNSt6vectorI12SDL_ScancodeEERKNSt6vectorI12SDL_ScancodeEERKNSt6vectorI12SDL_ScancodeEE">kn::input::getVector (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4I0EN2kn4math5clampE5digit5digit5digit5digit">kn::math::clamp (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4N2kn4math8clampVecE4Vec2RK4Vec2RK4Vec2">kn::math::clampVec (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4N2kn4math7lerpVecERK4Vec2RK4Vec2f">kn::math::lerpVec (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4N2kn4math4Vec2E">kn::math::Vec2 (C++ struct)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4NK2kn4math4Vec210distanceToERK4Vec2">kn::math::Vec2::distanceTo (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4NK2kn4math4Vec29getLengthEv">kn::math::Vec2::getLength (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4N2kn4math4Vec29normalizeEv">kn::math::Vec2::normalize (C++ function)</a>
+</li>
+        <li><a href="reference/math.html#_CPPv4N2kn4math4Vec24ZEROEv">kn::math::Vec2::ZERO (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4RectE">kn::Rect (C++ struct)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect5clampERKN4math4Vec2ERKN4math4Vec2E">kn::Rect::clamp (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect12collidePointERKN4math4Vec2E">kn::Rect::collidePoint (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect11collideRectERK4Rect">kn::Rect::collideRect (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect6getPosEv">kn::Rect::getPos (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect7getSizeEv">kn::Rect::getSize (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect4RectEffff">kn::Rect::Rect (C++ function)</a>
+</li>
+        <li><a href="reference/rect.html#_CPPv4N2kn4Rect7setSizeERKN4math4Vec2E">kn::Rect::setSize (C++ function)</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindowE">kn::RenderWindow (C++ class)</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow4blitERKNSt10shared_ptrI7TextureEE4Rect4Rect">kn::RenderWindow::blit (C++ function)</a>, <a href="reference/render_window.html#_CPPv4N2kn12RenderWindow4blitERKNSt10shared_ptrI7TextureEERKN4math4Vec2E">[1]</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow6blitExERKNSt10shared_ptrI7TextureEE4Rect4Rectdbb">kn::RenderWindow::blitEx (C++ function)</a>, <a href="reference/render_window.html#_CPPv4N2kn12RenderWindow6blitExERKNSt10shared_ptrI7TextureEERKN4math4Vec2Edbb">[1]</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow3clsE9SDL_Color">kn::RenderWindow::cls (C++ function)</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow4flipEv">kn::RenderWindow::flip (C++ function)</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow9getEventsEv">kn::RenderWindow::getEvents (C++ function)</a>
+</li>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow11getRendererEv">kn::RenderWindow::getRenderer (C++ function)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="reference/render_window.html#_CPPv4N2kn12RenderWindow12RenderWindowERKNSt6stringEib">kn::RenderWindow::RenderWindow (C++ function)</a>
+</li>
+        <li><a href="reference/sprite.html#_CPPv4N2kn6SpriteE">kn::Sprite (C++ class)</a>
+</li>
+        <li><a href="reference/sprite.html#_CPPv4NK2kn6Sprite10getTextureEv">kn::Sprite::getTexture (C++ function)</a>
+</li>
+        <li><a href="reference/sprite.html#_CPPv4N2kn6Sprite6SpriteER12RenderWindowNSt10shared_ptrI7TextureEE">kn::Sprite::Sprite (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7TextureE">kn::Texture (C++ class)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7Texture9fitHeightEf">kn::Texture::fitHeight (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7Texture8fitWidthEf">kn::Texture::fitWidth (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4NK2kn7Texture7getRectEv">kn::Texture::getRect (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4NK2kn7Texture13getSDLTextureEv">kn::Texture::getSDLTexture (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4NK2kn7Texture7getSizeEv">kn::Texture::getSize (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7Texture7scaleByEf">kn::Texture::scaleBy (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7Texture7setSizeERKN4math4Vec2E">kn::Texture::setSize (C++ function)</a>
+</li>
+        <li><a href="reference/texture.html#_CPPv4N2kn7Texture7TextureEP11SDL_Texture">kn::Texture::Texture (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCacheE">kn::TextureCache (C++ class)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache6createERKNSt6stringERKN4math4Vec2E9SDL_Color">kn::TextureCache::create (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4NK2kn12TextureCache8getCacheEv">kn::TextureCache::getCache (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4NK2kn12TextureCache10getTextureERKNSt6stringE">kn::TextureCache::getTexture (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache4loadERKNSt6stringERKNSt6stringE">kn::TextureCache::load (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache4moveERKNSt6stringENSt10shared_ptrI7TextureEE">kn::TextureCache::move (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache12TextureCacheER12RenderWindow">kn::TextureCache::TextureCache (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache6unloadERKNSt6stringE">kn::TextureCache::unload (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCache9unloadAllEv">kn::TextureCache::unloadAll (C++ function)</a>
+</li>
+        <li><a href="reference/texture_cache.html#_CPPv4N2kn12TextureCacheD0Ev">kn::TextureCache::~TextureCache (C++ function)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4N2kn7TileMapE">kn::TileMap (C++ class)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4N2kn7TileMap7drawAllEv">kn::TileMap::drawAll (C++ function)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4N2kn7TileMap11drawObjectsEv">kn::TileMap::drawObjects (C++ function)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4N2kn7TileMap9drawTilesEv">kn::TileMap::drawTiles (C++ function)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4NK2kn7TileMap10getObjectsEv">kn::TileMap::getObjects (C++ function)</a>
+</li>
+        <li><a href="reference/tile_map.html#_CPPv4N2kn7TileMap7TileMapER12RenderWindowR12TextureCacheRKNSt6stringE">kn::TileMap::TileMap (C++ function)</a>
+</li>
+        <li><a href="reference/time.html#_CPPv4N2kn4time5ClockE">kn::time::Clock (C++ class)</a>
+</li>
+        <li><a href="reference/time.html#_CPPv4N2kn4time5Clock4tickEi">kn::time::Clock::tick (C++ function)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
 
         </article>
       </div>

diff --git a/docs/build/html/getting_started.html b/docs/build/html/getting_started.html
@@ -157,7 +157,18 @@
   <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Getting Started</a></li>
-<li class="toctree-l1 has-children"><a class="reference internal" href="reference/ref_main.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="simple">
+<li class="toctree-l1 has-children"><a class="reference internal" href="reference/ref_main.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="reference/draw.html">draw</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/font.html">Font</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/input.html">input</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/math.html">math</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/rect.html">Rect</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/render_window.html">RenderWindow</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/sprite.html">Sprite</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/texture_cache.html">TextureCache</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/texture.html">Texture</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/tile_map.html">TileMap</a></li>
+<li class="toctree-l2"><a class="reference internal" href="reference/time.html">time</a></li>
 </ul>
 </li>
 </ul>
@@ -205,7 +216,7 @@ <h2>Hello World<a class="headerlink" href="#hello-world" title="Link to this hea
 <span class="linenos"> 4</span>
 <span class="linenos"> 5</span>
 <span class="linenos"> 6</span><span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
-<span class="linenos"> 7</span><span class="w">    </span><span class="n">kn</span><span class="o">::</span><span class="n">RenderWindow</span><span class="w"> </span><span class="n">window</span><span class="p">(</span><span class="s">&quot;Hello World&quot;</span><span class="p">);</span>
+<span class="linenos"> 7</span><span class="w">    </span><span class="n">kn</span><span class="o">::</span><span class="n">RenderWindow</span><span class="w"> </span><span class="n">window</span><span class="p">;</span>
 <span class="linenos"> 8</span><span class="w">    </span><span class="n">kn</span><span class="o">::</span><span class="n">time</span><span class="o">::</span><span class="n">Clock</span><span class="w"> </span><span class="n">clock</span><span class="p">;</span>
 <span class="linenos"> 9</span>
 <span class="linenos">10</span><span class="w">    </span><span class="kt">bool</span><span class="w"> </span><span class="n">done</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span><span class="p">;</span>