<!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"/>
<title>android::RSC::Type Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<!-- Generated by Doxygen 1.7.5.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li class="current"><a href="annotated.html"><span>Structs</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>android</b> </li>
<li class="navelem"><b>RSC</b> </li>
<li class="navelem"><a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">android::RSC::Type Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="android::RSC::Type" --><!-- doxytag: inherits="android::RSC::BaseObj" -->
<p><code>#include <<a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for android::RSC::Type:</div>
<div class="dyncontent">
<div class="center">
<img src="classandroid_1_1RSC_1_1Type.png" usemap="#android::RSC::Type_map" alt=""/>
<map id="android::RSC::Type_map" name="android::RSC::Type_map">
<area href="classandroid_1_1RSC_1_1BaseObj.html" alt="android::RSC::BaseObj" shape="rect" coords="0,0,140,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type_1_1Builder.html">Builder</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RSYuvFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#ac4ad2c5b3c9a4758b356b2152f03d4e8">getYuvFormat</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">sp< const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#a258364640b18256c338178b056fcc2d6">getElement</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#ad324073e4cb9144f225fbea6074b3564">getX</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#ae3f2a8d78737664290c9da35e5afc284">getY</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#a6640a753fb08cb9413559021b3f37665">getZ</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#ac0e02c8a4926a35f6237b00d3af3f829">hasMipmaps</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#adc58082d46bfc33efc0232b2a85b5278">hasFaces</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#a0fa390504b01957f1f9fe9e34899621c">getCount</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#a046466fc4156806d9d133d38af965380">getSizeBytes</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static sp< const <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classandroid_1_1RSC_1_1Type.html#a26a26f44a40ffa8cc650152c3f834989">create</a> (sp< <a class="el" href="classandroid_1_1RSC_1_1RS.html">RS</a> > rs, sp< const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> > e, uint32_t dimX, uint32_t dimY, uint32_t dimZ)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> describes the <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> and dimensions used for an <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> or a parallel operation.</p>
<p>A <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> always includes an <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> and an X dimension. A <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> may be multidimensional, up to three dimensions. A nonzero value in the Y or Z dimensions indicates that the dimension is present. Note that a <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> with only a given X dimension and a <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> with the same X dimension but Y = 1 are not equivalent.</p>
<p>A <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> also supports inclusion of level of detail (LOD) or cube map faces. LOD and cube map faces are booleans to indicate present or not present.</p>
<p>A <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> also supports YUV format information to support an <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> in a YUV format. The YUV formats supported are YV12 and NV21. </p>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01188">1188</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a26a26f44a40ffa8cc650152c3f834989"></a><!-- doxytag: member="android::RSC::Type::create" ref="a26a26f44a40ffa8cc650152c3f834989" args="(sp< RS > rs, sp< const Element > e, uint32_t dimX, uint32_t dimY, uint32_t dimZ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static sp<const <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a>> android::RSC::Type::create </td>
<td>(</td>
<td class="paramtype">sp< <a class="el" href="classandroid_1_1RSC_1_1RS.html">RS</a> > </td>
<td class="paramname"><em>rs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">sp< const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> > </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dimX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dimY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>dimZ</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> with the given <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> and dimensions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rs</td><td>RenderScript context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">e</td><td><a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dimX</td><td>X dimension </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dimY</td><td>Y dimension </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dimZ</td><td>Z dimension </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0fa390504b01957f1f9fe9e34899621c"></a><!-- doxytag: member="android::RSC::Type::getCount" ref="a0fa390504b01957f1f9fe9e34899621c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t android::RSC::Type::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns number of accessible Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of accessible Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01268">1268</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="a258364640b18256c338178b056fcc2d6"></a><!-- doxytag: member="android::RSC::Type::getElement" ref="a258364640b18256c338178b056fcc2d6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sp<const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a>> android::RSC::Type::getElement </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>YUV format of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01220">1220</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="a046466fc4156806d9d133d38af965380"></a><!-- doxytag: member="android::RSC::Type::getSizeBytes" ref="a046466fc4156806d9d133d38af965380" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t android::RSC::Type::getSizeBytes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns size in bytes of all Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size in bytes of all Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01276">1276</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad324073e4cb9144f225fbea6074b3564"></a><!-- doxytag: member="android::RSC::Type::getX" ref="ad324073e4cb9144f225fbea6074b3564" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t android::RSC::Type::getX </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the X dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>X dimension of the allocation </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01228">1228</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae3f2a8d78737664290c9da35e5afc284"></a><!-- doxytag: member="android::RSC::Type::getY" ref="ae3f2a8d78737664290c9da35e5afc284" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t android::RSC::Type::getY </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the Y dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Y dimension of the allocation </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01236">1236</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac4ad2c5b3c9a4758b356b2152f03d4e8"></a><!-- doxytag: member="android::RSC::Type::getYuvFormat" ref="ac4ad2c5b3c9a4758b356b2152f03d4e8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RSYuvFormat android::RSC::Type::getYuvFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the YUV format. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>YUV format of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01212">1212</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6640a753fb08cb9413559021b3f37665"></a><!-- doxytag: member="android::RSC::Type::getZ" ref="a6640a753fb08cb9413559021b3f37665" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t android::RSC::Type::getZ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the Z dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Z dimension of the allocation </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01244">1244</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="adc58082d46bfc33efc0232b2a85b5278"></a><!-- doxytag: member="android::RSC::Type::hasFaces" ref="adc58082d46bfc33efc0232b2a85b5278" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool android::RSC::Type::hasFaces </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> is a cube map </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> is a cube map </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01260">1260</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac0e02c8a4926a35f6237b00d3af3f829"></a><!-- doxytag: member="android::RSC::Type::hasMipmaps" ref="ac0e02c8a4926a35f6237b00d3af3f829" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool android::RSC::Type::hasMipmaps </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> has mipmaps. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> has mipmaps </dd></dl>
<p>Definition at line <a class="el" href="rsCppStructs_8h_source.html#l01252">1252</a> of file <a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a></li>
</ul>
</div>
</body>
</html>