~kiwigl

A three-dimensional header-only graphics library written in C++13 and accelerated with CUDA/Apple Metal.

Built With

Preview

Getting Started

Prerequisites

Before attempting to build this project, make sure you have Simple DirectMedia Layer (SDL 2), GNU Make, and CMake installed on your machine.

Additionally, if you wish to utilize the GPU acceleration features, you will need to have CUDA Toolkit or Apple Metal installed on your machine.

Installation

To get a local copy of the project up and running on your machine, follow these simple steps:

1. Clone the project repository

   git clone https://github.com/Kaweees/kiwigl.git
   cd kiwigl

2. Create a fresh build directory and navigate to it

   rm -rf build
   mkdir build
   cd build

3. Generate build files using CMake

   cmake -S .. -B . -DCMAKE_BUILD_TYPE=Debug

4. Build the entire project

   cmake --build .

Building and Running Tests

1. Build only the tests

   cmake --build . --target tests

2. Run all tests

   ctest --output-on-failure

3. Run a specific test suite

   ./tests/test_suite_name

Building and Running Examples

1. Build only the examples

   cmake --build . --target examples

2. Run a specific example

   ./examples/example_name

Usage

Convention

Kiwigl uses the following conventions:

• left-handed coordinate system
• counter-clockwise winding order for triangle vertices

Keyboard Controls

Kiwigl uses the following keyboard shortcuts:

Command Keybind	Command Description
CTRL + q	Quit the application

Project Structure

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

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 for details and more information.