Updates to iOS and macOS functionality using MoltenVK.

Use getAssetPath() instead of ASSET_PATH to support broader range of platforms.
Multisampling example determines sample rate from device at runtime.
Move example wrapper code from DemoViewController.mm to dedicated MVKExample.cpp file.
Remove AssImp libraries for iOS and macOS from repo, and add instructions for
generating them from AssImp source files.
Update general README.md file to mention support for iOS and macOS platforms.
Add Apple logo for README.md.
Update Vulkan logo to current registered TM logo.
Update copyright notice of MoltenVK example files to MIT license.
Examples use +/- on main keyboard, instead of numpad.

Author: billhollings

README.md

@@ -33,6 +33,10 @@ Note that you need [assimp](https://github.com/assimp/assimp) in order to compil
 
 Building on Android is done using the [Android NDK](http://developer.android.com/tools/sdk/ndk/index.html) and requires a device that supports Vulkan. Please see the [Android readme](./android/README.md) on how to build and deploy the examples.
 
+## <img src="./images/applelogo.png" alt="" height="32px"> [iOS and macOS](xcode/)
+
+Building for *iOS* and *macOS* is done using the [examples](xcode/examples.xcodeproj) *Xcode* project found in the [xcode](xcode) directory. These examples use the [**MoltenVK**](https://moltengl.com/moltenvk) Vulkan driver to provide Vulkan support on *iOS* and *macOS*, and require an *iOS* or *macOS* device that supports *Metal*. Please see the [MoltenVK Examples readme](xcode/README_MoltenVK_Examples.md) for more info on acquiring **MoltenVK** and building and deploying the examples on *iOS* and *macOS*.
+
 ## Additional asset pack
 
 **Note:** Binary assets (textures, models) will no longer be added directly to the repository to keep it's size down, so newer examples will require the download of an [additional asset pack](data/README.md).

base/keycodes.hpp

@@ -55,6 +55,7 @@
 
 #elif defined(VK_USE_PLATFORM_IOS_MVK)
 // Use numeric keys instead of function keys.
+// Use main keyboard plus/minus instead of keypad plus/minus
 // Use Delete key instead of Escape key.
 #define KEY_ESCAPE 0x33
 #define KEY_F1 '1'
@@ -77,8 +78,9 @@
 #define KEY_T 't'
 
 #elif defined(VK_USE_PLATFORM_MACOS_MVK)
-// For iOS UX compatibility:
+// For compatibility with iOS UX and absent keypad on MacBook:
 // - Use numeric keys instead of function keys
+// - Use main keyboard plus/minus instead of keypad plus/minus
 // - Use Delete key instead of Escape key
 #define KEY_ESCAPE 0x33
 #define KEY_F1 0x12
@@ -91,8 +93,8 @@
 #define KEY_D 0x02
 #define KEY_P 0x23
 #define KEY_SPACE 0x31
-#define KEY_KPADD 0x45
-#define KEY_KPSUB 0x4E
+#define KEY_KPADD 0x18
+#define KEY_KPSUB 0x1B
 #define KEY_B 0x0B
 #define KEY_F 0x03
 #define KEY_L 0x25

hdr/hdr.cpp

@@ -606,7 +606,7 @@ class VulkanExample : public VulkanExampleBase
 		std::vector<std::string> filenames = { "geosphere.obj", "teapot.dae", "torusknot.obj", "venus.fbx" };
 		for (auto file : filenames) {
 			vks::Model model;
-			model.loadFromFile(ASSET_PATH "models/" + file, vertexLayout, 0.05f * (file == "venus.fbx" ? 3.0f : 1.0f), vulkanDevice, queue);
+			model.loadFromFile(getAssetPath() + "models/" + file, vertexLayout, 0.05f * (file == "venus.fbx" ? 3.0f : 1.0f), vulkanDevice, queue);
 			models.objects.push_back(model);
 		}
 		// Load HDR cube map

images/applelogo.png

@@ -11,6 +11,7 @@
 #include <string.h>
 #include <assert.h>
 #include <vector>
+#include <algorithm>
 
 #define GLM_FORCE_RADIANS
 #define GLM_FORCE_DEPTH_ZERO_TO_ONE
@@ -25,7 +26,6 @@
 
 #define VERTEX_BUFFER_BIND_ID 0
 #define ENABLE_VALIDATION false
-#define SAMPLE_COUNT VK_SAMPLE_COUNT_8_BIT
 
 struct {
 	struct {
@@ -44,6 +44,7 @@ class VulkanExample : public VulkanExampleBase
 {
 public:
 	bool useSampleShading = false;
+    VkSampleCountFlagBits sampleCount = VK_SAMPLE_COUNT_1_BIT;
 
 	struct {
 		vks::Texture2D colorMap;
@@ -123,7 +124,7 @@ class VulkanExample : public VulkanExampleBase
 	void setupMultisampleTarget()
 	{
 		// Check if device supports requested sample count for color and depth frame buffer
-		assert((deviceProperties.limits.framebufferColorSampleCounts >= SAMPLE_COUNT) && (deviceProperties.limits.framebufferDepthSampleCounts >= SAMPLE_COUNT));
+		assert((deviceProperties.limits.framebufferColorSampleCounts >= sampleCount) && (deviceProperties.limits.framebufferDepthSampleCounts >= sampleCount));
 
 		// Color target
 		VkImageCreateInfo info = vks::initializers::imageCreateInfo();
@@ -136,7 +137,7 @@ class VulkanExample : public VulkanExampleBase
 		info.arrayLayers = 1;
 		info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 		info.tiling = VK_IMAGE_TILING_OPTIMAL;
-		info.samples = SAMPLE_COUNT;
+		info.samples = sampleCount;
 		// Image will only be used as a transient target
 		info.usage = VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
 		info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
@@ -184,7 +185,7 @@ class VulkanExample : public VulkanExampleBase
 		info.arrayLayers = 1;
 		info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 		info.tiling = VK_IMAGE_TILING_OPTIMAL;
-		info.samples = SAMPLE_COUNT;
+		info.samples = sampleCount;
 		// Image will only be used as a transient target
 		info.usage = VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
 		info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
@@ -230,7 +231,7 @@ class VulkanExample : public VulkanExampleBase
 
 		// Multisampled attachment that we render to
 		attachments[0].format = swapChain.colorFormat;
-		attachments[0].samples = SAMPLE_COUNT;
+		attachments[0].samples = sampleCount;
 		attachments[0].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
 		// No longer required after resolve, this may save some bandwidth on certain GPUs
 		attachments[0].storeOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
@@ -252,7 +253,7 @@ class VulkanExample : public VulkanExampleBase
 
 		// Multisampled depth attachment we render to
 		attachments[2].format = depthFormat;
-		attachments[2].samples = SAMPLE_COUNT;
+		attachments[2].samples = sampleCount;
 		attachments[2].loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
 		attachments[2].storeOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
 		attachments[2].stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
@@ -630,7 +631,7 @@ class VulkanExample : public VulkanExampleBase
 		shaderStages[0] = loadShader(getAssetPath() + "shaders/mesh/mesh.vert.spv", VK_SHADER_STAGE_VERTEX_BIT);
 		shaderStages[1] = loadShader(getAssetPath() + "shaders/mesh/mesh.frag.spv", VK_SHADER_STAGE_FRAGMENT_BIT);
 		// Setup multi sampling
-		multisampleState.rasterizationSamples = SAMPLE_COUNT;		// Number of samples to use for rasterization
+		multisampleState.rasterizationSamples = sampleCount;		// Number of samples to use for rasterization
 
 		VK_CHECK_RESULT(vkCreateGraphicsPipelines(device, pipelineCache, 1, &pipelineCreateInfo, nullptr, &pipelines.MSAA));
 
@@ -693,6 +694,7 @@ class VulkanExample : public VulkanExampleBase
 
 	void prepare()
 	{
+        setSampleCount();
 		VulkanExampleBase::prepare();
 		loadAssets();
 		setupVertexDescriptions();
@@ -733,6 +735,16 @@ class VulkanExample : public VulkanExampleBase
 			break;
 		}
 	}
+
+    // Determine the maximum sample count usable by the platform
+    void setSampleCount()
+    {
+        VkSampleCountFlags flags = std::min(deviceProperties.limits.framebufferColorSampleCounts,
+                                            deviceProperties.limits.framebufferDepthSampleCounts);
+        // Extract the value of the high-order bit of the flags
+        sampleCount = (VkSampleCountFlagBits)(flags ? (1 << (fls(flags) - 1)) : 0);
+    }
+
 };
 
-VULKAN_EXAMPLE_MAIN()
+VULKAN_EXAMPLE_MAIN()

images/vulkanlogo.png

@@ -179,7 +179,7 @@ class VulkanExample : public VulkanExampleBase
 	void loadTexture()
 	{
 		// We use the Khronos texture format (https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/) 
-		std::string filename = ASSET_PATH "textures/metalplate01_rgba.ktx";
+		std::string filename = getAssetPath() + "textures/metalplate01_rgba.ktx";
 		// Texture data contains 4 channels (RGBA) with unnormalized 8-bit values, this is the most commonly supported format
 		VkFormat format = VK_FORMAT_R8G8B8A8_UNORM;
 

libs/assimp/ios/libassimp.a

@@ -0,0 +1,30 @@
+/*
+ *  MVKExample.cpp
+ *
+ *  Copyright (c) 2016-2017 The Brenwill Workshop Ltd.
+ *  This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
+ */
+
+
+#include "MVKExample.h"
+#include "examples.h"
+
+void MVKExample::renderFrame() {
+    _vulkanExample->renderFrame();
+}
+
+void MVKExample::keyPressed(uint32_t keyCode) {
+    _vulkanExample->keyPressed(keyCode);
+}
+
+MVKExample::MVKExample(void* view) {
+    _vulkanExample = new VulkanExample();
+    _vulkanExample->initVulkan();
+    _vulkanExample->setupWindow(view);
+    _vulkanExample->initSwapchain();
+    _vulkanExample->prepare();
+}
+
+MVKExample::~MVKExample() {
+    delete _vulkanExample;
+}

libs/assimp/ios/libzlibstatic.a

@@ -0,0 +1,27 @@
+/*
+ *  MVKExample.h
+ *
+ *  Copyright (c) 2016-2017 The Brenwill Workshop Ltd.
+ *  This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
+ */
+
+#pragma once
+
+#include "vulkanexamplebase.h"
+
+// Wrapper class for the SW VulkanExample instance.
+class MVKExample {
+
+public:
+    void renderFrame();
+    void keyPressed(uint32_t keyCode);
+
+    MVKExample(void* view);
+    ~MVKExample();
+
+protected:
+    VulkanExampleBase* _vulkanExample;
+};
+
+
+

libs/assimp/macos/libassimp.dylib

@@ -4,7 +4,8 @@
 
 #MoltenVK Vulkan Examples
 
-Copyright (c) 2014-2017 [The Brenwill Workshop Ltd.](http://www.brenwill.com) All rights reserved.
+Copyright (c) 2016-2017 [The Brenwill Workshop Ltd.](http://www.brenwill.com).
+This document is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
 
 *This document is written in [Markdown](http://en.wikipedia.org/wiki/Markdown) format. 
 For best results, use a Markdown reader.*
@@ -27,6 +28,9 @@ Installing MoltenVK
 
 The examples in this repository can be run on *iOS* and *macOS* by using 
 the [**MoltenVK**](http://www.moltengl.com/moltenvk/) *Vulkan* driver.
+
+These examples require **MoltenVK 0.18.0** or greater.
+
 Follow these instructions to install **MoltenVK**:
 
 1. [Download](https://moltengl.com/free-trial/) the **Molten** free evaluation trial.
@@ -45,6 +49,72 @@ Follow these instructions to install **MoltenVK**:
 		ln -s path-to-Molten-package/MoltenVK
 
 
+
+<a name="installing-assimp"></a>
+
+Installing AssImp
+-----------------
+
+The examples in this repository make use of the [*AssImp*](http://assimp.sourceforge.net) 
+library to load resource assets from files. To run the examples you must download and 
+install *AssImp* library as follows.
+
+>***Note:*** Due to the way that *AssImp* makes use of the *CMake* utility, an installation 
+of *AssImp* can only be built for a single platform. To create *AssImp* libraries for both 
+*iOS* and *macOS*, download a separate copy of the *AssImp* directory for each platform 
+(or create a copy of the downloaded *AssImp* directory for each platform before building).
+
+
+####iOS
+
+1. Download [AssImp 3.3.1](https://github.com/assimp/assimp/releases/tag/v3.3.1/).
+
+2. Unzip and rename the directory to `assimp-3.3.1-ios`.
+
+3. Open the file `assimp-3.3.1-ios/port/iOS/IPHONEOS_ARM64_TOOLCHAIN.cmake` file and comment
+   out the following lines:
+   
+   		#SET (CC         "${DEVROOT}/usr/bin/llvm-gcc")
+		#SET (CXX        "${DEVROOT}/usr/bin/llvm-g++")
+		#CMAKE_FORCE_C_COMPILER          (${CC} LLVM)
+		#CMAKE_FORCE_CXX_COMPILER        (${CXX} LLVM)
+
+4. Open a *Terminal* session and navigate to the `assimp-3.3.1-ios/port/iOS` directory,
+   and run the following build command:
+   
+		cd path-to-assimp-3.3.1-ios/port/iOS
+		./build.sh --stdlib=libc++ --archs="arm64" --no-fat
+
+5. In the `assimp` directory within this directory, remove the existing `assimp-ios` 
+   symbolic link, and create a new symbolic link pointing to the `assimp-3.3.1-ios` directory:
+   
+   		cd path-to-this-directory/assimp
+		rm assimp-ios
+		ln -s path-to-assimp-3.3.1-ios assimp-ios
+
+
+####macOS
+
+1. Download [AssImp 3.3.1](https://github.com/assimp/assimp/releases/tag/v3.3.1/).
+
+2. Unzip and rename the directory to `assimp-3.3.1-macos`.
+
+3. Open a *Terminal* session and navigate to the `assimp-3.3.1-ios/port/macOS` directory,
+   and run the following build commands:
+   
+		cd path-to-assimp-3.3.1-macos
+		cmake CMakeLists.txt -G 'Unix Makefiles'
+		make
+
+4. In the `assimp` directory within this directory, remove the existing `assimp-macos` 
+   symbolic link, and create a new symbolic link pointing to the `assimp-3.3.1-macos` directory:
+   
+   		cd path-to-this-directory/assimp
+		rm assimp-macos
+		ln -s path-to-assimp-3.3.1-macos assimp-macos
+
+
+
 <a name="running-examples"></a>
 
 Running the Vulkan Examples
@@ -67,5 +137,6 @@ in this repository on either *iOS* or *macOS*. To do so, follow these instructio
 
    - On *iOS*, tap on the scene to display the keyboard. Tap again on the scene to hide the keyboard.
    - On both *iOS* and *macOS*, use the numeric keys (*1, 2, 3...*) instead of function keys (*F1, F2, F3...*). 
+   - On both *iOS* and *macOS*, use the regular keyboard *+* and *-* keys instead of the numpad *+* and *-* keys. 
    - On both *iOS* and *macOS*, use the *delete* key instead of the *escape* key. 
 

multisampling/multisampling.cpp

@@ -0,0 +1 @@
+../../../assimp-3.3.1-ios

texture/texture.cpp

@@ -0,0 +1 @@
+../../../assimp-3.3.1-macos