https://github.com/gpuopen-librariesandsdks/vulkan-samples
based on Khronos Vulkan-Samples
https://github.com/gpuopen-librariesandsdks/vulkan-samples
Last synced: 4 months ago
JSON representation
based on Khronos Vulkan-Samples
- Host: GitHub
- URL: https://github.com/gpuopen-librariesandsdks/vulkan-samples
- Owner: GPUOpen-LibrariesAndSDKs
- License: other
- Created: 2023-07-28T11:02:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T19:55:40.000Z (over 1 year ago)
- Last Synced: 2025-04-20T12:40:38.532Z (about 1 year ago)
- Language: C++
- Homepage: https://github.com/KhronosGroup/Vulkan-Samples
- Size: 47 MB
- Stars: 38
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Vulkan GPU Work Graphs sample
This branch adds a sample application for `VK_AMDX_shader_enqueue` extension that provides
access to GPU Work Graphs feature on Radeon™ RX 7000 series graphics cards.
To build the sample, follow the standard build instructions.
To run the compute sample, execute with the arguments `sample gpu_dispatch`.
See more details and command line options in the [readme](./samples/extensions/gpu_dispatch/README.md).
To run the mesh draw sample, execute with the arguments `sample gpu_draw_dispatch`.
See more details and command line options in the [readme](./samples/extensions/gpu_draw_dispatch/README.md).
Navigate to the following paths to learn more:
- Source code
- [samples/extensions/gpu_dispatch](./samples/extensions/gpu_dispatch)
- [samples/extensions/gpu_draw_dispatch](./samples/extensions/gpu_draw_dispatch)
- Shaders
- [shaders/gpu_dispatch](./shaders/gpu_dispatch)
- [shaders/gpu_draw_dispatch](./shaders/gpu_draw_dispatch)
# Vulkan Dense Geometry Format sample
This branch adds a sample application for the `VK_AMDX_dense_geometry_format` extension that enables
the use of pre-compressed Dense Geometry Format data to build acceleration structures.
To build the sample, follow the standard build instructions.
To run sample, execute with the arguments `sample dense_geometry_format`.
Navigate to the following path to learn more:
- Source code
- [samples/extensions/dense_geometry_format](./samples/extensions/dense_geometry_format)
# Vulkan Samples
## Contents
- [Renaming Default Branch](#renaming-default-branch)
- [Introduction](#introduction)
- [Goals](#goals)
- [Samples](#samples)
- [General information](#general-information)
- [Setup](#setup)
- [Build](#build)
- [Supported Platforms](#supported-platforms)
- [Usage](#usage)
- [Tests](#tests)
- [License](#license)
- [Trademarks](#trademarks)
- [Contributions](#contributions)
- [Related resources](#related-resources)
## Renaming Default Branch
We have recently transitioned the repository to use the `main` branch by default. All remote git usage is handled automatically. To update your local repository to use main please use the following commands
> git branch -m master main
> git fetch origin
> git branch -u origin/main main
> git remote set-head origin -a
## Introduction
The Vulkan Samples is collection of resources to help you develop optimized Vulkan applications.
If you are new to Vulkan the [API samples](samples/api) are the right place to start.
Additionally you may find the following links useful:
- [Vulkan Guide](https://github.com/KhronosGroup/Vulkan-Guide)
- [Get Started in Vulkan](https://vulkan-tutorial.com/)
[Performance samples](samples/performance) 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.
### 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
- Create a framework that can be used as reference material and also as a sandbox for advanced experimentation with Vulkan
## Samples
- [Listing of all samples available in this repository ](./samples/README.md)
## General information
- **Project Basics**
- [Controls](./docs/misc.md#controls)
- [Debug window](./docs/misc.md#debug-window)
- [Create a Sample](./docs/create_sample.md)
- **Vulkan Essentials**
- [How does Vulkan compare to OpenGL ES? What should you expect when targeting Vulkan?](./samples/vulkan_basics.md)
- **Misc**
- [Driver version](./docs/misc.md#driver-version)
- [Memory limits](./docs/memory_limits.md)
## Setup
Prerequisites: [git](https://git-scm.com/downloads) with [git large file storage (git-lfs)](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage).
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.
## Build
### Supported Platforms
- Windows - [Build Guide](./docs/build.md#windows "Windows Build Guide")
- Linux - [Build Guide](./docs/build.md#linux "Linux Build Guide")
- macOS - [Build Guide](./docs/build.md#macos "macOS Build Guide")
- Android - [Build Guide](./docs/build.md#android "Android Build Guide")
## Usage
The following shows some example command line usage on how to configure and run the Vulkan Samples.
```
# For the entire usage use
vulkan_samples --help
# For subcommand usage use
vulkan_samples --help
# Run Swapchain Images sample
vulkan_samples sample swapchain_images
# Run AFBC sample in benchmark mode for 5000 frames
vulkan_samples sample afbc --benchmark --stop-after-frame 5000
# Run bonza test offscreen
vulkan_samples test bonza --headless
# Run all the performance samples for 10 seconds in each configuration
vulkan_samples batch --category performance --duration 10
# Run Swapchain Images sample on an Android device
adb shell am start-activity -n com.khronos.vulkan_samples/com.khronos.vulkan_samples.SampleLauncherActivity -e sample swapchain_images
```
## Tests
- System Test - [Usage Guide](docs/testing.md#system-test "System Test Guide")
- Generate Sample - [Usage Guide](docs/testing.md#generate-sample-test "Generate Sample Test Guide")
## License
See [LICENSE](LICENSE).
This project has some third-party dependencies, each of which may have independent licensing:
- [astc-encoder](https://github.com/ARM-software/astc-encoder): ASTC Evaluation Codec
- [CTPL](https://github.com/vit-vit/CTPL): Thread Pool Library
- [docopt](https://github.com/docopt/docopt.cpp): A C++11 port of the Python argument parsing library
- [glfw](https://github.com/glfw/glfw): A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input
- [glm](https://github.com/g-truc/glm): OpenGL Mathematics
- [glslang](https://github.com/KhronosGroup/glslang): Shader front end and validator
- [dear imgui](https://github.com/ocornut/imgui): Immediate Mode Graphical User Interface
- [HWCPipe](https://github.com/ARM-software/HWCPipe): Interface to mobile Hardware Counters
- [KTX-Software](https://github.com/KhronosGroup/KTX-Software): Khronos Texture Library and Tools
- [spdlog](https://github.com/gabime/spdlog): Fast C++ logging library
- [SPIRV-Cross](https://github.com/KhronosGroup/SPIRV-Cross): Parses and converts SPIR-V to other shader languages
- [stb](https://github.com/nothings/stb): Single-file public domain (or MIT licensed) libraries
- [tinygltf](https://github.com/syoyo/tinygltf): Header only C++11 glTF 2.0 file parser
- [nlohmann json](https://github.com/nlohmann/json): C++ JSON Library (included by [tinygltf](https://github.com/syoyo/tinygltf))
- [vma](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator): Vulkan Memory Allocator
- [volk](https://github.com/zeux/volk): Meta loader for Vulkan API
- [vulkan](https://github.com/KhronosGroup/Vulkan-Docs): Sources for the formal documentation of the Vulkan API
This project uses assets from [vulkan-samples-assets](https://github.com/KhronosGroup/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 [CONTRIBUTORS](CONTRIBUTORS.md) for the full contributor list.
Also see [CONTRIBUTING](CONTRIBUTING.md) for contribution guidelines.
## Related resources
- [Mali GPU Best Practices](https://developer.arm.com/documentation/101897/latest/): A document with recommendations for efficient API usage
- [PerfDoc](https://github.com/ARM-software/perfdoc): A Vulkan layer which aims to validate applications against Mali GPU Best Practices