Google Git
Sign in
android / platform / external / ComputeLibrary / 975dfe175 / . / documentation / classarm__compute_1_1_i_c_l_multi_image.xhtml
blob: 2216730aa5e44812bdcccbd6ea12d0518baa7477 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: ICLMultiImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.08</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1_i_c_l_multi_image.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ICLMultiImage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for OpenCL multi-planar images.
<a href="classarm__compute_1_1_i_c_l_multi_image.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ICLMultiImage:</div>
<div class="dyncontent">
<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>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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>
<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>
<tr class="separator:ad6273d4c4587f7956d48f2ea356a5c9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<tr class="separator:a3188cda5497ec91ce0839d7a2f14d578"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8cc996a2730daa7954ab5095ef55d62"><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#ab8cc996a2730daa7954ab5095ef55d62">plane</a> (unsigned int index) override</td></tr>
<tr class="memdesc:ab8cc996a2730daa7954ab5095ef55d62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the requested plane of the image. <a href="#ab8cc996a2730daa7954ab5095ef55d62">More...</a><br /></td></tr>
<tr class="separator:ab8cc996a2730daa7954ab5095ef55d62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86abf6a49a5191f283a81f911ae4c482"><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#a86abf6a49a5191f283a81f911ae4c482">plane</a> (unsigned int index) const override</td></tr>
<tr class="memdesc:a86abf6a49a5191f283a81f911ae4c482"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant pointer to the requested plane of the image. <a href="#a86abf6a49a5191f283a81f911ae4c482">More...</a><br /></td></tr>
<tr class="separator:a86abf6a49a5191f283a81f911ae4c482"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<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="classarm__compute_1_1_i_multi_image.xhtml#a52c8ee0f7ff87c20c213bf2860729ea0">More...</a><br /></td></tr>
<tr class="separator:a52c8ee0f7ff87c20c213bf2860729ea0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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="classarm__compute_1_1_i_multi_image.xhtml#a38261214e277cba5b90dd1ffe31170e0">More...</a><br /></td></tr>
<tr class="separator:a38261214e277cba5b90dd1ffe31170e0 inherit pub_methods_classarm__compute_1_1_i_multi_image"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for OpenCL multi-planar images. </p>
<p class="definition">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>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad6273d4c4587f7956d48f2ea356a5c9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6273d4c4587f7956d48f2ea356a5c9b">&#9670;&nbsp;</a></span>cl_plane() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a pointer to the requested OpenCL plane of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the OpenCL plane </dd></dl>
<p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#a70f036263783a4fdb84a55852154a9f3">CLMultiImage</a>.</p>
<p class="reference">Referenced by <a class="el" href="_c_l_channel_extract_kernel_8cpp_source.xhtml#l00107">CLChannelExtractKernel::configure()</a>, <a class="el" href="_c_l_color_convert_kernel_8cpp_source.xhtml#l00331">CLColorConvertKernel::configure()</a>, <a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml#l00031">ICLMultiImage::plane()</a>, <a class="el" href="_c_l_channel_combine_kernel_8cpp_source.xhtml#l00239">CLChannelCombineKernel::run()</a>, and <a class="el" href="_c_l_color_convert_kernel_8cpp_source.xhtml#l00432">CLColorConvertKernel::run()</a>.</p>
</div>
</div>
<a id="a3188cda5497ec91ce0839d7a2f14d578"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3188cda5497ec91ce0839d7a2f14d578">&#9670;&nbsp;</a></span>cl_plane() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="namespacearm__compute.xhtml#aa80145f30ddae0c2ccbcaa910e3e71dd">ICLImage</a>* cl_plane </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a constant pointer to the requested OpenCL plane of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the OpenCL plane </dd></dl>
<p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_multi_image.xhtml#ac8cccd621b4a77d099d96b7aaefd051a">CLMultiImage</a>.</p>
</div>
</div>
<a id="ab8cc996a2730daa7954ab5095ef55d62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8cc996a2730daa7954ab5095ef55d62">&#9670;&nbsp;</a></span>plane() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> * plane </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a pointer to the requested plane of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer pointed to the plane </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a84ad04ee4d2efc59632a3224d7a813b3">IMultiImage</a>.</p>
<p class="definition">Definition at line <a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml#l00031">31</a> of file <a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml">ICLMultiImage.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">cl_plane</a>(index);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1_i_c_l_multi_image_xhtml_ad6273d4c4587f7956d48f2ea356a5c9b"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">arm_compute::ICLMultiImage::cl_plane</a></div><div class="ttdeci">virtual ICLImage * cl_plane(unsigned int index)=0</div><div class="ttdoc">Return a pointer to the requested OpenCL plane of the image.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">ICLMultiImage::cl_plane()</a>.</p>
<p class="reference">Referenced by <a class="el" href="_c_l_color_convert_kernel_8cpp_source.xhtml#l00139">CLColorConvertKernel::configure()</a>, and <a class="el" href="_c_l_channel_combine_kernel_8cpp_source.xhtml#l00137">CLChannelCombineKernel::configure()</a>.</p>
</div>
</div>
<a id="a86abf6a49a5191f283a81f911ae4c482"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86abf6a49a5191f283a81f911ae4c482">&#9670;&nbsp;</a></span>plane() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacearm__compute.xhtml#ac20902ac1ef01783c8a8d71a9bdf1100">IImage</a> * plane </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a constant pointer to the requested plane of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the wanted planed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A constant pointer pointed to the plane </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_multi_image.xhtml#a18bc117545eec0b9d0d502286d1afd62">IMultiImage</a>.</p>
<p class="definition">Definition at line <a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml#l00036">36</a> of file <a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml">ICLMultiImage.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">cl_plane</a>(index);</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1_i_c_l_multi_image_xhtml_ad6273d4c4587f7956d48f2ea356a5c9b"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">arm_compute::ICLMultiImage::cl_plane</a></div><div class="ttdeci">virtual ICLImage * cl_plane(unsigned int index)=0</div><div class="ttdoc">Return a pointer to the requested OpenCL plane of the image.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="classarm__compute_1_1_i_c_l_multi_image.xhtml#ad6273d4c4587f7956d48f2ea356a5c9b">ICLMultiImage::cl_plane()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/core/CL/<a class="el" href="_i_c_l_multi_image_8h_source.xhtml">ICLMultiImage.h</a></li>
<li>src/core/CL/<a class="el" href="_i_c_l_multi_image_8cpp_source.xhtml">ICLMultiImage.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<li class="footer">Generated on Mon Sep 2 2019 11:47:35 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>