Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 2.28 KB

README.md

File metadata and controls

39 lines (26 loc) · 2.28 KB
Raw

sfcgal-sys

Build Crates.io Documentation

Rust low-level FFI bindings to SFCGAL 2.0.x C API.
Don't use this crate directly, prefer it's higher-level wrapper : sfcgal-rs.

Important

Note that the required version of SFCGAL is currently 2.0.x (latest version - 2024-10-10).
If you want to use SFCCAL 1.5.x, you can use the 0.7.x version of this crate / of sfcgal-rs.

Internals

This crate contains a few lines of C code (compiled as a static library with cc crate) wrapping SFCGAL C API in order to replace the error and warning handlers (which use printf by default).
It expects SFCGAL to be installed as a system library and that you have the header file for it's C API. Then bindgen is run to generate these low-levels bindings.

In addition to all the sfcgal_ types and functions, this crate expose :

  • a Rust initialize function: it calls sfcgal_init() function then it calls a custom w_sfcgal_init_handlers() function which replace the error and warning handlers from printf to a char buffer. That initialize function internally uses std::sync::Once to ensure it's only called once.
  • two C functions w_sfcgal_get_last_error and w_sfcgal_get_last_warning which respectively reads the buffer containing the error message and the buffer containing the warning message.

In the future it could probably be improved by not requiring SFCGAL to be installed as a system library.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.