Quick Start
Contributors: This Release
| Documentation | GitHub Actions | AppVeyor | Regression | Codecov |
|---|---|---|---|---|
 |
 |
 |
 |
|
 |
 |
 |
 |
Boost.GIL
Introduction
Boost.GIL is a part of the Boost C++ Libraries.
The Boost Generic Image Library (GIL) is a C++14 header-only 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
- Latest release
- Branch master (latest release with minor changes)
- Branch develop
See RELEASES.md for release notes.
See CONTRIBUTING.md for instructions about how to build and run tests and examples using Boost.Build or CMake.
See example/README.md for GIL usage examples.
See example/b2/README.md for Boost.Build configuration examples.
See example/cmake/README.md for CMake configuration examples.
Requirements
The Boost Generic Image Library (GIL) requires:
- C++14 compiler (GCC 6, clang 3.9, MSVC++ 14.1 (1910) 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 and some of examples.
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:
- GitHub Discussions
- Mailing lists (Boost discussion policy)
- boost-gil (recommended) official Boost.GIL mailing list (archive)
- boost-users for all Boost users
- boost for all Boost developers
- Slack at cpplang.slack.com with Boost channels:
- #boost-gil (recommended) official Boost.GIL channel
- #boost-user for all Boost users
- #boost for all Boost developers
- Gitter room boostorg/gil (old real-time chat space)
- You can also ask questions via GitHub issue.
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.
All Contributors
<p><img src="https://raw.githubusercontent.com/boostorg/gil/develop/doc/_static/gil.png" alt="Boost Generic Image Library (GIL)" /></p> <p><a href="https://en.wikipedia.org/wiki/C%2B%2B#Standardization"><img src="https://img.shields.io/badge/C%2B%2B-14-blue.svg" alt="Language" /></a> <a href="https://opensource.org/licenses/BSL-1.0"><img src="https://img.shields.io/badge/license-BSL-blue.svg" alt="License" /></a> <a href="http://boostorg.github.com/gil/"><img src="https://img.shields.io/badge/gil-documentation-blue.svg" alt="Documentation" /></a> <a href="https://github.com/boostorg/gil/wiki"><img src="https://img.shields.io/badge/gil-wiki-blue.svg" alt="Wiki" /></a> <a href="https://lists.boost.org/mailman/listinfo.cgi/boost-gil"><img src="https://img.shields.io/badge/gil-mailing%20list-4eb899.svg" alt="Mailing List" /></a> <a href="https://gitter.im/boostorg/gil"><img src="https://img.shields.io/badge/gil-chat%20on%20gitter-4eb899.svg" alt="Gitter" /></a> <a href="https://wandbox.org/permlink/isNgnMuqWcqTqzy7"><img src="https://img.shields.io/badge/on-wandbox-blue.svg" alt="Try it online" /></a> <a href="https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters"><img src="https://img.shields.io/badge/on-conan-blue.svg" alt="Conan" /></a> <a href="https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil"><img src="https://img.shields.io/badge/on-vcpkg-blue.svg" alt="Vcpkg" /></a></p> <table> <thead> <tr> <th align="left">Documentation</th> <th align="left">GitHub Actions</th> <th align="left">AppVeyor</th> <th align="left">Regression</th> <th align="left">Codecov</th> </tr> </thead> <tbody> <tr> <td align="left"><a href="https://boostorg.github.io/gil/develop/"><img src="https://img.shields.io/badge/doc-develop-blue.svg" alt="develop" /></a></td> <td align="left"><a href="https://github.com/boostorg/gil/actions?query=branch:develop"><img src="https://github.com/boostorg/gil/workflows/CI/badge.svg?branch=develop" alt="GitHub Actions" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h/branch/develop?svg=true" alt="AppVeyor" /></a></td> <td align="left"><a href="https://regression.boost.io/develop/developer/gil.html"><img src="https://img.shields.io/badge/gil-develop-blue.svg" alt="gil" /></a></td> <td align="left"><a href="https://app.codecov.io/gh/boostorg/gil/branch/develop"><img src="https://codecov.io/gh/boostorg/gil/branch/develop/graphs/badge.svg" alt="codecov" /></a></td> </tr> <tr> <td align="left"><a href="https://boostorg.github.io/gil/"><img src="https://img.shields.io/badge/doc-master-blue.svg" alt="master" /></a></td> <td align="left"><a href="https://github.com/boostorg/gil/actions?query=branch:master"><img src="https://github.com/boostorg/gil/workflows/CI/badge.svg?branch=master" alt="GitHub Actions" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/stefanseefeld/gil/branch/master"><img src="https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h?svg=true" alt="AppVeyor" /></a></td> <td align="left"><a href="https://regression.boost.io/master/developer/gil.html"><img src="https://img.shields.io/badge/gil-master-blue.svg" alt="gil" /></a></td> <td align="left"><a href="https://app.codecov.io/gh/boostorg/gil/branch/master"><img src="https://codecov.io/gh/boostorg/gil/branch/master/graphs/badge.svg" alt="codecov" /></a></td> </tr> </tbody> </table> <h1>Boost.GIL</h1> <ul> <li><a href="#introduction">Introduction</a></li> <li><a href="#documentation">Documentation</a></li> <li><a href="#requirements">Requirements</a></li> <li><a href="#branches">Branches</a></li> <li><a href="#community">Community</a></li> <li><a href="#contributing-we-need-your-help">Contributing</a></li> <li><a href="#license">License</a></li> </ul> <h2>Introduction</h2> <p>Boost.GIL is a part of the <a href="http://github.com/boostorg">Boost C++ Libraries</a>.</p> <p>The Boost Generic Image Library (GIL) is a <strong>C++14</strong> header-only 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.</p> <h2>Documentation</h2> <ul> <li><a href="https://boost.org/libs/gil">Latest release</a></li> <li><a href="http://boostorg.github.io/gil/">Branch master</a> (latest release with minor changes)</li> <li><a href="http://boostorg.github.io/gil/develop/">Branch develop</a></li> </ul> <p>See <a href="RELEASES.md">RELEASES.md</a> for release notes.</p> <p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> for instructions about how to build and run tests and examples using Boost.Build or CMake.</p> <p>See <a href="example/README.md">example/README.md</a> for GIL usage examples.</p> <p>See <a href="example/b2/README.md">example/b2/README.md</a> for Boost.Build configuration examples.</p> <p>See <a href="example/cmake/README.md">example/cmake/README.md</a> for CMake configuration examples.</p> <h2>Requirements</h2> <p>The Boost Generic Image Library (GIL) requires:</p> <ul> <li>C++14 compiler (GCC 6, clang 3.9, MSVC++ 14.1 (1910) or any later version)</li> <li>Boost header-only libraries</li> </ul> <p>Optionally, in order to build and run tests and examples:</p> <ul> <li>Boost.Filesystem</li> <li>Boost.Test</li> <li>Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension and some of examples.</li> </ul> <h2>Branches</h2> <p>The official repository contains the following branches:</p> <ul> <li> <p><a href="https://github.com/boostorg/gil/tree/master"><strong>master</strong></a> This holds the most recent snapshot with code that is known to be stable.</p> </li> <li> <p><a href="https://github.com/boostorg/gil/tree/develop"><strong>develop</strong></a> This holds the most recent snapshot. It may contain unstable code.</p> </li> </ul> <h2>Community</h2> <p>There is number of communication channels to ask questions and discuss Boost.GIL issues:</p> <ul> <li><a href="https://github.com/boostorg/gil/discussions/">GitHub Discussions</a></li> <li>Mailing lists (<a href="https://www.boost.org/more/discussion_policy.html">Boost discussion policy</a>) <ul> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost-gil">boost-gil</a> (<em>recommended</em>) official Boost.GIL mailing list (<a href="https://lists.boost.org/boost-gil/">archive</a>)</li> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost-users">boost-users</a> for all Boost users</li> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost">boost</a> for all Boost developers</li> </ul> </li> <li>Slack at <a href="https://cppalliance.org/slack/">cpplang.slack.com</a> with Boost channels: <ul> <li><a href="https://cpplang.slack.com/archives/CSVT0STV2">#boost-gil</a> (<em>recommended</em>) official Boost.GIL channel</li> <li><a href="https://cpplang.slack.com/messages/CEWTCFDN0/">#boost-user</a> for all Boost users</li> <li><a href="https://cpplang.slack.com/messages/C27KZLB0X/">#boost</a> for all Boost developers</li> </ul> </li> <li>Gitter room <a href="https://gitter.im/boostorg/gil">boostorg/gil</a> (old real-time chat space)</li> <li>You can also ask questions via GitHub issue.</li> </ul> <h2>Contributing (We Need Your Help!)</h2> <p>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.</p> <p>If you would like to test the library, contribute new feature or a bug fix, see the <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> where the whole development infrastructure and the contributing workflow is explained in details.</p> <p>You may consider performing code reviews on active <a href="https://github.com/boostorg/gil/pulls">pull requests</a> or help with solving reported issues, especially those labelled with:</p> <ul> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-help">status/need-help</a></li> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-feedback">status/need-feedback</a></li> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example">need-minimal-example</a></li> </ul> <p>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.</p> <h2>License</h2> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
-
Code Commits Commits authored to any Boost repository. With 1 contribution, you will earn the bronze badge for Code Commits.
-
Documentation Doc contributions using standardised Boost tooling (Antora / BoostLook). With 1 contribution, you will earn the bronze badge for Documentation.
-
Library Authoring Authored an original Boost library accepted into the collection. With 1 contribution, you will earn the bronze badge for Library Authoring.
-
Library Maintenance Number of libraries actively maintained. With 1 contribution, you will earn the bronze badge for Library Maintenance.
-
Library Review Formal review submissions on Boost proposals. With 1 contribution, you will earn the bronze badge for Library Review.
-
Library Versioning Authored new versions / releases of Boost libraries. With 10 contributions, you will earn the bronze badge for Library Versioning.
-
Mailing List Participation Participation on the Boost developers mailing list. With 1 contribution, you will earn the bronze badge for Mailing List Participation.
-
News Posts Published Articles / news posts published on Boost.org. With 1 contribution, you will earn the bronze badge for News Posts Published.
<p><img src="https://raw.githubusercontent.com/boostorg/gil/develop/doc/_static/gil.png" alt="Boost Generic Image Library (GIL)" /></p> <p><a href="https://en.wikipedia.org/wiki/C%2B%2B#Standardization"><img src="https://img.shields.io/badge/C%2B%2B-14-blue.svg" alt="Language" /></a> <a href="https://opensource.org/licenses/BSL-1.0"><img src="https://img.shields.io/badge/license-BSL-blue.svg" alt="License" /></a> <a href="http://boostorg.github.com/gil/"><img src="https://img.shields.io/badge/gil-documentation-blue.svg" alt="Documentation" /></a> <a href="https://github.com/boostorg/gil/wiki"><img src="https://img.shields.io/badge/gil-wiki-blue.svg" alt="Wiki" /></a> <a href="https://lists.boost.org/mailman/listinfo.cgi/boost-gil"><img src="https://img.shields.io/badge/gil-mailing%20list-4eb899.svg" alt="Mailing List" /></a> <a href="https://gitter.im/boostorg/gil"><img src="https://img.shields.io/badge/gil-chat%20on%20gitter-4eb899.svg" alt="Gitter" /></a> <a href="https://wandbox.org/permlink/isNgnMuqWcqTqzy7"><img src="https://img.shields.io/badge/on-wandbox-blue.svg" alt="Try it online" /></a> <a href="https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters"><img src="https://img.shields.io/badge/on-conan-blue.svg" alt="Conan" /></a> <a href="https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil"><img src="https://img.shields.io/badge/on-vcpkg-blue.svg" alt="Vcpkg" /></a></p> <table> <thead> <tr> <th align="left">Documentation</th> <th align="left">GitHub Actions</th> <th align="left">AppVeyor</th> <th align="left">Regression</th> <th align="left">Codecov</th> </tr> </thead> <tbody> <tr> <td align="left"><a href="https://boostorg.github.io/gil/develop/"><img src="https://img.shields.io/badge/doc-develop-blue.svg" alt="develop" /></a></td> <td align="left"><a href="https://github.com/boostorg/gil/actions?query=branch:develop"><img src="https://github.com/boostorg/gil/workflows/CI/badge.svg?branch=develop" alt="GitHub Actions" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h/branch/develop?svg=true" alt="AppVeyor" /></a></td> <td align="left"><a href="https://regression.boost.io/develop/developer/gil.html"><img src="https://img.shields.io/badge/gil-develop-blue.svg" alt="gil" /></a></td> <td align="left"><a href="https://app.codecov.io/gh/boostorg/gil/branch/develop"><img src="https://codecov.io/gh/boostorg/gil/branch/develop/graphs/badge.svg" alt="codecov" /></a></td> </tr> <tr> <td align="left"><a href="https://boostorg.github.io/gil/"><img src="https://img.shields.io/badge/doc-master-blue.svg" alt="master" /></a></td> <td align="left"><a href="https://github.com/boostorg/gil/actions?query=branch:master"><img src="https://github.com/boostorg/gil/workflows/CI/badge.svg?branch=master" alt="GitHub Actions" /></a></td> <td align="left"><a href="https://ci.appveyor.com/project/stefanseefeld/gil/branch/master"><img src="https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h?svg=true" alt="AppVeyor" /></a></td> <td align="left"><a href="https://regression.boost.io/master/developer/gil.html"><img src="https://img.shields.io/badge/gil-master-blue.svg" alt="gil" /></a></td> <td align="left"><a href="https://app.codecov.io/gh/boostorg/gil/branch/master"><img src="https://codecov.io/gh/boostorg/gil/branch/master/graphs/badge.svg" alt="codecov" /></a></td> </tr> </tbody> </table> <h1>Boost.GIL</h1> <ul> <li><a href="#introduction">Introduction</a></li> <li><a href="#documentation">Documentation</a></li> <li><a href="#requirements">Requirements</a></li> <li><a href="#branches">Branches</a></li> <li><a href="#community">Community</a></li> <li><a href="#contributing-we-need-your-help">Contributing</a></li> <li><a href="#license">License</a></li> </ul> <h2>Introduction</h2> <p>Boost.GIL is a part of the <a href="http://github.com/boostorg">Boost C++ Libraries</a>.</p> <p>The Boost Generic Image Library (GIL) is a <strong>C++14</strong> header-only 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.</p> <h2>Documentation</h2> <ul> <li><a href="https://boost.org/libs/gil">Latest release</a></li> <li><a href="http://boostorg.github.io/gil/">Branch master</a> (latest release with minor changes)</li> <li><a href="http://boostorg.github.io/gil/develop/">Branch develop</a></li> </ul> <p>See <a href="RELEASES.md">RELEASES.md</a> for release notes.</p> <p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> for instructions about how to build and run tests and examples using Boost.Build or CMake.</p> <p>See <a href="example/README.md">example/README.md</a> for GIL usage examples.</p> <p>See <a href="example/b2/README.md">example/b2/README.md</a> for Boost.Build configuration examples.</p> <p>See <a href="example/cmake/README.md">example/cmake/README.md</a> for CMake configuration examples.</p> <h2>Requirements</h2> <p>The Boost Generic Image Library (GIL) requires:</p> <ul> <li>C++14 compiler (GCC 6, clang 3.9, MSVC++ 14.1 (1910) or any later version)</li> <li>Boost header-only libraries</li> </ul> <p>Optionally, in order to build and run tests and examples:</p> <ul> <li>Boost.Filesystem</li> <li>Boost.Test</li> <li>Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension and some of examples.</li> </ul> <h2>Branches</h2> <p>The official repository contains the following branches:</p> <ul> <li> <p><a href="https://github.com/boostorg/gil/tree/master"><strong>master</strong></a> This holds the most recent snapshot with code that is known to be stable.</p> </li> <li> <p><a href="https://github.com/boostorg/gil/tree/develop"><strong>develop</strong></a> This holds the most recent snapshot. It may contain unstable code.</p> </li> </ul> <h2>Community</h2> <p>There is number of communication channels to ask questions and discuss Boost.GIL issues:</p> <ul> <li><a href="https://github.com/boostorg/gil/discussions/">GitHub Discussions</a></li> <li>Mailing lists (<a href="https://www.boost.org/more/discussion_policy.html">Boost discussion policy</a>) <ul> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost-gil">boost-gil</a> (<em>recommended</em>) official Boost.GIL mailing list (<a href="https://lists.boost.org/boost-gil/">archive</a>)</li> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost-users">boost-users</a> for all Boost users</li> <li><a href="https://lists.boost.org/mailman/listinfo.cgi/boost">boost</a> for all Boost developers</li> </ul> </li> <li>Slack at <a href="https://cppalliance.org/slack/">cpplang.slack.com</a> with Boost channels: <ul> <li><a href="https://cpplang.slack.com/archives/CSVT0STV2">#boost-gil</a> (<em>recommended</em>) official Boost.GIL channel</li> <li><a href="https://cpplang.slack.com/messages/CEWTCFDN0/">#boost-user</a> for all Boost users</li> <li><a href="https://cpplang.slack.com/messages/C27KZLB0X/">#boost</a> for all Boost developers</li> </ul> </li> <li>Gitter room <a href="https://gitter.im/boostorg/gil">boostorg/gil</a> (old real-time chat space)</li> <li>You can also ask questions via GitHub issue.</li> </ul> <h2>Contributing (We Need Your Help!)</h2> <p>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.</p> <p>If you would like to test the library, contribute new feature or a bug fix, see the <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> where the whole development infrastructure and the contributing workflow is explained in details.</p> <p>You may consider performing code reviews on active <a href="https://github.com/boostorg/gil/pulls">pull requests</a> or help with solving reported issues, especially those labelled with:</p> <ul> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-help">status/need-help</a></li> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-feedback">status/need-feedback</a></li> <li><a href="https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example">need-minimal-example</a></li> </ul> <p>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.</p> <h2>License</h2> <p>Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</p>
-
Achievement-based Reflects the depth of your contributions. Accumulate achievements to unlock five tiers; Bronze, Silver, Gold, Platinum and Diamond.
-
Tenure-based Awarded in recognition of your time on the platform. The longer you've been part of the Boost community, the higher the tier you unlock.
-
Boost day celebration A celebration of the day you joined Boost. Awarded annually to mark another year as part of the community.
