Docs

Author: Kaweees

.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+# name: Docs
+
+# on:
+#   push:
+#     branches:
+#       - main
+
+# jobs:
+#   Docs:
+#     runs-on: ubuntu-latest
+#     permissions:
+#       contents: write
+
+#     steps:
+#     - uses: actions/checkout@v3
+
+#     - name: Cancel Previous Runs
+#       uses: styfle/[email protected]
+#       with:
+#         access_token: ${{ secrets.DOCS_TOKEN }}
+
+#     - name: Add Submodules
+#       run: git submodule update --init --recursive
+
+#     - name: Install Dependencies
+#       run: sudo apt install doxygen
+
+#     - name: Build Docs
+#       working-directory: .
+#       run: |
+#         cd scripts
+#         ./doxygen.sh
+
+#     - name: Deploy
+#       uses: peaceiris/actions-gh-pages@v3
+#       with:
+#         github_token: ${{ secrets.DOCS_TOKEN }}
+#         publish_dir: './website'

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/doxygen/m.css"]
+	path = docs/doxygen/m.css
+	url = https://github.com/mosra/m.css.git

.justfile

@@ -30,7 +30,7 @@ build *build_type='Release':
 # Build the project for the web
 web *build_type='Release':
   @mkdir -p build
-  @if [ -n "${EM_CACHE-}" ]; then mkdir -p "$EM_CACHE"; fi
+  @if [ -n "${EM_CACHE-}" ]; then mkdir -p "$EM_CACHE" && mkdir -p "$EM_CACHE/tmp"; fi
   @echo "Configuring the build system..."
   @cd build && emcmake cmake -S .. -B . -DCMAKE_BUILD_TYPE={{build_type}} -DBUILD_WASM=1
   @echo "Building the project..."

CMakeLists.txt

@@ -77,7 +77,7 @@ else()
       target_link_libraries(
         ${PROJECT_NAME} INTERFACE "-framework Metal" "-framework Foundation"
                                   "-framework QuartzCore" "-framework MetalKit")
-      # add_compile_definitions("__METAL__")
+      add_compile_definitions("__METAL__")
     else()
       message(STATUS "Apple Metal not found. Building without Metal support")
     endif()

README.md

@@ -19,12 +19,12 @@
 
 </div>
 
-<a href="https://github.com/Kaweees/kiwigl">
+<a href="https://github.com/Kaweees/kiwiGL">
   <img alt="C++ Logo" src="assets/img/cpp.svg" align="right" width="150">
 </a>
 
 <div align="left">
-  <h1><em><a href="https://github.com/Kaweees/kiwigl">~kiwigl</a></em></h1>
+  <h1><em><a href="https://github.com/Kaweees/kiwiGL">~kiwiGL</a></em></h1>
 </div>
 
 <!-- ABOUT THE PROJECT -->
@@ -56,7 +56,7 @@ A three-dimensional header-only graphics library written in C++13 and accelerate
 
 ### Prerequisites
 
-Before attempting to build this project, make sure you have [Simple DirectMedia Layer (SDL 2)](https://wiki.libsdl.org/SDL2/Installation), [GNU Make](https://www.gnu.org/software/make/), and [CMake](https://cmake.org) installed on your machine.
+Before attempting to build this project, make sure you have [Nix](https://nixos.org/download.html) with [Flake](https://nixos.wiki/wiki/Flakes) support installed on your machine.
 
 Additionally, if you wish to utilize the GPU acceleration features, you will need to have [CUDA Toolkit](https://developer.nvidia.com/cuda-downloads) or [Apple Metal](https://developer.apple.com/metal/cpp/) installed on your machine.
 
@@ -67,89 +67,57 @@ To get a local copy of the project up and running on your machine, follow these
 1. Clone the project repository
 
    ```sh
-   git clone https://github.com/Kaweees/kiwigl.git
-   cd kiwigl
+   git clone https://github.com/Kaweees/kiwiGL.git
+   cd kiwiGL
    ```
 
-2. Create a fresh build directory and navigate to it
+2. Install the project dependencies
 
    ```sh
-   rm -rf build
-   mkdir build
-   cd build
+   nix-shell
    ```
 
-3. Generate build files using CMake
+3. Build the project
 
    ```sh
-   cmake -S .. -B . -DCMAKE_BUILD_TYPE=Debug
+   just build
    ```
 
-4. Build the entire project
+4. Run the project
 
    ```sh
-   cmake --build .
+   just run <package_name>
    ```
 
-### Building and Running Tests
-
-1. Build only the tests
-
-   ```sh
-   cmake --build . --target tests
-   ```
-
-2. Run all tests
-
-   ```sh
-   ctest --output-on-failure
-   ```
-
-3. Run a specific test suite
-
-   ```sh
-   ./tests/test_suite_name
-   ```
-
-### Building and Running Examples
-
-1. Build only the examples
-
-   ```sh
-   cmake --build . --target examples
-   ```
-
-2. Run a specific example
+## Usage
 
-   ```sh
-   ./examples/example_name
-   ```
+kiwiGL is designed to be easy to use. You can include the library in your C++ project by adding the following line to your source files:
 
-## Usage
+```cpp
+#include <kiwigl/kiwigl.h>
+```
 
-<!--
 ### Benchmarks
 
-Kiwigl is capable of rendering 3D scenes with thousands of triangles at interactive frame rates. The following benchmarks were conducted on a 2019 MacBook Pro with a 2.3 GHz 8-Core Intel Core i9 processor and 16 GB of RAM.
+kiwiGL is capable of rendering 3D scenes with thousands of triangles at interactive frame rates. The following benchmarks were conducted on a 2019 MacBook Pro with a 2.3 GHz 8-Core Intel Core i9 processor and 16 GB of RAM.
 
 | Benchmark | Description | Result |
 | --------- | ----------- | ------ |
 | `cube` | Render a cube with 12 triangles | 60 FPS |
 | `sphere` | Render a sphere with 960 triangles | 60 FPS |
 | `bunny` | Render a Stanford Bunny with 69451 triangles | 60 FPS |
 | `dragon` | Render a Stanford Dragon with 871306 triangles | 60 FPS |
--->
 
-### Convention
+### Conventions
 
-Kiwigl uses the following conventions:
+kiwiGL uses the following conventions:
 
 - [left-handed coordinate system](https://www.scratchapixel.com/lessons/mathematics-physics-for-computer-graphics/geometry/coordinate-systems.html#:~:text=The%20differentiation%20between%20left%2Dhanded,a%20right%2Dhand%20coordinate%20system)
 - [counter-clockwise winding order](https://learnwebgl.brown37.net/model_data/model_volume.html#:~:text=Winding%20Order%20for%20a%20triangle,the%20front%20of%20the%20triangle.) for triangle vertices
 
 ### Keyboard Controls
 
-Kiwigl uses the following keyboard shortcuts:
+kiwiGL uses the following keyboard shortcuts:
 
 | Command Keybind | Command Description |
 | --------------- | ------------------- |
@@ -159,29 +127,30 @@ Kiwigl uses the following keyboard shortcuts:
 ## Project Structure
 
 ```sh
-graphics/
-├── .github/                       - GitHub Actions CI/CD workflows
-├── include/                       - project header files
-├── src/                           - project source files
-│   └── main.c                     - Entry point, main function
-├── CMakeLists.txt                 - CMake build script
-├── LICENSE                        - project license
-└── README.md                      - you are here
+kiwiGL/
+├── .github/                       # GitHub Actions CI/CD workflows
+├── include/                       # project header files
+│   └── kiwiGL/                      # Header files for the kiwiGL library
+├── src/                           # project source files
+│   └── ...                          # Entry point, main function
+├── CMakeLists.txt                 # CMake build script
+├── LICENSE                        # project license
+└── README.md                      # you are here
 ```
 
 ## License
 
-The source code for kiwigl  is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information.
+The source code for [Kaweees/kiwiGL](https://github.com/Kaweees/kiwiGL) is distributed under the terms of the GNU General Public License v3.0, as I firmly believe that collaborating on free and open-source software fosters innovations that mutually and equitably beneficial to both collaborators and users alike. See [`LICENSE`](./LICENSE) for details and more information.
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
 
-[contributors-shield]: https://img.shields.io/github/contributors/Kaweees/kiwigl.svg?style=for-the-badge
-[contributors-url]: https://github.com/Kaweees/kiwigl/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/Kaweees/kiwigl.svg?style=for-the-badge
-[forks-url]: https://github.com/Kaweees/kiwigl/network/members
-[stars-shield]: https://img.shields.io/github/stars/Kaweees/kiwigl.svg?style=for-the-badge
-[stars-url]: https://github.com/Kaweees/kiwigl/stargazers
+[contributors-shield]: https://img.shields.io/github/contributors/Kaweees/kiwiGL.svg?style=for-the-badge
+[contributors-url]: https://github.com/Kaweees/kiwiGL/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/Kaweees/kiwiGL.svg?style=for-the-badge
+[forks-url]: https://github.com/Kaweees/kiwiGL/network/members
+[stars-shield]: https://img.shields.io/github/stars/Kaweees/kiwiGL.svg?style=for-the-badge
+[stars-url]: https://github.com/Kaweees/kiwiGL/stargazers
 
 <!-- MARKDOWN SHIELD BAGDES & LINKS -->
 <!-- https://github.com/Ileriayo/markdown-badges -->

docs/doxygen/m.css

@@ -0,0 +1,3 @@
+# RaidZeroLib Docs Index  
+
+![Caption](images/templogo.png "Caption")

docs/index.md

@@ -52,17 +52,14 @@ class Display {
     std::unique_ptr<FrameBuffer> frameBuffer;
     Mesh mesh;
     std::vector<Triangle> projectedTriangles;
-    Face* d_faces;
-    Vector3D* d_vertices;
-    Triangle* d_projectedTriangles;
 
     Vector3D camera;
     Vector3D rotation;
     Vector3D rotationSpeed;
   public:
 #ifndef BENCHMARK_MODE
     // Constructor to initialize memory
-    Display(const std::string& title, const Vector3D& cameraPosition = Vector3D(0, 0, -5),
+    Display(const std::string& title, bool fullscreen = false, const Vector3D& cameraPosition = Vector3D(0, 0, -5),
             const Vector3D& cameraRotation = Vector3D(0, 0, 0)) {
 #else
     Display(uint32_t numOfFrames, const Vector3D& cameraPosition = Vector3D(0, 0, -5),
@@ -73,7 +70,7 @@ class Display {
       rotation = cameraRotation;
       rotationSpeed = Vector3D(0, 0, 0);
 #ifndef BENCHMARK_MODE
-      fullScreen = true;
+      fullScreen = fullscreen;
       keyPressed = SDLK_UNKNOWN;
       prevTime = SDL_GetTicks();
       // Initialize SDL with only the required subsystems
@@ -95,12 +92,11 @@ class Display {
       // Initialize the frame buffer
       frameBuffer = std::make_unique<FrameBuffer>(displayMode.w, displayMode.h);
 
-      // Initialize the CUDA device pointers
-      d_faces = nullptr;
-      d_vertices = nullptr;
-      d_projectedTriangles = nullptr;
-
 #ifdef __CUDA__
+      // Initialize the CUDA device pointers
+      Face* d_faces = nullptr;
+      Vector3D* d_vertices = nullptr;
+      Triangle* d_projectedTriangles = nullptr;
       InitalizeCuda();
 #elif __METAL__
       InitalizeMetal();
@@ -137,21 +133,22 @@ class Display {
 
     // Destructor to free memory
     ~Display() {
-      // Free the frame buffer
-      frameBuffer.reset();
-
-      // Free the window
 #ifndef BENCHMARK_MODE
-      SDL_DestroyWindow(window);
-      window = nullptr;
-
-      // Free the renderer
-      SDL_DestroyRenderer(renderer);
-
       // Free the texture
-      SDL_DestroyTexture(texture);
-      texture = nullptr;
-
+      if (texture != nullptr) {
+        SDL_DestroyTexture(texture);
+        texture = nullptr;
+      }
+      // Free the renderer
+      if (renderer != nullptr) {
+        SDL_DestroyRenderer(renderer);
+        renderer = nullptr;
+      }
+      // Free the window
+      if (window != nullptr) {
+        SDL_DestroyWindow(window);
+        window = nullptr;
+      }
       // Quit SDL subsystems
       SDL_Quit();
 #endif

include/kiwigl/graphics/display.hpp

@@ -9,10 +9,11 @@
         padding: 0%;
         width: 100%;
         height: 100%;
+        overflow: hidden;
       }
       .container {
-        width: 100%;
-        height: 100%;
+        width: 100vw;
+        height: 100vh;
         display: flex;
         justify-content: center;
         align-items: center;
@@ -21,9 +22,22 @@
   </head>
   <body>
     <div class="container">
-      <canvas id="_canvas" oncontextmenu="event.preventDefault()" tabindex="-1"></canvas>
+      <canvas
+        id="_canvas"
+        oncontextmenu="event.preventDefault()"
+        tabindex="-1"
+      ></canvas>
     </div>
-    <script src="web.js"></script> <!-- Script Name -->
+    <script
+      type="text/javascript"
+      data-href="https://github.com/Kaweees/kiwiGL"
+      data-target="_blank"
+      src="https://unpkg.com/github-corners/dist/embed.min.js"
+    ></script>
+    <script
+      type="text/javascript"
+      src="web.js"
+    ></script> <!-- Script Name -->
     <script type='text/javascript'>
       let Module;
       Main({