Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.48 KB

README.md

File metadata and controls

62 lines (45 loc) · 2.48 KB
Raw

Filament sample iOS app

This directory contains a sample app that demonstrates how to use the Filament API in an iOS application.

Prequisites

iOS support for Filament is experimental. Currently, both the OpenGL ES 3.0 and Vulkan (via MoltenVK) backends are supported. The iOS simulator is supported, but because the simulator has no support for Metal, running Filament on the simulator is limited to the OpenGL ES backend.

Before attempting to build for iOS, read Filament's README. You must first cross-compile Filament for ARM64 on a macOS host before running the sample. The easiest way to do this is by running the following command at the root of Filament's source tree:

$ ./build.sh -p ios debug

This will automatically download Apple's iOS toolchain file for CMake and build Filament for iOS.

Afterwards, you should find all the Filament libraries inside of out/ios-debug/filament/lib/arm64:

libbluevk.a
libfilabridge.a
libfilaflat.a
libfilament.a
libutils.a

The sample application expects the libraries to be present here. Likewise, when building the sample in Release mode, the linker looks for the libraries in out/ios-release/filament/lib/arm64. To build Filament in Release mode, replace debug with release in the above build.sh command.

If using the Vulkan backend, the pre-compiled libMoltenVK.dylib library must be present in third_party/moltenvk/ios. When building, the Xcode project automatically signs and includes this library inside the application bundle.

If you also want to be able to run on the iOS simulator, add the -s flag to the build.sh command. For example, the following command will build for both devices (ARM64) and the simulator (x86_64) in Debug mode:

$ ./build.sh -s -p ios debug

When building for the simulator, the sample will then link against the libraries present in `out/ios-debug/filament/lib/x86_64'.

Xcode

Open up the Xcode project at ios/samples/hello-triangle/hello-triangle.xcodeproj. The hello-triangle project contains two schemes, hello-triangle-VK and hello-triangle-OpenGL, which use the Vulkan and OpenGL backends respectively. Before building you will need to select one of the schemes, sign in to your Apple developer account, and select an appropriate development team in the project editor.

Building

At this point you should be able to hit the "Run" icon to run the sample on your device. Alternatively, if you have also built Filament for the simulator, select an iPhone simulator.