Skip to content

Javascript bindings for Nvidia PhysX based on emscripten/WebIDL

License

Notifications You must be signed in to change notification settings

ammarhattab/physx-js-webidl

 
 

Repository files navigation

physx-js-webidl

Javascript/WASM bindings for Nvidia PhysX 5.1.3.

Looking for pre-built binaries / build instructions? See below

Getting started

There is a very basic hello world example: No fancy graphics, only console output but it should get you started.

Documentation

The API is very close to the original PhysX C++ API, so you can simply use the official PhysX API documentation

Demos

I also use this lib in my engine kool and have a few demos in place:

  • Vehicle: Basic vehicle demo with a few obstacles.
  • Character: 3rd person character demo on an island.
  • Ragdolls: A simple ragdoll demo.
  • Joints: A chain running over two gears.
  • Collision: The obligatory box (and other shapes) collision physics demo.

However, these are written in kotlin, not javascript.

Pre-built binaries

This library is published as a npm package:

npm i physx-js-webidl

Alternatively you can grab the pre-built binaries (.wasm + support .js) from the dist directory.

Building

In order to build the library you need a recent version of the emscripten SDK - I'm using version 3.1.25.

# Clone this repo
git clone https://github.com/fabmax/physx-js-webidl

# Enter that directory
cd physx-js-webidl

# Download submodule containing the PhysX code
git submodule update --init

# Generate build-scripts
./generate.sh

# Build
./make.sh

To add bindings to additional PhysX interfaces you only have to edit the PhysXJs.idl file located in PhysX/physx/source/webidlbindings/src/wasm/ and recompile the library.

Build with Docker

# Build the image
docker compose up

# Build Release
docker compose run --rm builder ./make.sh

# Build Profile
docker compose run --rm builder ./make-profile.sh

# Build Debug
docker compose run --rm builder ./make-debug.sh

Build Types

It is also possible to generate Typescript bindings out of the idl file (apparently broken on recent node version):

npx @milkshakeio/webidl2ts -e -d -n PhysX -i PhysX/physx/source/webidlbindings/src/wasm/PhysXWasm.idl -o dist/physx-js-webidl.wasm.d.ts

About

Javascript bindings for Nvidia PhysX based on emscripten/WebIDL

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 91.2%
  • Dockerfile 8.8%