mirror/Vulkan-Hpp
1
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Hpp.git synced 2024-10-14 16:32:17 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Martin Hammerchmidt 2020-08-06 14:13:03 +02:00 committed by GitHub
parent 85f049ba74
commit dd2bcdf719
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -30,7 +30,7 @@ If the program clang-format is found by CMake, the define CLANG_FORMAT_EXECUTABL
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 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, handles, and structs have the Vk prefix removed. In addition to this the first letter of functions is lower case. * All functions, enums, handles, and structs have the Vk prefix removed. In addition to this the first letter of functions is lower case.
* `vkCreateImage` can be accessed as `vk::createImage` * `vkCreateInstance` can be accessed as `vk::createInstance`
* `VkImageTiling` can be accessed as `vk::ImageTiling` * `VkImageTiling` can be accessed as `vk::ImageTiling`
* `VkImageCreateInfo` can be accessed as `vk::ImageCreateInfo` * `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. * 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.