123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417 |
- <!-- HTML header for doxygen 1.8.13-->
- <!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/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.15"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Generic Image Library: I/O</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div class="boost-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="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
- </td>
- <td ><h1 align="center"><a href="../index.html"></a></h1></td>
- <td></td>
- </tr>
- </table>
- </div>
- <hr/>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <!-- Generated by Doxygen 1.8.15 -->
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',false,false,'search.php','Search');
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#groups">Modules</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">I/O</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Support for reading and writing images to file.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
- Modules</h2></td></tr>
- <tr class="memitem:group___j_p_e_g___i_o"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_p_e_g___i_o.html">JPEG I/O</a></td></tr>
- <tr class="memdesc:group___j_p_e_g___i_o"><td class="mdescLeft"> </td><td class="mdescRight">Support for reading and writing JPEG image files. <br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group___t_i_f_f___i_o"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_i_f_f___i_o.html">TIFF I/O</a></td></tr>
- <tr class="memdesc:group___t_i_f_f___i_o"><td class="mdescLeft"> </td><td class="mdescRight">Support for reading and writing TIFF image files. <br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:group___p_n_g___i_o"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___p_n_g___i_o.html">PNG I/O</a></td></tr>
- <tr class="memdesc:group___p_n_g___i_o"><td class="mdescLeft"> </td><td class="mdescRight">Support for reading and writing PNG image files. <br /></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memTemplParams" colspan="2">template<typename Reader , typename Image > </td></tr>
- <tr class="memitem:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga48e4b8fecad8dd6a535eb8ff3f426a4c">read_and_convert_image</a> (Reader &reader, Image &img, typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t > >::value >::type *=nullptr)</td></tr>
- <tr class="memdesc:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="mdescLeft"> </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>
- <tr class="separator:ga48e4b8fecad8dd6a535eb8ff3f426a4c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaf30e030fab17abdd159c08478008cde1"><td class="memTemplParams" colspan="2">template<typename Reader , typename View > </td></tr>
- <tr class="memitem:gaf30e030fab17abdd159c08478008cde1"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gaf30e030fab17abdd159c08478008cde1">read_and_convert_view</a> (Reader &reader, View const &view, typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t > >::value >::type *=nullptr)</td></tr>
- <tr class="memdesc:gaf30e030fab17abdd159c08478008cde1"><td class="mdescLeft"> </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>
- <tr class="separator:gaf30e030fab17abdd159c08478008cde1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memTemplParams" colspan="2">template<typename Reader , typename Image > </td></tr>
- <tr class="memitem:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gac1e65b2ad8cd28fe8d694f1663df0d78">read_image</a> (Reader reader, Image &img, typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t >, <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>< typename get_pixel_type< typename Image::view_t >::type, typename Reader::format_tag_t > >::value >::type *=nullptr)</td></tr>
- <tr class="memdesc:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="mdescLeft"> </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>
- <tr class="separator:gac1e65b2ad8cd28fe8d694f1663df0d78"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memTemplParams" colspan="2">template<typename Device , typename FormatTag > </td></tr>
- <tr class="memitem:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memTemplItemLeft" align="right" valign="top">auto </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga465aa7d369af94dd3fdfe98d6c3f833b">read_image_info</a> (Device &file, image_read_settings< FormatTag > const &settings, typename std::enable_if< mp11::mp_and< detail::is_adaptable_input_device< FormatTag, Device >, is_format_tag< FormatTag > >::value >::type *=nullptr) -> typename <a class="el" href="structboost_1_1gil_1_1get__reader__backend.html">get_reader_backend</a>< Device, FormatTag >::type</td></tr>
- <tr class="memdesc:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="mdescLeft"> </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>
- <tr class="separator:ga465aa7d369af94dd3fdfe98d6c3f833b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memTemplParams" colspan="2">template<typename Reader , typename View > </td></tr>
- <tr class="memitem:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga9b5ae3d12c73aa1d81245fd5f8772847">read_view</a> (Reader reader, View const &view, typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, typename is_format_tag< typename Reader::format_tag_t >::type, typename <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>< typename get_pixel_type< View >::type, typename Reader::format_tag_t >::type >::value >::type *=nullptr)</td></tr>
- <tr class="memdesc:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="mdescLeft"> </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>
- <tr class="separator:ga9b5ae3d12c73aa1d81245fd5f8772847"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8e840ef6099b9b654610c96038f57fa6"><td class="memTemplParams" colspan="2"><a id="ga8e840ef6099b9b654610c96038f57fa6"></a>
- template<typename Writer , typename View > </td></tr>
- <tr class="memitem:ga8e840ef6099b9b654610c96038f57fa6"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Writer &writer, View const &view, typename std::enable_if< mp11::mp_and< typename detail::is_writer< Writer >::type, typename is_format_tag< typename Writer::format_tag_t >::type, typename is_write_supported< typename get_pixel_type< View >::type, typename Writer::format_tag_t >::type >::value >::type *=nullptr)</td></tr>
- <tr class="separator:ga8e840ef6099b9b654610c96038f57fa6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memTemplParams" colspan="2"><a id="ga31c6d70facdbf5381586074d21c8d0e7"></a>
- template<typename Device , typename View , typename FormatTag > </td></tr>
- <tr class="memitem:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &device, View const &view, FormatTag const &tag, typename std::enable_if< mp11::mp_and< typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>< FormatTag, Device >::type, typename is_format_tag< FormatTag >::type, typename is_write_supported< typename get_pixel_type< View >::type, FormatTag >::type >::value >::type *=nullptr)</td></tr>
- <tr class="separator:ga31c6d70facdbf5381586074d21c8d0e7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gadb22d45dbc5665cd2f7be4154874d767"><td class="memTemplParams" colspan="2"><a id="gadb22d45dbc5665cd2f7be4154874d767"></a>
- template<typename String , typename View , typename FormatTag > </td></tr>
- <tr class="memitem:gadb22d45dbc5665cd2f7be4154874d767"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (String const &file_name, View const &view, FormatTag const &tag, typename std::enable_if< mp11::mp_and< typename detail::is_supported_path_spec< String >::type, typename is_format_tag< FormatTag >::type, typename is_write_supported< typename get_pixel_type< View >::type, FormatTag >::type >::value >::type *=nullptr)</td></tr>
- <tr class="separator:gadb22d45dbc5665cd2f7be4154874d767"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memTemplParams" colspan="2"><a id="ga470d1ef2c232560cfa143a235a5d1fbe"></a>
- template<typename Device , typename View , typename FormatTag , typename Log > </td></tr>
- <tr class="memitem:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &device, View const &view, image_write_info< FormatTag, Log > const &info, typename std::enable_if< mp11::mp_and< typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>< FormatTag, Device >::type, typename is_format_tag< FormatTag >::type, typename is_write_supported< typename get_pixel_type< View >::type, FormatTag >::type >::value >::type *=nullptr)</td></tr>
- <tr class="separator:ga470d1ef2c232560cfa143a235a5d1fbe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gad1818e8779fe3c702cff7a56f923beb0"><td class="memTemplParams" colspan="2"><a id="gad1818e8779fe3c702cff7a56f923beb0"></a>
- template<typename String , typename View , typename FormatTag , typename Log > </td></tr>
- <tr class="memitem:gad1818e8779fe3c702cff7a56f923beb0"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (String const &file_name, View const &view, image_write_info< FormatTag, Log > const &info, typename std::enable_if< mp11::mp_and< typename detail::is_supported_path_spec< String >::type, typename is_format_tag< FormatTag >::type, typename is_write_supported< typename get_pixel_type< View >::type, FormatTag >::type >::value >::type *=nullptr)</td></tr>
- <tr class="separator:gad1818e8779fe3c702cff7a56f923beb0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga7dd99f2010b46f211aca3d61debadcae"><td class="memTemplParams" colspan="2"><a id="ga7dd99f2010b46f211aca3d61debadcae"></a>
- template<typename Device , typename Views , typename FormatTag , typename Log > </td></tr>
- <tr class="memitem:ga7dd99f2010b46f211aca3d61debadcae"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &device, <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>< Views > const &views, image_write_info< FormatTag, Log > const &info, typename std::enable_if< mp11::mp_and< typename <a class="el" href="structboost_1_1gil_1_1detail_1_1is__write__device.html">detail::is_write_device</a>< FormatTag, Device >::type, typename is_format_tag< FormatTag >::type >::value >::type *=0)</td></tr>
- <tr class="separator:ga7dd99f2010b46f211aca3d61debadcae"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>Support for reading and writing images to file. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a id="ga48e4b8fecad8dd6a535eb8ff3f426a4c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga48e4b8fecad8dd6a535eb8ff3f426a4c">◆ </a></span>read_and_convert_image()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void boost::gil::read_and_convert_image </td>
- <td>(</td>
- <td class="paramtype">Reader & </td>
- <td class="paramname"><em>reader</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Image & </td>
- <td class="paramname"><em>img</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t > >::value >::type * </td>
- <td class="paramname"> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads and color-converts an image. Image memory is allocated. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
- <tr><td class="paramname">img</td><td>The image in which the data is read into. </td></tr>
- <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
- <tr><td class="paramname">cc</td><td>Color converter function object. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gaf30e030fab17abdd159c08478008cde1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gaf30e030fab17abdd159c08478008cde1">◆ </a></span>read_and_convert_view()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void boost::gil::read_and_convert_view </td>
- <td>(</td>
- <td class="paramtype">Reader & </td>
- <td class="paramname"><em>reader</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">View const & </td>
- <td class="paramname"><em>view</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t > >::value >::type * </td>
- <td class="paramname"> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads and color-converts an image view. No memory is allocated. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
- <tr><td class="paramname">img</td><td>The image in which the data is read into. </td></tr>
- <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
- <tr><td class="paramname">cc</td><td>Color converter function object. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="gac1e65b2ad8cd28fe8d694f1663df0d78"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#gac1e65b2ad8cd28fe8d694f1663df0d78">◆ </a></span>read_image()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void boost::gil::read_image </td>
- <td>(</td>
- <td class="paramtype">Reader </td>
- <td class="paramname"><em>reader</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">Image & </td>
- <td class="paramname"><em>img</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, is_format_tag< typename Reader::format_tag_t >, <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>< typename get_pixel_type< typename Image::view_t >::type, typename Reader::format_tag_t > >::value >::type * </td>
- <td class="paramname"> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads an image without conversion. Image memory is allocated. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga465aa7d369af94dd3fdfe98d6c3f833b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga465aa7d369af94dd3fdfe98d6c3f833b">◆ </a></span>read_image_info()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">auto boost::gil::read_image_info </td>
- <td>(</td>
- <td class="paramtype">Device & </td>
- <td class="paramname"><em>file</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">image_read_settings< FormatTag > const & </td>
- <td class="paramname"><em>settings</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">typename std::enable_if< mp11::mp_and< detail::is_adaptable_input_device< FormatTag, Device >, is_format_tag< FormatTag > >::value >::type * </td>
- <td class="paramname"> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> -> typename <a class="el" href="structboost_1_1gil_1_1get__reader__backend.html">get_reader_backend</a><Device, FormatTag>::type
- </td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the image format backend. Backend is format specific. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">file</td><td>It's a device. Must satisfy is_adaptable_input_device metafunction. </td></tr>
- <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>image_read_info object dependent on the image format. </dd></dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ga9b5ae3d12c73aa1d81245fd5f8772847"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ga9b5ae3d12c73aa1d81245fd5f8772847">◆ </a></span>read_view()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void boost::gil::read_view </td>
- <td>(</td>
- <td class="paramtype">Reader </td>
- <td class="paramname"><em>reader</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">View const & </td>
- <td class="paramname"><em>view</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">typename std::enable_if< mp11::mp_and< detail::is_reader< Reader >, typename is_format_tag< typename Reader::format_tag_t >::type, typename <a class="el" href="structboost_1_1gil_1_1is__read__supported.html">is_read_supported</a>< typename get_pixel_type< View >::type, typename Reader::format_tag_t >::type >::value >::type * </td>
- <td class="paramname"> = <code>nullptr</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads an image view without conversion. No memory is allocated. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reader</td><td>An image reader. </td></tr>
- <tr><td class="paramname">view</td><td>The image view in which the data is read into. </td></tr>
- <tr><td class="paramname">settings</td><td>Specifies read settings depending on the image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">std::ios_base::failure</td><td></td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- HTML footer for doxygen 1.8.13-->
- <!-- start footer part -->
- <hr class="footer"/>
- <address class="footer">
- <small>
- Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
- </small>
- </address>
- </body>
- </html>
|