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: 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);
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.04</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_i_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">ICLMultiImage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
122 <div class="contents">
124 <p>Interface for OpenCL multi-planar images.
125 <a href="classarm__compute_1_1_i_c_l_multi_image.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for ICLMultiImage:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_multi_image__coll__graph.svg" width="118" height="112"><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:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> * </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>
138 <tr class="memdesc:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the requested OpenCL plane of the image. <a href="#ad6273d4c4587f7956d48f2ea356a5c9b">More...</a><br /></td></tr>
139 <tr class="separator:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a3188cda5497ec91ce0839d7a2f14d578"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a> * </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>
141 <tr class="memdesc:a3188cda5497ec91ce0839d7a2f14d578"><td class="mdescLeft"> </td><td class="mdescRight">Return a constant pointer to the requested OpenCL plane of the image. <a href="#a3188cda5497ec91ce0839d7a2f14d578">More...</a><br /></td></tr>
142 <tr class="separator:a3188cda5497ec91ce0839d7a2f14d578"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a1a074b1525a405db59cba015b89f23a1"><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>
144 <tr class="memdesc:a1a074b1525a405db59cba015b89f23a1"><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>
145 <tr class="separator:a1a074b1525a405db59cba015b89f23a1"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ad136a4299cb6e978ab975fe4a4691fba"><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>
147 <tr class="memdesc:ad136a4299cb6e978ab975fe4a4691fba"><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>
148 <tr class="separator:ad136a4299cb6e978ab975fe4a4691fba"><td class="memSeparator" colspan="2"> </td></tr>
149 <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>
150 <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>
151 <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>
152 <tr class="separator:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2"> </td></tr>
153 <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> * </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>
154 <tr class="memdesc:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><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="#a38261214e277cba5b90dd1ffe31170e0">More...</a><br /></td></tr>
155 <tr class="separator:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2"> </td></tr>
157 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
158 <div class="textblock"><p>Interface for OpenCL multi-planar images. </p>
160 <p>Definition at line <a class="el" href="_i_c_l_multi_image_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a>.</p>
161 </div><h2 class="groupheader">Member Function Documentation</h2>
162 <a class="anchor" id="ad6273d4c4587f7956d48f2ea356a5c9b"></a>
163 <div class="memitem">
164 <div class="memproto">
165 <table class="mlabels">
167 <td class="mlabels-left">
168 <table class="memname">
170 <td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
172 <td class="paramtype">unsigned int </td>
173 <td class="paramname"><em>index</em></td><td>)</td>
178 <td class="mlabels-right">
179 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
182 </div><div class="memdoc">
184 <p>Return a pointer to the requested OpenCL plane of the image. </p>
185 <dl class="params"><dt>Parameters</dt><dd>
186 <table class="params">
187 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
191 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the OpenCL plane </dd></dl>
193 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a0d104ade841ef3aa9b0783b25836ea19">CLMultiImage</a>.</p>
197 <a class="anchor" id="a3188cda5497ec91ce0839d7a2f14d578"></a>
198 <div class="memitem">
199 <div class="memproto">
200 <table class="mlabels">
202 <td class="mlabels-left">
203 <table class="memname">
205 <td class="memname">virtual const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
207 <td class="paramtype">unsigned int </td>
208 <td class="paramname"><em>index</em></td><td>)</td>
213 <td class="mlabels-right">
214 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
217 </div><div class="memdoc">
219 <p>Return a constant pointer to the requested OpenCL plane of the image. </p>
220 <dl class="params"><dt>Parameters</dt><dd>
221 <table class="params">
222 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
226 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the OpenCL plane </dd></dl>
228 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#aa6e80644cacd12488fbd8ce1125f72aa">CLMultiImage</a>.</p>
232 <a class="anchor" id="a1a074b1525a405db59cba015b89f23a1"></a>
233 <div class="memitem">
234 <div class="memproto">
235 <table class="mlabels">
237 <td class="mlabels-left">
238 <table class="memname">
240 <td class="memname"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a>* plane </td>
242 <td class="paramtype">unsigned int </td>
243 <td class="paramname"><em>index</em></td><td>)</td>
248 <td class="mlabels-right">
249 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
252 </div><div class="memdoc">
254 <p>Return a pointer to the requested plane of the image. </p>
255 <dl class="params"><dt>Parameters</dt><dd>
256 <table class="params">
257 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
261 <dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the plane </dd></dl>
263 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a84ad04ee4d2efc59632a3224d7a813b3">IMultiImage</a>.</p>
267 <a class="anchor" id="ad136a4299cb6e978ab975fe4a4691fba"></a>
268 <div class="memitem">
269 <div class="memproto">
270 <table class="mlabels">
272 <td class="mlabels-left">
273 <table class="memname">
275 <td class="memname">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a>* plane </td>
277 <td class="paramtype">unsigned int </td>
278 <td class="paramname"><em>index</em></td><td>)</td>
283 <td class="mlabels-right">
284 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
287 </div><div class="memdoc">
289 <p>Return a constant pointer to the requested plane of the image. </p>
290 <dl class="params"><dt>Parameters</dt><dd>
291 <table class="params">
292 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
296 <dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the plane </dd></dl>
298 <p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a18bc117545eec0b9d0d502286d1afd62">IMultiImage</a>.</p>
302 <hr/>The documentation for this class was generated from the following file:<ul>
303 <li>arm_compute/core/CL/<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a></li>
305 </div><!-- contents -->
306 </div><!-- doc-content -->
307 <!-- start footer part -->
308 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
310 <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>
311 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
312 <a href="http://www.doxygen.org/index.html">
313 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>