Skip to content

chore(📖): update README with Three.js and polyfill instructions #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wcandillon merged 1 commit into from
Sep 18, 2025
Merged

chore(📖): update README with Three.js and polyfill instructions #260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,18 @@ Below are some examples from the [example app](/apps/example/).

https://github.com/user-attachments/assets/116a41b2-2cf8-49f1-9f16-a5c83637c198

## Three.js

Starting from `r168`, Three.js runs out of the box with React Native WebGPU.
You need to have a slight modification of [the metro config](/apps/example/metro.config.js) to resolve Three.js to the WebGPU build.
We also support [three-fiber](/apps/example/src/ThreeJS/Fiber.tsx).
For model loading, we also need [the following polyfill](/apps/example/src/App.tsx#29).
For model loading, we also need the following polyfill:

```tsx
// The two lines below are needed by three.js
import "fast-text-encoding";
window.parent = window;
```

https://github.com/user-attachments/assets/5b49ef63-0a3c-4679-aeb5-e4b4dddfcc1d

Expand Down Expand Up @@ -190,7 +198,7 @@ device.queue.copyExternalImageToTexture(
### iOS

To run the React Native WebGPU project on the iOS simulator, you need to disable the Metal validation API.
In "Edit Scheme," uncheck "Metal Validation."
In "Edit Scheme," uncheck "Metal Validation.". Learn more [here](https://developer.apple.com/documentation/xcode/validating-your-apps-metal-api-usage/).

Copilot AI Sep 18, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's an extra period after 'Metal Validation.' - it should be either 'Metal Validation.' or 'Metal Validation'. Learn more...' but not both punctuation marks together.

Suggested change
In "Edit Scheme," uncheck "Metal Validation.". Learn more [here](https://developer.apple.com/documentation/xcode/validating-your-apps-metal-api-usage/).
In "Edit Scheme," uncheck "Metal Validation". Learn more [here](https://developer.apple.com/documentation/xcode/validating-your-apps-metal-api-usage/).

Copilot uses AI. Check for mistakes.

<img width="1052" alt="Uncheck 'Metal Validation'" src="https://github.com/user-attachments/assets/2676e5cc-e351-4a97-bdc8-22cbd7df2ef2">

Expand Down
Loading