Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 5 additions & 22 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ ifdef::site-gen-antora[]
endif::[]

ifndef::site-gen-antora[]
* https://github.com/KhronosGroup/Vulkan-Guide[Vulkan Guide]
* https://vulkan-tutorial.com/[Get Started in Vulkan]
* https://docs.vulkan.org/guide/latest/index.html[Vulkan Guide]
* 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.
Expand Down Expand Up @@ -109,8 +109,9 @@ VPN service.

* Windows - xref:./docs/build.adoc#windows[Build Guide]
* Linux - xref:./docs/build.adoc#linux[Build Guide]
* macOS - xref:./docs/build.adoc#macos[Build Guide]
* Android - xref:./docs/build.adoc#android[Build Guide]
* macOS - xref:./docs/build.adoc#macos[Build Guide]
* iOS - xref:./docs/build.adoc#ios[Build Guide]

== Usage

Expand Down Expand Up @@ -151,25 +152,7 @@ adb shell am start-activity -n com.khronos.vulkan_samples/com.khronos.vulkan_sam

See link:LICENSE[LICENSE].

This project has some third-party dependencies, each of which may have independent licensing:

* https://github.com/ARM-software/astc-encoder[astc-encoder]: ASTC Evaluation Codec
* https://github.com/vit-vit/CTPL[CTPL]: Thread Pool Library
* https://github.com/docopt/docopt.cpp[docopt]: A C{pp}11 port of the Python argument parsing library
* https://github.com/glfw/glfw[glfw]: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input
* https://github.com/g-truc/glm[glm]: OpenGL Mathematics
* https://github.com/KhronosGroup/glslang[glslang]: Shader front end and validator
* https://github.com/ocornut/imgui[dear imgui]: Immediate Mode Graphical User Interface
* https://github.com/ARM-software/HWCPipe[HWCPipe]: Interface to mobile Hardware Counters
* https://github.com/KhronosGroup/KTX-Software[KTX-Software]: Khronos Texture Library and Tools
* https://github.com/gabime/spdlog[spdlog]: Fast C{pp} logging library
* https://github.com/KhronosGroup/SPIRV-Cross[SPIRV-Cross]: Parses and converts SPIR-V to other shader languages
* https://github.com/nothings/stb[stb]: Single-file public domain (or MIT licensed) libraries
* https://github.com/syoyo/tinygltf[tinygltf]: Header only C{pp}11 glTF 2.0 file parser
* https://github.com/nlohmann/json[nlohmann json]: C{pp} JSON Library (included by https://github.com/syoyo/tinygltf[tinygltf])
* https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator[vma]: Vulkan Memory Allocator
* https://github.com/zeux/volk[volk]: Meta loader for Vulkan API
* https://github.com/KhronosGroup/Vulkan-Docs[vulkan]: Sources for the formal documentation of the Vulkan API
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.
Expand Down
4 changes: 2 additions & 2 deletions antora/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2022-2023 The Khronos Group Inc.
# Copyright 2022-2024 The Khronos Group Inc.
# SPDX-License-Identifier: Apache-2.0

# Configure Vulkan Guide Antora tree with transformed markup files.
Expand All @@ -14,7 +14,7 @@ function(gatherAntoraAssets)
samples
scripts
shaders
tests
third_party
)
set(PAGES_DIR_SEARCH)
set(IMAGES_DIR_SEARCH)
Expand Down
45 changes: 45 additions & 0 deletions third_party/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
////
- Copyright (c) 2019-2024, Arm Limited and Contributors
-
- SPDX-License-Identifier: Apache-2.0
-
- Licensed under the Apache License, Version 2.0 the "License";
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
////
= Vulkan Samples third-party dependencies
// omit in toc
:pp: {plus}{plus}

This project has multiple third-party dependencies, each of which may have independent licensing:

* https://github.com/ARM-software/astc-encoder[astc-encoder]: ASTC Evaluation Codec
* https://github.com/catchorg/Catch2[Catch2]: Modern C++ test framework
* https://github.com/CLIUtils/CLI11[CLI11] Command line parser for C++11 and beyond
* https://github.com/vit-vit/CTPL[CTPL]: Thread Pool Library
* https://github.com/fmtlib/fmt[fmt]: A modern formating library
* https://github.com/glfw/glfw[glfw]: A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input
* https://github.com/g-truc/glm[glm]: OpenGL Mathematics
* https://github.com/KhronosGroup/glslang[glslang]: Shader front end and validator
* https://github.com/ARM-software/HWCPipe[HWCPipe]: Interface to mobile Hardware Counters
* https://github.com/ocornut/imgui[dear imgui]: Immediate Mode Graphical User Interface
* https://github.com/KhronosGroup/KTX-Software[KTX-Software]: Khronos Texture Library and Tools
* https://github.com/KhronosGroup/OpenCL-Headers[OpenCL]: Khronos OpenCL-Headers
* https://github.com/gabime/spdlog[spdlog]: Fast C{pp} logging library
* https://github.com/KhronosGroup/SPIRV-Cross[SPIRV-Cross]: Parses and converts SPIR-V to other shader languages
* https://github.com/nothings/stb[stb]: Single-file public domain (or MIT licensed) libraries
* https://github.com/syoyo/tinygltf[tinygltf]: Header only C{pp}11 glTF 2.0 file parser
* https://github.com/wolfpld/tracy[tracy]: Frame profiler
* https://github.com/nlohmann/json[nlohmann json]: C{pp} JSON Library (included by https://github.com/syoyo/tinygltf[tinygltf])
* https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator[vma]: Vulkan Memory Allocator
* https://github.com/zeux/volk[volk]: Meta loader for Vulkan API
* https://github.com/KhronosGroup/Vulkan-Docs[Vulkan]: Sources for the formal documentation of the Vulkan API
Loading