Google Git
Sign in
android / platform / external / ComputeLibrary / e8521c234 / . / documentation / classarm__compute_1_1_multi_image_info.xhtml
blob: 95d7e041ed0f7442c75cff1ac8ae6671740c9ef2 [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: MultiImageInfo 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">20.02.1</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_multi_image_info.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">MultiImageInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Store the multi-planar image's metadata.
<a href="classarm__compute_1_1_multi_image_info.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a>&gt;</code></p>
<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:a335d0038f37278ee9adc798b2efa7775"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a335d0038f37278ee9adc798b2efa7775">MultiImageInfo</a> ()</td></tr>
<tr class="memdesc:a335d0038f37278ee9adc798b2efa7775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a335d0038f37278ee9adc798b2efa7775">More...</a><br /></td></tr>
<tr class="separator:a335d0038f37278ee9adc798b2efa7775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7453bdfcb39e068357022f0861e59637"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7453bdfcb39e068357022f0861e59637">init</a> (unsigned int <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7f0f3e5dd09a150b2cc221c01804d1a7">width</a>, unsigned int <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#adc7679009b582b99d859c0edfc35aa4a">height</a>, <a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> <a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7047a267776924cf166c301310f03a2c">format</a>)</td></tr>
<tr class="memdesc:a7453bdfcb39e068357022f0861e59637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the metadata structure with the given parameters. <a href="#a7453bdfcb39e068357022f0861e59637">More...</a><br /></td></tr>
<tr class="separator:a7453bdfcb39e068357022f0861e59637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7047a267776924cf166c301310f03a2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7047a267776924cf166c301310f03a2c">format</a> () const</td></tr>
<tr class="memdesc:a7047a267776924cf166c301310f03a2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Colour format of the image. <a href="#a7047a267776924cf166c301310f03a2c">More...</a><br /></td></tr>
<tr class="separator:a7047a267776924cf166c301310f03a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f0f3e5dd09a150b2cc221c01804d1a7"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#a7f0f3e5dd09a150b2cc221c01804d1a7">width</a> () const</td></tr>
<tr class="memdesc:a7f0f3e5dd09a150b2cc221c01804d1a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width in pixels. <a href="#a7f0f3e5dd09a150b2cc221c01804d1a7">More...</a><br /></td></tr>
<tr class="separator:a7f0f3e5dd09a150b2cc221c01804d1a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc7679009b582b99d859c0edfc35aa4a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml#adc7679009b582b99d859c0edfc35aa4a">height</a> () const</td></tr>
<tr class="memdesc:adc7679009b582b99d859c0edfc35aa4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Height in pixels. <a href="#adc7679009b582b99d859c0edfc35aa4a">More...</a><br /></td></tr>
<tr class="separator:adc7679009b582b99d859c0edfc35aa4a"><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>Store the multi-planar image's metadata. </p>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a335d0038f37278ee9adc798b2efa7775"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a335d0038f37278ee9adc798b2efa7775">&#9670;&nbsp;</a></span>MultiImageInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_multi_image_info.xhtml">MultiImageInfo</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00028">28</a> of file <a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; : _width(0), _height(0), _format(<a class="code" href="namespacearm__compute.xhtml#a3a440b3893fa10608d4428958be1c52ea696b031073e74bf2cb98e5ef201d4aa3">Format::UNKNOWN</a>)</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div><div class="ttc" id="namespacearm__compute_xhtml_a3a440b3893fa10608d4428958be1c52ea696b031073e74bf2cb98e5ef201d4aa3"><div class="ttname"><a href="namespacearm__compute.xhtml#a3a440b3893fa10608d4428958be1c52ea696b031073e74bf2cb98e5ef201d4aa3">arm_compute::CLVersion::UNKNOWN</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="namespacearm__compute.xhtml#a3a440b3893fa10608d4428958be1c52ea696b031073e74bf2cb98e5ef201d4aa3">arm_compute::UNKNOWN</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7047a267776924cf166c301310f03a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7047a267776924cf166c301310f03a2c">&#9670;&nbsp;</a></span>format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a> format </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Colour format of the image. </p>
<dl class="section return"><dt>Returns</dt><dd>Colour format of the image </dd></dl>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00040">40</a> of file <a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> _format;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_c_l_multi_image_8cpp_source.xhtml#l00130">CLMultiImage::allocate()</a>, <a class="el" href="_multi_image_8cpp_source.xhtml#l00130">MultiImage::allocate()</a>, <a class="el" href="_c_l_channel_combine_kernel_8cpp_source.xhtml#l00137">CLChannelCombineKernel::configure()</a>, <a class="el" href="_c_l_color_convert_kernel_8cpp_source.xhtml#l00224">CLColorConvertKernel::configure()</a>, <a class="el" href="_n_e_color_convert_kernel_8cpp_source.xhtml#l00253">NEColorConvertKernel::configure()</a>, <a class="el" href="_n_e_channel_combine_kernel_8cpp_source.xhtml#l00162">NEChannelCombineKernel::configure()</a>, <a class="el" href="_multi_image_8cpp_source.xhtml#l00164">MultiImage::create_subimage()</a>, <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00033">MultiImageInfo::init()</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="adc7679009b582b99d859c0edfc35aa4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc7679009b582b99d859c0edfc35aa4a">&#9670;&nbsp;</a></span>height()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int height </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Height in pixels. </p>
<dl class="section return"><dt>Returns</dt><dd>The height in pixels </dd></dl>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00050">50</a> of file <a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> _height;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00033">MultiImageInfo::init()</a>.</p>
</div>
</div>
<a id="a7453bdfcb39e068357022f0861e59637"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7453bdfcb39e068357022f0861e59637">&#9670;&nbsp;</a></span>init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void init </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#ab4e88c89b3b7ea1735996cc4def22d58">Format</a>&#160;</td>
<td class="paramname"><em>format</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the metadata structure with the given parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the image (in number of pixels) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of the image (in number of pixels) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>Colour format of the image. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00033">33</a> of file <a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; _format = <a class="code" href="classarm__compute_1_1_multi_image_info.xhtml#a7047a267776924cf166c301310f03a2c">format</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; _width = <a class="code" href="classarm__compute_1_1_multi_image_info.xhtml#a7f0f3e5dd09a150b2cc221c01804d1a7">width</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; _height = <a class="code" href="classarm__compute_1_1_multi_image_info.xhtml#adc7679009b582b99d859c0edfc35aa4a">height</a>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div><div class="ttc" id="classarm__compute_1_1_multi_image_info_xhtml_a7f0f3e5dd09a150b2cc221c01804d1a7"><div class="ttname"><a href="classarm__compute_1_1_multi_image_info.xhtml#a7f0f3e5dd09a150b2cc221c01804d1a7">arm_compute::MultiImageInfo::width</a></div><div class="ttdeci">unsigned int width() const</div><div class="ttdoc">Width in pixels.</div><div class="ttdef"><b>Definition:</b> <a href="_multi_image_info_8cpp_source.xhtml#l00045">MultiImageInfo.cpp:45</a></div></div>
<div class="ttc" id="classarm__compute_1_1_multi_image_info_xhtml_adc7679009b582b99d859c0edfc35aa4a"><div class="ttname"><a href="classarm__compute_1_1_multi_image_info.xhtml#adc7679009b582b99d859c0edfc35aa4a">arm_compute::MultiImageInfo::height</a></div><div class="ttdeci">unsigned int height() const</div><div class="ttdoc">Height in pixels.</div><div class="ttdef"><b>Definition:</b> <a href="_multi_image_info_8cpp_source.xhtml#l00050">MultiImageInfo.cpp:50</a></div></div>
<div class="ttc" id="classarm__compute_1_1_multi_image_info_xhtml_a7047a267776924cf166c301310f03a2c"><div class="ttname"><a href="classarm__compute_1_1_multi_image_info.xhtml#a7047a267776924cf166c301310f03a2c">arm_compute::MultiImageInfo::format</a></div><div class="ttdeci">Format format() const</div><div class="ttdoc">Colour format of the image.</div><div class="ttdef"><b>Definition:</b> <a href="_multi_image_info_8cpp_source.xhtml#l00040">MultiImageInfo.cpp:40</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00040">MultiImageInfo::format()</a>, <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00050">MultiImageInfo::height()</a>, and <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00045">MultiImageInfo::width()</a>.</p>
<p class="reference">Referenced by <a class="el" href="_multi_image_8cpp_source.xhtml#l00164">MultiImage::create_subimage()</a>.</p>
</div>
</div>
<a id="a7f0f3e5dd09a150b2cc221c01804d1a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f0f3e5dd09a150b2cc221c01804d1a7">&#9670;&nbsp;</a></span>width()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int width </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Width in pixels. </p>
<dl class="section return"><dt>Returns</dt><dd>The width in pixels </dd></dl>
<p class="definition">Definition at line <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00045">45</a> of file <a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">return</span> _width;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div></div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="_multi_image_info_8cpp_source.xhtml#l00033">MultiImageInfo::init()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/core/<a class="el" href="_multi_image_info_8h_source.xhtml">MultiImageInfo.h</a></li>
<li>src/core/<a class="el" href="_multi_image_info_8cpp_source.xhtml">MultiImageInfo.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_multi_image_info.xhtml">MultiImageInfo</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:14 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>