new way to handle window and events

documentation category dropdowns now work

docs/_static/css/custom.css

@@ -1905,8 +1905,3 @@ p + .classref-constant {
         padding: 3px 5px;
     }
 }
-
-/* Giscus */
-#godot-giscus {
-    margin-bottom: 1em;
-}

docs/conf.py

@@ -1,15 +1,15 @@
 import os
 import subprocess
 
-breathe_projects = {'KrakenEngine': 'xml'}
-breathe_default_project = 'KrakenEngine'
+breathe_projects = {"KrakenEngine": "xml"}
+breathe_default_project = "KrakenEngine"
 
 needs_sphinx = "7.1"
 
 extensions = [
-    'breathe',
-    'sphinx.ext.autosectionlabel',
-    'notfound.extension',
+    "breathe",
+    "sphinx.ext.autosectionlabel",
+    "notfound.extension",
 ]
 
 notfound_context = {
@@ -35,22 +35,22 @@
 
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 if on_rtd:
-    subprocess.call('doxygen', shell=True)
+    subprocess.call("doxygen", shell=True)
 else:
     notfound_urls_prefix = ''
 
 templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 source_encoding = "utf-8-sig"
 
-master_doc = 'index'
+master_doc = "index"
 
-project = 'Kraken Engine'
-copyright = '2024, Derrick Martinez'
-author = 'Derrick Martinez'
+project = "Kraken Engine"
+copyright = "2024, Derrick Martinez"
+author = "Derrick Martinez"
 
-version = os.getenv("READTHEDOCS_VERSION", "0.0.3")
+version = os.getenv("READTHEDOCS_VERSION", "0.0.6")
 release = version
 
 exclude_patterns = ["_build"]
@@ -66,7 +66,6 @@
 html_theme_options = {
     "logo_only": True,
     "collapse_navigation": False,
-    "display_version": False,
 }
 
 html_title = f"Kraken Engine ({version}) documentation in English"
@@ -75,33 +74,25 @@
     "display_github": True,  # Integrate GitHub
     "github_user": "durkisneer1",  # Username
     "github_repo": "Kraken-Engine",  # Repo name
-    "github_version": "0.0.3",  # Version
-    "conf_py_path": "/",  # Path in the checkout to the docs root
+    "github_version": "main",  # Version
+    "conf_py_path": "/docs/",  # Path in the checkout to the docs root
     "kraken_docs_title": html_title,
     "kraken_docs_basepath": "https://kraken-engine.readthedocs.io/",
     "kraken_docs_suffix": ".html",
     "kraken_default_lang": "en",
     "kraken_canonical_version": "stable",
     # Set this to `True` when in the `latest` branch to clearly indicate to the reader
     # that they are not reading the `stable` documentation.
-    "kraken_is_latest": False,
-    "kraken_version": "0.0.3",
+    "kraken_is_latest": True,
+    "kraken_version": "0.0.6",
     # Enables a banner that displays the up-to-date status of each article.
     "kraken_show_article_status": True,
 }
 
 html_logo = "_static/kraken-engine-banner.png"
-html_static_path = ['_static']
-
-html_css_files = [
-    'css/algolia.css',
-    'https://cdn.jsdelivr.net/npm/@docsearch/css@3',
-    "css/custom.css",
-]
-
-html_js_files = [
-    "js/custom.js",
-]
+html_static_path = ["_static"]
+html_css_files = ["css/custom.css"]
+html_js_files = ["js/custom.js"]
 
 file_insertion_enabled = False
 
@@ -110,4 +101,4 @@
 
 gettext_compact = False
 
-epub_tocscope = 'includehidden'
+epub_tocscope = "includehidden"

docs/getting_started/create_window.rst

@@ -2,6 +2,7 @@ Creating a Window
 =================
 
 After following the :doc:`installation` guide, you are ready for your first Kraken Engine program.
+The following code creates a window and keeps it open until the user closes it.
 
 .. code-block:: c++
     :linenos:
@@ -11,21 +12,17 @@ After following the :doc:`installation` guide, you are ready for your first Krak
     int main()
     {
         kn::window::init({800, 600});
-        kn::time::Clock clock;
 
-        bool done = false;
-        while (!done)
+        kn::Event event;
+        while (kn::window::isOpen())
         {
-            clock.tick();
+            kn::window::pollEvent(event);
+            if (event.type == kn::QUIT)
+                kn::window::close();
 
-            for (const auto &event : kn::window::getEvents())
-                if (event.type == kn::QUIT)
-                    done = true;
-
-            kn::window::clear();
             kn::window::flip();
         }
-
         kn::window::quit();
+
         return EXIT_SUCCESS;
     }

docs/index.rst

@@ -30,24 +30,40 @@ We look forward to seeing the incredible games you create with the Kraken Engine
 .. toctree::
     :hidden:
     :maxdepth: 1
+    :caption: Getting Started
 
     getting_started/installation
     getting_started/create_window
 
 .. toctree::
     :hidden:
     :maxdepth: 1
+    :caption: Manual
 
     tutorials/index
 
 .. toctree::
     :hidden:
     :maxdepth: 1
+    :caption: Contributing
 
     contributing/how_to_contribute
 
 .. toctree::
     :hidden:
     :maxdepth: 1
-
-    reference/index
+    :caption: API Reference
+
+    reference/animation_controller
+    reference/font
+    reference/rect
+    reference/sound
+    reference/texture
+    reference/tile_map
+    reference/constants
+    reference/draw
+    reference/input
+    reference/math
+    reference/music
+    reference/time
+    reference/window

docs/reference/animation_controller.rst

@@ -11,7 +11,7 @@ What the AnimationController class does **NOT** do is provide a draw function.
 This design decision is to give users the flexibility to draw the current frame in a desired position and size.
 
 Usage
--------------
+-----
 
 .. code-block:: cpp
 
@@ -33,5 +33,8 @@ Usage
     // Draw the current frame texture at position (50, 50) and size (16, 16).
     kn::window::blit(*frame.tex, {50, 50, 16, 16}, frame.rect);
 
+Members
+-------
+
 .. doxygenclass:: kn::AnimationController
     :members:

docs/reference/font.rst

@@ -20,5 +20,8 @@ Usage
     // Draw the text texture at position (50, 50).
     kn::window::blit(text, {50, 50});
 
+Members
+-------
+
 .. doxygenclass:: kn::Font
     :members:

docs/reference/input.rst

@@ -31,6 +31,9 @@ Usage
 
     kn::math::Vec2 inputDir = kn::input::getVector(left, right, up, down);
 
+Functions
+---------
+
 .. doxygenfunction:: kn::input::getMousePos
 
 .. doxygenfunction:: kn::input::isMouseButtonPressed

docs/reference/music.rst

@@ -28,6 +28,9 @@ Usage
     // Fade out the music over 2 seconds.
     kn::music::fadeOut(2000);
 
+Functions
+---------
+
 .. doxygenfunction:: kn::music::load
 
 .. doxygenfunction:: kn::music::unload

docs/reference/sound.rst

@@ -25,5 +25,8 @@ Usage
     // Play the sound 3 times after it fades in over 2 seconds.
     sound.play(2, -1, 2000);
 
+Members
+-------
+
 .. doxygenclass:: kn::Sound
     :members:

docs/reference/texture.rst

@@ -29,6 +29,8 @@ Usage
     kn::window::blit(imageTexture, {50, 50});
     kn::window::blit(colorTexture, {100, 100});
 
+Members
+-------
 
 .. doxygenclass:: kn::Texture
     :members:

docs/reference/tile_map.rst

@@ -41,6 +41,9 @@ Usage
     tileMap.drawMap();
     tileMap.drawLayer("walls");
 
+Members
+-------
+
 .. doxygenstruct:: kn::Tile
     :members:
     :undoc-members:

docs/reference/time.rst

@@ -21,7 +21,13 @@ Usage
     // Get the time since Kraken was initialized.
     double elapsedTime = kn::time::getTicks();
 
+Members
+-------
+
 .. doxygenclass:: kn::time::Clock
     :members:
 
+Functions
+---------
+
 .. doxygenfunction:: kn::time::getTicks

example/main.cpp

@@ -12,15 +12,18 @@ int main()
 
     Player player(tileMap);
 
-    bool done = false;
-    while (!done)
+    kn::Event event;
+    while (kn::window::isOpen())
     {
         const double dt = clock.tick();
 
-        for (const auto& event : kn::window::getEvents())
-            if (event.type == kn::QUIT ||
-                (event.type == kn::KEYDOWN && event.key.keysym.sym == kn::K_ESCAPE))
-                done = true;
+        kn::window::pollEvent(event);
+        if (event.type == kn::QUIT ||
+            (event.type == kn::KEYDOWN && event.key.keysym.sym == kn::K_ESCAPE))
+            kn::window::close();
+        if (event.type == kn::MOUSEMOTION)
+            if (event.type == kn::MOUSEBUTTONDOWN)
+                std::cout << "yes\n";
 
         kn::window::clear({21, 18, 37});
 

include/Window.hpp

@@ -29,6 +29,18 @@ namespace window
  */
 void init(const math::Vec2& resolution, const std::string& title = "Kraken Window", int scale = 1);
 
+/**
+ * @brief Get whether the window is open.
+ *
+ * @return Whether the window is open.
+ */
+bool isOpen();
+
+/**
+ * @brief Close the window.
+ */
+void close();
+
 /**
  * @brief Clear the screen.
  *
@@ -66,11 +78,11 @@ void blit(const Texture& texture, const math::Vec2& position = {});
 SDL_Renderer* getRenderer();
 
 /**
- *  @brief Get user events.
+ *  @brief Populate an event with the next window events.
  *
- *  @return The user events.
+ *  @param event The event to poll.
  */
-const std::vector<Event>& getEvents();
+void pollEvent(Event& event);
 
 /**
  * @brief Get whether the window is fullscreen or not.