boost/gil
2
0
Fork 0
mirror of https://github.com/boostorg/gil.git synced 2026-02-10 11:32:18 +00:00
Code Issues Projects Releases Wiki Activity
Files
adccd7fb0e1fb29fa32365240cb8dd47631dfd26
gil/doc/html/reference/group___i_o.html
Travis CI ac07876de7 Manually fix the docs.
2019-05-07 01:46:31 -04:00

417 lines
26 KiB
HTML
Raw Blame History

<!-- 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.13"/>
<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.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<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">&#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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:gaf18f6566f79d4957be982c8f3795e3eb"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
<tr class="memitem:gaf18f6566f79d4957be982c8f3795e3eb"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gaf18f6566f79d4957be982c8f3795e3eb">read_and_convert_image</a> (Reader &amp;reader, Image &amp;img, typename std::enable_if&lt; mpl::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>
<tr class="memdesc:gaf18f6566f79d4957be982c8f3795e3eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads and color-converts an image. Image memory is allocated. <a href="group___i_o.html#gaf18f6566f79d4957be982c8f3795e3eb">More...</a><br /></td></tr>
<tr class="separator:gaf18f6566f79d4957be982c8f3795e3eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d72534307184ad2adbb5bb31ac16e79"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
<tr class="memitem:ga6d72534307184ad2adbb5bb31ac16e79"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga6d72534307184ad2adbb5bb31ac16e79">read_and_convert_view</a> (Reader &amp;reader, View const &amp;view, typename std::enable_if&lt; mpl::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>
<tr class="memdesc:ga6d72534307184ad2adbb5bb31ac16e79"><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#ga6d72534307184ad2adbb5bb31ac16e79">More...</a><br /></td></tr>
<tr class="separator:ga6d72534307184ad2adbb5bb31ac16e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc45cfa7ae76b7e2ca8e748addd6a27a"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
<tr class="memitem:gafc45cfa7ae76b7e2ca8e748addd6a27a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gafc45cfa7ae76b7e2ca8e748addd6a27a">read_image</a> (Reader reader, Image &amp;img, typename std::enable_if&lt; mpl::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>
<tr class="memdesc:gafc45cfa7ae76b7e2ca8e748addd6a27a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image without conversion. Image memory is allocated. <a href="group___i_o.html#gafc45cfa7ae76b7e2ca8e748addd6a27a">More...</a><br /></td></tr>
<tr class="separator:gafc45cfa7ae76b7e2ca8e748addd6a27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0aabfc20bb861dae2f4c5bb1a89dd186"><td class="memTemplParams" colspan="2">template&lt;typename Device , typename FormatTag &gt; </td></tr>
<tr class="memitem:ga0aabfc20bb861dae2f4c5bb1a89dd186"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga0aabfc20bb861dae2f4c5bb1a89dd186">read_image_info</a> (Device &amp;file, image_read_settings&lt; FormatTag &gt; const &amp;settings, typename std::enable_if&lt; mpl::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>
<tr class="memdesc:ga0aabfc20bb861dae2f4c5bb1a89dd186"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the image format backend. Backend is format specific. <a href="group___i_o.html#ga0aabfc20bb861dae2f4c5bb1a89dd186">More...</a><br /></td></tr>
<tr class="separator:ga0aabfc20bb861dae2f4c5bb1a89dd186"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7906e41288b6617e5b6b55123f0ca73"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
<tr class="memitem:gac7906e41288b6617e5b6b55123f0ca73"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gac7906e41288b6617e5b6b55123f0ca73">read_view</a> (Reader reader, View const &amp;view, typename std::enable_if&lt; mpl::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>
<tr class="memdesc:gac7906e41288b6617e5b6b55123f0ca73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image view without conversion. No memory is allocated. <a href="group___i_o.html#gac7906e41288b6617e5b6b55123f0ca73">More...</a><br /></td></tr>
<tr class="separator:gac7906e41288b6617e5b6b55123f0ca73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4f6d6d9b3fadffc5c2b0e683b021c5e"><td class="memTemplParams" colspan="2"><a id="gaf4f6d6d9b3fadffc5c2b0e683b021c5e"></a>
template&lt;typename Writer , typename View &gt; </td></tr>
<tr class="memitem:gaf4f6d6d9b3fadffc5c2b0e683b021c5e"><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; mpl::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>
<tr class="separator:gaf4f6d6d9b3fadffc5c2b0e683b021c5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff78d2f5a1d2752363f71c26b6052fc9"><td class="memTemplParams" colspan="2"><a id="gaff78d2f5a1d2752363f71c26b6052fc9"></a>
template&lt;typename Device , typename View , typename FormatTag &gt; </td></tr>
<tr class="memitem:gaff78d2f5a1d2752363f71c26b6052fc9"><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; mpl::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>
<tr class="separator:gaff78d2f5a1d2752363f71c26b6052fc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8139e12e2ad65153358a39814abc295f"><td class="memTemplParams" colspan="2"><a id="ga8139e12e2ad65153358a39814abc295f"></a>
template&lt;typename String , typename View , typename FormatTag &gt; </td></tr>
<tr class="memitem:ga8139e12e2ad65153358a39814abc295f"><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; mpl::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>
<tr class="separator:ga8139e12e2ad65153358a39814abc295f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab5c9624653af13392d1fa9c1d4a78a42"><td class="memTemplParams" colspan="2"><a id="gab5c9624653af13392d1fa9c1d4a78a42"></a>
template&lt;typename Device , typename View , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:gab5c9624653af13392d1fa9c1d4a78a42"><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; mpl::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>
<tr class="separator:gab5c9624653af13392d1fa9c1d4a78a42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacde5f3bbe437cd506904eab32582b571"><td class="memTemplParams" colspan="2"><a id="gacde5f3bbe437cd506904eab32582b571"></a>
template&lt;typename String , typename View , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:gacde5f3bbe437cd506904eab32582b571"><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; mpl::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>
<tr class="separator:gacde5f3bbe437cd506904eab32582b571"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e636f14f7b1701867924267a122c20e"><td class="memTemplParams" colspan="2"><a id="ga5e636f14f7b1701867924267a122c20e"></a>
template&lt;typename Device , typename Views , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:ga5e636f14f7b1701867924267a122c20e"><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; mpl::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>
<tr class="separator:ga5e636f14f7b1701867924267a122c20e"><td class="memSeparator" colspan="2">&#160;</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="gaf18f6566f79d4957be982c8f3795e3eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf18f6566f79d4957be982c8f3795e3eb">&#9670;&nbsp;</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 &amp;&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Image &amp;&#160;</td>
<td class="paramname"><em>img</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if&lt; mpl::and_&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *&#160;</td>
<td class="paramname"> = <code>nullptr</code>&#160;</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="ga6d72534307184ad2adbb5bb31ac16e79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d72534307184ad2adbb5bb31ac16e79">&#9670;&nbsp;</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 &amp;&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">View const &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if&lt; mpl::and_&lt; detail::is_reader&lt; Reader &gt;, is_format_tag&lt; typename Reader::format_tag_t &gt; &gt;::value &gt;::type *&#160;</td>
<td class="paramname"> = <code>nullptr</code>&#160;</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="gafc45cfa7ae76b7e2ca8e748addd6a27a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc45cfa7ae76b7e2ca8e748addd6a27a">&#9670;&nbsp;</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&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Image &amp;&#160;</td>
<td class="paramname"><em>img</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if&lt; mpl::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>
<td class="paramname"> = <code>nullptr</code>&#160;</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="ga0aabfc20bb861dae2f4c5bb1a89dd186"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0aabfc20bb861dae2f4c5bb1a89dd186">&#9670;&nbsp;</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 &amp;&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">image_read_settings&lt; FormatTag &gt; const &amp;&#160;</td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if&lt; mpl::and_&lt; detail::is_adaptable_input_device&lt; FormatTag, Device &gt;, is_format_tag&lt; FormatTag &gt; &gt;::value &gt;::type *&#160;</td>
<td class="paramname"> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<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
</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="gac7906e41288b6617e5b6b55123f0ca73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7906e41288b6617e5b6b55123f0ca73">&#9670;&nbsp;</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&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">View const &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename std::enable_if&lt; mpl::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>
<td class="paramname"> = <code>nullptr</code>&#160;</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 &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.13
</small>
</address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink