From 00bc7f6b9634a659700f98248a4c1050147556da Mon Sep 17 00:00:00 2001 From: David Ludwig Date: Mon, 23 Sep 2019 18:27:14 -0400 Subject: [PATCH] CMake: document iOS/tvOS support in README-cmake.md --- docs/README-cmake.md | 54 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/docs/README-cmake.md b/docs/README-cmake.md index 2ce11d7a01d1d..905aea2a2a0d8 100644 --- a/docs/README-cmake.md +++ b/docs/README-cmake.md @@ -15,7 +15,7 @@ platforms: * Linux * VS.NET 2010 * MinGW and Msys -* OS X with support for XCode +* macOS, iOS, and tvOS, with support for XCode ================================================================================ @@ -30,3 +30,55 @@ Assuming the source for SDL is located at ~/sdl cmake ../sdl This will build the static and dynamic versions of SDL in the ~/build directory. + + +================================================================================ +Usage, iOS/tvOS +================================================================================ + +CMake 3.14+ natively includes support for iOS and tvOS. SDL binaries may be built +using Xcode or Make, possibly among other build-systems. + +When using a recent version of CMake (3.14+), it should be possible to: + +- build SDL for iOS, both static and dynamic +- build SDL test apps (as iOS/tvOS .app bundles) +- generate a working SDL_config.h for iOS (using SDL_config.h.cmake as a basis) + +To use, set the following CMake variables when running CMake's configuration stage: + +- `CMAKE_SYSTEM_NAME=` (either `iOS` or `tvOS`) +- `CMAKE_OSX_SYSROOT=` (examples: `iphoneos`, `iphonesimulator`, `iphoneos12.4`, `/full/path/to/iPhoneOS.sdk`, + `appletvos`, `appletvsimulator`, `appletvos12.4`, `/full/path/to/AppleTVOS.sdk`, etc.) +- `CMAKE_OSX_ARCHITECTURES=` (example: "arm64;armv7s;x86_64") + + +### Examples (for iOS/tvOS): + +- for iOS-Simulator, using the latest, installed SDK: + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64` + +- for iOS-Device, using the latest, installed SDK, 64-bit only + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES=arm64` + +- for iOS-Device, using the latest, installed SDK, mixed 32/64 bit + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos -DCMAKE_OSX_ARCHITECTURES="arm64;armv7s"` + +- for iOS-Device, using a specific SDK revision (iOS 12.4, in this example): + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphoneos12.4 -DCMAKE_OSX_ARCHITECTURES=arm64` + +- for iOS-Simulator, using the latest, installed SDK, and building SDL test apps (as .app bundles): + + `cmake ~/sdl -DSDL_TEST=1 -DCMAKE_SYSTEM_NAME=iOS -DCMAKE_OSX_SYSROOT=iphonesimulator -DCMAKE_OSX_ARCHITECTURES=x86_64` + +- for tvOS-Simulator, using the latest, installed SDK: + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvsimulator -DCMAKE_OSX_ARCHITECTURES=x86_64` + +- for tvOS-Device, using the latest, installed SDK: + + `cmake ~/sdl -DCMAKE_SYSTEM_NAME=tvOS -DCMAKE_OSX_SYSROOT=appletvos -DCMAKE_OSX_ARCHITECTURES=arm64`