You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You might need to specify a generator via `-G`, for a full list of generators execute `cmake -G`.
156
-
- To rebuild `vulkan.hpp` from the `vk.xml` XML registry file, add the
154
+
To rebuild `vulkan.hpp` from the `vk.xml` XML registry file, add the
157
155
`-DVULKAN_HPP_RUN_GENERATOR=ON` option to the CMake command line.
158
-
4. Either open the generated project with an IDE, e.g. Visual Studio or launch the build process with `cmake --build build --parallel`.
156
+
5. The generated project may be opened with an IDE like Visual Studio or CLion, or the generator, samples, and tests may be built directly from a shell:
159
157
160
-
Optional: To update the Vulkan-Hpp and its submodules execute `git pull --recurse-submodules`.
158
+
```cmake --build build --parallel```
161
159
162
160
### Additional features
163
161
164
162
#### Formatting
165
163
166
-
If the program clang-formatis found by CMake, the define `CLANG_FORMAT_EXECUTABLE` is set accordingly. In that case, the generated `vulkan.hpp` is formatted using the `.clang-format` file located in the root directory of this project. Otherwise, it's formatted as hard-coded in the generator.
164
+
If a `clang-format` executable is found by CMake, the define `CLANG_FORMAT_EXECUTABLE` is set accordingly. In that case, the generated headers are formatted using the `.clang-format` file located in the root directory of this project; otherwise, the formatting is left as hard-coded in the generator.
167
165
168
166
#### Custom views of Vulkan-Hpp objects in Visual Studio
169
167
170
168
The file `VulkanHpp.natvis` provides a custom view on `vk::Flags` for Visual Studio. If you add this file to the user-specific natvis directory of your Visual Studio installation (%USERPROFILE%\Documents\Visual Studio 2022\Visualizers), you get `vk::Flags` nicely formatted in your debugger with all your Visual Studio projects.
171
169
172
170
## Breaking Changes
173
171
174
-
We seriously try to keep the API for all flavours of the Vulkan-Hpp constant or backwards compatible. But every now and then, some breaking changes might get in. Here is a list of those changes, sorted by version.
172
+
We try to keep the API for all flavours of Vulkan-Hpp constant or backwards compatible. However, we may introduce unavoidable breaking changes, usually to fix bugs. Following is a list of those changes, arranged by version.
0 commit comments