libs/gil/doc/html/reference/group___i_o.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: I/O</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><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#groups">Modules</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">I/O</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>Support for reading and writing images to file.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  54 Modules</h2></td></tr>
  55 <tr class="memitem:group___j_p_e_g___i_o"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_p_e_g___i_o.html">JPEG I/O</a></td></tr>
  56 <tr class="memdesc:group___j_p_e_g___i_o"><td class="mdescLeft">&#160;</td><td class="mdescRight">Support for reading and writing JPEG image files. <br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:group___t_i_f_f___i_o"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_f_f___i_o.html">TIFF I/O</a></td></tr>
  59 <tr class="memdesc:group___t_i_f_f___i_o"><td class="mdescLeft">&#160;</td><td class="mdescRight">Support for reading and writing TIFF image files. <br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:group___p_n_g___i_o"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_n_g___i_o.html">PNG I/O</a></td></tr>
  62 <tr class="memdesc:group___p_n_g___i_o"><td class="mdescLeft">&#160;</td><td class="mdescRight">Support for reading and writing PNG image files. <br /></td></tr>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table><table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  66 Functions</h2></td></tr>
  67 <tr class="memitem:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
  68 <tr class="memitem:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga48e4b8fecad8dd6a535eb8ff3f426a4c">read_and_convert_image</a> (Reader &amp;reader, Image &amp;img, typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *=nullptr)</td></tr>
  69 <tr class="memdesc:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads and color-converts an image. Image memory is allocated.  <a href="group___i_o.html#ga48e4b8fecad8dd6a535eb8ff3f426a4c">More...</a><br /></td></tr>
  70 <tr class="separator:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <tr class="memitem:gaf30e030fab17abdd159c08478008cde1"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
  72 <tr class="memitem:gaf30e030fab17abdd159c08478008cde1"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gaf30e030fab17abdd159c08478008cde1">read_and_convert_view</a> (Reader &amp;reader, View const &amp;view, typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *=nullptr)</td></tr>
  73 <tr class="memdesc:gaf30e030fab17abdd159c08478008cde1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads and color-converts an image view. No memory is allocated.  <a href="group___i_o.html#gaf30e030fab17abdd159c08478008cde1">More...</a><br /></td></tr>
  74 <tr class="separator:gaf30e030fab17abdd159c08478008cde1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
  76 <tr class="memitem:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gac1e65b2ad8cd28fe8d694f1663df0d78">read_image</a> (Reader reader, Image &amp;img, typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt;, <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>&lt; typename get_pixel_type&lt; typename Image::view_t &gt;::type, typename Reader::format_tag_t &gt; &gt;::value &gt;::type *=nullptr)</td></tr>
  77 <tr class="memdesc:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image without conversion. Image memory is allocated.  <a href="group___i_o.html#gac1e65b2ad8cd28fe8d694f1663df0d78">More...</a><br /></td></tr>
  78 <tr class="separator:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memTemplParams" colspan="2">template&lt;typename Device , typename FormatTag &gt; </td></tr>
  80 <tr class="memitem:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga465aa7d369af94dd3fdfe98d6c3f833b">read_image_info</a> (Device &amp;file, image_read_settings&lt; FormatTag &gt; const &amp;settings, typename std::enable_if&lt; mp11::mp_and&lt; detail::is_adaptable_input_device&lt; FormatTag, Device &gt;, is_format_tag&lt; FormatTag &gt; &gt;::value &gt;::type *=nullptr) -&gt; typename <a class="el" href="structboost_1_1gil_1_1get__reader__backend.html">get_reader_backend</a>&lt; Device, FormatTag &gt;::type</td></tr>
  81 <tr class="memdesc:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the image format backend. Backend is format specific.  <a href="group___i_o.html#ga465aa7d369af94dd3fdfe98d6c3f833b">More...</a><br /></td></tr>
  82 <tr class="separator:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <tr class="memitem:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
  84 <tr class="memitem:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga9b5ae3d12c73aa1d81245fd5f8772847">read_view</a> (Reader reader, View const &amp;view, typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, typename is_format_tag&lt; typename Reader::format_tag_t &gt;::type, typename <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>&lt; typename get_pixel_type&lt; View &gt;::type, typename Reader::format_tag_t &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
  85 <tr class="memdesc:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image view without conversion. No memory is allocated.  <a href="group___i_o.html#ga9b5ae3d12c73aa1d81245fd5f8772847">More...</a><br /></td></tr>
  86 <tr class="separator:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87 <tr class="memitem:ga8e840ef6099b9b654610c96038f57fa6"><td class="memTemplParams" colspan="2"><a id="ga8e840ef6099b9b654610c96038f57fa6"></a>
  88 template&lt;typename Writer , typename View &gt; </td></tr>
  89 <tr class="memitem:ga8e840ef6099b9b654610c96038f57fa6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Writer &amp;writer, View const &amp;view, typename std::enable_if&lt; mp11::mp_and&lt; typename detail::is_writer&lt; Writer &gt;::type, typename is_format_tag&lt; typename Writer::format_tag_t &gt;::type, typename is_write_supported&lt; typename get_pixel_type&lt; View &gt;::type, typename Writer::format_tag_t &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
  90 <tr class="separator:ga8e840ef6099b9b654610c96038f57fa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memTemplParams" colspan="2"><a id="ga31c6d70facdbf5381586074d21c8d0e7"></a>
  92 template&lt;typename Device , typename View , typename FormatTag &gt; </td></tr>
  93 <tr class="memitem:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &amp;device, View const &amp;view, FormatTag const &amp;tag, typename std::enable_if&lt; mp11::mp_and&lt; typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>&lt; FormatTag, Device &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type, typename is_write_supported&lt; typename get_pixel_type&lt; View &gt;::type, FormatTag &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
  94 <tr class="separator:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 <tr class="memitem:gadb22d45dbc5665cd2f7be4154874d767"><td class="memTemplParams" colspan="2"><a id="gadb22d45dbc5665cd2f7be4154874d767"></a>
  96 template&lt;typename String , typename View , typename FormatTag &gt; </td></tr>
  97 <tr class="memitem:gadb22d45dbc5665cd2f7be4154874d767"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (String const &amp;file_name, View const &amp;view, FormatTag const &amp;tag, typename std::enable_if&lt; mp11::mp_and&lt; typename detail::is_supported_path_spec&lt; String &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type, typename is_write_supported&lt; typename get_pixel_type&lt; View &gt;::type, FormatTag &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
  98 <tr class="separator:gadb22d45dbc5665cd2f7be4154874d767"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 <tr class="memitem:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memTemplParams" colspan="2"><a id="ga470d1ef2c232560cfa143a235a5d1fbe"></a>
 100 template&lt;typename Device , typename View , typename FormatTag , typename Log &gt; </td></tr>
 101 <tr class="memitem:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &amp;device, View const &amp;view, image_write_info&lt; FormatTag, Log &gt; const &amp;info, typename std::enable_if&lt; mp11::mp_and&lt; typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>&lt; FormatTag, Device &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type, typename is_write_supported&lt; typename get_pixel_type&lt; View &gt;::type, FormatTag &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
 102 <tr class="separator:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 103 <tr class="memitem:gad1818e8779fe3c702cff7a56f923beb0"><td class="memTemplParams" colspan="2"><a id="gad1818e8779fe3c702cff7a56f923beb0"></a>
 104 template&lt;typename String , typename View , typename FormatTag , typename Log &gt; </td></tr>
 105 <tr class="memitem:gad1818e8779fe3c702cff7a56f923beb0"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (String const &amp;file_name, View const &amp;view, image_write_info&lt; FormatTag, Log &gt; const &amp;info, typename std::enable_if&lt; mp11::mp_and&lt; typename detail::is_supported_path_spec&lt; String &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type, typename is_write_supported&lt; typename get_pixel_type&lt; View &gt;::type, FormatTag &gt;::type &gt;::value &gt;::type *=nullptr)</td></tr>
 106 <tr class="separator:gad1818e8779fe3c702cff7a56f923beb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 <tr class="memitem:ga7dd99f2010b46f211aca3d61debadcae"><td class="memTemplParams" colspan="2"><a id="ga7dd99f2010b46f211aca3d61debadcae"></a>
 108 template&lt;typename Device , typename Views , typename FormatTag , typename Log &gt; </td></tr>
 109 <tr class="memitem:ga7dd99f2010b46f211aca3d61debadcae"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &amp;device, <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; Views &gt; const &amp;views, image_write_info&lt; FormatTag, Log &gt; const &amp;info, typename std::enable_if&lt; mp11::mp_and&lt; typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>&lt; FormatTag, Device &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type &gt;::value &gt;::type *=0)</td></tr>
 110 <tr class="separator:ga7dd99f2010b46f211aca3d61debadcae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 </table>
 112 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 113 <p>Support for reading and writing images to file. </p>
 114 <h2 class="groupheader">Function Documentation</h2>
 115 <a id="ga48e4b8fecad8dd6a535eb8ff3f426a4c"></a>
 116 <h2 class="memtitle"><span class="permalink"><a href="#ga48e4b8fecad8dd6a535eb8ff3f426a4c">&#9670;&nbsp;</a></span>read_and_convert_image()</h2>
 117
 118 <div class="memitem">
 119 <div class="memproto">
 120 <table class="mlabels">
 121   <tr>
 122   <td class="mlabels-left">
 123       <table class="memname">
 124         <tr>
 125           <td class="memname">void boost::gil::read_and_convert_image </td>
 126           <td>(</td>
 127           <td class="paramtype">Reader &amp;&#160;</td>
 128           <td class="paramname"><em>reader</em>, </td>
 129         </tr>
 130         <tr>
 131           <td class="paramkey"></td>
 132           <td></td>
 133           <td class="paramtype">Image &amp;&#160;</td>
 134           <td class="paramname"><em>img</em>, </td>
 135         </tr>
 136         <tr>
 137           <td class="paramkey"></td>
 138           <td></td>
 139           <td class="paramtype">typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *&#160;</td>
 140           <td class="paramname"> = <code>nullptr</code>&#160;</td>
 141         </tr>
 142         <tr>
 143           <td></td>
 144           <td>)</td>
 145           <td></td><td></td>
 146         </tr>
 147       </table>
 148   </td>
 149   <td class="mlabels-right">
 150 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 151   </tr>
 152 </table>
 153 </div><div class="memdoc">
 154
 155 <p>Reads and color-converts an image. Image memory is allocated. </p>
 156 <dl class="params"><dt>Parameters</dt><dd>
 157   <table class="params">
 158     <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
 159     <tr><td class="paramname">img</td><td>The image in which the data is read into. </td></tr>
 160     <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
 161     <tr><td class="paramname">cc</td><td>Color converter function object. </td></tr>
 162   </table>
 163   </dd>
 164 </dl>
 165 <dl class="exception"><dt>Exceptions</dt><dd>
 166   <table class="exception">
 167     <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
 168   </table>
 169   </dd>
 170 </dl>
 171
 172 </div>
 173 </div>
 174 <a id="gaf30e030fab17abdd159c08478008cde1"></a>
 175 <h2 class="memtitle"><span class="permalink"><a href="#gaf30e030fab17abdd159c08478008cde1">&#9670;&nbsp;</a></span>read_and_convert_view()</h2>
 176
 177 <div class="memitem">
 178 <div class="memproto">
 179 <table class="mlabels">
 180   <tr>
 181   <td class="mlabels-left">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">void boost::gil::read_and_convert_view </td>
 185           <td>(</td>
 186           <td class="paramtype">Reader &amp;&#160;</td>
 187           <td class="paramname"><em>reader</em>, </td>
 188         </tr>
 189         <tr>
 190           <td class="paramkey"></td>
 191           <td></td>
 192           <td class="paramtype">View const &amp;&#160;</td>
 193           <td class="paramname"><em>view</em>, </td>
 194         </tr>
 195         <tr>
 196           <td class="paramkey"></td>
 197           <td></td>
 198           <td class="paramtype">typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *&#160;</td>
 199           <td class="paramname"> = <code>nullptr</code>&#160;</td>
 200         </tr>
 201         <tr>
 202           <td></td>
 203           <td>)</td>
 204           <td></td><td></td>
 205         </tr>
 206       </table>
 207   </td>
 208   <td class="mlabels-right">
 209 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 210   </tr>
 211 </table>
 212 </div><div class="memdoc">
 213
 214 <p>Reads and color-converts an image view. No memory is allocated. </p>
 215 <dl class="params"><dt>Parameters</dt><dd>
 216   <table class="params">
 217     <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
 218     <tr><td class="paramname">img</td><td>The image in which the data is read into. </td></tr>
 219     <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
 220     <tr><td class="paramname">cc</td><td>Color converter function object. </td></tr>
 221   </table>
 222   </dd>
 223 </dl>
 224 <dl class="exception"><dt>Exceptions</dt><dd>
 225   <table class="exception">
 226     <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
 227   </table>
 228   </dd>
 229 </dl>
 230
 231 </div>
 232 </div>
 233 <a id="gac1e65b2ad8cd28fe8d694f1663df0d78"></a>
 234 <h2 class="memtitle"><span class="permalink"><a href="#gac1e65b2ad8cd28fe8d694f1663df0d78">&#9670;&nbsp;</a></span>read_image()</h2>
 235
 236 <div class="memitem">
 237 <div class="memproto">
 238 <table class="mlabels">
 239   <tr>
 240   <td class="mlabels-left">
 241       <table class="memname">
 242         <tr>
 243           <td class="memname">void boost::gil::read_image </td>
 244           <td>(</td>
 245           <td class="paramtype">Reader&#160;</td>
 246           <td class="paramname"><em>reader</em>, </td>
 247         </tr>
 248         <tr>
 249           <td class="paramkey"></td>
 250           <td></td>
 251           <td class="paramtype">Image &amp;&#160;</td>
 252           <td class="paramname"><em>img</em>, </td>
 253         </tr>
 254         <tr>
 255           <td class="paramkey"></td>
 256           <td></td>
 257           <td class="paramtype">typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt;, <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>&lt; typename get_pixel_type&lt; typename Image::view_t &gt;::type, typename Reader::format_tag_t &gt; &gt;::value &gt;::type *&#160;</td>
 258           <td class="paramname"> = <code>nullptr</code>&#160;</td>
 259         </tr>
 260         <tr>
 261           <td></td>
 262           <td>)</td>
 263           <td></td><td></td>
 264         </tr>
 265       </table>
 266   </td>
 267   <td class="mlabels-right">
 268 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 269   </tr>
 270 </table>
 271 </div><div class="memdoc">
 272
 273 <p>Reads an image without conversion. Image memory is allocated. </p>
 274 <dl class="params"><dt>Parameters</dt><dd>
 275   <table class="params">
 276     <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
 277     <tr><td class="paramname">img</td><td>The image in which the data is read into. Must satisfy <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a> metafunction. </td></tr>
 278   </table>
 279   </dd>
 280 </dl>
 281 <dl class="exception"><dt>Exceptions</dt><dd>
 282   <table class="exception">
 283     <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
 284   </table>
 285   </dd>
 286 </dl>
 287
 288 </div>
 289 </div>
 290 <a id="ga465aa7d369af94dd3fdfe98d6c3f833b"></a>
 291 <h2 class="memtitle"><span class="permalink"><a href="#ga465aa7d369af94dd3fdfe98d6c3f833b">&#9670;&nbsp;</a></span>read_image_info()</h2>
 292
 293 <div class="memitem">
 294 <div class="memproto">
 295 <table class="mlabels">
 296   <tr>
 297   <td class="mlabels-left">
 298       <table class="memname">
 299         <tr>
 300           <td class="memname">auto boost::gil::read_image_info </td>
 301           <td>(</td>
 302           <td class="paramtype">Device &amp;&#160;</td>
 303           <td class="paramname"><em>file</em>, </td>
 304         </tr>
 305         <tr>
 306           <td class="paramkey"></td>
 307           <td></td>
 308           <td class="paramtype">image_read_settings&lt; FormatTag &gt; const &amp;&#160;</td>
 309           <td class="paramname"><em>settings</em>, </td>
 310         </tr>
 311         <tr>
 312           <td class="paramkey"></td>
 313           <td></td>
 314           <td class="paramtype">typename std::enable_if&lt; mp11::mp_and&lt; detail::is_adaptable_input_device&lt; FormatTag, Device &gt;, is_format_tag&lt; FormatTag &gt; &gt;::value &gt;::type *&#160;</td>
 315           <td class="paramname"> = <code>nullptr</code>&#160;</td>
 316         </tr>
 317         <tr>
 318           <td></td>
 319           <td>)</td>
 320           <td></td><td> -&gt; typename <a class="el" href="structboost_1_1gil_1_1get__reader__backend.html">get_reader_backend</a>&lt;Device, FormatTag&gt;::type
 321 </td>
 322         </tr>
 323       </table>
 324   </td>
 325   <td class="mlabels-right">
 326 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 327   </tr>
 328 </table>
 329 </div><div class="memdoc">
 330
 331 <p>Returns the image format backend. Backend is format specific. </p>
 332 <dl class="params"><dt>Parameters</dt><dd>
 333   <table class="params">
 334     <tr><td class="paramname">file</td><td>It's a device. Must satisfy is_adaptable_input_device metafunction. </td></tr>
 335     <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
 336   </table>
 337   </dd>
 338 </dl>
 339 <dl class="section return"><dt>Returns</dt><dd>image_read_info object dependent on the image format. </dd></dl>
 340 <dl class="exception"><dt>Exceptions</dt><dd>
 341   <table class="exception">
 342     <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
 343   </table>
 344   </dd>
 345 </dl>
 346
 347 </div>
 348 </div>
 349 <a id="ga9b5ae3d12c73aa1d81245fd5f8772847"></a>
 350 <h2 class="memtitle"><span class="permalink"><a href="#ga9b5ae3d12c73aa1d81245fd5f8772847">&#9670;&nbsp;</a></span>read_view()</h2>
 351
 352 <div class="memitem">
 353 <div class="memproto">
 354 <table class="mlabels">
 355   <tr>
 356   <td class="mlabels-left">
 357       <table class="memname">
 358         <tr>
 359           <td class="memname">void boost::gil::read_view </td>
 360           <td>(</td>
 361           <td class="paramtype">Reader&#160;</td>
 362           <td class="paramname"><em>reader</em>, </td>
 363         </tr>
 364         <tr>
 365           <td class="paramkey"></td>
 366           <td></td>
 367           <td class="paramtype">View const &amp;&#160;</td>
 368           <td class="paramname"><em>view</em>, </td>
 369         </tr>
 370         <tr>
 371           <td class="paramkey"></td>
 372           <td></td>
 373           <td class="paramtype">typename std::enable_if&lt; mp11::mp_and&lt; detail::is_reader&lt; Reader &gt;, typename is_format_tag&lt; typename Reader::format_tag_t &gt;::type, typename <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>&lt; typename get_pixel_type&lt; View &gt;::type, typename Reader::format_tag_t &gt;::type &gt;::value &gt;::type *&#160;</td>
 374           <td class="paramname"> = <code>nullptr</code>&#160;</td>
 375         </tr>
 376         <tr>
 377           <td></td>
 378           <td>)</td>
 379           <td></td><td></td>
 380         </tr>
 381       </table>
 382   </td>
 383   <td class="mlabels-right">
 384 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 385   </tr>
 386 </table>
 387 </div><div class="memdoc">
 388
 389 <p>Reads an image view without conversion. No memory is allocated. </p>
 390 <dl class="params"><dt>Parameters</dt><dd>
 391   <table class="params">
 392     <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
 393     <tr><td class="paramname">view</td><td>The image view in which the data is read into. </td></tr>
 394     <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
 395   </table>
 396   </dd>
 397 </dl>
 398 <dl class="exception"><dt>Exceptions</dt><dd>
 399   <table class="exception">
 400     <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
 401   </table>
 402   </dd>
 403 </dl>
 404
 405 </div>
 406 </div>
 407 </div><!-- contents -->
 408      <!-- HTML footer for doxygen 1.8.13-->
 409      <!-- start footer part -->
 410      <hr class="footer"/>
 411      <address class="footer">
 412       <small>
 413         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 414       </small>
 415     </address>
 416   </body>
 417 </html>