https://github.com/kevinpruvost/venomengine

Cross-Platform Modern Graphics Engine
https://github.com/kevinpruvost/venomengine

bazel hlsl metal raytracing ruby vulkan

Last synced: about 1 month ago
JSON representation

Cross-Platform Modern Graphics Engine

• Host: GitHub
• URL: https://github.com/kevinpruvost/venomengine
• Owner: kevinpruvost
• License: other
• Created: 2024-08-16T12:38:29.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-11-15T08:13:52.000Z (about 2 months ago)
• Last Synced: 2024-11-15T09:24:57.907Z (about 2 months ago)
• Topics: bazel, hlsl, metal, raytracing, ruby, vulkan
• Language: C++
• Homepage: https://kevinpruvost.github.io/VenomEngine/
• Size: 327 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        



  





  :bulb: Description  • 

  :sparkles: Showcase  • 

  :rocket: Quick Setup & Compilation  • 

  :classical_building: Features & Roadmap  • 

  :book: Documentation & User Guide  • 

  :fountain_pen: License





  

  

  

  

  

  

    

  



## :sparkles: Showcase

TODO

## :warning: **Warning: This project is a Work in Progress (WIP).**

## :bulb: Description

`Venom Engine` is my solo Computer Graphics journey, designed to dive deep into cutting-edge technologies:

- 🧑‍💻️ **Graphics APIs**: Mastering `Vulkan`, `Metal`, and `DirectX12`.

- 🛠️ **Build Systems**: Streamlining development with `Bazel`.

- 🖥️ **Technical Tools**: Exploring `Renderer Debuggers`, `protobuf`, and `HLSL`.

- 💻 **Scripting**: Enhancing workflows with `Ruby` and more.

Join me as I explore these technologies and push the boundaries of what's possible in modern graphics programming.

## :rocket: Quick Setup & Compilation

`VenomEngine` uses a combination of `Bazel` & `Makefile` as its build system (will integrate CMake later). 

Here is how to setup and compile the project:

```bash

make dxc

make compile_shaders

make release_run

```

## :classical_building: Features & Roadmap

- [ ] Vulkan Renderer

- [ ] Metal Renderer

- [ ] DirectX12 Renderer

- [x] Bazel Build System

- [ ] CMake Build System

- [x] HLSL to SPIR-V Compilation

- [x] Ruby Task Runner

- [ ] Custom Renderer Debuggers

- [ ] Protobuf Serialization

- [ ] ...

## :book: Documentation & User Guide

Looking for detailed information? Explore the comprehensive documentation and user guide for `Venom Engine`:

[![View Documentation](https://img.shields.io/badge/View-Documentation-blue?style=for-the-badge&logo=read-the-docs)](https://kevinpruvost.github.io/VenomEngine/html/index.html)

## :fountain_pen: License

[![CC BY-NC-SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa]

This work is licensed under a

[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].

**Dual Licensing:**  

Exclusive dual licensing options are available for commercial or other use cases that do not fit within the terms of the CC BY-NC-SA 4.0 license. If you require different licensing terms, please contact me directly to discuss your needs by [mail](mailto:[email protected]), [Linkedin](https://www.linkedin.com/in/kevin-pruvost-3766a4178) or [Discord](https://www.discordapp.com/users/186896052656406528).

[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]

[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/

[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png

[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg