summaryrefslogtreecommitdiff
path: root/docs/README-ios.md
diff options
context:
space:
mode:
authorRyan C. Gordon <icculus@icculus.org>2017-08-27 22:15:57 -0400
committerRyan C. Gordon <icculus@icculus.org>2017-08-27 22:15:57 -0400
commitece8a728c72c4d402e4ec19e6ce98458627364ee (patch)
tree068aef0c7305ebe6905cdf178c552335ac7bae49 /docs/README-ios.md
parent7c79ee2f600947b608064f04f5069a02357e0c7e (diff)
downloadsdl-ece8a728c72c4d402e4ec19e6ce98458627364ee.tar.gz
vulkan: Initial Vulkan support!
This work was done by Jacob Lifshay and Mark Callow; I'm just merging it into revision control.
Diffstat (limited to 'docs/README-ios.md')
-rw-r--r--docs/README-ios.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/README-ios.md b/docs/README-ios.md
index 29f417048..746b4fba7 100644
--- a/docs/README-ios.md
+++ b/docs/README-ios.md
@@ -7,9 +7,12 @@ Building the Simple DirectMedia Layer for iOS 5.1+
Requirements: Mac OS X 10.8 or later and the iOS 7+ SDK.
-Instructions:
-1. Open SDL.xcodeproj (located in Xcode-iOS/SDL) in Xcode.
-2. Select your desired target, and hit build.
+Instructions:
+
+1. Either download [Molten](https://moltengl.com/free-trial/) and unzip it or download the Vulkan headers from Khronos's [Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs/tree/1.0/src/vulkan) repo and put them in a directory hierarchy `include/vulkan`.
+2. Open SDL.xcodeproj (located in Xcode-iOS/SDL) in Xcode.
+3. Set a `VULKAN_SDK` custom path in the Xcode preferences. Select *Custom Paths* on the *Locations* tab. The value should be either the `MoltenVK` directory within the unzipped Molten package or the parent of the `include/vulkan` hierarchy.
+4. Select your desired target, and hit build.
There are three build targets:
- libSDL.a:
@@ -24,7 +27,9 @@ There are three build targets:
Build SDL for iOS from the command line
==============================================================================
-1. cd (PATH WHERE THE SDL CODE IS)/build-scripts
+1. Follow step 1 above.
+2. Either create and export a `VULKAN_SDK` environment variable with the value described in step 3 above or open Xcode, set the custom path described in step 3 above and close Xcode.
+3. cd (PATH WHERE THE SDL CODE IS)/build-scripts
2. ./iosbuild.sh
If everything goes fine, you should see a build/ios directory, inside there's