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

208 lines
9.6 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: reader_base&lt; FormatTag, ConversionPolicy &gt; Struct Template Reference</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1reader__base.html">reader_base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="structboost_1_1gil_1_1reader__base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">reader_base&lt; FormatTag, ConversionPolicy &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="reader__base_8hpp_source.html">reader_base.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab7d83e196429f1866b5116097463791b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#ab7d83e196429f1866b5116097463791b">reader_base</a> ()</td></tr>
<tr class="separator:ab7d83e196429f1866b5116097463791b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d4a087855cec43f12ec8dfa8447f9ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#a5d4a087855cec43f12ec8dfa8447f9ae">reader_base</a> (const ConversionPolicy &amp;cc)</td></tr>
<tr class="separator:a5d4a087855cec43f12ec8dfa8447f9ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memTemplParams" colspan="2">template&lt;typename Image &gt; </td></tr>
<tr class="memitem:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structboost_1_1gil_1_1reader__base.html#a74c187b2eea93fb74ecaa0d5848b595e">init_image</a> (Image &amp;img, const image_read_settings&lt; FormatTag &gt; &amp;settings)</td></tr>
<tr class="separator:a74c187b2eea93fb74ecaa0d5848b595e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca2c4379bd365e450b18260b2d1916d3"><td class="memTemplParams" colspan="2"><a id="aca2c4379bd365e450b18260b2d1916d3"></a>
template&lt;typename View &gt; </td></tr>
<tr class="memitem:aca2c4379bd365e450b18260b2d1916d3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>init_view</b> (const View &amp;view, const image_read_settings&lt; FormatTag &gt; &amp;)</td></tr>
<tr class="separator:aca2c4379bd365e450b18260b2d1916d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af41bac8cb5ef4e50adcaa8ca022a92d9"><td class="memItemLeft" align="right" valign="top"><a id="af41bac8cb5ef4e50adcaa8ca022a92d9"></a>
ConversionPolicy&#160;</td><td class="memItemRight" valign="bottom"><b>_cc_policy</b></td></tr>
<tr class="separator:af41bac8cb5ef4e50adcaa8ca022a92d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename FormatTag, typename ConversionPolicy&gt;<br />
struct boost::gil::reader_base&lt; FormatTag, ConversionPolicy &gt;</h3>
<p>Reader Base Class</p>
<p>It provides some basic functionality which is shared for all readers. For instance, it recreates images when necessary. It checks whether user supplied coordinates are valid.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">FormatTag</td><td>A format tag, like jpeg_tag. </td></tr>
<tr><td class="paramname">ConversionPolicy</td><td>Conversion policy, see coversion_policies.hpp. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab7d83e196429f1866b5116097463791b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7d83e196429f1866b5116097463791b">&#9670;&nbsp;</a></span>reader_base() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structboost_1_1gil_1_1reader__base.html">reader_base</a> </td>
<td>(</td>
<td class="paramname"></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>Default Constructor </p>
</div>
</div>
<a id="a5d4a087855cec43f12ec8dfa8447f9ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d4a087855cec43f12ec8dfa8447f9ae">&#9670;&nbsp;</a></span>reader_base() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structboost_1_1gil_1_1reader__base.html">reader_base</a> </td>
<td>(</td>
<td class="paramtype">const ConversionPolicy &amp;&#160;</td>
<td class="paramname"><em>cc</em></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>Constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a74c187b2eea93fb74ecaa0d5848b595e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74c187b2eea93fb74ecaa0d5848b595e">&#9670;&nbsp;</a></span>init_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void init_image </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">const image_read_settings&lt; FormatTag &gt; &amp;&#160;</td>
<td class="paramname"><em>settings</em>&#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>Initializes an image. But also does some check ups.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Image</td><td>Image which implements boost::gil's <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept ">ImageConcept</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">img</td><td>The image. </td></tr>
<tr><td class="paramname">info</td><td>The image read info. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="reader__base_8hpp_source.html">reader_base.hpp</a></li>
</ul>
</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