You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Modules/@babylonjs/react-native/README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,11 @@ The minimum Android SDK version is 18. This must be set as `minSdkVersion` in th
16
16
17
17
### iOS Configuration
18
18
19
-
The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `podfile`.
20
-
Make sure `pod install` is called from ios folder after npm install.
19
+
The minimum deployment target version is 12. This must be set as `iOS Deployment Target` in the consuming project's `project.pbxproj`, and must also be set as `platform` in the consuming project's `Podfile`.
20
+
Make sure `pod install` is called from the ios folder after npm install.
21
21
22
22
#### Workspace
23
-
In your app workspace, add a reference to BabylonReactNative project by add these lines:
23
+
In your app workspace, add a reference to BabylonReactNative project by adding these lines:
@@ -29,36 +29,36 @@ In your app workspace, add a reference to BabylonReactNative project by add thes
29
29
to your app `xcworkspace/content.xcworkspacedata` file.
30
30
31
31
#### CMake
32
-
iOS NPM needs CMake 3.26+ to be present to generate Xcode project. If CMake is not in default path(or an older version that can't be upgraded) a local version can be set and used with this variable:
32
+
iOS NPM needs CMake 3.26+ to be present to generate Xcode project. If CMake is not in the default path(or an older version that can't be upgraded) a local version can be set and used with this variable:
To disable post install CMake generation, set this variable before runnong`npm install`:
38
+
To disable post install CMake generation, set this variable before running`npm install`:
39
39
```
40
40
export BABYLON_NO_CMAKE_POSTINSTALL=1
41
41
```
42
42
43
43
### Plugins selection
44
44
45
-
Plugins can be disabled at build time. They are all enabled by default and disabling is done with Environment variables:
45
+
Plugins can be disabled at build time. They are all enabled by default and disabling is done with environment variables:
46
46
47
47
To disable Camera plugin:
48
48
```
49
-
export BABYLON_NATIVE_PLUGIN_NATIVECAMERA = 0
49
+
export BABYLON_NATIVE_PLUGIN_NATIVECAMERA=0
50
50
```
51
51
52
52
For Native XR:
53
53
```
54
-
export BABYLON_NATIVE_PLUGIN_NATIVEXR = 0
54
+
export BABYLON_NATIVE_PLUGIN_NATIVEXR=0
55
55
```
56
56
57
57
### Platform Native Packages
58
58
59
59
Starting with BabylonReactNative NPM 2.0.0+, one single package is available for iOS, Android and Windows versus multiple packages before.
60
60
61
-
Babylon.js minimal version:
61
+
Babylon.js minimal version:
62
62
63
63
|BabylonReactNative version | Babylon.js version | BabylonNative commit |
64
64
| ----------- | ------------------------ | --- |
@@ -136,18 +136,18 @@ e.g.
136
136
137
137
Note: Currently only one `EngineView` can be active at any given time. Multi-view will be supported in a future release.
138
138
139
-
The Android specific `androidView` property can help set the type of the view used for rendering. Depending on user needs and performance, refer to the table below. [`TextureView`](https://developer.android.com/reference/android/view/TextureView) can be inserted anywhere in the view hierarchy, but is less efficient. [`SurfaceView`](https://developer.android.com/reference/android/view/SurfaceView) can only be full above or fully below the rest of the UI, but is more efficient.
139
+
The Android specific `androidView` property can help set the type of the view used for rendering. Depending on user needs and performance, refer to the table below. [`TextureView`](https://developer.android.com/reference/android/view/TextureView) can be inserted anywhere in the view hierarchy, but is less efficient. [`SurfaceView`](https://developer.android.com/reference/android/view/SurfaceView) can only be fully above or fully below the rest of the UI, but is more efficient.
| False | SurfaceView | Simple surfaceView (default when no `androidView` set with `isTransparent=false`).
144
+
| False | SurfaceView | Simple SurfaceView (default when no `androidView` set with `isTransparent=false`).
145
145
| False | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`.
146
146
| False | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`.
147
147
| True | TextureView | Transparent TextureView.
148
148
| True | SurfaceView | SurfaceView will stay opaque
149
-
| True | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`. Transparent but top most. (default when no `androidView` set with `isTransparent=true`)
150
-
| True | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`. Only Transparent on top of other SurfaceViews.
149
+
| True | SurfaceViewZTopMost | SurfaceView with [ZTopMost](https://developer.android.com/reference/android/view/SurfaceView#setZOrderOnTop(boolean)) set to `true`. Transparent but topmost. (default when no `androidView` set with `isTransparent=true`)
150
+
| True | SurfaceViewZMediaOverlay | SurfaceView with [ZMediaOverlay](https://developer.android.com/reference/android/view/SurfaceView#setZOrderMediaOverlay(boolean)) set to `true`. Only transparent on top of other SurfaceViews.
151
151
152
-
More infos on TextureView Vs SurfaceView performance here:
Copy file name to clipboardExpand all lines: README.md
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,13 +35,13 @@ Note: Official support for React Native frameworks, like Expo, is not provided b
35
35
36
36
## Contributing
37
37
38
-
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and MacOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below (unless otherwise noted).
38
+
This quick overview will help you get started developing in the Babylon React Native repository. We support development on Windows and macOS, but assume the use of [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell) in the instructions below (unless otherwise noted).
39
39
40
40
If you are interested in making contributions, be sure to also review [CONTRIBUTING.md](CONTRIBUTING.md).
41
41
42
42
## Using BabylonReactNative
43
43
44
-
Following section will describe how to build locally a package and how to develop BabylonReactNative. If your intend is to use the plugin, follow instructions in the NPM [BabylonReadNative readme](Modules/@babylonjs/react-native/README.md).
44
+
The following section will describe how to build locally a package and how to develop BabylonReactNative. If your intent is to use the plugin, follow instructions in the NPM [BabylonReactNative readme](Modules/@babylonjs/react-native/README.md).
45
45
46
46
### **Preparing a new Repo**
47
47
@@ -53,7 +53,7 @@ Step 1 for all development environments and targets is to clone the repo. Use a
- If the Metro server is not started with `npm run android`, you can start it manually by running `npm run start` in a terminal.
141
+
- If the Metro server is not started with `npm run android`, you can start it manually by running `npm run start` in a terminal.
142
142
- Android Studio is the tool of choice for downloading the various versions of NDK.
143
143
- If something goes wrong with the build `npm run android --verbose` can give some hints.
144
144
- If the emulator is not launched by the build, you can run `~/Android/Sdk/emulator/emulator @name_of_your_image`.
@@ -175,9 +175,9 @@ When making local changes, the following manual test steps should be performed w
175
175
176
176
### **Building the NPM Package**
177
177
178
-
Every change for a Pull Request will trigger the build of the NPM package. The artifact is named `BabylonReactNative` and can be found in the Artifact section of the Corresponding GitHub Action.
178
+
Every change for a Pull Request will trigger the build of the NPM package. The artifact is named `BabylonReactNative` and can be found in the Artifact section of the corresponding GitHub Action.
179
179
180
-
> :warning: The zip contains a Tarball GZipped`.tgz` that is automatically decompressed on MacOS. When installing that directory ( `npm install /path/to/unzipped/untared/package` ) npm creates symlinks that are not supported by the build system. Installing the .tgz instead of its decompressed version works correctly.
180
+
> :warning: The zip contains a Tarball Gzipped`.tgz` that is automatically decompressed on macOS. When installing that directory ( `npm install /path/to/unzipped/untarred/package` ) npm creates symlinks that are not supported by the build system. Installing the .tgz instead of its decompressed version works correctly.
181
181
182
182
To get a `.tgz` that can be shared or published, follow these steps:
Package versions are listed on this npm.js page: [@babylonjs/react-native](https://www.npmjs.com/package/@babylonjs/react-native). Check supported Babylon.js version and corresponding BabylonNative dependency in package [README](Modules/@babylonjs/react-native/README.md)
210
+
Package versions are listed on this npm.js page: [@babylonjs/react-native](https://www.npmjs.com/package/@babylonjs/react-native). Check supported Babylon.js version and corresponding BabylonNative dependency in package [README](Modules/@babylonjs/react-native/README.md)
211
211
212
212
## Security
213
213
214
-
If you believe you have found a security vulnerability in this repository, please see [SECURITY.md](SECURITY.md).
215
-
214
+
If you believe you have found a security vulnerability in this repository, please see [SECURITY.md](SECURITY.md).
0 commit comments