group___i_o.html 26 KB

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