documentation/classarm__compute_1_1_i_c_l_multi_image.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.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: ICLMultiImage 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="navtreedata.js"></script>
  16 <script type="text/javascript" src="navtree.js"></script>
  17 <script type="text/javascript">
  18   $(document).ready(initResizable);
  19   $(window).load(resizeHeight);
  20 </script>
  21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22 <script type="text/javascript" src="search/searchdata.js"></script>
  23 <script type="text/javascript" src="search/search.js"></script>
  24 <script type="text/javascript">
  25   $(document).ready(function() { init_search(); });
  26 </script>
  27 <script type="text/x-mathjax-config">
  28   MathJax.Hub.Config({
  29     extensions: ["tex2jax.js"],
  30     jax: ["input/TeX","output/HTML-CSS"],
  31 });
  32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  34 </head>
  35 <body>
  36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  37 <div id="titlearea">
  38 <table cellspacing="0" cellpadding="0">
  39  <tbody>
  40  <tr style="height: 56px;">
  41   <td style="padding-left: 0.5em;">
  42    <div id="projectname">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_c_l_multi_image.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">ICLMultiImage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Interface for OpenCL multi-planar images.
 126  <a href="classarm__compute_1_1_i_c_l_multi_image.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for ICLMultiImage:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_multi_image__coll__graph.svg" width="122" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">cl_plane</a> (unsigned int index)=0</td></tr>
 139 <tr class="memdesc:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the requested OpenCL plane of the image.  <a href="#ad6273d4c4587f7956d48f2ea356a5c9b">More...</a><br /></td></tr>
 140 <tr class="separator:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a3188cda5497ec91ce0839d7a2f14d578"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#a3188cda5497ec91ce0839d7a2f14d578">cl_plane</a> (unsigned int index) const =0</td></tr>
 142 <tr class="memdesc:a3188cda5497ec91ce0839d7a2f14d578"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant pointer to the requested OpenCL plane of the image.  <a href="#a3188cda5497ec91ce0839d7a2f14d578">More...</a><br /></td></tr>
 143 <tr class="separator:a3188cda5497ec91ce0839d7a2f14d578"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a1a074b1525a405db59cba015b89f23a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#a1a074b1525a405db59cba015b89f23a1">plane</a> (unsigned int index) override</td></tr>
 145 <tr class="memdesc:a1a074b1525a405db59cba015b89f23a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the requested plane of the image.  <a href="#a1a074b1525a405db59cba015b89f23a1">More...</a><br /></td></tr>
 146 <tr class="separator:a1a074b1525a405db59cba015b89f23a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ad136a4299cb6e978ab975fe4a4691fba"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad136a4299cb6e978ab975fe4a4691fba">plane</a> (unsigned int index) const override</td></tr>
 148 <tr class="memdesc:ad136a4299cb6e978ab975fe4a4691fba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant pointer to the requested plane of the image.  <a href="#ad136a4299cb6e978ab975fe4a4691fba">More...</a><br /></td></tr>
 149 <tr class="separator:ad136a4299cb6e978ab975fe4a4691fba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_multi_image"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_multi_image')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml">IMultiImage</a></td></tr>
 151 <tr class="memitem:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a52c8ee0f7ff87c20c213bf2860729ea0">~IMultiImage</a> ()=default</td></tr>
 152 <tr class="memdesc:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a52c8ee0f7ff87c20c213bf2860729ea0">More...</a><br /></td></tr>
 153 <tr class="separator:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a38261214e277cba5b90dd1ffe31170e0">info</a> () const =0</td></tr>
 155 <tr class="memdesc:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return the multi-planar image's metadata.  <a href="#a38261214e277cba5b90dd1ffe31170e0">More...</a><br /></td></tr>
 156 <tr class="separator:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 </table>
 158 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 159 <div class="textblock"><p>Interface for OpenCL multi-planar images. </p>
 160
 161 <p>Definition at line <a class="el" href="_i_c_l_multi_image_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a>.</p>
 162 </div><h2 class="groupheader">Member Function Documentation</h2>
 163 <a class="anchor" id="ad6273d4c4587f7956d48f2ea356a5c9b"></a>
 164 <div class="memitem">
 165 <div class="memproto">
 166 <table class="mlabels">
 167   <tr>
 168   <td class="mlabels-left">
 169       <table class="memname">
 170         <tr>
 171           <td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
 172           <td>(</td>
 173           <td class="paramtype">unsigned int&#160;</td>
 174           <td class="paramname"><em>index</em></td><td>)</td>
 175           <td></td>
 176         </tr>
 177       </table>
 178   </td>
 179   <td class="mlabels-right">
 180 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 181   </tr>
 182 </table>
 183 </div><div class="memdoc">
 184
 185 <p>Return a pointer to the requested OpenCL plane of the image. </p>
 186 <dl class="params"><dt>Parameters</dt><dd>
 187   <table class="params">
 188     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
 189   </table>
 190   </dd>
 191 </dl>
 192 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the OpenCL plane </dd></dl>
 193
 194 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a0d104ade841ef3aa9b0783b25836ea19">CLMultiImage</a>.</p>
 195
 196 </div>
 197 </div>
 198 <a class="anchor" id="a3188cda5497ec91ce0839d7a2f14d578"></a>
 199 <div class="memitem">
 200 <div class="memproto">
 201 <table class="mlabels">
 202   <tr>
 203   <td class="mlabels-left">
 204       <table class="memname">
 205         <tr>
 206           <td class="memname">virtual const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
 207           <td>(</td>
 208           <td class="paramtype">unsigned int&#160;</td>
 209           <td class="paramname"><em>index</em></td><td>)</td>
 210           <td> const</td>
 211         </tr>
 212       </table>
 213   </td>
 214   <td class="mlabels-right">
 215 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 216   </tr>
 217 </table>
 218 </div><div class="memdoc">
 219
 220 <p>Return a constant pointer to the requested OpenCL plane of the image. </p>
 221 <dl class="params"><dt>Parameters</dt><dd>
 222   <table class="params">
 223     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
 224   </table>
 225   </dd>
 226 </dl>
 227 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the OpenCL plane </dd></dl>
 228
 229 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#aa6e80644cacd12488fbd8ce1125f72aa">CLMultiImage</a>.</p>
 230
 231 </div>
 232 </div>
 233 <a class="anchor" id="a1a074b1525a405db59cba015b89f23a1"></a>
 234 <div class="memitem">
 235 <div class="memproto">
 236 <table class="mlabels">
 237   <tr>
 238   <td class="mlabels-left">
 239       <table class="memname">
 240         <tr>
 241           <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a>* plane </td>
 242           <td>(</td>
 243           <td class="paramtype">unsigned int&#160;</td>
 244           <td class="paramname"><em>index</em></td><td>)</td>
 245           <td></td>
 246         </tr>
 247       </table>
 248   </td>
 249   <td class="mlabels-right">
 250 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 251   </tr>
 252 </table>
 253 </div><div class="memdoc">
 254
 255 <p>Return a pointer to the requested plane of the image. </p>
 256 <dl class="params"><dt>Parameters</dt><dd>
 257   <table class="params">
 258     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
 259   </table>
 260   </dd>
 261 </dl>
 262 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the plane </dd></dl>
 263
 264 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a84ad04ee4d2efc59632a3224d7a813b3">IMultiImage</a>.</p>
 265
 266 </div>
 267 </div>
 268 <a class="anchor" id="ad136a4299cb6e978ab975fe4a4691fba"></a>
 269 <div class="memitem">
 270 <div class="memproto">
 271 <table class="mlabels">
 272   <tr>
 273   <td class="mlabels-left">
 274       <table class="memname">
 275         <tr>
 276           <td class="memname">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a>* plane </td>
 277           <td>(</td>
 278           <td class="paramtype">unsigned int&#160;</td>
 279           <td class="paramname"><em>index</em></td><td>)</td>
 280           <td> const</td>
 281         </tr>
 282       </table>
 283   </td>
 284   <td class="mlabels-right">
 285 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 286   </tr>
 287 </table>
 288 </div><div class="memdoc">
 289
 290 <p>Return a constant pointer to the requested plane of the image. </p>
 291 <dl class="params"><dt>Parameters</dt><dd>
 292   <table class="params">
 293     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
 294   </table>
 295   </dd>
 296 </dl>
 297 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the plane </dd></dl>
 298
 299 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a18bc117545eec0b9d0d502286d1afd62">IMultiImage</a>.</p>
 300
 301 </div>
 302 </div>
 303 <hr/>The documentation for this class was generated from the following file:<ul>
 304 <li>arm_compute/core/CL/<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a></li>
 305 </ul>
 306 </div><!-- contents -->
 307 </div><!-- doc-content -->
 308 <!-- start footer part -->
 309 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 310   <ul>
 311     <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_i_c_l_multi_image.xhtml">ICLMultiImage</a></li>
 312     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
 313     <a href="http://www.doxygen.org/index.html">
 314     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 315   </ul>
 316 </div>
 317 </body>
 318 </html>