Img2Num C++
API Documentation
Img2Num Core Library

Introduction

This is the heart of Img2Num. All implementations start here and are built upwards using this framework of functions and libraries. C++ developers include this library directly, C developers include a lightweight wrapper around it, and JavaScript developers import a safe wrapper that protects them from manual memory management.

The main raster image vectorization functions are located in this part of the library—FFTs, contour tracing, blurring, and much more.

Key Features

All public functions are exported from img2num.h:

  • Image processing algorithms (FFT, Contour Tracing, etc.)
  • Memory management utilities
  • Cross-platform compatibility

Building Img2Num

To build the project, follow these instructions:

cmake -B build
cmake --build build

Installation

To install the library, use the following commands:

cmake --install build

The library and headers will be installed as follows:

  • Libraries are installed to /usr/local/lib
  • Headers are installed to /usr/local/include

To link to the library in your CMake project, use:

find_package(Img2Num REQUIRED)
target_link_libraries(your_app PRIVATE Img2Num)

Usage Example

For complete working examples, see the example-apps/ directory.

API Reference

Browse the detailed function documentation:

  • Image Processing Algorithms
  • Memory Management Functions