Skip to content

API Reference

This page documents the public API of the library. It is generated from the source code comments and is intended for developers who want to use the library in their own projects.

The python version of this library has the same API as the C++ version, but with some differences in naming conventions and data types. The python API is generated using pybind11, which allows us to expose the C++ classes and functions to python in a natural way.

Naming convention: - C++ uses camelCase (for example: getType()). - Python uses snake_case (for example: get_type()).

Doxygen C++ API

The full generated C++ API reference is published here:

This section is generated from source comments at deploy time and is not stored in the repository.