From a644c98864a868352d3ea5b1529927b940bca506 Mon Sep 17 00:00:00 2001 From: Bill Hollings Date: Sun, 5 Apr 2020 20:44:44 -0400 Subject: [PATCH] Disable API-Samples demos and document in Demos/README.md. --- Demos/Demos.xcworkspace/contents.xcworkspacedata | 3 --- Demos/README.md | 11 ++++++++--- Docs/Whats_New.md | 1 + 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/Demos/Demos.xcworkspace/contents.xcworkspacedata b/Demos/Demos.xcworkspace/contents.xcworkspacedata index 87886c356..c306685bc 100644 --- a/Demos/Demos.xcworkspace/contents.xcworkspacedata +++ b/Demos/Demos.xcworkspace/contents.xcworkspacedata @@ -7,9 +7,6 @@ - - diff --git a/Demos/README.md b/Demos/README.md index bf32a4bc5..3b33c84e8 100644 --- a/Demos/README.md +++ b/Demos/README.md @@ -64,7 +64,12 @@ as a system library instead. ### *API-Samples* -This *Xcode* project actually contains a large number of modular demos, with each demo +> **_Note:_** The `Vulkan-Samples API-Samples` have recently changed to use a different build + process that involves converting GLSL to SPIR-V via scripts. This upgrade has not yet been + integrated into the *Xcode*-based build environment used to build these demos here. + As a result, the `API-Samples` demos have been disabled here until this can be corrected. + +This *Xcode* project contains a large number of modular demos, with each demo demonstrating a particular *Vulkan* feature, or suite of calls. This demo can be found in the `LunarG-VulkanSamples/API-Samples` folder, and in the @@ -77,7 +82,7 @@ To specify which of the many modular demos to run, open the `Samples.h` in the ` project in the *Xcode Project Navigator* in the `Demos.xcworkspace` *Xcode* workspace, and follow the instructions in the comments within that file. -> **Note:** For simplicity, the `API-Samples` demos are bare-bones. Each of the `API-Samples` +> **_Note:_** For simplicity, the `API-Samples` demos are bare-bones. Each of the `API-Samples` > demos renders a single frame during app startup, and then leaves the rendered image static. > There is no display loop or motion in any of these demos. > **This is normal for these demos, and the demo has not "hung" or "crashed" when this occurs.** @@ -91,7 +96,7 @@ The `API-Samples` demo is a simple example of installing **MoltenVK** as a *stat ### *Hologram* -> **Note:** In order to build the `Hologram` demo, you must have *Python3* installed +> **_Note:_** In order to build the `Hologram` demo, you must have *Python3* installed > on your build computer. This is a sophisticated particle demo that populates command buffers from multiple threads. diff --git a/Docs/Whats_New.md b/Docs/Whats_New.md index 92649bccf..18df43410 100644 --- a/Docs/Whats_New.md +++ b/Docs/Whats_New.md @@ -38,6 +38,7 @@ Released 2020/04/05 - Update the `README.md` and `MoltenVK_Runtime_UserGuide.md` documents to clarify that **MoltenVK** is not a fully-compliant implementation of *Vulkan*. - Support Xcode 11.4. +- Disable `API-Samples` demos and document in `Demos/README.md`. - Update dependency libraries to match *Vulkan SDK 1.2.135*. - Update to latest SPIRV-Cross version: - MSL: Support inline uniform blocks in argument buffers.