Developers Reference #

Using OpenGJK is so easy that most of the intended users can just look at the header of the library to understand how to interface with it, however I created this page because, perhaps, someone may find this document easier to read. I also did it for myself to explore automated documentation: the in-source comments are automatically turned into a pretty website by means of Gitlab pipeline.

API #

Search or navitage the structs and functions from this the menu on the left. While the interface is trivial, you may find interesting information about the GJK algorithm itself and how to fine-tune it to your needs.

Style Guideline #

Read the existing code and try to imitate its style - even if it is not your favourite. Other than this requirement, you can aim to:

• Keep lines short,
• Keep names short,
• Add empty lines between code blocks are good,
• Follow C99 convention and these guidelines.

Updated on 2024-03-30