fmod-sys

Crates.iofmod-sys
lib.rsfmod-sys
version0.1.1
sourcesrc
created_at2020-04-04 14:05:13.286362
updated_at2020-04-04 14:21:22.754458
descriptionBindgen wrappers around the FMOD Core and Studio libraries
homepage
repositoryhttps://github.com/khonsulabs/fmod-sys
max_upload_size
id226267
size22,156,073
(jestarray)

documentation

README

fmod-sys

Bindgen generated wrappers for FMOD

This library is aiming to be an idiomatic "-sys" version of wrappers for FMOD.

The library itself is licensed using the MIT license, but the fmodapi folder contains headers from the FMOD API download, and those files are licensed under the FMOD License.

Usage

While I'm still getting this testing, you can use the git feature of Cargo.toml dependencies to use this crate:

[dependencies]
fmod-sys = { git = "https://github.com/khonsulabs/fmod-sys.git" }

You will need to put the fmod libraries in an appropriate location for linking to succeed.

Enabling Studio APIs

By default, the core library and its API is all that is exported. If you want to enable the FMOD Studio API, enable the studio feature:

[dependencies]
fmod-sys = { git = "https://github.com/khonsulabs/fmod-sys.git", features = ["studio"] }

Building

To update the headers, just copy them into the fmodapi folder, make sure the LICENSE.TXT doesn't need to be updated, and then the build.rs script should automatically generate the new bindings.

Mac OS Notes

When attempting to run an application linking against libfmod.dylib without signing it, you will be prompted for a security warning. Find the file in the Finder, right click on it and choose Open. It makes no sense to do this, but it will prompt you just like it would an unsigned application -- Click open and it will launch the Terminal app and do nothing.

However, once you've done this step, you can run the application until you replace the library wth a new version.

Warning

I don't know what I'm doing meme

This is my first bindgen crate. I have experience using other bindgen wrappers like the gl crate, but this is my first attempt at bundling a crate for others. Please don't hesitate to leave constructive feedback as issues or submit your own pull requests!

Other notes

I plan on writing a rusty-wrapper for FMOD Studio. More details to come.

Commit count: 10

cargo fmt