https://github.com/aldrinmathew/vkmini

VkMini - C++ library for simplifying the Vulkan development experience
https://github.com/aldrinmathew/vkmini

Last synced: 30 days ago
JSON representation

VkMini - C++ library for simplifying the Vulkan development experience

• Host: GitHub
• URL: https://github.com/aldrinmathew/vkmini
• Owner: aldrinmathew
• Created: 2024-08-11T16:33:45.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-18T17:48:30.000Z (2 months ago)
• Last Synced: 2024-11-24T18:17:21.139Z (about 1 month ago)
• Language: C++
• Size: 38.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# VkMini

Simplify your Vulkan apps and improve the development experience

## Using this library

If your application uses _several threads_ or if you are unsure, include **`vkmini.hpp`** all the time, instead of any other header.

If your application uses just one thread, include **`vkmini_single.hpp`** all the time to avoid the cost of mutex locks.

## Things to keep in mind

- Requires C++20 or above

- `vk::Result` is a custom type that represents the result of a function or a group of functions, where T is the type that represents a value if the function is successful, and E is the type that represents an error.

- `VkMiniError` is an enum value that represents an error returned by functions in this library. Sometimes, the value represents standalone errors and sometimes it provides additional context to Vulkan errors.

- `vk::ErrorPair` is a struct that represents two error values. The first field `vulkan` is of type `VkResult` which is an error enum value from Vulkan itself. The second field `vkMini` is of type `VkMiniError` which provides additional context to the error, usually indicating at what point an operation failed.