1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2 <html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5 6 <title>android::RSC::Type Class Reference</title> 7 <link href="tabs.css" rel="stylesheet" type="text/css"/> 8 <link href="doxygen.css" rel="stylesheet" type="text/css" /> 9 10 11 12 </head> 13 <body> 14 <div id="top"><!-- do not remove this div! --> 15 16 17 <!-- Generated by Doxygen 1.7.5.1 --> 18 <div id="navrow1" class="tabs"> 19 <ul class="tablist"> 20 <li><a href="index.html"><span>Overview</span></a></li> 21 <li class="current"><a href="annotated.html"><span>Structs</span></a></li> 22 </ul> 23 </div> 24 <div id="nav-path" class="navpath"> 25 <ul> 26 <li class="navelem"><b>android</b> </li> 27 <li class="navelem"><b>RSC</b> </li> 28 <li class="navelem"><a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> </li> 29 </ul> 30 </div> 31 </div> 32 <div class="header"> 33 <div class="summary"> 34 <a href="#nested-classes">Data Structures</a> | 35 <a href="#pub-methods">Public Member Functions</a> | 36 <a href="#pub-static-methods">Static Public Member Functions</a> </div> 37 <div class="headertitle"> 38 <div class="title">android::RSC::Type Class Reference</div> </div> 39 </div> 40 <div class="contents"> 41 <!-- doxytag: class="android::RSC::Type" --><!-- doxytag: inherits="android::RSC::BaseObj" --> 42 <p><code>#include <<a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a>></code></p> 43 <div class="dynheader"> 44 Inheritance diagram for android::RSC::Type:</div> 45 <div class="dyncontent"> 46 <div class="center"> 47 <img src="classandroid_1_1RSC_1_1Type.png" usemap="#android::RSC::Type_map" alt=""/> 48 <map id="android::RSC::Type_map" name="android::RSC::Type_map"> 49 <area href="classandroid_1_1RSC_1_1BaseObj.html" alt="android::RSC::BaseObj" shape="rect" coords="0,0,140,24"/> 50 </map> 51 </div></div> 52 <table class="memberdecls"> 53 <tr><td colspan="2"><h2><a name="nested-classes"></a> 54 Data Structures</h2></td></tr> 55 <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> 56 <tr><td colspan="2"><h2><a name="pub-methods"></a> 57 Public Member Functions</h2></td></tr> 58 <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> 59 <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> 60 <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> 61 <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> 62 <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> 63 <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> 64 <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> 65 <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> 66 <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> 67 <tr><td colspan="2"><h2><a name="pub-static-methods"></a> 68 Static Public Member Functions</h2></td></tr> 69 <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> 70 </table> 71 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> 72 <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> 73 <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> 74 <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> 75 <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> 76 77 <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> 78 </div><hr/><h2>Member Function Documentation</h2> 79 <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)" --> 80 <div class="memitem"> 81 <div class="memproto"> 82 <table class="memname"> 83 <tr> 84 <td class="memname">static sp<const <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a>> android::RSC::Type::create </td> 85 <td>(</td> 86 <td class="paramtype">sp< <a class="el" href="classandroid_1_1RSC_1_1RS.html">RS</a> > </td> 87 <td class="paramname"><em>rs</em>, </td> 88 </tr> 89 <tr> 90 <td class="paramkey"></td> 91 <td></td> 92 <td class="paramtype">sp< const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a> > </td> 93 <td class="paramname"><em>e</em>, </td> 94 </tr> 95 <tr> 96 <td class="paramkey"></td> 97 <td></td> 98 <td class="paramtype">uint32_t </td> 99 <td class="paramname"><em>dimX</em>, </td> 100 </tr> 101 <tr> 102 <td class="paramkey"></td> 103 <td></td> 104 <td class="paramtype">uint32_t </td> 105 <td class="paramname"><em>dimY</em>, </td> 106 </tr> 107 <tr> 108 <td class="paramkey"></td> 109 <td></td> 110 <td class="paramtype">uint32_t </td> 111 <td class="paramname"><em>dimZ</em> </td> 112 </tr> 113 <tr> 114 <td></td> 115 <td>)</td> 116 <td></td><td><code> [static]</code></td> 117 </tr> 118 </table> 119 </div> 120 <div class="memdoc"> 121 <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> 122 <dl><dt><b>Parameters:</b></dt><dd> 123 <table class="params"> 124 <tr><td class="paramdir">[in]</td><td class="paramname">rs</td><td>RenderScript context </td></tr> 125 <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> 126 <tr><td class="paramdir">[in]</td><td class="paramname">dimX</td><td>X dimension </td></tr> 127 <tr><td class="paramdir">[in]</td><td class="paramname">dimY</td><td>Y dimension </td></tr> 128 <tr><td class="paramdir">[in]</td><td class="paramname">dimZ</td><td>Z dimension </td></tr> 129 </table> 130 </dd> 131 </dl> 132 <dl class="return"><dt><b>Returns:</b></dt><dd>new <a class="el" href="classandroid_1_1RSC_1_1Type.html">Type</a> </dd></dl> 133 134 </div> 135 </div> 136 <a class="anchor" id="a0fa390504b01957f1f9fe9e34899621c"></a><!-- doxytag: member="android::RSC::Type::getCount" ref="a0fa390504b01957f1f9fe9e34899621c" args="() const " --> 137 <div class="memitem"> 138 <div class="memproto"> 139 <table class="memname"> 140 <tr> 141 <td class="memname">size_t android::RSC::Type::getCount </td> 142 <td>(</td> 143 <td class="paramname"></td><td>)</td> 144 <td> const<code> [inline]</code></td> 145 </tr> 146 </table> 147 </div> 148 <div class="memdoc"> 149 <p>Returns number of accessible Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </p> 150 <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> 151 152 <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> 153 154 </div> 155 </div> 156 <a class="anchor" id="a258364640b18256c338178b056fcc2d6"></a><!-- doxytag: member="android::RSC::Type::getElement" ref="a258364640b18256c338178b056fcc2d6" args="() const " --> 157 <div class="memitem"> 158 <div class="memproto"> 159 <table class="memname"> 160 <tr> 161 <td class="memname">sp<const <a class="el" href="classandroid_1_1RSC_1_1Element.html">Element</a>> android::RSC::Type::getElement </td> 162 <td>(</td> 163 <td class="paramname"></td><td>)</td> 164 <td> const<code> [inline]</code></td> 165 </tr> 166 </table> 167 </div> 168 <div class="memdoc"> 169 <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> 170 <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> 171 172 <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> 173 174 </div> 175 </div> 176 <a class="anchor" id="a046466fc4156806d9d133d38af965380"></a><!-- doxytag: member="android::RSC::Type::getSizeBytes" ref="a046466fc4156806d9d133d38af965380" args="() const " --> 177 <div class="memitem"> 178 <div class="memproto"> 179 <table class="memname"> 180 <tr> 181 <td class="memname">size_t android::RSC::Type::getSizeBytes </td> 182 <td>(</td> 183 <td class="paramname"></td><td>)</td> 184 <td> const<code> [inline]</code></td> 185 </tr> 186 </table> 187 </div> 188 <div class="memdoc"> 189 <p>Returns size in bytes of all Elements in the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> </p> 190 <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> 191 192 <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> 193 194 </div> 195 </div> 196 <a class="anchor" id="ad324073e4cb9144f225fbea6074b3564"></a><!-- doxytag: member="android::RSC::Type::getX" ref="ad324073e4cb9144f225fbea6074b3564" args="() const " --> 197 <div class="memitem"> 198 <div class="memproto"> 199 <table class="memname"> 200 <tr> 201 <td class="memname">uint32_t android::RSC::Type::getX </td> 202 <td>(</td> 203 <td class="paramname"></td><td>)</td> 204 <td> const<code> [inline]</code></td> 205 </tr> 206 </table> 207 </div> 208 <div class="memdoc"> 209 <p>Returns the X dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p> 210 <dl class="return"><dt><b>Returns:</b></dt><dd>X dimension of the allocation </dd></dl> 211 212 <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> 213 214 </div> 215 </div> 216 <a class="anchor" id="ae3f2a8d78737664290c9da35e5afc284"></a><!-- doxytag: member="android::RSC::Type::getY" ref="ae3f2a8d78737664290c9da35e5afc284" args="() const " --> 217 <div class="memitem"> 218 <div class="memproto"> 219 <table class="memname"> 220 <tr> 221 <td class="memname">uint32_t android::RSC::Type::getY </td> 222 <td>(</td> 223 <td class="paramname"></td><td>)</td> 224 <td> const<code> [inline]</code></td> 225 </tr> 226 </table> 227 </div> 228 <div class="memdoc"> 229 <p>Returns the Y dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p> 230 <dl class="return"><dt><b>Returns:</b></dt><dd>Y dimension of the allocation </dd></dl> 231 232 <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> 233 234 </div> 235 </div> 236 <a class="anchor" id="ac4ad2c5b3c9a4758b356b2152f03d4e8"></a><!-- doxytag: member="android::RSC::Type::getYuvFormat" ref="ac4ad2c5b3c9a4758b356b2152f03d4e8" args="() const " --> 237 <div class="memitem"> 238 <div class="memproto"> 239 <table class="memname"> 240 <tr> 241 <td class="memname">RSYuvFormat android::RSC::Type::getYuvFormat </td> 242 <td>(</td> 243 <td class="paramname"></td><td>)</td> 244 <td> const<code> [inline]</code></td> 245 </tr> 246 </table> 247 </div> 248 <div class="memdoc"> 249 <p>Returns the YUV format. </p> 250 <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> 251 252 <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> 253 254 </div> 255 </div> 256 <a class="anchor" id="a6640a753fb08cb9413559021b3f37665"></a><!-- doxytag: member="android::RSC::Type::getZ" ref="a6640a753fb08cb9413559021b3f37665" args="() const " --> 257 <div class="memitem"> 258 <div class="memproto"> 259 <table class="memname"> 260 <tr> 261 <td class="memname">uint32_t android::RSC::Type::getZ </td> 262 <td>(</td> 263 <td class="paramname"></td><td>)</td> 264 <td> const<code> [inline]</code></td> 265 </tr> 266 </table> 267 </div> 268 <div class="memdoc"> 269 <p>Returns the Z dimension of the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a>. </p> 270 <dl class="return"><dt><b>Returns:</b></dt><dd>Z dimension of the allocation </dd></dl> 271 272 <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> 273 274 </div> 275 </div> 276 <a class="anchor" id="adc58082d46bfc33efc0232b2a85b5278"></a><!-- doxytag: member="android::RSC::Type::hasFaces" ref="adc58082d46bfc33efc0232b2a85b5278" args="() const " --> 277 <div class="memitem"> 278 <div class="memproto"> 279 <table class="memname"> 280 <tr> 281 <td class="memname">bool android::RSC::Type::hasFaces </td> 282 <td>(</td> 283 <td class="paramname"></td><td>)</td> 284 <td> const<code> [inline]</code></td> 285 </tr> 286 </table> 287 </div> 288 <div class="memdoc"> 289 <p>Returns true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> is a cube map </p> 290 <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> 291 292 <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> 293 294 </div> 295 </div> 296 <a class="anchor" id="ac0e02c8a4926a35f6237b00d3af3f829"></a><!-- doxytag: member="android::RSC::Type::hasMipmaps" ref="ac0e02c8a4926a35f6237b00d3af3f829" args="() const " --> 297 <div class="memitem"> 298 <div class="memproto"> 299 <table class="memname"> 300 <tr> 301 <td class="memname">bool android::RSC::Type::hasMipmaps </td> 302 <td>(</td> 303 <td class="paramname"></td><td>)</td> 304 <td> const<code> [inline]</code></td> 305 </tr> 306 </table> 307 </div> 308 <div class="memdoc"> 309 <p>Returns true if the <a class="el" href="classandroid_1_1RSC_1_1Allocation.html">Allocation</a> has mipmaps. </p> 310 <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> 311 312 <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> 313 314 </div> 315 </div> 316 <hr/>The documentation for this class was generated from the following file:<ul> 317 <li><a class="el" href="rsCppStructs_8h_source.html">rsCppStructs.h</a></li> 318 </ul> 319 </div> 320 321 </body> 322 </html> 323
