On GitHub, KhronosGroup/Vulkan-Samples has picked up 5.4k stars, Backend, C++. One stop solution for all Vulkan samples
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
ifndef::site-gen-antora[]
== Vulkan Documentation Site
Documentation for the samples is best viewed at the new link:https://docs.vulkan.org/samples/latest/README.html[Vulkan Documentation Site]. The documentation uses AsciiDoc which isn't fully supported by github.
endif::[]
== Introduction
The Vulkan Samples is collection of resources to help you develop optimized Vulkan applications.
If you are new to Vulkan the xref:samples/api/README.adoc[API samples] are the right place to start.
Additionally you may find the following links useful:
ifdef::site-gen-antora[]
xref:guide:ROOT:index.adoc[Vulkan Guide]
xref:tutorial:ROOT:00_Introduction.adoc[Get Started in Vulkan]
endif::[]
https://docs.vulkan.org/tutorial/latest/index.html[Get Started in Vulkan]
endif::[]
xref:samples/performance/README.adoc[Performance samples] show the recommended best practice together with real-time profiling information.
They are more advanced but also contain a detailed tutorial with more in-detail explanations.
=== Requirements
The samples are written in C{pp} and require a compiler that supports at least C{pp}20. To run the samples, a device that supports at least Vulkan 1.1 or newer is required. Some samples might require a higher Vulkan version and/or support for certain extensions.
=== Goals
Create a collection of resources that demonstrate best-practice recommendations in Vulkan
Create tutorials that explain the implementation of best-practices and include performance analysis guides
== Samples
xref:./samples/README.adoc[Listing of all samples available in this repository]
Prerequisites: https://git-scm.com/downloads[git] with https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage[git large file storage (git-lfs)].
Clone the repo with submodules using the following command:
git clone --recurse-submodules https://github.com/KhronosGroup/Vulkan-Samples.git
cd Vulkan-Samples
Follow build instructions for your platform below.
[NOTE]
The full repository is very large, and some ISPs appear to have trouble
providing a robust connection to github while the clone is being made.
If you notice problems such as submodules downloading at reported rates in
the tens of kB/s, or fatal timeout errors occurring, these may be due to
network routing issues to github within your ISP's internal network, rather
than anything wrong in your own networking setup.
It can be very difficult to get ISPs to acknowledge such problems exist, much
less to fix them.
One workaround is to switch the repository to use ssh protocol prior to the
submodule download, which can be done via e.g.
While this can be a good alternative if you are running into this connection
issue, you must have GitHub ssh key authentication setup to use ssh
protocol - see
link:https://docs.github.com/en/authentication/connecting-to-github-with-ssh[Connecting
to GitHub with SSH] for details.
So it is a not a solution we can implement as the repository default.
Another option which may help is to run github through a VPN service.
== Build
=== Supported Platforms
Windows - xref:./docs/build.adoc#windows[Build Guide]
The following shows some example command line usage on how to configure and run the Vulkan Samples.
Make sure that you are running the samples from the root directory of the repository.
Otherwise the samples will not be able to find the assets.
./build/app/bin///vulkan_samples
adb shell am start-activity -n com.khronos.vulkan_samples/com.khronos.vulkan_samples.SampleLauncherActivity -e sample swapchain_images
== License
See link:LICENSE[LICENSE].
This project has several xref:./third_party/README.adoc[third-party dependencies]
This project uses assets from https://github.com/KhronosGroup/Vulkan-Samples-Assets[vulkan-samples-assets].
Each one has its own license.
=== Trademarks
Vulkan is a registered trademark of the Khronos Group Inc.
== Contributions
Donated to Khronos by Arm, with further contributions by Sascha Willems and Adam Sawicki.
See xref:CONTRIBUTORS.adoc[CONTRIBUTORS] for the full contributor list.
Also see xref:CONTRIBUTING.adoc[CONTRIBUTING] for contribution guidelines.
== Related resources
https://developer.arm.com/documentation/101897/latest/[Mali GPU Best Practices]: A document with recommendations for efficient API usage
Does KhronosGroup/Vulkan-Samples have a project website?
No homepage URL was recorded for KhronosGroup/Vulkan-Samples in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
How active is development on KhronosGroup/Vulkan-Samples?
The most recent commit recorded on KhronosGroup/Vulkan-Samples was 1 day ago, based on the GitHub push timestamp. The repository has 845 forks — one of the better signals of community interest.
Is KhronosGroup/Vulkan-Samples open source?
Yes — KhronosGroup/Vulkan-Samples ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/KhronosGroup/Vulkan-Samples.
What license does KhronosGroup/Vulkan-Samples use?
KhronosGroup/Vulkan-Samples is released under the Apache-2.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
What topics is KhronosGroup/Vulkan-Samples associated with?
GitHub's repository topics for KhronosGroup/Vulkan-Samples: "best-practices", "cpp", "graphics", "graphics-programming", "khronos", "tutorials", "vulkan", "vulkan-api", "vulkan-samples". TopGit's editorial category is Backend.
Where do I read more about KhronosGroup/Vulkan-Samples?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/KhronosGroup/Vulkan-Samples is the definitive source.
Read full README in the tab above.
Curious whether Vulkan-Samples is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about Vulkan-Samples.