ceph/src/boost/libs/gil/README.md

   1 ![Boost Generic Image Library (GIL)](https://raw.githubusercontent.com/boostorg/gil/develop/doc/_static/gil.png)
   2
   3 [![Language](https://img.shields.io/badge/C%2B%2B-11-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization)
   4 [![License](https://img.shields.io/badge/license-BSL-blue.svg)](https://opensource.org/licenses/BSL-1.0)
   5 [![Documentation](https://img.shields.io/badge/gil-documentation-blue.svg)](http://boostorg.github.com/gil/)
   6 [![Wiki](https://img.shields.io/badge/gil-wiki-blue.svg)](https://github.com/boostorg/gil/wiki)
   7 [![Mailing List](https://img.shields.io/badge/gil-mailing%20list-4eb899.svg)](https://lists.boost.org/mailman/listinfo.cgi/boost-gil)
   8 [![Gitter](https://img.shields.io/badge/gil-chat%20on%20gitter-4eb899.svg)](https://gitter.im/boostorg/gil)
   9 [![Try it online](https://img.shields.io/badge/on-wandbox-blue.svg)](https://wandbox.org/permlink/isNgnMuqWcqTqzy7)
  10 [![Conan](https://img.shields.io/badge/on-conan-blue.svg)](https://bintray.com/bincrafters/public-conan/boost_gil%3Abincrafters)
  11 [![Vcpkg](https://img.shields.io/badge/on-vcpkg-blue.svg)](https://github.com/Microsoft/vcpkg/tree/master/ports/boost-gil)
  12
  13 Documentation | AppVeyor        | Azure Pipelines | Travis CI       | CircleCI        | Regression
  14 --------------|-----------------|-----------------|-----------------|-----------------|------------
  15 [![develop](https://img.shields.io/badge/doc-develop-blue.svg)](https://boostorg.github.io/gil/develop/) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h/branch/develop?svg=true)](https://ci.appveyor.com/project/stefanseefeld/gil/branch/develop) | [![Azure](https://dev.azure.com/boostorg/gil/_apis/build/status/boostorg.gil?branchName=develop)](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=4?branchName=develop) | [![Travis](https://travis-ci.org/boostorg/gil.svg?branch=develop)](https://travis-ci.org/boostorg/gil) | [![CircleCI](https://circleci.com/gh/boostorg/gil/tree/develop.svg?style=shield)](https://circleci.com/gh/boostorg/workflows/gil/tree/develop) | [![gil](https://img.shields.io/badge/gil-develop-blue.svg)](http://www.boost.org/development/tests/develop/developer/gil.html)
  16 [![master](https://img.shields.io/badge/doc-master-blue.svg)](https://boostorg.github.io/gil/) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/w4k19d8io2af168h?svg=true)](https://ci.appveyor.com/project/stefanseefeld/gil/branch/master) | [![Azure](https://dev.azure.com/boostorg/gil/_apis/build/status/boostorg.gil?branchName=master)](https://dev.azure.com/boostorg/gil/_build/latest?definitionId=4?branchName=master) | [![Travis](https://travis-ci.org/boostorg/gil.svg?branch=master)](https://travis-ci.org/boostorg/gil) | [![CircleCI](https://circleci.com/gh/boostorg/gil/tree/master.svg?style=shield)](https://circleci.com/gh/boostorg/workflows/gil/tree/master) | [![gil](https://img.shields.io/badge/gil-master-blue.svg)](http://www.boost.org/development/tests/master/developer/gil.html)
  17  **C++/compilers:** | 11, 14, 17 | 11, 14, 17 | 11 | 11 |
  18  msvc++    | VS2015, VS2017 | VS2015, VS2017 |   |   |
  19  clang++   |   | Xcode 9.4.1 | 3.9, 5.0, Xcode 9.4.1 | 3.9, 4.0, 5.0 |
  20  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 |
  21  **tests coverage:** |
  22 core + concepts | Y | Y | Y | Y |
  23 headers    | core + ext | core + ext | core + ext | core + ext |
  24 ext/dynamic_image |   |   |   |   |
  25 ext/io     | simple |  | simple | simple |
  26 ext/numeric| Y | Y | Y | Y |
  27 ext/toolbox| Y | Y | Y | Y |
  28  **build config:** | Boost.Build, CMake | CMake | Boost.Build, UBSan | Boost.Build |
  29
  30 # Boost.GIL
  31
  32 - [Introduction](#introduction)
  33 - [Documentation](#documentation)
  34 - [Requirements](#requirements)
  35 - [Branches](#branches)
  36 - [Community](#community)
  37 - [Contributing](#contributing-we-need-your-help)
  38 - [License](#license)
  39
  40 ## Introduction
  41
  42 Boost.GIL is a part of the [Boost C++ Libraries](http://github.com/boostorg).
  43
  44 The Boost Generic Image Library (GIL) is a C++ library that abstracts image
  45 representations from algorithms and allows writing code that can work on a
  46 variety of images with performance similar to hand-writing for a specific image type.
  47
  48 ## Documentation
  49
  50 - [Latest release](https://boost.org/libs/gil)
  51 - [Branch master](http://boostorg.github.io/gil/) (latest release with minor changes)
  52 - [Branch develop](http://boostorg.github.io/gil/develop/)
  53
  54 See [RELEASES.md](RELEASES.md) for release notes.
  55
  56 See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions about how to build and
  57 run tests, examples.
  58
  59 See [example/README.md](example/README.md) for available GIL examples.
  60
  61 ## Requirements
  62
  63 **NOTE:** The library source code is currently being modernized for C++11.
  64
  65 The Boost Generic Image Library (GIL) requires:
  66
  67 - C++11 compiler (GCC 4.9, clang 3.3, MSVC++ 14.0 (1900) or any later version)
  68 - Boost header-only libraries
  69
  70 Optionally, in order to build and run tests and examples:
  71
  72 - Boost.Filesystem
  73 - Boost.Test
  74 - Headers and libraries of libjpeg, libpng, libtiff, libraw for the I/O extension
  75
  76 ## Branches
  77
  78 The official repository contains the following branches:
  79
  80 - [**master**](https://github.com/boostorg/gil/tree/master) This
  81   holds the most recent snapshot with code that is known to be stable.
  82
  83 - [**develop**](https://github.com/boostorg/gil/tree/develop) This
  84   holds the most recent snapshot. It may contain unstable code.
  85
  86 ## Community
  87
  88 There is number of communication channels to ask questions and discuss Boost.GIL issues:
  89
  90 - 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
  91 [boost](https://lists.boost.org/mailman/listinfo.cgi/boost).
  92 - Gitter chat room [boostorg//gil](https://gitter.im/boostorg/gil).
  93 - [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/).
  94 - IRC channel [\#boost](irc://chat.freenode.net/#boost) on FreeNode.
  95 - You can also ask questions via GitHub issue.
  96
  97 ## Contributing (We Need Your Help!)
  98
  99 If you would like to contribute to Boost.GIL, help us improve the library
 100 and maintain high quality, there is number of ways to do it.
 101
 102 If you would like to test the library, contribute new feature or a bug fix,
 103 see the [CONTRIBUTING.md](CONTRIBUTING.md) where the whole development
 104 infrastructure and the contributing workflow is explained in details.
 105
 106 You may consider performing code reviews on active
 107 [pull requests](https://github.com/boostorg/gil/pulls) or help
 108 with solving reported issues, especially those labelled with:
 109
 110 - [status/need-help](https://github.com/boostorg/gil/labels/status%2Fneed-help)
 111 - [status/need-feedback](https://github.com/boostorg/gil/labels/status%2Fneed-feedback)
 112 - [need-minimal-example](https://github.com/boostorg/gil/labels/status%2Fneed-minimal-example)
 113
 114 Any feedback from users and developers, even simple questions about how things work
 115 or why they were done a certain way, carries value and can be used to improve the library.
 116
 117 ## License
 118
 119 Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).