Merge pull request #25 from ARM-software/release

Release 1.1.2

.gitignore

@@ -3,4 +3,7 @@ build
 .vs
 .vscode
 imgui.ini
-./doxygen
+./doxygen
+tests/system_test/artifacts
+tests/system_test/tmp
+output/*

.gitlab-ci.yml

@@ -65,7 +65,7 @@ Linux:
     - linux
     - docker
   script:
-    - cmake -H. -Bbuild
+    - cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_BUILD_TYPE=Release -DVKB_BUILD_TESTS=ON -DVKB_BUILD_SAMPLES=ON
     - cmake --build build --target vulkan_best_practice --config Release
 
 Windows:
@@ -76,7 +76,7 @@ Windows:
     - windows
     - shell
   script:
-    - cmake -H. -Bbuild
+    - cmake -H. -Bbuild -DVKB_BUILD_TESTS:BOOL=ON -DVKB_BUILD_SAMPLES:BOOL=ON
     - cmake --build build --target vulkan_best_practice --config Release
 
 Android:
@@ -88,8 +88,8 @@ Android:
     - linux
     - docker
   script:
-    - cmake -DCMAKE_TOOLCHAIN_FILE=bldsys/toolchain/android_gradle.cmake -H. -Bbuild
-    - cmake --build build --target vulkan_best_practice_package --config Release
+    - cmake -G "Unix Makefiles" -H. -Bbuild -DCMAKE_TOOLCHAIN_FILE=bldsys/toolchain/android_gradle.cmake -DVKB_BUILD_TESTS=ON -DVKB_BUILD_SAMPLES=ON
+    - cmake --build build --config Release --target vulkan_best_practice_package
 
 LinuxExternalProject:
   stage: Test
@@ -121,4 +121,4 @@ AndroidExternalProject:
     - linux
     - docker
   script:
-    - cmake -DCMAKE_TOOLCHAIN_FILE=../../bldsys/toolchain/android_gradle.cmake -Htests/external_project -Bbuild -DVKB_BUILD_SAMPLES=OFF
+    - cmake -DCMAKE_TOOLCHAIN_FILE=../../bldsys/toolchain/android_gradle.cmake -Htests/external_project -Bbuild -DVKB_BUILD_SAMPLES=OFF

CMakeLists.txt

@@ -37,10 +37,15 @@ add_subdirectory(third_party)
 # Add vulkan framework
 add_subdirectory(framework)
 
+if(VKB_BUILD_TESTS)
+    # Add vulkan tests
+    add_subdirectory(tests)
+endif()
+
 if(VKB_BUILD_SAMPLES)
     # Add vulkan samples
     add_subdirectory(samples)
-
+    
     # Add vulkan app (runs all samples)
     add_subdirectory(vulkan_best_practice)
 endif()

README.md

@@ -35,6 +35,7 @@
 - [License](#license)
   - [Trademarks](#trademarks)
 - [Contributions](#contributions)
+- [Related resources](#related-resources)
 
 ## Introduction
 
@@ -57,12 +58,16 @@ The Vulkan Best Practice for Mobile Developers is collection of resources to hel
   - [How does Vulkan compare to OpenGL ES? What should you expect when targeting Vulkan?](./samples/vulkan_basics.md)
 - **Vulkan Swapchains**  
 More detailed look at swapchains, and how you might want to use them
-  - [Appropriate use of N-buffering](./samples/swapchain_images/swapchain_images_tutorial.md)
-  - [Appropriate use of surface rotation](./samples/surface_rotation/surface_rotation_tutorial.md)
+  - [Appropriate use of N-buffering](./samples/advanced/swapchain_images/swapchain_images_tutorial.md)
+  - [Appropriate use of surface rotation](./samples/advanced/surface_rotation/surface_rotation_tutorial.md)
+- **Pipelines**
+  - [Use of pipeline caches to avoid startup latency](./samples/advanced/pipeline_cache/pipeline_cache_tutorial.md)
 - **Render Passes**
-  - [Appropriate use of load/store operations, and use of transient attachments](./samples/render_passes/render_passes_tutorial.md)
+  - [Appropriate use of load/store operations, and use of transient attachments](./samples/advanced/render_passes/render_passes_tutorial.md)
+- **Command Buffers**
+  - [Allocation and management of command buffers](./samples/advanced/command_buffer_usage/command_buffer_usage_tutorial.md)
 - **AFBC**
-  - [Appropriate use of AFBC](./samples/afbc/afbc_tutorial.md)
+  - [Appropriate use of AFBC](./samples/advanced/afbc/afbc_tutorial.md)
 
 ## Setup
 
@@ -80,11 +85,16 @@ Follow build instructions for your platform below.
 ### Supported Platforms
 - Windows - [Build Guide](./docs/build.md#windows "Windows Build Guide")
 - Linux - [Build Guide](./docs/build.md#linux "Linux Build Guide")
+- Mac OSX - [Build Guide](./docs/build.md#mac "Mac OSX Build Guide")
 - Android - [Build Guide](./docs/build.md#android "Android Build Guide")
-<!-- - Mac OSX (Experimental) - [Build Guide](./build.md#mac "Mac OSX Build Guide") --> 
 
 > Tested on: Samsung Galaxy S9, Samsung Galaxy S10, Huawei Mate 20 Pro, OPPO R15
 
+## Testing
+
+- System Test - [Usage Guide](docs/testing.md#system-test "System Test Guide")
+
+
 ## License
 
 See [LICENSE](LICENSE).
@@ -109,11 +119,13 @@ This project has some third-party dependencies, each of which may have independe
 
 This project uses the following 3D models. Each one has its own licence.
 
-- Sponza [license](https://creativecommons.org/licenses/by/3.0/) with the following modifications:
+- Sponza: [CC BY 3.0 license](https://creativecommons.org/licenses/by/3.0/) with the following modifications:
    - All textures are converted to ASTC in .ktx format.
    - Converted to gltf using [Blender exporter](https://github.com/KhronosGroup/glTF-Blender-IO).
+- Bonza: [MIT license](LICENSE)
+- Space Module: [MIT license](LICENSE)
 
-Models downloaded from Morgan McGuire's [Computer Graphics Archive](https://casual-effects.com/data).
+Sponza model downloaded from Morgan McGuire's [Computer Graphics Archive](https://casual-effects.com/data).
 
 Fonts downloaded from [Google Fonts](https://fonts.google.com), under license [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
 

VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

bldsys/cmake/android_sync_assets.cmake

@@ -26,7 +26,17 @@ set(CMAKE_MODULE_PATH
 set(ASSETS_DIR ${ASSETS_DIR})
 set(DEVICE_DIR ${DEVICE_DIR})
 
-find_package(Adb 1.0.40 REQUIRED)
+find_package(Adb 1.0.39 REQUIRED)
+
+# Ensure that directory exists in the target
+
+set(ADB_COMMAND ${ADB_EXECUTABLE} shell mkdir -p ${DEVICE_DIR})
+
+execute_process(
+        COMMAND
+        ${ADB_COMMAND})
+
+# Sync files
 
 set(ADB_COMMAND ${ADB_EXECUTABLE} push --sync ${ASSETS_DIR} ${DEVICE_DIR})
 

bldsys/cmake/global_options.cmake

@@ -20,8 +20,6 @@
 
  ]]
 
-set(CMAKE_BUILD_TYPE "debug" CACHE STRING "Build configuration")
-
 if(NOT CMAKE_ANDROID_NDK)
     set(CMAKE_ANDROID_NDK ${ANDROID_NDK})
 endif()
@@ -36,10 +34,12 @@ else()
     set(TARGET_ARCH ${CMAKE_SYSTEM_PROCESSOR})
 endif()
 
-set(VKB_SAMPLE_ENTRYPOINT OFF CACHE BOOL "Enable create entrypoint project for every sample.")
-set(VKB_ASSETS_SYMLINK OFF CACHE BOOL "Enable create symlink assets folder for every sample.")
-set(VKB_VALIDATION_LAYERS OFF CACHE BOOL "Enable validation layers for every sample.")
+set(VKB_WARNINGS_AS_ERRORS ON CACHE BOOL "Enable Warnings as Errors")
+set(VKB_ENTRYPOINTS OFF CACHE BOOL "Enable create entrypoint project for every application.")
+set(VKB_SYMLINKS OFF CACHE BOOL "Enable create symlink folders for every application.")
+set(VKB_VALIDATION_LAYERS OFF CACHE BOOL "Enable validation layers for every application.")
 set(VKB_BUILD_SAMPLES ON CACHE BOOL "Enable generation and building of Vulkan best practice samples.")
+set(VKB_BUILD_TESTS OFF CACHE BOOL "Enable generation and building of Vulkan best practice tests.")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "bin/${CMAKE_BUILD_TYPE}/${TARGET_ARCH}")
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "lib/${CMAKE_BUILD_TYPE}/${TARGET_ARCH}")