Add VK_KHR_pipeline_binary sample #1418
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduce a new Vulkan sample demonstrating VK_KHR_pipeline_binary usage. It includes querying pipeline keys, capturing pipeline binaries, and managing them explicitly. The sample is accompanied by documentation, CMake lists, shaders, and updates to the Vulkan framework mapping.
- Add detailed logging for pipeline binary operations. - Introduce UI overlay in `PipelineBinary` to display aggregated log information. - General code clean-up and formatting adjustments.
gary-sweet
reviewed
Oct 20, 2025
Contributor
gary-sweet
left a comment
gary-sweet
left a comment
There was a problem hiding this comment.
I can only really say that this builds ok as we don't currently support pipeline binaries.
Contributor
asuessenbach
left a comment
asuessenbach
left a comment
There was a problem hiding this comment.
Nice little sample. Just a few comments...
| LOGI("VK_KHR_pipeline_binary supported feature: pipelineBinaries = {}", pb); | ||
| char buf[256]; | ||
| snprintf(buf, sizeof(buf), "VK_KHR_pipeline_binary supported feature: pipelineBinaries = %s\n", pb); | ||
| log_text_ += buf; |
Contributor
There was a problem hiding this comment.
Instead of all those fixed-size buffers, you could as well use std::format:
std::string message = std::format( "VK_KHR_pipeline_binary supported feature: pipelineBinaries = {}", pb );
or maybe
std::string message = std::format("VK_KHR_pipeline_binary supported feature: pipelineBinaries = {}", static_cast<bool>(features.pipelineBinaries));
| const char *pic = props.pipelineBinaryPrefersInternalCache ? "true" : "false"; | ||
| const char *pic2 = props.pipelineBinaryPrecompiledInternalCache ? "true" : "false"; | ||
| const char *cd = props.pipelineBinaryCompressedData ? "true" : "false"; | ||
| LOGI("VK_KHR_pipeline_binary properties: internalCache={}, internalCacheControl={}, prefersInternalCache={}, precompiledInternalCache={}, compressedData={}", ic, icc, pic, pic2, cd); |
Contributor
There was a problem hiding this comment.
Maybe add some newlines and tabs to make the output more readable.
| } | ||
| } | ||
|
|
||
| void PipelineBinary::on_update_ui_overlay(vkb::Drawer &drawer) |
Contributor
There was a problem hiding this comment.
Despite overriding on_update_ui_overlay, I don't see any UI.
Don't know why.
20 tasks
ShabbyX
reviewed
Oct 30, 2025
| - VK_EXT_graphics_pipeline_library reduces link-time work, but doesn’t hand you the final binary for persistence. | ||
| - VK_EXT_shader_object changes the binding model, not binary persistence. | ||
|
|
||
| == How it works (TL;DR) |
Contributor
There was a problem hiding this comment.
You could consider linking to https://www.khronos.org/blog/bringing-explicit-pipeline-caching-control-to-vulkan somewhere, which has some graphs that could help understand these better.
# Conflicts: # framework/vulkan_type_mapping.h # samples/extensions/README.adoc
…etrics Add interactive GUI to demonstrate pipeline recreation from scratch vs. from cached binaries with timing measurements. Implement binary persistence (save/load to disk) and display performance statistics including speedup calculations. Update documentation to reflect new interactive features and workflow.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Introduce a new Vulkan sample demonstrating VK_KHR_pipeline_binary usage. It includes querying pipeline keys, capturing pipeline binaries, and managing them explicitly. The sample is accompanied by documentation, CMake lists, shaders, and updates to the Vulkan framework mapping.
General Checklist:
Please ensure the following points are checked:
Note: The Samples CI runs a number of checks including:
If this PR contains framework changes:
batchcommand line argument to make sure all samples still work properlySample Checklist
If your PR contains a new or modified sample, these further checks must be carried out in addition to the General Checklist: