Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 2.45 KB

README.md

File metadata and controls

96 lines (69 loc) · 2.45 KB
Raw

vk-thin-wrapper

A simple to use vulkan thin wrapper library (headeronly)

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

vk-thin-wrapper is a simple headeronly vulkan thin raii wrapper library I've been working on for a while now. It might be slow. It might even crash your entire pc. But at least it isnt made in rust.

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Dependencies:
    • volk
    • spdlog
    • clang/gcc with c++20 support

Usage

Simple example:

using Instance_T = bs::thin_wrappers::thin_wrapper<VkInstance, VkInstanceCreateInfo, no_parent_t, 
thin_wrappers::vkTrampFn<&vkCreateInstance>, thin_wrappers::vkTrampFn<&vkDestroyInstance>>;

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Discord: Big-Smarty#2123 EMail: [email protected]