https://github.com/libgdx/gdx-box2d
https://github.com/libgdx/gdx-box2d
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/libgdx/gdx-box2d
- Owner: libgdx
- License: apache-2.0
- Created: 2024-12-27T10:02:53.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-28T15:15:06.000Z (about 1 year ago)
- Last Synced: 2025-04-28T16:24:17.462Z (about 1 year ago)
- Language: Java
- Size: 555 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## gdx-box2d
This project contains java bindings for the v3.1.0 release of [Box2D](https://github.com/erincatto/box2d).
The project is build from commit [0f2b0246f39594e93fcc8dde0fe0bb1b20b403f9](https://github.com/erincatto/box2d/tree/0f2b0246f39594e93fcc8dde0fe0bb1b20b403f9).
## Installation
The current version is: `3.1.0-0`
gdx-box2d provides the following artifacts:
- `com.badlogicgames.gdx:gdx-box2d:$version`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-desktop`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-ios`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-arm64-v8a`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-armeabi-v7a`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-x86`
- `com.badlogicgames.gdx:gdx-box2d-platform:$version:natives-x86_64`
Additionally, the following utility artifact is provided:
- `com.badlogicgames.gdx:gdx-box2d-utils:$version`
## Usage
At first, you need to call `com.badlogic.gdx.box2d.Box2d#initialize`. This will load the shared libraries and set up the native code.
After that, `com.badlogic.gdx.box2d.Box2d` provides all entry points into Box2D.
### Closure
Closures can be allocated with `ClosureObject#fromClosure`.
### Memory handling
Structs and Pointer are part of the java GC cycle. If a struct/pointer gets allocated in java, it will be freed once the GC collects the java object.
All pointer types provide constructors to make them not freed by GC. You need to free those manually.
Closures always need to be freed manually.
If a box2d method returns a pointer, it will not be registered for GC.
> [!NOTE]
> For more information on the bindings see the [documentation](https://github.com/libgdx/gdx-jnigen/blob/master/RUNTIME.MD#the-runtime).
## Java 8
The project needs java 8 language features to build. However, it doesn't use any java 8 APIs and is therefor still safe to use with mobiVM.
## Deviation from box2d
The following changes have been applied that are more than sole bindings:
- On initialization a custom routine for assertion handling gets installed. This will throw the assertion as an `Box2DAssertionError`.
The behaviour can be overwritten with `b2SetAssertFcn`, see the box2d docs for more infos.
## Supported OS
Windows:
- i686
- x86_64
MacOS:
- x86_64
- arm64
Linux:
- arm
- arm64
- x86_64
- riscv64
iOS:
- arm64 iphoneos
- arm64 iphonesimulator
- x86_64 iphonesimulator
Android:
- arm64-v8a
- armeabi-v7a
- x86
- x86_64