mewin/vulkan-hpp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix naming conventions for functions in README.md and update to Vulkan 1.0.34 (#50)

Browse Source 
Fixes issue #49
This commit is contained in:
Markus Tavenrath
2016-11-22 08:53:31 +01:00
committed by Andreas Süßenbach
parent 3e3c16a0a1
commit 81dd365ccc
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -13,8 +13,8 @@ Vulkan-Hpp requires a C++11 capable compiler to compile. The following compilers
# namespace vk
To avoid name collisions with the Vulkan C API the C++ bindings reside in the vk namespace. The following rules apply to the new naming
* All functions, enums and structs have the Vk prefix removed.
* ```vkCreateImage``` can be accessed as ```vk::CreateImage```
* All functions, enums, handles, and structs have the Vk prefix removed. In addition to this the first leter of functions is lower case.
* ```vkCreateImage``` can be accessed as ```vk::createImage```
* ```VkImageTiling``` can be accessed as ```vk::ImageTiling```
* ```VkImageCreateInfo``` can be accessed as ```vk::ImageCreateInfo```
* Enums are mapped to scoped enums to provide compile time type safety. The names have been changed to 'e' + CamelCase with the VK_ prefix and type infix removed. In case the enum type is an extension the extension suffix has been removed from the enum values.