2
0
mirror of https://github.com/boostorg/gil.git synced 2026-01-19 16:22:14 +00:00
Files
gil/develop/doc/html/toolbox.html
github-actions[bot] 43e8aef5bd deploy: 942196bedc
2025-12-11 07:34:54 +00:00

137 lines
6.0 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ToolBox extension - Boost.GIL documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/sphinx_highlight.js"></script>
<script data-url_root="./" id="documentation_options" src="./_static/documentation_options.js"></script>
<script src="./_static/searchtools.js"></script>
<script src="./_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Boost.GIL documentation" href="index.html" />
<link rel="next" title="Numeric extension" href="numeric.html" />
<link rel="prev" title="IO extensions" href="io.html" />
</head>
<body>
<div class="header">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
"header">
<tr>
<td valign="top" width="300">
<h3><a href="index.html"><img
alt="C++ Boost" src="_static/gil.png" border="0"></a></h3>
</td>
<td >
<h1 align="center"><a href="index.html"></a></h1>
</td>
<td>
<div id="searchbox" style="display: none">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</td>
</tr>
</table>
</div>
<hr/>
<div class="content">
<div class="navbar" style="text-align:right;">
<a class="prev" title="IO extensions" href="io.html"><img src="_static/prev.png" alt="prev"/></a>
<a class="next" title="Numeric extension" href="numeric.html"><img src="_static/next.png" alt="next"/></a>
</div>
<section id="toolbox-extension">
<h1>ToolBox extension<a class="headerlink" href="#toolbox-extension" title="Link to this heading"></a></h1>
<section id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h2>
<p>ToolBox provides collection of Boost.GIL extensions which are too
small to be maintained as standalone extensions.</p>
<p>Content:</p>
<ul class="simple">
<li><p>Color converters: Gray to RGBA</p></li>
<li><p>Color spaces: CMYKA, Gray with Alpha, HSL, HSV, Lab, XYZ</p></li>
<li><p>Metafunctions:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">channel_type</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">channel_type_to_index</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_num_bits</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_pixel_type</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_bit_aligned</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_homogeneous</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">is_similar</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">pixel_bit_size</span></code></p></li>
</ul>
</li>
<li><p>Image types:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">indexed_image</span></code></p></li>
</ul>
</li>
</ul>
<p>This extension will hopefully be added on by the community.</p>
<p>Since the extension is header-only, user just needs to include
its main header <code class="docutils literal notranslate"><span class="pre">#include</span> <span class="pre">&lt;boost/gil/extension/toolbox.hpp&gt;</span></code>.</p>
<p>All definitions of the toolbox belong to the <code class="docutils literal notranslate"><span class="pre">boost::gil</span></code> namespace.</p>
</section>
<section id="folder-structure">
<h2>Folder Structure<a class="headerlink" href="#folder-structure" title="Link to this heading"></a></h2>
<p>The toolbox structured in the following sub-directories:</p>
<ul class="simple">
<li><p>color_converters</p></li>
<li><p>color_spaces</p></li>
<li><p>metafunctions</p></li>
<li><p>image_types</p></li>
</ul>
</section>
<section id="acknowledgements">
<h2>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link to this heading"></a></h2>
<p>Thanks to all the people who have reviewed this library and
made suggestions for improvements.</p>
</section>
<section id="id1">
<h2>Reference<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
<p>The <a class="reference external" href="reference.html">Reference</a> section.</p>
</section>
</section>
<div class="navbar" style="text-align:right;">
<a class="prev" title="IO extensions" href="io.html"><img src="_static/prev.png" alt="prev"/></a>
<a class="next" title="Numeric extension" href="numeric.html"><img src="_static/next.png" alt="next"/></a>
</div>
</div>
<div class="footer" role="contentinfo">
Last updated on 2025-12-11 07:12:45.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>