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">
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>ARM Compute Library: CLMultiImage 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.05</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
68 <input type="text" id="MSearchField" value="Search" accesskey="S"
69 onfocus="searchBox.OnSearchFieldFocus(true)"
70 onblur="searchBox.OnSearchFieldFocus(false)"
71 onkeyup="searchBox.OnSearchFieldChange(event)"/>
72 </span><span class="right">
73 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_multi_image.xhtml','');});
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104 onmouseover="return searchBox.OnSearchSelectShow()"
105 onmouseout="return searchBox.OnSearchSelectHide()"
106 onkeydown="return searchBox.OnSearchSelectKey(event)">
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0"
112 name="MSearchResults" id="MSearchResults">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">CLMultiImage Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic implementation of the CL multi-planar image interface.
125 <a href="classarm__compute_1_1_c_l_multi_image.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_c_l_multi_image_8h_source.xhtml">CLMultiImage.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for CLMultiImage:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_multi_image__coll__graph.svg" width="118" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:a1cda3e46e0e37219f45643bc6445e5cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a1cda3e46e0e37219f45643bc6445e5cf">CLMultiImage</a> ()</td></tr>
138 <tr class="memdesc:a1cda3e46e0e37219f45643bc6445e5cf"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a1cda3e46e0e37219f45643bc6445e5cf">More...</a><br /></td></tr>
139 <tr class="separator:a1cda3e46e0e37219f45643bc6445e5cf"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a7453bdfcb39e068357022f0861e59637"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a7453bdfcb39e068357022f0861e59637">init</a> (unsigned int width, unsigned int height, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> format)</td></tr>
141 <tr class="memdesc:a7453bdfcb39e068357022f0861e59637"><td class="mdescLeft"> </td><td class="mdescRight">Init the multi-planar image. <a href="#a7453bdfcb39e068357022f0861e59637">More...</a><br /></td></tr>
142 <tr class="separator:a7453bdfcb39e068357022f0861e59637"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a32c7d923aa5aad1ef6afe95204c7d723"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a32c7d923aa5aad1ef6afe95204c7d723">init_auto_padding</a> (unsigned int width, unsigned int height, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> format)</td></tr>
144 <tr class="memdesc:a32c7d923aa5aad1ef6afe95204c7d723"><td class="mdescLeft"> </td><td class="mdescRight">Init the multi-planar image. <a href="#a32c7d923aa5aad1ef6afe95204c7d723">More...</a><br /></td></tr>
145 <tr class="separator:a32c7d923aa5aad1ef6afe95204c7d723"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#acaefe811b78a2fdc4a0dba0c4029c3ef">allocate</a> ()</td></tr>
147 <tr class="memdesc:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="mdescLeft"> </td><td class="mdescRight">Allocated a previously initialised multi image. <a href="#acaefe811b78a2fdc4a0dba0c4029c3ef">More...</a><br /></td></tr>
148 <tr class="separator:acaefe811b78a2fdc4a0dba0c4029c3ef"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:ae8d325a13f6f9d17ffe9ea076216b02f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#ae8d325a13f6f9d17ffe9ea076216b02f">info</a> () const override</td></tr>
150 <tr class="memdesc:ae8d325a13f6f9d17ffe9ea076216b02f"><td class="mdescLeft"> </td><td class="mdescRight">Interface to be implemented by the child class to return the multi-planar image's metadata. <a href="#ae8d325a13f6f9d17ffe9ea076216b02f">More...</a><br /></td></tr>
151 <tr class="separator:ae8d325a13f6f9d17ffe9ea076216b02f"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a0d104ade841ef3aa9b0783b25836ea19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#aae712f442eae2d56d17529ca6cb9cb77">CLImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a0d104ade841ef3aa9b0783b25836ea19">cl_plane</a> (unsigned int index) override</td></tr>
153 <tr class="memdesc:a0d104ade841ef3aa9b0783b25836ea19"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the requested OpenCL plane of the image. <a href="#a0d104ade841ef3aa9b0783b25836ea19">More...</a><br /></td></tr>
154 <tr class="separator:a0d104ade841ef3aa9b0783b25836ea19"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:aa6e80644cacd12488fbd8ce1125f72aa"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearm__compute.xhtml#aae712f442eae2d56d17529ca6cb9cb77">CLImage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#aa6e80644cacd12488fbd8ce1125f72aa">cl_plane</a> (unsigned int index) const override</td></tr>
156 <tr class="memdesc:aa6e80644cacd12488fbd8ce1125f72aa"><td class="mdescLeft"> </td><td class="mdescRight">Return a constant pointer to the requested OpenCL plane of the image. <a href="#aa6e80644cacd12488fbd8ce1125f72aa">More...</a><br /></td></tr>
157 <tr class="separator:aa6e80644cacd12488fbd8ce1125f72aa"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_multi_image')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml">ICLMultiImage</a></td></tr>
159 <tr class="memitem:a1a074b1525a405db59cba015b89f23a1 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> * </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>
160 <tr class="memdesc:a1a074b1525a405db59cba015b89f23a1 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the requested plane of the image. <a href="#a1a074b1525a405db59cba015b89f23a1">More...</a><br /></td></tr>
161 <tr class="separator:a1a074b1525a405db59cba015b89f23a1 inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="memSeparator" colspan="2"> </td></tr>
162 <tr class="memitem:ad136a4299cb6e978ab975fe4a4691fba inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> * </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>
163 <tr class="memdesc:ad136a4299cb6e978ab975fe4a4691fba inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="mdescLeft"> </td><td class="mdescRight">Return a constant pointer to the requested plane of the image. <a href="#ad136a4299cb6e978ab975fe4a4691fba">More...</a><br /></td></tr>
164 <tr class="separator:ad136a4299cb6e978ab975fe4a4691fba inherit pub_methods_classarm__compute_1_1_i_c_l_multi_image"><td class="memSeparator" colspan="2"> </td></tr>
165 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml">IMultiImage</a></td></tr>
166 <tr class="memitem:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a52c8ee0f7ff87c20c213bf2860729ea0">~IMultiImage</a> ()=default</td></tr>
167 <tr class="memdesc:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a52c8ee0f7ff87c20c213bf2860729ea0">More...</a><br /></td></tr>
168 <tr class="separator:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2"> </td></tr>
170 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
171 <div class="textblock"><p>Basic implementation of the CL multi-planar image interface. </p>
173 <p>Definition at line <a class="el" href="_c_l_multi_image_8h_source.xhtml#l00040">40</a> of file <a class="el" href="_c_l_multi_image_8h_source.xhtml">CLMultiImage.h</a>.</p>
174 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
175 <a class="anchor" id="a1cda3e46e0e37219f45643bc6445e5cf"></a>
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
180 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml">CLMultiImage</a> </td>
182 <td class="paramname"></td><td>)</td>
186 </div><div class="memdoc">
192 <h2 class="groupheader">Member Function Documentation</h2>
193 <a class="anchor" id="acaefe811b78a2fdc4a0dba0c4029c3ef"></a>
194 <div class="memitem">
195 <div class="memproto">
196 <table class="memname">
198 <td class="memname">void allocate </td>
200 <td class="paramname"></td><td>)</td>
204 </div><div class="memdoc">
206 <p>Allocated a previously initialised multi image. </p>
207 <dl class="section note"><dt>Note</dt><dd>The multi image must not already be allocated when calling this function. </dd></dl>
211 <a class="anchor" id="a0d104ade841ef3aa9b0783b25836ea19"></a>
212 <div class="memitem">
213 <div class="memproto">
214 <table class="mlabels">
216 <td class="mlabels-left">
217 <table class="memname">
219 <td class="memname"><a class="el" href="namespacearm__compute.xhtml#aae712f442eae2d56d17529ca6cb9cb77">CLImage</a>* cl_plane </td>
221 <td class="paramtype">unsigned int </td>
222 <td class="paramname"><em>index</em></td><td>)</td>
227 <td class="mlabels-right">
228 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
231 </div><div class="memdoc">
233 <p>Return a pointer to the requested OpenCL plane of the image. </p>
234 <dl class="params"><dt>Parameters</dt><dd>
235 <table class="params">
236 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
240 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the OpenCL plane </dd></dl>
242 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">ICLMultiImage</a>.</p>
246 <a class="anchor" id="aa6e80644cacd12488fbd8ce1125f72aa"></a>
247 <div class="memitem">
248 <div class="memproto">
249 <table class="mlabels">
251 <td class="mlabels-left">
252 <table class="memname">
254 <td class="memname">const <a class="el" href="namespacearm__compute.xhtml#aae712f442eae2d56d17529ca6cb9cb77">CLImage</a>* cl_plane </td>
256 <td class="paramtype">unsigned int </td>
257 <td class="paramname"><em>index</em></td><td>)</td>
262 <td class="mlabels-right">
263 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
266 </div><div class="memdoc">
268 <p>Return a constant pointer to the requested OpenCL plane of the image. </p>
269 <dl class="params"><dt>Parameters</dt><dd>
270 <table class="params">
271 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
275 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the OpenCL plane </dd></dl>
277 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#a3188cda5497ec91ce0839d7a2f14d578">ICLMultiImage</a>.</p>
281 <a class="anchor" id="ae8d325a13f6f9d17ffe9ea076216b02f"></a>
282 <div class="memitem">
283 <div class="memproto">
284 <table class="mlabels">
286 <td class="mlabels-left">
287 <table class="memname">
289 <td class="memname">const <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a>* info </td>
291 <td class="paramname"></td><td>)</td>
296 <td class="mlabels-right">
297 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
300 </div><div class="memdoc">
302 <p>Interface to be implemented by the child class to return the multi-planar image's metadata. </p>
303 <dl class="section return"><dt>Returns</dt><dd>A pointer to the image's metadata. </dd></dl>
305 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a38261214e277cba5b90dd1ffe31170e0">IMultiImage</a>.</p>
309 <a class="anchor" id="a7453bdfcb39e068357022f0861e59637"></a>
310 <div class="memitem">
311 <div class="memproto">
312 <table class="memname">
314 <td class="memname">void init </td>
316 <td class="paramtype">unsigned int </td>
317 <td class="paramname"><em>width</em>, </td>
320 <td class="paramkey"></td>
322 <td class="paramtype">unsigned int </td>
323 <td class="paramname"><em>height</em>, </td>
326 <td class="paramkey"></td>
328 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> </td>
329 <td class="paramname"><em>format</em> </td>
337 </div><div class="memdoc">
339 <p>Init the multi-planar image. </p>
340 <dl class="params"><dt>Parameters</dt><dd>
341 <table class="params">
342 <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the whole image </td></tr>
343 <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Heigth of the whole image </td></tr>
344 <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Format of the whole image </td></tr>
351 <a class="anchor" id="a32c7d923aa5aad1ef6afe95204c7d723"></a>
352 <div class="memitem">
353 <div class="memproto">
354 <table class="memname">
356 <td class="memname">void init_auto_padding </td>
358 <td class="paramtype">unsigned int </td>
359 <td class="paramname"><em>width</em>, </td>
362 <td class="paramkey"></td>
364 <td class="paramtype">unsigned int </td>
365 <td class="paramname"><em>height</em>, </td>
368 <td class="paramkey"></td>
370 <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> </td>
371 <td class="paramname"><em>format</em> </td>
379 </div><div class="memdoc">
381 <p>Init the multi-planar image. </p>
382 <dl class="section note"><dt>Note</dt><dd>Uses conservative padding strategy which fits all kernels.</dd></dl>
383 <dl class="params"><dt>Parameters</dt><dd>
384 <table class="params">
385 <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the whole image </td></tr>
386 <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of the whole image </td></tr>
387 <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Format of the whole image </td></tr>
394 <hr/>The documentation for this class was generated from the following file:<ul>
395 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_multi_image_8h_source.xhtml">CLMultiImage.h</a></li>
397 </div><!-- contents -->
398 </div><!-- doc-content -->
399 <!-- start footer part -->
400 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
402 <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_c_l_multi_image.xhtml">CLMultiImage</a></li>
403 <li class="footer">Generated on Wed May 3 2017 17:20:05 for ARM Compute Library by
404 <a href="http://www.doxygen.org/index.html">
405 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>