classboost_1_1gil_1_1any__image.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  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: any_image&lt; Images &gt; Class Template Reference</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 id="nav-path" class="navpath">
  41. <ul>
  42. <li class="navelem"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a></li> </ul>
  43. </div>
  44. </div><!-- top -->
  45. <div class="header">
  46. <div class="summary">
  47. <a href="#pub-types">Public Types</a> &#124;
  48. <a href="#pub-methods">Public Member Functions</a> &#124;
  49. <a href="classboost_1_1gil_1_1any__image-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">any_image&lt; Images &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___image.html">Image</a> &raquo; <a class="el" href="group___image_model.html">Models</a></div></div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Represents a run-time specified image. Note it does NOT model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>.
  55. <a href="classboost_1_1gil_1_1any__image.html#details">More...</a></p>
  56. <p><code>#include &lt;<a class="el" href="any__image_8hpp_source.html">any_image.hpp</a>&gt;</code></p>
  57. <p>Inherits type&lt; Images &gt;.</p>
  58. <table class="memberdecls">
  59. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  60. Public Types</h2></td></tr>
  61. <tr class="memitem:aa5b7e5ecbb766bc33411683b334f471b"><td class="memItemLeft" align="right" valign="top"><a id="aa5b7e5ecbb766bc33411683b334f471b"></a>
  62. using&#160;</td><td class="memItemRight" valign="bottom"><b>view_t</b> = <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; detail::images_get_views_t&lt; Images &gt; &gt;</td></tr>
  63. <tr class="separator:aa5b7e5ecbb766bc33411683b334f471b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ae708c7e232a3ee4d89aecb744dfdcf26"><td class="memItemLeft" align="right" valign="top"><a id="ae708c7e232a3ee4d89aecb744dfdcf26"></a>
  65. using&#160;</td><td class="memItemRight" valign="bottom"><b>const_view_t</b> = <a class="el" href="classboost_1_1gil_1_1any__image__view.html">any_image_view</a>&lt; detail::images_get_const_views_t&lt; Images &gt; &gt;</td></tr>
  66. <tr class="separator:ae708c7e232a3ee4d89aecb744dfdcf26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memItemLeft" align="right" valign="top"><a id="a2f1a92adcae3b10cbad7fe560a94d1b1"></a>
  68. using&#160;</td><td class="memItemRight" valign="bottom"><b>x_coord_t</b> = std::ptrdiff_t</td></tr>
  69. <tr class="separator:a2f1a92adcae3b10cbad7fe560a94d1b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a13938895b1e20b12d10f76329d47dc4a"><td class="memItemLeft" align="right" valign="top"><a id="a13938895b1e20b12d10f76329d47dc4a"></a>
  71. using&#160;</td><td class="memItemRight" valign="bottom"><b>y_coord_t</b> = std::ptrdiff_t</td></tr>
  72. <tr class="separator:a13938895b1e20b12d10f76329d47dc4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:addc40a18340d115ea17a7ab120debe08"><td class="memItemLeft" align="right" valign="top"><a id="addc40a18340d115ea17a7ab120debe08"></a>
  74. using&#160;</td><td class="memItemRight" valign="bottom"><b>point_t</b> = <a class="el" href="classboost_1_1gil_1_1point.html">point</a>&lt; std::ptrdiff_t &gt;</td></tr>
  75. <tr class="separator:addc40a18340d115ea17a7ab120debe08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:a501be2950a656e5774d0eb5ebd88b7e0"><td class="memItemLeft" align="right" valign="top"><a id="a501be2950a656e5774d0eb5ebd88b7e0"></a>
  80. &#160;</td><td class="memItemRight" valign="bottom"><b>any_image</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> const &amp;img)</td></tr>
  81. <tr class="separator:a501be2950a656e5774d0eb5ebd88b7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a0f81201cd238bc60c4107826bc72b405"><td class="memTemplParams" colspan="2"><a id="a0f81201cd238bc60c4107826bc72b405"></a>
  83. template&lt;typename Image &gt; </td></tr>
  84. <tr class="memitem:a0f81201cd238bc60c4107826bc72b405"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (Image const &amp;img)</td></tr>
  85. <tr class="separator:a0f81201cd238bc60c4107826bc72b405"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memTemplParams" colspan="2"><a id="a6adb3b7be63a7e1e99f41c5d27b3017a"></a>
  87. template&lt;typename Image &gt; </td></tr>
  88. <tr class="memitem:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (Image &amp;img, bool do_swap)</td></tr>
  89. <tr class="separator:a6adb3b7be63a7e1e99f41c5d27b3017a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a32308751fc5e34ccfc42b368bbf86c73"><td class="memTemplParams" colspan="2"><a id="a32308751fc5e34ccfc42b368bbf86c73"></a>
  91. template&lt;typename OtherImages &gt; </td></tr>
  92. <tr class="memitem:a32308751fc5e34ccfc42b368bbf86c73"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><b>any_image</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; OtherImages &gt; const &amp;img)</td></tr>
  93. <tr class="separator:a32308751fc5e34ccfc42b368bbf86c73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:aba2e458291892f9f796c00582a2facaf"><td class="memItemLeft" align="right" valign="top"><a id="aba2e458291892f9f796c00582a2facaf"></a>
  95. <a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> const &amp;img)</td></tr>
  96. <tr class="separator:aba2e458291892f9f796c00582a2facaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memTemplParams" colspan="2"><a id="aa1d6ed6e77e895e39fd9bc37f34e7902"></a>
  98. template&lt;typename Image &gt; </td></tr>
  99. <tr class="memitem:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (Image const &amp;img)</td></tr>
  100. <tr class="separator:aa1d6ed6e77e895e39fd9bc37f34e7902"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a31ee6077b443a1eb297792d7dea83e7f"><td class="memTemplParams" colspan="2"><a id="a31ee6077b443a1eb297792d7dea83e7f"></a>
  102. template&lt;typename OtherImages &gt; </td></tr>
  103. <tr class="memitem:a31ee6077b443a1eb297792d7dea83e7f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classboost_1_1gil_1_1any__image.html">any_image</a>&lt; OtherImages &gt; const &amp;img)</td></tr>
  104. <tr class="separator:a31ee6077b443a1eb297792d7dea83e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a7625c48852788be3463d7320b5ea50e5"><td class="memItemLeft" align="right" valign="top"><a id="a7625c48852788be3463d7320b5ea50e5"></a>
  106. void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (const <a class="el" href="classboost_1_1gil_1_1point.html">point_t</a> &amp;dims, unsigned alignment=1)</td></tr>
  107. <tr class="separator:a7625c48852788be3463d7320b5ea50e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a31a2d04ff9175ac5ddc7a82cde18d8c2"><td class="memItemLeft" align="right" valign="top"><a id="a31a2d04ff9175ac5ddc7a82cde18d8c2"></a>
  109. void&#160;</td><td class="memItemRight" valign="bottom"><b>recreate</b> (x_coord_t width, y_coord_t height, unsigned alignment=1)</td></tr>
  110. <tr class="separator:a31a2d04ff9175ac5ddc7a82cde18d8c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memItemLeft" align="right" valign="top"><a id="a01929e1ce958f3b0258d24a6cfe90bee"></a>
  112. std::size_t&#160;</td><td class="memItemRight" valign="bottom"><b>num_channels</b> () const</td></tr>
  113. <tr class="separator:a01929e1ce958f3b0258d24a6cfe90bee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ae8ab598c540ffef16daf364f7aa87c21"><td class="memItemLeft" align="right" valign="top"><a id="ae8ab598c540ffef16daf364f7aa87c21"></a>
  115. <a class="el" href="classboost_1_1gil_1_1point.html">point_t</a>&#160;</td><td class="memItemRight" valign="bottom"><b>dimensions</b> () const</td></tr>
  116. <tr class="separator:ae8ab598c540ffef16daf364f7aa87c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:add9c490d2545adf2d1f85b84958c167c"><td class="memItemLeft" align="right" valign="top"><a id="add9c490d2545adf2d1f85b84958c167c"></a>
  118. x_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>width</b> () const</td></tr>
  119. <tr class="separator:add9c490d2545adf2d1f85b84958c167c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memItemLeft" align="right" valign="top"><a id="a7dd7e3c9d94dc1ab42b6d04b39ab1201"></a>
  121. y_coord_t&#160;</td><td class="memItemRight" valign="bottom"><b>height</b> () const</td></tr>
  122. <tr class="separator:a7dd7e3c9d94dc1ab42b6d04b39ab1201"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. </table>
  124. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  125. <div class="textblock"><h3>template&lt;typename Images&gt;<br />
  126. class boost::gil::any_image&lt; Images &gt;</h3>
  127. <p>Represents a run-time specified image. Note it does NOT model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>. </p>
  128. <p>Represents an image whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of <code>image</code>. Some of the requirements of <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>, such as the <code>value_type</code> alias cannot be fulfilled, since the language does not allow runtime type specification. Other requirements, such as access to the pixels, would be inefficient to provide. Thus <code><a class="el" href="classboost_1_1gil_1_1any__image.html" title="Represents a run-time specified image. Note it does NOT model ImageConcept.">any_image</a></code> does not fully model <a class="el" href="structboost_1_1gil_1_1_image_concept.html" title="2-dimensional image whose value type models PixelValueConcept">ImageConcept</a>. In particular, its <code>view</code> and <code>const_view</code> methods return <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code>, which does not fully model <a class="el" href="structboost_1_1gil_1_1_image_view_concept.html" title="GIL&#39;s 2-dimensional view over immutable GIL pixels.">ImageViewConcept</a>. See <code><a class="el" href="classboost_1_1gil_1_1any__image__view.html" title="Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeCon...">any_image_view</a></code> for more. </p>
  129. </div><hr/>The documentation for this class was generated from the following file:<ul>
  130. <li><a class="el" href="any__image_8hpp_source.html">any_image.hpp</a></li>
  131. </ul>
  132. </div><!-- contents -->
  133. <!-- HTML footer for doxygen 1.8.13-->
  134. <!-- start footer part -->
  135. <hr class="footer"/>
  136. <address class="footer">
  137. <small>
  138. Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  139. </small>
  140. </address>
  141. </body>
  142. </html>