Integrate Babylon native in existing Swift project

ioridev · April 14, 2024, 7:47am

Is the git submodule gone?

Edit:
Oh, I found this PR a day later.

I may need to know about UNITY_BUILD

ioridev · April 14, 2024, 8:13am

I was able to manually place IOS-cmake in the project and proceed, but cmake --build . but I can’t run it because of openXR_loader.


GatherProvisioningInputs

CreateBuildDescription

Build description signature: 86ced6bfdd018ec74a18a3130f4fdbdf

Build description path: /Users/iori/src/BabylonNative/build/build/XCBuildData/86ced6bfdd018ec74a18a3130f4fdbdf.xcbuilddata

note: Run script build phase 'CMake PostBuild Rules' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'Playground' from project 'BabylonNative')

note: Run script build phase 'CMake PostBuild Rules' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'UnitTests' from project 'BabylonNative')

note: Run script build phase 'Generate CMakeFiles/ALL_BUILD' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'ALL_BUILD' from project 'BabylonNative')

note: Run script build phase 'Generate CMakeFiles/ZERO_CHECK' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'ZERO_CHECK' from project 'BabylonNative')

/Users/iori/src/BabylonNative/build/BabylonNative.xcodeproj: error: Signing for "openxr_loader" requires a development team. Select a development team in the Signing & Capabilities editor. (in target 'openxr_loader' from project 'BabylonNative')

note: Run script build phase 'CMake PostBuild Rules' will be run during every build because the option to run the script phase "Based on dependency analysis" is unchecked. (in target 'openxr_loader' from project 'BabylonNative')

BUILD FAILED

This is just my personal opinion, and you can ignore it, but I think there are many use cases for integrating BabylonNative into existing Swift projects, and there should be documentation for that.

Alternatively, please revive PR293.

github.com/BabylonJS/BabylonNative

Integration + iOS.Framework

BabylonJS:master ← CedricGuillemet:iosFramework

opened 09:20AM - 12 Jun 20 UTC

CedricGuillemet

+184 -0

This is part 2 of ios packaging. Part 1 is here https://github.com/BabylonJS/Bab…ylonNative/pull/291 The goal of this PR is to add a new target that builds a Framework usable for Xcode directly (drag and drop .framework in the source tree) or with a cocoapod. The artifact contains this: ![image](https://user-images.githubusercontent.com/1312968/84491209-78d41380-aca4-11ea-85c8-9f8a34e27c2c.png) - Headers from the Include directories of plugins, core, polyfills, and napi - .js resources - a big BabylonNative static library that is the concatenation of all .a (plugins, dependencies, ...) Xcode automaticaly recognise the format of this archive so end user doesn't have to set path for includes, name of lib,... When building the framework, napi.h is replaced with a special napi.h with relative to framework path. See Part1. The archive is published as a build artifact. Part3 will be cocoapods and binary feed. It's not possible to use this framework before the Part1 is merged. Once you have downloaded/installed the framework in the Xcode project, just add some includes. ![image](https://user-images.githubusercontent.com/1312968/84492031-cd2bc300-aca5-11ea-98a8-1ff586de5f24.png) Some words on cocoapods, I'll elaborate more in the next PR. A pod, basically, needs to files : a podspec and a pod. The podspec specifies what the pod is composed of. It's used for publishing, and consuming the pod. a pod file contains the list and path to podspec that will be integrated in a named project. BabylonNative.podspec: ``` Pod::Spec.new do |s| s.name = 'BabylonNative' s.version = '0.0.4' s.summary = 'Babylon Native.' s.homepage = 'https://github.com/CedricGuillemet' s.author = { 'ceguille' => 'ceguille@microsoft.com' } s.license = { :type => 'MIT' } s.platform = :ios s.source = { :http => 'file:///Users/cedricguillemet/dev/podtest/BabylonNative/buildios/Integration/Debug-iphonesimulator/BabylonNative.framework.zip'} s.resource = '**/*.js' s.ios.deployment_target = '12.0' s.ios.vendored_frameworks = 'BabylonNative.framework' end ``` Two most important things here: the s.source and s.resource. s.resource is needed so xcode can merge the resource in the app bundle. s.source here points to a local directory that I'm using for my tests. This path can points to a GitHub release (so we need to update it when we do a GitHub). My task now is to see if it can point to a CI Feed: when merging into master, a build is triggered and it's the artifact from that master version that I'd like to put in the feed. User would have to do a 'pod update' to update to the latest good version of BabylonNative. It also possible to point to the GitHub and trigger a local build when installing pod. This file will be at the root of the repo. End user will only have to update its own pod file like this: ``` target 'name_of_app' do pod 'BabylonNative', :git => "https://github.com/BabylonJS/BabylonNative.git" end ``` Once the pod is installed, load the workspace that cocoapods has generated. For reactnative integration, it's possible to write its own podspec that will not use the resources from the framework (and use npm instead for Babylonjs). It's possible to release the framework as an npm package. You then need a podspec to points to that framework (s.source = ".... /node_modules/BabylonNative/). You pod would point to your local podspec. user would do : ``` npm install pod install ```

Cedric · April 15, 2024, 7:36am

It’s possible to use BN in a swift project.
Take a look at iOS playground : BabylonNative/Apps/Playground/iOS at master · BabylonJS/BabylonNative · GitHub
The documentation from the readme should be up to date and, as a reference, here are the build steps for iOS:

github.com

BabylonJS/BabylonNative/blob/master/.github/jobs/ios.yml

parameters:
  name: ''
  vmImage: ''
  xCodeVersion: ''
  macOSCodename: ''
  deploymentTarget: '12'

jobs:
  - job: ${{ parameters.name }}
    timeoutInMinutes: 30
    pool:
      vmImage: ${{ parameters.vmImage }}
  
    steps:
    - template: cmake.yml
      parameters:
        vmImage: ${{ parameters.vmImage }}

    - script: |
        sudo xcode-select --switch /Applications/Xcode_${{ parameters.xCodeVersion }}.app/Contents/Developer

This file has been truncated. show original

ioridev · April 15, 2024, 11:19am

Thank you very much! Now that the build is done I can proceed with my development.

mkdir buildiOS
cd buildiOS
cmake … -G Xcode -D IOS=ON -D DEPLOYMENT_TARGET=17.0 -D CMAKE_UNITY_BUILD=ON

ioridev · April 16, 2024, 11:21am

I’m doing something wrong, but I don’t know what I’m missing

Cedric · April 16, 2024, 12:08pm

unity build is optional and more meant to be used on CI and I would use ios 15 or 16 instead because of compatibility issues with 17.

So, try this:

cmake .. -G Xcode -D IOS=ON -D DEPLOYMENT_TARGET=15

ioridev · April 16, 2024, 2:15pm

I re-read this post and added NODE_ADDON_API_ and it solved the problem. However, I still get an error and am not able to build.
It’s a pretty complicated build system, so I’m going to read Configure XCode manually carefully and try to unravel it a little bit at a time. Thanks again.

julapy · July 8, 2024, 12:01pm

Hi, ive successfully built BabylonNative into a XCode project on iOS, following instruction HERE

cmake -B build/iOS -G Xcode -D IOS=ON

im now trying to copy binaries and headers to a install folder

cmake --install . --prefix="./install"

although receiving the following error:

any advice would be appreciated, thanks.

Babylon Native (v7.12.0)
master branch - d0c97077d07da3a4f07d92473155db11c2e5a6c3

Cedric · July 8, 2024, 12:29pm

I’m taking a look!

EDIT: I can repro. I’m working on a fix…

Cedric · July 9, 2024, 3:01pm

Can you check this fix works on your side

github.com/BabylonJS/BabylonNative

Test installation iOS/Linux/MacOS

BabylonJS:master ← CedricGuillemet:InstallationTests

opened 02:14PM - 08 Jul 24 UTC

CedricGuillemet

+37 -11

- Building PG as Release because installation needs bgfx .a files to be found in… release folder. Building the `Install` target leads to some issue I could not get over, even with more recent CMake ( https://gitlab.kitware.com/cmake/cmake/-/issues/21282 ) - `if (TARGET ...` in cmake script test if the target exists. But if the target exists but is not used, it will not be built. This is the case for NativeTracing, disabling its build for iOS otherwise its .a is not found at installation. Why is it not an issue for other build/installs? - disable gtest fetching for ios - disable openXR not other than win32 platforms - `UNIX` is true in cmake scripts for Apple platforms, update checks accordingly

Installation expects a Release build to be available.

julapy · July 10, 2024, 12:40pm

Hi @Cedric, that seems to have worked!
Tomorrow I’ll try including these files in a project with fresh eyes.

Just a note for the next person doing this:
cmake --install build/iOS --prefix="./install" failed and expected an absolute path.
cmake --install build/iOS --prefix="/Users/absolutepath/BabylonNative/build/iOS/install" worked.

Q1
i was expecting to see more folders for all the other libraries in the include folder.
just want to confirm the screen grab below is correct?

Q2
how to go about building Debug binaries?

many thanks!

Cedric · July 10, 2024, 12:48pm

yes, for iOS, prefix needs to be absolute path. I need to put that somewhere in the documentation.
It looks good to me for the include folder. I can see the same files for the win32 install.
Debug symbols should still be present in static libs because there is no task in the toolchain to strip them. You can check using nm tool.

julapy · July 12, 2024, 5:54am

ok its working!
ive added the files and configured my existing XCode project and have the experience.js examples working. amazing, thanks @Cedric for your help.

one issue i ran into was the cmake --install process did not build libxr.a
for now, ive copied this file directly from the BabylonNative XCode project.
it would be good if install/lib/libxr.a was also provided so others don’t get tripped up by this.

another issues which was specific to my project but others might experience,
in Build Settings, C++ Language Dialect had to be changed to C++17 since the default setting for my project was using C++11

Cedric · July 12, 2024, 8:32am

Good catch for libxr! I’ve updated Test installation iOS/Linux/MacOS by CedricGuillemet · Pull Request #1401 · BabylonJS/BabylonNative · GitHub
Yes, c++17 is now old enough to consider it the minimum version of c++ language.

Topic		Replies	Views
Integration of Babylon native in exisiting Application Questions babylon-native , ios	17	124	October 3, 2024
Babylon Native Swift project Bugs	3	41	April 8, 2025
Native iOS implementation Questions	17	967	December 20, 2022
BabylonReactNative: building for iOS simulator Bugs	6	781	June 9, 2023
BabylonReactNative in new react native project that's not the playground Questions	4	1045	May 20, 2021

Integrate Babylon native in existing Swift project

Related topics