documentation/classarm__compute_1_1_i_c_l_memory_region.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: ICLMemoryRegion 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_memory_region.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">ICLMemoryRegion Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>OpenCL memory region interface.
 126  <a href="classarm__compute_1_1_i_c_l_memory_region.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_c_l_memory_region_8h_source.xhtml">CLMemoryRegion.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for ICLMemoryRegion:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_memory_region__coll__graph.svg" width="146" 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:a7cdcf7d89e4815422fcb3843e4ffbb4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a7cdcf7d89e4815422fcb3843e4ffbb4b">ICLMemoryRegion</a> (cl::Context ctx, size_t <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a>)</td></tr>
 139 <tr class="memdesc:a7cdcf7d89e4815422fcb3843e4ffbb4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7cdcf7d89e4815422fcb3843e4ffbb4b">More...</a><br /></td></tr>
 140 <tr class="separator:a7cdcf7d89e4815422fcb3843e4ffbb4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a04ae87317614a2332dea02ad30eaced5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a04ae87317614a2332dea02ad30eaced5">~ICLMemoryRegion</a> ()=default</td></tr>
 142 <tr class="memdesc:a04ae87317614a2332dea02ad30eaced5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Destructor.  <a href="#a04ae87317614a2332dea02ad30eaced5">More...</a><br /></td></tr>
 143 <tr class="separator:a04ae87317614a2332dea02ad30eaced5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:af1759d36be2abbe1002a68ddc2255fad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#af1759d36be2abbe1002a68ddc2255fad">ICLMemoryRegion</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;)=delete</td></tr>
 145 <tr class="memdesc:af1759d36be2abbe1002a68ddc2255fad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#af1759d36be2abbe1002a68ddc2255fad">More...</a><br /></td></tr>
 146 <tr class="separator:af1759d36be2abbe1002a68ddc2255fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a4e5aaebd133c159b70f757d6ba7c4dc5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a4e5aaebd133c159b70f757d6ba7c4dc5">ICLMemoryRegion</a> (<a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&amp;)=default</td></tr>
 148 <tr class="memdesc:a4e5aaebd133c159b70f757d6ba7c4dc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move constructor.  <a href="#a4e5aaebd133c159b70f757d6ba7c4dc5">More...</a><br /></td></tr>
 149 <tr class="separator:a4e5aaebd133c159b70f757d6ba7c4dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:aba791ecf7c921e9a1c8d84baa7dd270e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#aba791ecf7c921e9a1c8d84baa7dd270e">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;)=delete</td></tr>
 151 <tr class="memdesc:aba791ecf7c921e9a1c8d84baa7dd270e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#aba791ecf7c921e9a1c8d84baa7dd270e">More...</a><br /></td></tr>
 152 <tr class="separator:aba791ecf7c921e9a1c8d84baa7dd270e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:ad09657054c2f981a19b9ac7e4b95bd30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#ad09657054c2f981a19b9ac7e4b95bd30">operator=</a> (<a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&amp;)=default</td></tr>
 154 <tr class="memdesc:ad09657054c2f981a19b9ac7e4b95bd30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator.  <a href="#ad09657054c2f981a19b9ac7e4b95bd30">More...</a><br /></td></tr>
 155 <tr class="separator:ad09657054c2f981a19b9ac7e4b95bd30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a7f4714c4a9320d1760102ef78a984241"><td class="memItemLeft" align="right" valign="top">const cl::Buffer &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a7f4714c4a9320d1760102ef78a984241">cl_data</a> () const </td></tr>
 157 <tr class="memdesc:a7f4714c4a9320d1760102ef78a984241"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the underlying CL buffer.  <a href="#a7f4714c4a9320d1760102ef78a984241">More...</a><br /></td></tr>
 158 <tr class="separator:a7f4714c4a9320d1760102ef78a984241"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:ab8777d03065e8c7146157148a5355dd1"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#ab8777d03065e8c7146157148a5355dd1">ptr</a> ()=0</td></tr>
 160 <tr class="memdesc:ab8777d03065e8c7146157148a5355dd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Host/SVM pointer accessor.  <a href="#ab8777d03065e8c7146157148a5355dd1">More...</a><br /></td></tr>
 161 <tr class="separator:ab8777d03065e8c7146157148a5355dd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <tr class="memitem:a929af627a6a0430539998d12024d6c69"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a929af627a6a0430539998d12024d6c69">map</a> (cl::CommandQueue &amp;q, bool blocking)=0</td></tr>
 163 <tr class="memdesc:a929af627a6a0430539998d12024d6c69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer on the given queue.  <a href="#a929af627a6a0430539998d12024d6c69">More...</a><br /></td></tr>
 164 <tr class="separator:a929af627a6a0430539998d12024d6c69"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:a0ee6b952accaff0f7e8e61bda7889102"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a0ee6b952accaff0f7e8e61bda7889102">unmap</a> (cl::CommandQueue &amp;q)=0</td></tr>
 166 <tr class="memdesc:a0ee6b952accaff0f7e8e61bda7889102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated buffer on the given queue.  <a href="#a0ee6b952accaff0f7e8e61bda7889102">More...</a><br /></td></tr>
 167 <tr class="separator:a0ee6b952accaff0f7e8e61bda7889102"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:ad477d98361ee9ca6858819b772423bc4"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#ad477d98361ee9ca6858819b772423bc4">buffer</a> () override</td></tr>
 169 <tr class="memdesc:ad477d98361ee9ca6858819b772423bc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the pointer to the allocated data.  <a href="#ad477d98361ee9ca6858819b772423bc4">More...</a><br /></td></tr>
 170 <tr class="separator:ad477d98361ee9ca6858819b772423bc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:aefe8db4d79cd87ccb3d6ac55e25594aa"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#aefe8db4d79cd87ccb3d6ac55e25594aa">buffer</a> () const override</td></tr>
 172 <tr class="memdesc:aefe8db4d79cd87ccb3d6ac55e25594aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the pointer to the allocated data.  <a href="#aefe8db4d79cd87ccb3d6ac55e25594aa">More...</a><br /></td></tr>
 173 <tr class="separator:aefe8db4d79cd87ccb3d6ac55e25594aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a0942fe2d17942077bc9c6706b8a3cc3a"><td class="memItemLeft" align="right" valign="top">void **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml#a0942fe2d17942077bc9c6706b8a3cc3a">handle</a> () override</td></tr>
 175 <tr class="memdesc:a0942fe2d17942077bc9c6706b8a3cc3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle of internal memory.  <a href="#a0942fe2d17942077bc9c6706b8a3cc3a">More...</a><br /></td></tr>
 176 <tr class="separator:a0942fe2d17942077bc9c6706b8a3cc3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_memory_region"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_memory_region')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a></td></tr>
 178 <tr class="memitem:a92ee6f66a47e8ba4bd3d01579ad4ef42 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a92ee6f66a47e8ba4bd3d01579ad4ef42">IMemoryRegion</a> (size_t <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a>)</td></tr>
 179 <tr class="memdesc:a92ee6f66a47e8ba4bd3d01579ad4ef42 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a92ee6f66a47e8ba4bd3d01579ad4ef42">More...</a><br /></td></tr>
 180 <tr class="separator:a92ee6f66a47e8ba4bd3d01579ad4ef42 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memSeparator" colspan="2">&#160;</td></tr>
 181 <tr class="memitem:aaa097212d2b66253335ff2dca6385b13 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#aaa097212d2b66253335ff2dca6385b13">~IMemoryRegion</a> ()=default</td></tr>
 182 <tr class="memdesc:aaa097212d2b66253335ff2dca6385b13 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual Destructor.  <a href="#aaa097212d2b66253335ff2dca6385b13">More...</a><br /></td></tr>
 183 <tr class="separator:aaa097212d2b66253335ff2dca6385b13 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memSeparator" colspan="2">&#160;</td></tr>
 184 <tr class="memitem:a0b6b70701c46e22849f0f363861351cd inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a> ()</td></tr>
 185 <tr class="memdesc:a0b6b70701c46e22849f0f363861351cd inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> region size accessor.  <a href="#a0b6b70701c46e22849f0f363861351cd">More...</a><br /></td></tr>
 186 <tr class="separator:a0b6b70701c46e22849f0f363861351cd inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memSeparator" colspan="2">&#160;</td></tr>
 187 <tr class="memitem:ab5c159b7d0cdca9f543019f4f47ec288 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#ab5c159b7d0cdca9f543019f4f47ec288">set_size</a> (size_t <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a>)</td></tr>
 188 <tr class="memdesc:ab5c159b7d0cdca9f543019f4f47ec288 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets size of region.  <a href="#ab5c159b7d0cdca9f543019f4f47ec288">More...</a><br /></td></tr>
 189 <tr class="separator:ab5c159b7d0cdca9f543019f4f47ec288 inherit pub_methods_classarm__compute_1_1_i_memory_region"><td class="memSeparator" colspan="2">&#160;</td></tr>
 190 </table>
 191 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 192 <div class="textblock"><p>OpenCL memory region interface. </p>
 193
 194 <p>Definition at line <a class="el" href="_c_l_memory_region_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_c_l_memory_region_8h_source.xhtml">CLMemoryRegion.h</a>.</p>
 195 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 196 <a class="anchor" id="a7cdcf7d89e4815422fcb3843e4ffbb4b"></a>
 197 <div class="memitem">
 198 <div class="memproto">
 199       <table class="memname">
 200         <tr>
 201           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> </td>
 202           <td>(</td>
 203           <td class="paramtype">cl::Context&#160;</td>
 204           <td class="paramname"><em>ctx</em>, </td>
 205         </tr>
 206         <tr>
 207           <td class="paramkey"></td>
 208           <td></td>
 209           <td class="paramtype">size_t&#160;</td>
 210           <td class="paramname"><em>size</em>&#160;</td>
 211         </tr>
 212         <tr>
 213           <td></td>
 214           <td>)</td>
 215           <td></td><td></td>
 216         </tr>
 217       </table>
 218 </div><div class="memdoc">
 219
 220 <p>Constructor. </p>
 221 <dl class="params"><dt>Parameters</dt><dd>
 222   <table class="params">
 223     <tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>OpenCL context </td></tr>
 224     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Region size </td></tr>
 225   </table>
 226   </dd>
 227 </dl>
 228
 229 </div>
 230 </div>
 231 <a class="anchor" id="a04ae87317614a2332dea02ad30eaced5"></a>
 232 <div class="memitem">
 233 <div class="memproto">
 234 <table class="mlabels">
 235   <tr>
 236   <td class="mlabels-left">
 237       <table class="memname">
 238         <tr>
 239           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> </td>
 240           <td>(</td>
 241           <td class="paramname"></td><td>)</td>
 242           <td></td>
 243         </tr>
 244       </table>
 245   </td>
 246   <td class="mlabels-right">
 247 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 248   </tr>
 249 </table>
 250 </div><div class="memdoc">
 251
 252 <p>Default Destructor. </p>
 253
 254 </div>
 255 </div>
 256 <a class="anchor" id="af1759d36be2abbe1002a68ddc2255fad"></a>
 257 <div class="memitem">
 258 <div class="memproto">
 259 <table class="mlabels">
 260   <tr>
 261   <td class="mlabels-left">
 262       <table class="memname">
 263         <tr>
 264           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> </td>
 265           <td>(</td>
 266           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&#160;</td>
 267           <td class="paramname"></td><td>)</td>
 268           <td></td>
 269         </tr>
 270       </table>
 271   </td>
 272   <td class="mlabels-right">
 273 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 274   </tr>
 275 </table>
 276 </div><div class="memdoc">
 277
 278 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 279
 280 </div>
 281 </div>
 282 <a class="anchor" id="a4e5aaebd133c159b70f757d6ba7c4dc5"></a>
 283 <div class="memitem">
 284 <div class="memproto">
 285 <table class="mlabels">
 286   <tr>
 287   <td class="mlabels-left">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> </td>
 291           <td>(</td>
 292           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&amp;&#160;</td>
 293           <td class="paramname"></td><td>)</td>
 294           <td></td>
 295         </tr>
 296       </table>
 297   </td>
 298   <td class="mlabels-right">
 299 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 300   </tr>
 301 </table>
 302 </div><div class="memdoc">
 303
 304 <p>Default move constructor. </p>
 305
 306 </div>
 307 </div>
 308 <h2 class="groupheader">Member Function Documentation</h2>
 309 <a class="anchor" id="ad477d98361ee9ca6858819b772423bc4"></a>
 310 <div class="memitem">
 311 <div class="memproto">
 312 <table class="mlabels">
 313   <tr>
 314   <td class="mlabels-left">
 315       <table class="memname">
 316         <tr>
 317           <td class="memname">void* buffer </td>
 318           <td>(</td>
 319           <td class="paramname"></td><td>)</td>
 320           <td></td>
 321         </tr>
 322       </table>
 323   </td>
 324   <td class="mlabels-right">
 325 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 326   </tr>
 327 </table>
 328 </div><div class="memdoc">
 329
 330 <p>Returns the pointer to the allocated data. </p>
 331 <dl class="section return"><dt>Returns</dt><dd>Pointer to the allocated data </dd></dl>
 332
 333 <p>Implements <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#af4cf95f81e1b269a31d2d9a7e0429a24">IMemoryRegion</a>.</p>
 334
 335 </div>
 336 </div>
 337 <a class="anchor" id="aefe8db4d79cd87ccb3d6ac55e25594aa"></a>
 338 <div class="memitem">
 339 <div class="memproto">
 340 <table class="mlabels">
 341   <tr>
 342   <td class="mlabels-left">
 343       <table class="memname">
 344         <tr>
 345           <td class="memname">void* buffer </td>
 346           <td>(</td>
 347           <td class="paramname"></td><td>)</td>
 348           <td> const</td>
 349         </tr>
 350       </table>
 351   </td>
 352   <td class="mlabels-right">
 353 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 354   </tr>
 355 </table>
 356 </div><div class="memdoc">
 357
 358 <p>Returns the pointer to the allocated data. </p>
 359 <dl class="section return"><dt>Returns</dt><dd>Pointer to the allocated data </dd></dl>
 360
 361 <p>Implements <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#aeb4cf01e5d74997a1994272225baeb05">IMemoryRegion</a>.</p>
 362
 363 </div>
 364 </div>
 365 <a class="anchor" id="a7f4714c4a9320d1760102ef78a984241"></a>
 366 <div class="memitem">
 367 <div class="memproto">
 368       <table class="memname">
 369         <tr>
 370           <td class="memname">const cl::Buffer&amp; cl_data </td>
 371           <td>(</td>
 372           <td class="paramname"></td><td>)</td>
 373           <td> const</td>
 374         </tr>
 375       </table>
 376 </div><div class="memdoc">
 377
 378 <p>Returns the underlying CL buffer. </p>
 379 <dl class="section return"><dt>Returns</dt><dd>CL memory buffer object </dd></dl>
 380
 381 </div>
 382 </div>
 383 <a class="anchor" id="a0942fe2d17942077bc9c6706b8a3cc3a"></a>
 384 <div class="memitem">
 385 <div class="memproto">
 386 <table class="mlabels">
 387   <tr>
 388   <td class="mlabels-left">
 389       <table class="memname">
 390         <tr>
 391           <td class="memname">void** handle </td>
 392           <td>(</td>
 393           <td class="paramname"></td><td>)</td>
 394           <td></td>
 395         </tr>
 396       </table>
 397   </td>
 398   <td class="mlabels-right">
 399 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 400   </tr>
 401 </table>
 402 </div><div class="memdoc">
 403
 404 <p>Handle of internal memory. </p>
 405 <dl class="section return"><dt>Returns</dt><dd>Handle of memory </dd></dl>
 406
 407 <p>Implements <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml#a0883358ee166a82da191e1a5cd957ca5">IMemoryRegion</a>.</p>
 408
 409 </div>
 410 </div>
 411 <a class="anchor" id="a929af627a6a0430539998d12024d6c69"></a>
 412 <div class="memitem">
 413 <div class="memproto">
 414 <table class="mlabels">
 415   <tr>
 416   <td class="mlabels-left">
 417       <table class="memname">
 418         <tr>
 419           <td class="memname">virtual void* map </td>
 420           <td>(</td>
 421           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 422           <td class="paramname"><em>q</em>, </td>
 423         </tr>
 424         <tr>
 425           <td class="paramkey"></td>
 426           <td></td>
 427           <td class="paramtype">bool&#160;</td>
 428           <td class="paramname"><em>blocking</em>&#160;</td>
 429         </tr>
 430         <tr>
 431           <td></td>
 432           <td>)</td>
 433           <td></td><td></td>
 434         </tr>
 435       </table>
 436   </td>
 437   <td class="mlabels-right">
 438 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 439   </tr>
 440 </table>
 441 </div><div class="memdoc">
 442
 443 <p>Enqueue a map operation of the allocated buffer on the given queue. </p>
 444 <dl class="params"><dt>Parameters</dt><dd>
 445   <table class="params">
 446     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
 447     <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>If true, then the mapping will be ready to use by the time this method returns, else it is the caller's responsibility to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.</td></tr>
 448   </table>
 449   </dd>
 450 </dl>
 451 <dl class="section return"><dt>Returns</dt><dd>The mapping address. </dd></dl>
 452
 453 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_fine_s_v_m_memory_region.xhtml#af540d8670cb2ccdec5a30fd2471c2e85">CLFineSVMMemoryRegion</a>, <a class="el" href="classarm__compute_1_1_c_l_coarse_s_v_m_memory_region.xhtml#af540d8670cb2ccdec5a30fd2471c2e85">CLCoarseSVMMemoryRegion</a>, and <a class="el" href="classarm__compute_1_1_c_l_buffer_memory_region.xhtml#af540d8670cb2ccdec5a30fd2471c2e85">CLBufferMemoryRegion</a>.</p>
 454
 455 </div>
 456 </div>
 457 <a class="anchor" id="aba791ecf7c921e9a1c8d84baa7dd270e"></a>
 458 <div class="memitem">
 459 <div class="memproto">
 460 <table class="mlabels">
 461   <tr>
 462   <td class="mlabels-left">
 463       <table class="memname">
 464         <tr>
 465           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>&amp; operator= </td>
 466           <td>(</td>
 467           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&#160;</td>
 468           <td class="paramname"></td><td>)</td>
 469           <td></td>
 470         </tr>
 471       </table>
 472   </td>
 473   <td class="mlabels-right">
 474 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 475   </tr>
 476 </table>
 477 </div><div class="memdoc">
 478
 479 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 480
 481 </div>
 482 </div>
 483 <a class="anchor" id="ad09657054c2f981a19b9ac7e4b95bd30"></a>
 484 <div class="memitem">
 485 <div class="memproto">
 486 <table class="mlabels">
 487   <tr>
 488   <td class="mlabels-left">
 489       <table class="memname">
 490         <tr>
 491           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>&amp; operator= </td>
 492           <td>(</td>
 493           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &amp;&amp;&#160;</td>
 494           <td class="paramname"></td><td>)</td>
 495           <td></td>
 496         </tr>
 497       </table>
 498   </td>
 499   <td class="mlabels-right">
 500 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 501   </tr>
 502 </table>
 503 </div><div class="memdoc">
 504
 505 <p>Default move assignment operator. </p>
 506
 507 </div>
 508 </div>
 509 <a class="anchor" id="ab8777d03065e8c7146157148a5355dd1"></a>
 510 <div class="memitem">
 511 <div class="memproto">
 512 <table class="mlabels">
 513   <tr>
 514   <td class="mlabels-left">
 515       <table class="memname">
 516         <tr>
 517           <td class="memname">virtual void* ptr </td>
 518           <td>(</td>
 519           <td class="paramname"></td><td>)</td>
 520           <td></td>
 521         </tr>
 522       </table>
 523   </td>
 524   <td class="mlabels-right">
 525 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 526   </tr>
 527 </table>
 528 </div><div class="memdoc">
 529
 530 <p>Host/SVM pointer accessor. </p>
 531 <dl class="section return"><dt>Returns</dt><dd>Host/SVM pointer base </dd></dl>
 532
 533 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_buffer_memory_region.xhtml#a0d957ce12ecbf85d9ecff5c372cfdd26">CLBufferMemoryRegion</a>.</p>
 534
 535 </div>
 536 </div>
 537 <a class="anchor" id="a0ee6b952accaff0f7e8e61bda7889102"></a>
 538 <div class="memitem">
 539 <div class="memproto">
 540 <table class="mlabels">
 541   <tr>
 542   <td class="mlabels-left">
 543       <table class="memname">
 544         <tr>
 545           <td class="memname">virtual void unmap </td>
 546           <td>(</td>
 547           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 548           <td class="paramname"><em>q</em></td><td>)</td>
 549           <td></td>
 550         </tr>
 551       </table>
 552   </td>
 553   <td class="mlabels-right">
 554 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 555   </tr>
 556 </table>
 557 </div><div class="memdoc">
 558
 559 <p>Enqueue an unmap operation of the allocated buffer on the given queue. </p>
 560 <dl class="section note"><dt>Note</dt><dd>This method simply enqueue the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before the memory is accessed by the device.</dd></dl>
 561 <dl class="params"><dt>Parameters</dt><dd>
 562   <table class="params">
 563     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
 564   </table>
 565   </dd>
 566 </dl>
 567
 568 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_fine_s_v_m_memory_region.xhtml#a56b704bed25e1e66ebe6b435f83fefcd">CLFineSVMMemoryRegion</a>, <a class="el" href="classarm__compute_1_1_c_l_coarse_s_v_m_memory_region.xhtml#a56b704bed25e1e66ebe6b435f83fefcd">CLCoarseSVMMemoryRegion</a>, and <a class="el" href="classarm__compute_1_1_c_l_buffer_memory_region.xhtml#a56b704bed25e1e66ebe6b435f83fefcd">CLBufferMemoryRegion</a>.</p>
 569
 570 </div>
 571 </div>
 572 <hr/>The documentation for this class was generated from the following file:<ul>
 573 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_memory_region_8h_source.xhtml">CLMemoryRegion.h</a></li>
 574 </ul>
 575 </div><!-- contents -->
 576 </div><!-- doc-content -->
 577 <!-- start footer part -->
 578 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 579   <ul>
 580     <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_memory_region.xhtml">ICLMemoryRegion</a></li>
 581     <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
 582     <a href="http://www.doxygen.org/index.html">
 583     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 584   </ul>
 585 </div>
 586 </body>
 587 </html>