Merge pull request #24 from ARM-software/release

Release 1.1.1

Author: antonio-caggiano-arm

.copyrightignore

@@ -0,0 +1,10 @@
+.clang-format
+doxyfile
+.gitignore
+.snakeignore
+.yml
+.gitmodules
+.jpg
+.png
+.ttf
+VERSION

.gitlab-ci.yml

@@ -14,14 +14,23 @@ Doxygen:
     - doxygen docs/doxygen/doxyfile
     - if [ $(stat -c%s doxygen/warnings.txt) -gt 0 ]; then cat doxygen/warnings.txt; exit 1; fi
 
+CopyrightHeaders:
+  stage: Check
+  image: $DOCKER_REGISTRY/docker/copyright-check/linux:latest
+  tags:
+    - linux
+    - docker
+  script:
+    - python3 /usr/local/bin/check_copyright_headers.py $TARGET_BRANCH
+
 SnakeCase:
   stage: Check
   image: $DOCKER_REGISTRY/docker/snake_case_check/linux:latest
   tags:
     - linux
     - docker
   script:
-    - git snake-case origin/develop > snake-report.txt
+    - git snake-case $TARGET_BRANCH > snake-report.txt
     - if [ $(grep -c '@@' snake-report.txt) -gt 0 ]; then cat snake-report.txt; exit 1; fi
   allow_failure: true
 
@@ -32,7 +41,7 @@ ClangFormat:
     - linux
     - docker
   script:
-    - git clang-format -v --diff origin/develop > clang-format-report.txt
+    - git clang-format -v --diff $TARGET_BRANCH > clang-format-report.txt
     - if [ $(grep -c 'clang-format did not modify any files' clang-format-report.txt) -eq 0  ] && [ $(grep -c 'no modified files to format' clang-format-report.txt) -eq 0  ]; then cat clang-format-report.txt; exit 1; fi
 
 ClangTidy:

CMakeLists.txt

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-cmake_minimum_required(VERSION 3.6)
+cmake_minimum_required(VERSION 3.8)
 
 project(vulkan_best_practice)
 

README.md

@@ -115,6 +115,8 @@ This project uses the following 3D models. Each one has its own licence.
 
 Models 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)
+
 ### Trademarks
 
 Vulkan is a registered trademark of the Khronos Group Inc.

VERSION

@@ -1 +1 @@
-1.0.0
+1.1.1

assets/fonts/Roboto-Regular.ttf

@@ -21,38 +21,55 @@
 
 precision highp float;
 
-layout (set=0, binding=0) uniform sampler2D base_color_sampler;
+#ifdef HAS_BASE_COLOR_TEXTURE
+layout (set=0, binding=0) uniform sampler2D base_color_texture;
+#endif
 
 layout (location = 0) in vec4 in_pos;
 layout (location = 1) in vec2 in_uv;
 layout (location = 2) in vec3 in_normal;
 
 layout (location = 0) out vec4 o_color;
 
-layout(push_constant, std430) uniform PushConstant {
-    layout(offset = 128) vec4 light_pos;
+layout(set = 0, binding = 1) uniform GlobalUniform {
+    mat4 model;
+    mat4 view_proj;
+    vec4 light_pos;
     vec4 light_color;
-} fs_push_constant;
+} global_uniform;
+
+// Push constants are much quicker than uniforms
+// but they come with a limitation in the size of data.
+// The standard requires at least 128 bytes
+layout(push_constant, std430) uniform PBRMaterialUniform {
+    vec4 base_color_factor;
+    float metallic_factor;
+    float roughness_factor;
+} pbr_material_uniform;
 
 void main(void)
 {
     vec3 normal = normalize(in_normal);
 
-    vec3 world_to_light = fs_push_constant.light_pos.xyz - in_pos.xyz;
+    vec3 world_to_light = global_uniform.light_pos.xyz - in_pos.xyz;
 
     float dist = length(world_to_light) * 0.0001;
 
-    float atten = 1.0 - smoothstep(0.5 * fs_push_constant.light_pos.w, fs_push_constant.light_pos.w, dist);
+    float atten = 1.0 - smoothstep(0.5 * global_uniform.light_pos.w, global_uniform.light_pos.w, dist);
 
     world_to_light = normalize(world_to_light);
 
     float ndotl = clamp(dot(normal, world_to_light), 0.0, 1.0);
 
     vec4 base_color = vec4(1.0, 0.0, 0.0, 1.0);
 
-    base_color = texture(base_color_sampler, in_uv);
+#ifdef HAS_BASE_COLOR_TEXTURE
+    base_color = texture(base_color_texture, in_uv);
+#else
+    base_color = pbr_material_uniform.base_color_factor;    
+#endif
 
     vec4 ambient_color = vec4(0.2, 0.2, 0.2, 1.0) * base_color;
 
-    o_color = ambient_color + ndotl * atten * fs_push_constant.light_color * base_color;
+    o_color = ambient_color + ndotl * atten * global_uniform.light_color * base_color;
 }

assets/fonts/RobotoMono-Regular.ttf

@@ -23,22 +23,24 @@ layout(location = 0) in vec3 position;
 layout(location = 1) in vec2 texcoord_0;
 layout(location = 2) in vec3 normal;
 
-layout(push_constant, std430) uniform PushConstant {
+layout(set = 0, binding = 1) uniform GlobalUniform {
     mat4 model;
     mat4 view_proj;
-} vs_push_constant;
+    vec4 light_pos;
+    vec4 light_color;
+} global_uniform;
 
 layout (location = 0) out vec4 o_pos;
 layout (location = 1) out vec2 o_uv;
 layout (location = 2) out vec3 o_normal;
 
 void main(void)
 {
-    o_pos = vs_push_constant.model * vec4(position, 1.0);
+    o_pos = global_uniform.model * vec4(position, 1.0);
 
     o_uv = texcoord_0;
 
-    o_normal = mat3(vs_push_constant.model) * normal;
+    o_normal = mat3(global_uniform.model) * normal;
 
-    gl_Position = vs_push_constant.view_proj * o_pos;
+    gl_Position = global_uniform.view_proj * o_pos;
 }

assets/shaders/base.frag

@@ -0,0 +1,46 @@
+#[[
+ Copyright (c) 2019, Arm Limited and Contributors
+
+ SPDX-License-Identifier: MIT
+
+ Permission is hereby granted, free of charge,
+ to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ to deal in the Software without restriction, including without limitation the rights to
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+ ]]
+
+set(CMAKE_MODULE_PATH
+    ${CMAKE_MODULE_PATH}
+    ${CMAKE_MODULE_PATH}/module)
+set(ASSETS_DIR ${ASSETS_DIR})
+set(DEVICE_DIR ${DEVICE_DIR})
+
+find_package(Adb 1.0.40 REQUIRED)
+
+set(ADB_COMMAND ${ADB_EXECUTABLE} push --sync ${ASSETS_DIR} ${DEVICE_DIR})
+
+execute_process(
+        COMMAND
+        ${ADB_COMMAND}
+        RESULT_VARIABLE
+        ret_var
+        OUTPUT_VARIABLE
+        ret_msg
+        OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+if(NOT "${ret_var}" STREQUAL "0")
+    message(WARNING "Could not sync assets to device:\n${ret_msg}")
+else()
+    message(STATUS "Updating assets:\n${ret_msg}")
+endif()