libliquidfun-sys

Crates.iolibliquidfun-sys
lib.rslibliquidfun-sys
version0.4.0
sourcesrc
created_at2023-10-27 20:11:07.917818
updated_at2024-08-14 19:50:52.93054
descriptionA thin Rust ffi wrapper on top of Box2D and LiquidFun. Built using autocxx.
homepagehttps://github.com/mmatvein/libliquidfun-sys
repositoryhttps://github.com/mmatvein/libliquidfun-sys
max_upload_size
id1016414
size5,546,035
Mikael Matveinen (mmatvein)

documentation

README

🚨WARNING: WORK IN PROGRESS🚨

This crate is a work in progress and version changes may introduce breaking changes without warning.

libliquidfun-sys

A thin Rust ffi wrapper on top of Box2D (version 2.4.1) and LiquidFun. Built using autocxx.

This crate is used by bevy_liquidfun to integrate Box2D and LiquidFun with the bevy game engine.

Remarks

  • A forked version of Box2D included as git subtree under ./box2d/
  • Additions to the automatically generated wrappers are under ./include/extras.hpp
  • The autocxx generated wrappers for all the joint definitions have some misalignment, possibly caused by the inheritance hierarchy. This is worked around by having factory methods for joint creation with all the parameters.

Acknowledgements

This small wrapper stands on the shoulders of giants. Big thanks go to the original libraries, which do the heavy lifting:

Box2D by Erin Catto

LiquidFun by Google

autocxx by Google

Additionally, the version of Box2D used is a fork of Box2D:

LiquidFun rebase onto newer Box2D by Birch-san

License

This work is licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 21

cargo fmt