120 lines
7.1 KiB
Markdown
120 lines
7.1 KiB
Markdown
|
|
|
|
[](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
|
|
[](https://opensource.org/licenses/BSL-1.0)
|
|
[](http://boostorg.github.com/gil/)
|
|
[](https://github.com/boostorg/gil/wiki)
|
|
[](https://lists.boost.org/mailman/listinfo.cgi/boost-gil)
|
|
[](https://gitter.im/boostorg/gil)
|
|
[](https://wandbox.org/permlink/isNgnMuqWcqTqzy7)
|
|
[](https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters)
|
|
[](https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil)
|
|
|
|
Documentation | AppVeyor | Azure Pipelines | Travis CI | CircleCI | Regression
|
|
--------------|-----------------|-----------------|-----------------|-----------------|------------
|
|
[](https://boostorg.github.io/gil/develop/) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop) | [](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=4?branchName=develop) | [](https://travis-ci.org/boostorg/gil) | [](https://circleci.com/gh/boostorg/workflows/gil/tree/develop) | [](http://www.boost.org/development/tests/develop/developer/gil.html)
|
|
[](https://boostorg.github.io/gil/) | [](https://ci.appveyor.com/project/stefanseefeld/gil/branch/master) | [](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=4?branchName=master) | [](https://travis-ci.org/boostorg/gil) | [](https://circleci.com/gh/boostorg/workflows/gil/tree/master) | [](http://www.boost.org/development/tests/master/developer/gil.html)
|
|
**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](#introduction)
|
|
- [Documentation](#documentation)
|
|
- [Requirements](#requirements)
|
|
- [Branches](#branches)
|
|
- [Community](#community)
|
|
- [Contributing](#contributing-we-need-your-help)
|
|
- [License](#license)
|
|
|
|
## Introduction
|
|
|
|
Boost.GIL is a part of the [Boost C++ Libraries](http://github.com/boostorg).
|
|
|
|
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
|
|
|
|
- [Latest release](https://boost.org/libs/gil)
|
|
- [Branch master](http://boostorg.github.io/gil/) (latest release with minor changes)
|
|
- [Branch develop](http://boostorg.github.io/gil/develop/)
|
|
|
|
See [RELEASES.md](RELEASES.md) for release notes.
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions about how to build and
|
|
run tests, examples.
|
|
|
|
See [example/README.md](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**](https://github.com/boostorg/gil/tree/master) This
|
|
holds the most recent snapshot with code that is known to be stable.
|
|
|
|
- [**develop**](https://github.com/boostorg/gil/tree/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:
|
|
|
|
- Mailing list [boost-gil](https://lists.boost.org/mailman/listinfo.cgi/boost-gil) ([archive](https://lists.boost.org/boost-gil/)) as well as official Boost lists, [boost-users](https://lists.boost.org/mailman/listinfo.cgi/boost-users) and
|
|
[boost](https://lists.boost.org/mailman/listinfo.cgi/boost).
|
|
- Gitter chat room [boostorg//gil](https://gitter.im/boostorg/gil).
|
|
- [cpplang.slack.com](https://cpplang.slack.com) chat rooms [\#boost-user](https://cpplang.slack.com/messages/CEWTCFDN0/) and [\#boost](https://cpplang.slack.com/messages/C27KZLB0X/).
|
|
- IRC channel [\#boost](irc://chat.freenode.net/#boost) on FreeNode.
|
|
- 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](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](https://github.com/boostorg/gil/pulls) or help
|
|
with solving reported issues, especially those labelled with:
|
|
|
|
- [status/need-help](https://github.com/boostorg/gil/labels/status%2Fneed-help)
|
|
- [status/need-feedback](https://github.com/boostorg/gil/labels/status%2Fneed-feedback)
|
|
- [need-minimal-example](https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example)
|
|
|
|
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](http://www.boost.org/LICENSE_1_0.txt).
|