librgr: librgr API documentation

This manual documents the librgr programming interface.

The main goal of librgr is to make easy and high performance access to rgr data files accessible to 3rd party applications.

Grid data access modes

Load grid data to RAM
The complete grid data file is loaded to the systems main memory.

Surface patch cache evaluation
librgr tracks the active surface area where the grid is evaluated by the calling application and keeps only patches of the grid data in the system memory. Patches are fetched and unloaded automatically. The memory foorprint is independent from the actual grid data file size.

Memory mapped access
Grid data is not loaded to system RAM at all but mapped to the systems virtual memory space. This allows the use of virtually unlimited grid data file size without limitations to the installed system main memory.

Active surface tracking

librgr is tracking the surface evaluations and provides coordinates of bounding boxes enclosing the tire positions with a gives clearance. This allows the calling application e.g. to limit surface visualisation only to the actual active surface. Surface tracking is closely related to the surface patch evaluation mode, but can be used for tracking the bounding box coordinates without assigning a grid data file.

Legal notice

librgr is provided under the terms of the GNU Library General Public License (LGPL).

Visit the FTire homepage.

Notes and suggestions are highly appreciated.