README.md 7.1 KB

Boost Generic Image Library (GIL)

Language License Documentation Wiki Mailing List Gitter Try it online Conan Vcpkg

Documentation AppVeyor Azure Pipelines Travis CI CircleCI Regression
develop AppVeyor Azure Travis CircleCI gil
master AppVeyor Azure Travis CircleCI gil
C++/compilers: 11, 14, 17 11, 14, 17 11 11
msvc++ VS2015, VS2017 VS2015, VS2017
clang++ Xcode 9.4.1 3.9, 5.0, Xcode 9.4.1 3.9, 4.0, 5.0
g++ 5.4, 8.1 5.5, 6.5, 7.4 4.9, 5.1-5, 6.1-4, 7.1-3, 8.2-3
tests coverage:
core + concepts Y Y Y Y
headers core + ext core + ext core + ext core + ext
ext/dynamic_image
ext/io simple simple simple
ext/numeric Y Y Y Y
ext/toolbox Y Y Y Y
build config: Boost.Build, CMake CMake Boost.Build, UBSan Boost.Build

Boost.GIL

Introduction

Boost.GIL is a part of the Boost C++ Libraries.

The Boost Generic Image Library (GIL) is a C++ library that abstracts image representations from algorithms and allows writing code that can work on a variety of images with performance similar to hand-writing for a specific image type.

Documentation

See RELEASES.md for release notes.

See CONTRIBUTING.md for instructions about how to build and run tests, examples.

See example/README.md for available GIL examples.

Requirements

NOTE: The library source code is currently being modernized for C++11.

The Boost Generic Image Library (GIL) requires:

  • C++11 compiler (GCC 4.9, clang 3.3, MSVC++ 14.0 (1900) or any later version)
  • Boost header-only libraries

Optionally, in order to build and run tests and examples:

  • Boost.Filesystem
  • Boost.Test
  • Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension

Branches

The official repository contains the following branches:

  • master This holds the most recent snapshot with code that is known to be stable.

  • develop This holds the most recent snapshot. It may contain unstable code.

Community

There is number of communication channels to ask questions and discuss Boost.GIL issues:

Contributing (We Need Your Help!)

If you would like to contribute to Boost.GIL, help us improve the library and maintain high quality, there is number of ways to do it.

If you would like to test the library, contribute new feature or a bug fix, see the CONTRIBUTING.md where the whole development infrastructure and the contributing workflow is explained in details.

You may consider performing code reviews on active pull requests or help with solving reported issues, especially those labelled with:

Any feedback from users and developers, even simple questions about how things work or why they were done a certain way, carries value and can be used to improve the library.

License

Distributed under the Boost Software License, Version 1.0.