Skip to content
/ vulkan Public

Vulkan bindings for Nim

License

Notifications You must be signed in to change notification settings

nimgl/vulkan

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs

Vulkan Bindings for Nim Nimble

Separated module from NimGL. In order to mantain small sized modules to facilitate development and reduce number of required modules.

Some developers do not require the entire bundle of APIs that NimGL offer, and so, prefere to only download the required modules.

Installation

Nimble download

You can install this package through the official package manager of Nim.

$ nimble install https://github.com/nimgl/vulkan.git

In order to respect already existing libraries in the package registry, and because NimGL already exists in there, this package is only able to be accesible by direct git url.

Nimble direct install

$ git clone --recursive -j8 https://github.com/nimgl/vulkan.git
$ cd vulkan
$ nimble install

NimGL module

$ nimble install nimgl

You can find more information in the main repo.

Development

It is currently being developed and tested on

  • Windows 10
  • MacOS Mojave
  • Linux Ubuntu 18.10

Contribute

I'm only one person and I use this library almost daily for school and personal projects. If you are missing some extension, procedures, bindings or anything related feel free to PR them or open an Issue with the specification and if you can some examples to have an idea on how to implement it. Thank you so much 🎉

This being a separate module behaves slightly diferently.

Please open all issues in the main repository. The PRs and new feature development will occur in each binding's repo.

Usage

import vulkan

# Create window (GLFW Recommended)

if vkInit():
  echo "Vulkan started successfully!"

var extensionCount: uint32
discard vkEnumerateInstanceExtensionProperties(nil, extensionCount.addr, nil)

echo $extensionCount & " extensions supported"

# You can load extensions
loadVK_EXT_host_query_reset()
if vkResetQueryPoolEXT == nil:
  echo "Failed to load VK_EXT_host_query_reset extension"

Check out the references and doc in order to understand Vulkan usage.

License

MIT License

NimGL is open source and is under the MIT License, we highly encourage every developer that uses it to make improvements and fork them here.

Contributors

Thank you to every contributor that has spent their time improving this library.

List of all contributors.