documentation/classarm__compute_1_1_multi_image_info.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: MultiImageInfo Class 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="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.10</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_multi_image_info.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">MultiImageInfo Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Store the multi-planar image's metadata.
 124  <a href="classarm__compute_1_1_multi_image_info.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a>&gt;</code></p>
 127 <table class="memberdecls">
 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 129 Public Member Functions</h2></td></tr>
 130 <tr class="memitem:a335d0038f37278ee9adc798b2efa7775"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a335d0038f37278ee9adc798b2efa7775">MultiImageInfo</a> ()</td></tr>
 131 <tr class="memdesc:a335d0038f37278ee9adc798b2efa7775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a335d0038f37278ee9adc798b2efa7775">More...</a><br/></td></tr>
 132 <tr class="separator:a335d0038f37278ee9adc798b2efa7775"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a7453bdfcb39e068357022f0861e59637"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7453bdfcb39e068357022f0861e59637">init</a> (unsigned int <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7b736ec9a05be5c498760d35a0406ed3">width</a>, unsigned int <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#aa420a28166e708e3f8b9ecc8e527fc09">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a>)</td></tr>
 134 <tr class="memdesc:a7453bdfcb39e068357022f0861e59637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the metadata structure with the given parameters.  <a href="#a7453bdfcb39e068357022f0861e59637">More...</a><br/></td></tr>
 135 <tr class="separator:a7453bdfcb39e068357022f0861e59637"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:a0c875a3203d902e2ad6bc3045355e69e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a0c875a3203d902e2ad6bc3045355e69e">format</a> () const </td></tr>
 137 <tr class="memdesc:a0c875a3203d902e2ad6bc3045355e69e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Colour format of the image.  <a href="#a0c875a3203d902e2ad6bc3045355e69e">More...</a><br/></td></tr>
 138 <tr class="separator:a0c875a3203d902e2ad6bc3045355e69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a7b736ec9a05be5c498760d35a0406ed3"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7b736ec9a05be5c498760d35a0406ed3">width</a> () const </td></tr>
 140 <tr class="memdesc:a7b736ec9a05be5c498760d35a0406ed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width in pixels.  <a href="#a7b736ec9a05be5c498760d35a0406ed3">More...</a><br/></td></tr>
 141 <tr class="separator:a7b736ec9a05be5c498760d35a0406ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:aa420a28166e708e3f8b9ecc8e527fc09"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#aa420a28166e708e3f8b9ecc8e527fc09">height</a> () const </td></tr>
 143 <tr class="memdesc:aa420a28166e708e3f8b9ecc8e527fc09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Height in pixels.  <a href="#aa420a28166e708e3f8b9ecc8e527fc09">More...</a><br/></td></tr>
 144 <tr class="separator:aa420a28166e708e3f8b9ecc8e527fc09"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 </table>
 146 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 147 <div class="textblock"><p>Store the multi-planar image's metadata. </p>
 148
 149 <p>Definition at line <a class="el" href="_multi_image_info_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a>.</p>
 150 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 151 <a class="anchor" id="a335d0038f37278ee9adc798b2efa7775"></a>
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a> </td>
 157           <td>(</td>
 158           <td class="paramname"></td><td>)</td>
 159           <td></td>
 160         </tr>
 161       </table>
 162 </div><div class="memdoc">
 163
 164 <p>Constructor. </p>
 165
 166 </div>
 167 </div>
 168 <h2 class="groupheader">Member Function Documentation</h2>
 169 <a class="anchor" id="a0c875a3203d902e2ad6bc3045355e69e"></a>
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> format </td>
 175           <td>(</td>
 176           <td class="paramname"></td><td>)</td>
 177           <td> const</td>
 178         </tr>
 179       </table>
 180 </div><div class="memdoc">
 181
 182 <p>Colour format of the image. </p>
 183 <dl class="section return"><dt>Returns</dt><dd>Colour format of the image </dd></dl>
 184
 185 </div>
 186 </div>
 187 <a class="anchor" id="aa420a28166e708e3f8b9ecc8e527fc09"></a>
 188 <div class="memitem">
 189 <div class="memproto">
 190       <table class="memname">
 191         <tr>
 192           <td class="memname">unsigned int height </td>
 193           <td>(</td>
 194           <td class="paramname"></td><td>)</td>
 195           <td> const</td>
 196         </tr>
 197       </table>
 198 </div><div class="memdoc">
 199
 200 <p>Height in pixels. </p>
 201 <dl class="section return"><dt>Returns</dt><dd>The height in pixels </dd></dl>
 202
 203 </div>
 204 </div>
 205 <a class="anchor" id="a7453bdfcb39e068357022f0861e59637"></a>
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">void init </td>
 211           <td>(</td>
 212           <td class="paramtype">unsigned int&#160;</td>
 213           <td class="paramname"><em>width</em>, </td>
 214         </tr>
 215         <tr>
 216           <td class="paramkey"></td>
 217           <td></td>
 218           <td class="paramtype">unsigned int&#160;</td>
 219           <td class="paramname"><em>height</em>, </td>
 220         </tr>
 221         <tr>
 222           <td class="paramkey"></td>
 223           <td></td>
 224           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
 225           <td class="paramname"><em>format</em>&#160;</td>
 226         </tr>
 227         <tr>
 228           <td></td>
 229           <td>)</td>
 230           <td></td><td></td>
 231         </tr>
 232       </table>
 233 </div><div class="memdoc">
 234
 235 <p>Initialize the metadata structure with the given parameters. </p>
 236 <dl class="params"><dt>Parameters</dt><dd>
 237   <table class="params">
 238     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the image (in number of pixels) </td></tr>
 239     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of the image (in number of pixels) </td></tr>
 240     <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Colour format of the image. </td></tr>
 241   </table>
 242   </dd>
 243 </dl>
 244
 245 </div>
 246 </div>
 247 <a class="anchor" id="a7b736ec9a05be5c498760d35a0406ed3"></a>
 248 <div class="memitem">
 249 <div class="memproto">
 250       <table class="memname">
 251         <tr>
 252           <td class="memname">unsigned int width </td>
 253           <td>(</td>
 254           <td class="paramname"></td><td>)</td>
 255           <td> const</td>
 256         </tr>
 257       </table>
 258 </div><div class="memdoc">
 259
 260 <p>Width in pixels. </p>
 261 <dl class="section return"><dt>Returns</dt><dd>The width in pixels </dd></dl>
 262
 263 </div>
 264 </div>
 265 <hr/>The documentation for this class was generated from the following file:<ul>
 266 <li>arm_compute/core/<a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a></li>
 267 </ul>
 268 </div><!-- contents -->
 269 </div><!-- doc-content -->
 270 <!-- start footer part -->
 271 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 272   <ul>
 273     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a></li>
 274     <li class="footer">Generated on Thu Oct 12 2017 14:26:37 for Compute Library by
 275     <a href="http://www.doxygen.org/index.html">
 276     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 277   </ul>
 278 </div>
 279 </body>
 280 </html>