boost/gil
2
0
Fork 0
mirror of https://github.com/boostorg/gil.git synced 2026-02-16 01:22:10 +00:00
Code Issues Projects Releases Wiki Activity
Files
3ad0196f420f3e9bc053e0735b78c2b262c77ccd
gil/develop/doc/html/reference/group___i_o.html

408 lines
25 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.6"/>
<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.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</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:ga57e16d6184f66ccd429fd55ab8f7c2dc"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
<tr class="memitem:ga57e16d6184f66ccd429fd55ab8f7c2dc"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga57e16d6184f66ccd429fd55ab8f7c2dc">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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="memdesc:ga57e16d6184f66ccd429fd55ab8f7c2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads and color-converts an image. Image memory is allocated. <a href="#ga57e16d6184f66ccd429fd55ab8f7c2dc">More...</a><br/></td></tr>
<tr class="separator:ga57e16d6184f66ccd429fd55ab8f7c2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa0a37f39887c48fb3bda2af85cd3cb0c"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
<tr class="memitem:gaa0a37f39887c48fb3bda2af85cd3cb0c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#gaa0a37f39887c48fb3bda2af85cd3cb0c">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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="memdesc:gaa0a37f39887c48fb3bda2af85cd3cb0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads and color-converts an image view. No memory is allocated. <a href="#gaa0a37f39887c48fb3bda2af85cd3cb0c">More...</a><br/></td></tr>
<tr class="separator:gaa0a37f39887c48fb3bda2af85cd3cb0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23d8dd4e2f580722b0d57d2c1e601f0a"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename Image &gt; </td></tr>
<tr class="memitem:ga23d8dd4e2f580722b0d57d2c1e601f0a"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga23d8dd4e2f580722b0d57d2c1e601f0a">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;, is_read_supported&lt; typename get_pixel_type&lt; typename Image::view_t &gt;::type, typename Reader::format_tag_t &gt; &gt;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="memdesc:ga23d8dd4e2f580722b0d57d2c1e601f0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image without conversion. Image memory is allocated. <a href="#ga23d8dd4e2f580722b0d57d2c1e601f0a">More...</a><br/></td></tr>
<tr class="separator:ga23d8dd4e2f580722b0d57d2c1e601f0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60411bac48a3f632e3f2d9857eede9de"><td class="memTemplParams" colspan="2">template&lt;typename Device , typename FormatTag &gt; </td></tr>
<tr class="memitem:ga60411bac48a3f632e3f2d9857eede9de"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga60411bac48a3f632e3f2d9857eede9de">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;::type::value &gt;::type *=nullptr) -&gt; typename get_reader_backend&lt; Device, FormatTag &gt;::type</td></tr>
<tr class="memdesc:ga60411bac48a3f632e3f2d9857eede9de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the image format backend. Backend is format specific. <a href="#ga60411bac48a3f632e3f2d9857eede9de">More...</a><br/></td></tr>
<tr class="separator:ga60411bac48a3f632e3f2d9857eede9de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9728eeef0a75c0c06ea4ef6cb6e82e33"><td class="memTemplParams" colspan="2">template&lt;typename Reader , typename View &gt; </td></tr>
<tr class="memitem:ga9728eeef0a75c0c06ea4ef6cb6e82e33"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___i_o.html#ga9728eeef0a75c0c06ea4ef6cb6e82e33">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 is_read_supported&lt; typename get_pixel_type&lt; View &gt;::type, typename Reader::format_tag_t &gt;::type &gt;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="memdesc:ga9728eeef0a75c0c06ea4ef6cb6e82e33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an image view without conversion. No memory is allocated. <a href="#ga9728eeef0a75c0c06ea4ef6cb6e82e33">More...</a><br/></td></tr>
<tr class="separator:ga9728eeef0a75c0c06ea4ef6cb6e82e33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fa7fb712edb514c618d302903a180b5"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga5fa7fb712edb514c618d302903a180b5"></a>
template&lt;typename Writer , typename View &gt; </td></tr>
<tr class="memitem:ga5fa7fb712edb514c618d302903a180b5"><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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="separator:ga5fa7fb712edb514c618d302903a180b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5ee199b8f25ee4073c7380b094f0022"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaf5ee199b8f25ee4073c7380b094f0022"></a>
template&lt;typename Device , typename View , typename FormatTag &gt; </td></tr>
<tr class="memitem:gaf5ee199b8f25ee4073c7380b094f0022"><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 detail::is_write_device&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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="separator:gaf5ee199b8f25ee4073c7380b094f0022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40fa598d865cfc899a3f8e7a30ad8e19"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga40fa598d865cfc899a3f8e7a30ad8e19"></a>
template&lt;typename String , typename View , typename FormatTag &gt; </td></tr>
<tr class="memitem:ga40fa598d865cfc899a3f8e7a30ad8e19"><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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="separator:ga40fa598d865cfc899a3f8e7a30ad8e19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8043ecfebb11bdd9c17974ab8b76bf0"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaf8043ecfebb11bdd9c17974ab8b76bf0"></a>
template&lt;typename Device , typename View , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:gaf8043ecfebb11bdd9c17974ab8b76bf0"><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 detail::is_write_device&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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="separator:gaf8043ecfebb11bdd9c17974ab8b76bf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga50040d0dfe9516596c72fd37b348f06e"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga50040d0dfe9516596c72fd37b348f06e"></a>
template&lt;typename String , typename View , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:ga50040d0dfe9516596c72fd37b348f06e"><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;::type::value &gt;::type *=nullptr)</td></tr>
<tr class="separator:ga50040d0dfe9516596c72fd37b348f06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga66b09fa505d6acd5639df62a4d26e124"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga66b09fa505d6acd5639df62a4d26e124"></a>
template&lt;typename Device , typename Views , typename FormatTag , typename Log &gt; </td></tr>
<tr class="memitem:ga66b09fa505d6acd5639df62a4d26e124"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>write_view</b> (Device &amp;device, any_image_view&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 detail::is_write_device&lt; FormatTag, Device &gt;::type, typename is_format_tag&lt; FormatTag &gt;::type &gt;::type::value &gt;::type *=0)</td></tr>
<tr class="separator:ga66b09fa505d6acd5639df62a4d26e124"><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 class="anchor" id="ga57e16d6184f66ccd429fd55ab8f7c2dc"></a>
<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;::type::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 class="anchor" id="gaa0a37f39887c48fb3bda2af85cd3cb0c"></a>
<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;::type::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 class="anchor" id="ga23d8dd4e2f580722b0d57d2c1e601f0a"></a>
<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;, is_read_supported&lt; typename get_pixel_type&lt; typename Image::view_t &gt;::type, typename Reader::format_tag_t &gt; &gt;::type::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 class="anchor" id="ga60411bac48a3f632e3f2d9857eede9de"></a>
<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;::type::value &gt;::type *&#160;</td>
<td class="paramname"> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> -&gt; typename get_reader_backend&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 class="anchor" id="ga9728eeef0a75c0c06ea4ef6cb6e82e33"></a>
<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 is_read_supported&lt; typename get_pixel_type&lt; View &gt;::type, typename Reader::format_tag_t &gt;::type &gt;::type::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 on Thu Mar 14 2019 10:20:30 for Generic Image Library by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.6
</small>
</address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink