Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / device__n_8hpp_source.html
1 <!-- HTML header for doxygen 1.8.13-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7     <meta name="generator" content="Doxygen 1.8.15"/>
8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
9     <title>Generic Image Library: device_n.hpp Source File</title>
10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
11     <script type="text/javascript" src="jquery.js"></script>
12     <script type="text/javascript" src="dynsections.js"></script>
13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
15   </head>
16   <body>
17     <div class="boost-header">
18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
19         <tr>
20           <td valign="top" width="300">
21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
22           </td>
23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
24           <td></td>
25         </tr>
26       </table>
27     </div>
28     <hr/>
29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30 <!-- Generated by Doxygen 1.8.15 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35 $(function() {
36   initMenu('',false,false,'search.php','Search');
37 });
38 /* @license-end */</script>
39 <div id="main-nav"></div>
40 <div id="nav-path" class="navpath">
41   <ul>
42 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="headertitle">
47 <div class="title">device_n.hpp</div>  </div>
48 </div><!--header-->
49 <div class="contents">
50 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef BOOST_GIL_DEVICE_N_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define BOOST_GIL_DEVICE_N_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;boost/gil/metafunctions.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;boost/gil/utilities.hpp&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;boost/gil/detail/mp11.hpp&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;boost/config.hpp&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// TODO: Document the DeviceN Color Space and Color Model</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// with reference to the Adobe documentation</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// https://www.adobe.com/content/dam/acom/en/devnet/postscript/pdfs/TN5604.DeviceN_Color.pdf</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1devicen__color__t.html">   30</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1devicen__color__t.html">devicen_color_t</a> {};</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1devicen__t.html">   33</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a>;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1devicen__t.html">devicen_t</a></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;{</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="keyword">using</span> <a class="code" href="structboost_1_1gil_1_1devicen__color__t.html">color_t</a> = <a class="code" href="structboost_1_1gil_1_1devicen__color__t.html">devicen_color_t&lt;T::value&gt;</a>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    static_assert(</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        N == 1 || (3 &lt;= N &amp;&amp; N &lt;= 5),</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        <span class="stringliteral">&quot;invalid number of DeviceN color components&quot;</span>);</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keyword">using</span> type = mp11::mp_transform&lt;color_t, mp11::mp_iota_c&lt;N&gt;&gt;;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;};</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1devicen__layout__t.html">   56</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1devicen__layout__t.html">devicen_layout_t</a> : <a class="code" href="structboost_1_1gil_1_1layout.html">layout</a>&lt;typename devicen_t&lt;N&gt;::type&gt; {};</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IC&gt;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;2&gt;</a>&gt;&gt;::view_t</div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group___image_view_constructors.html#ga772354350229fa94e1e80466be41b571">   62</a></span>&#160;<a class="code" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">planar_devicen_view</a>(std::size_t width, std::size_t height, IC c0, IC c1, std::ptrdiff_t rowsize_in_bytes)</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;{</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">using</span> view_t = <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;2&gt;</a>&gt;&gt;::view_t;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordflow">return</span> view_t(width, height, <span class="keyword">typename</span> view_t::locator(<span class="keyword">typename</span> view_t::x_iterator(c0,c1), rowsize_in_bytes));</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;}</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IC&gt;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keyword">inline</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="group___image_view_constructors.html#gad9d6c36ed5f4db8ef5b0ff56ac27802c">   72</a></span>&#160;<span class="keyword">auto</span> <a class="code" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">planar_devicen_view</a>(std::size_t width, std::size_t height, IC c0, IC c1, IC c2, std::ptrdiff_t rowsize_in_bytes)</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    -&gt; <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;3&gt;</a>&gt;&gt;::view_t</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;{</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keyword">using</span> view_t = <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;3&gt;</a>&gt;&gt;::view_t;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordflow">return</span> view_t(width, height, <span class="keyword">typename</span> view_t::locator(<span class="keyword">typename</span> view_t::x_iterator(c0,c1,c2), rowsize_in_bytes));</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;}</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IC&gt;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="keyword">inline</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group___image_view_constructors.html#ga4024ac76fa2b79fffd62b149ecbee3d7">   83</a></span>&#160;<span class="keyword">auto</span> <a class="code" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">planar_devicen_view</a>(std::size_t width, std::size_t height, IC c0, IC c1, IC c2, IC c3, std::ptrdiff_t rowsize_in_bytes)</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    -&gt; <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;4&gt;</a>&gt;&gt;::view_t</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;{</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keyword">using</span> view_t = <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;4&gt;</a>&gt;&gt;::view_t;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keywordflow">return</span> view_t(width, height, <span class="keyword">typename</span> view_t::locator(<span class="keyword">typename</span> view_t::x_iterator(c0,c1,c2,c3), rowsize_in_bytes));</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;}</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IC&gt;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="keyword">inline</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">   94</a></span>&#160;<span class="keyword">auto</span> <a class="code" href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">planar_devicen_view</a>(std::size_t width, std::size_t height, IC c0, IC c1, IC c2, IC c3, IC c4, std::ptrdiff_t rowsize_in_bytes)</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    -&gt; <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;5&gt;</a>&gt;&gt;::view_t</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;{</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    <span class="keyword">using</span> view_t = <span class="keyword">typename</span> <a class="code" href="structboost_1_1gil_1_1type__from__x__iterator.html">type_from_x_iterator&lt;planar_pixel_iterator&lt;IC,devicen_t&lt;5&gt;</a>&gt;&gt;::view_t;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    <span class="keywordflow">return</span> view_t(width, height, <span class="keyword">typename</span> view_t::locator(<span class="keyword">typename</span> view_t::x_iterator(c0,c1,c2,c3,c4), rowsize_in_bytes));</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;}</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;}}  <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="group___image_view_constructors_html_ga194e74dc9028773c004d42c44abb2763"><div class="ttname"><a href="group___image_view_constructors.html#ga194e74dc9028773c004d42c44abb2763">boost::gil::planar_devicen_view</a></div><div class="ttdeci">auto planar_devicen_view(std::size_t width, std::size_t height, IC c0, IC c1, IC c2, IC c3, IC c4, std::ptrdiff_t rowsize_in_bytes) -&gt; typename type_from_x_iterator&lt; planar_pixel_iterator&lt; IC, devicen_t&lt; 5 &gt;&gt;&gt;::view_t</div><div class="ttdoc">from 5-channel planar data</div><div class="ttdef"><b>Definition:</b> device_n.hpp:94</div></div>
51 <div class="ttc" id="structboost_1_1gil_1_1type__from__x__iterator_html"><div class="ttname"><a href="structboost_1_1gil_1_1type__from__x__iterator.html">boost::gil::type_from_x_iterator</a></div><div class="ttdoc">Given a pixel iterator defining access to pixels along a row, returns the types of the corresponding ...</div><div class="ttdef"><b>Definition:</b> metafunctions.hpp:301</div></div>
52 <div class="ttc" id="structboost_1_1gil_1_1devicen__color__t_html"><div class="ttname"><a href="structboost_1_1gil_1_1devicen__color__t.html">boost::gil::devicen_color_t</a></div><div class="ttdoc">unnamed color</div><div class="ttdef"><b>Definition:</b> device_n.hpp:30</div></div>
53 <div class="ttc" id="structboost_1_1gil_1_1layout_html"><div class="ttname"><a href="structboost_1_1gil_1_1layout.html">boost::gil::layout</a></div><div class="ttdoc">Represents a color space and ordering of channels in memory.</div><div class="ttdef"><b>Definition:</b> utilities.hpp:266</div></div>
54 <div class="ttc" id="structboost_1_1gil_1_1devicen__t_html"><div class="ttname"><a href="structboost_1_1gil_1_1devicen__t.html">boost::gil::devicen_t</a></div><div class="ttdoc">Unnamed color space of 1, 3, 4, or 5 channels.</div><div class="ttdef"><b>Definition:</b> device_n.hpp:33</div></div>
55 <div class="ttc" id="structboost_1_1gil_1_1devicen__layout__t_html"><div class="ttname"><a href="structboost_1_1gil_1_1devicen__layout__t.html">boost::gil::devicen_layout_t</a></div><div class="ttdoc">unnamed color layout of up to five channels</div><div class="ttdef"><b>Definition:</b> device_n.hpp:56</div></div>
56 </div><!-- fragment --></div><!-- contents -->
57      <!-- HTML footer for doxygen 1.8.13-->
58      <!-- start footer part -->
59      <hr class="footer"/>
60      <address class="footer">
61       <small>
62         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
63       </small>
64     </address>
65   </body>
66 </html>