src/native_client_sdk/doc_generated/pepper_beta/cpp/classpp_1_1_size.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::Size Class Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::Size" -->
  14 <p><a href="classpp_1_1_size-members.html">List of all members.</a></p>
  15 <h2>
  16 Public Member Functions</h2><table class="memberdecls">
  17
  18 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a5ffffc4488c677716baed27752b6a6c1">Size</a> ()</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#aa050f55ab1775d0ee1b0ae174e1495df">Size</a> (const PP_Size &amp;s)</td></tr>
  20 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a14a1c612454596e43a94c01da338bc1e">Size</a> (int w, int h)</td></tr>
  21 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#aff4a88df9882be410ca78d338d2d87dc">~Size</a> ()</td></tr>
  22 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a72cbb6066dd37615daaa3d3c1a0c595a">operator PP_Size</a> ()</td></tr>
  23 <tr><td class="memItemLeft" align="right" valign="top">const PP_Size &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#ad61947a5f2a3bbe90dc62c62cc799174">pp_size</a> () const </td></tr>
  24 <tr><td class="memItemLeft" align="right" valign="top">PP_Size &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#ae20ce070c015adec8b5411b047db5917">pp_size</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#af043a504c701e32c504c63b9e91ac500">width</a> () const </td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a104cf1f6a95c1430f7cd15a26815e82a">set_width</a> (int w)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a61a68178eefa2589ead95491ac079139">height</a> () const </td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a2805413bf372ad033fcf505c8d3cce34">set_height</a> (int h)</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#ac056add4f1e8b1f90a6e3c65afa4ba3b">GetArea</a> () const </td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a25d85979d55798a9b672ca73c1d48222">SetSize</a> (int w, int h)</td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a51a74964f27e139003b82aad55dd63f5">Enlarge</a> (int w, int h)</td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_size.html#a11e791714686761966773adcc94218bb">IsEmpty</a> () const </td></tr>
  33 </table>
  34 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  35 <div class="textblock"><p>A size of an object based on width and height. </p>
  36 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  37 <a class="anchor" id="a5ffffc4488c677716baed27752b6a6c1"></a><!-- doxytag: member="pp::Size::Size" ref="a5ffffc4488c677716baed27752b6a6c1" args="()" -->
  38 <div class="memitem">
  39 <div class="memproto">
  40 <table class="memname">
  41 <tr>
  42 <td class="memname"><a class="el" href="classpp_1_1_size.html#a5ffffc4488c677716baed27752b6a6c1">pp::Size::Size</a> </td>
  43 <td>(</td>
  44 <td class="paramname"></td><td>)</td>
  45 <td><code> [inline]</code></td>
  46 </tr>
  47 </table>
  48 </div>
  49 <div class="memdoc">
  50 <p>The default constructor. Initializes the width and height to 0. </p>
  51 </div>
  52 </div>
  53 <a class="anchor" id="aa050f55ab1775d0ee1b0ae174e1495df"></a><!-- doxytag: member="pp::Size::Size" ref="aa050f55ab1775d0ee1b0ae174e1495df" args="(const PP_Size &amp;s)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56 <table class="memname">
  57 <tr>
  58 <td class="memname"><a class="el" href="classpp_1_1_size.html#a5ffffc4488c677716baed27752b6a6c1">pp::Size::Size</a> </td>
  59 <td>(</td>
  60 <td class="paramtype">const PP_Size &amp;&#160;</td>
  61 <td class="paramname"><em>s</em></td><td>)</td>
  62 <td><code> [inline]</code></td>
  63 </tr>
  64 </table>
  65 </div>
  66 <div class="memdoc">
  67 <p>A constructor accepting a pointer to a <code>PP_Size</code> and converting the <code>PP_Size</code> to a <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code>. </p>
  68 <p>This is an implicit conversion constructor.</p>
  69 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  70 <table class="params">
  71 <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>A pointer to a <code>PP_Size</code>. </td></tr>
  72 </table>
  73 </dd>
  74 </dl>
  75 </div>
  76 </div>
  77 <a class="anchor" id="a14a1c612454596e43a94c01da338bc1e"></a><!-- doxytag: member="pp::Size::Size" ref="a14a1c612454596e43a94c01da338bc1e" args="(int w, int h)" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80 <table class="memname">
  81 <tr>
  82 <td class="memname"><a class="el" href="classpp_1_1_size.html#a5ffffc4488c677716baed27752b6a6c1">pp::Size::Size</a> </td>
  83 <td>(</td>
  84 <td class="paramtype">int&#160;</td>
  85 <td class="paramname"><em>w</em>, </td>
  86 </tr>
  87 <tr>
  88 <td class="paramkey"></td>
  89 <td></td>
  90 <td class="paramtype">int&#160;</td>
  91 <td class="paramname"><em>h</em>&#160;</td>
  92 </tr>
  93 <tr>
  94 <td></td>
  95 <td>)</td>
  96 <td></td><td><code> [inline]</code></td>
  97 </tr>
  98 </table>
  99 </div>
 100 <div class="memdoc">
 101 <p>A constructor accepting two int values for width and height and converting them to a <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code>. </p>
 102 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 103 <table class="params">
 104 <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>An int value representing a width. </td></tr>
 105 <tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>An int value representing a height. </td></tr>
 106 </table>
 107 </dd>
 108 </dl>
 109 </div>
 110 </div>
 111 <a class="anchor" id="aff4a88df9882be410ca78d338d2d87dc"></a><!-- doxytag: member="pp::Size::~Size" ref="aff4a88df9882be410ca78d338d2d87dc" args="()" -->
 112 <div class="memitem">
 113 <div class="memproto">
 114 <table class="memname">
 115 <tr>
 116 <td class="memname"><a class="el" href="classpp_1_1_size.html#aff4a88df9882be410ca78d338d2d87dc">pp::Size::~Size</a> </td>
 117 <td>(</td>
 118 <td class="paramname"></td><td>)</td>
 119 <td><code> [inline]</code></td>
 120 </tr>
 121 </table>
 122 </div>
 123 <div class="memdoc">
 124 <p>Destructor. </p>
 125 </div>
 126 </div>
 127 <hr /><h2>Member Function Documentation</h2>
 128 <a class="anchor" id="a51a74964f27e139003b82aad55dd63f5"></a><!-- doxytag: member="pp::Size::Enlarge" ref="a51a74964f27e139003b82aad55dd63f5" args="(int w, int h)" -->
 129 <div class="memitem">
 130 <div class="memproto">
 131 <table class="memname">
 132 <tr>
 133 <td class="memname">void <a class="el" href="classpp_1_1_size.html#a51a74964f27e139003b82aad55dd63f5">pp::Size::Enlarge</a> </td>
 134 <td>(</td>
 135 <td class="paramtype">int&#160;</td>
 136 <td class="paramname"><em>w</em>, </td>
 137 </tr>
 138 <tr>
 139 <td class="paramkey"></td>
 140 <td></td>
 141 <td class="paramtype">int&#160;</td>
 142 <td class="paramname"><em>h</em>&#160;</td>
 143 </tr>
 144 <tr>
 145 <td></td>
 146 <td>)</td>
 147 <td></td><td><code> [inline]</code></td>
 148 </tr>
 149 </table>
 150 </div>
 151 <div class="memdoc">
 152 <p><a class="el" href="classpp_1_1_size.html#a51a74964f27e139003b82aad55dd63f5" title="Enlarge() enlarges the size of an object.">Enlarge()</a> enlarges the size of an object. </p>
 153 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 154 <table class="params">
 155 <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>A width to add the current width. </td></tr>
 156 <tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A height to add to the current height. </td></tr>
 157 </table>
 158 </dd>
 159 </dl>
 160 </div>
 161 </div>
 162 <a class="anchor" id="ac056add4f1e8b1f90a6e3c65afa4ba3b"></a><!-- doxytag: member="pp::Size::GetArea" ref="ac056add4f1e8b1f90a6e3c65afa4ba3b" args="() const " -->
 163 <div class="memitem">
 164 <div class="memproto">
 165 <table class="memname">
 166 <tr>
 167 <td class="memname">int <a class="el" href="classpp_1_1_size.html#ac056add4f1e8b1f90a6e3c65afa4ba3b">pp::Size::GetArea</a> </td>
 168 <td>(</td>
 169 <td class="paramname"></td><td>)</td>
 170 <td> const<code> [inline]</code></td>
 171 </tr>
 172 </table>
 173 </div>
 174 <div class="memdoc">
 175 <p><a class="el" href="classpp_1_1_size.html#ac056add4f1e8b1f90a6e3c65afa4ba3b" title="GetArea() determines the area (width * height).">GetArea()</a> determines the area (width * height). </p>
 176 <dl class="return"><dt><b>Returns:</b></dt><dd>The area. </dd></dl>
 177 </div>
 178 </div>
 179 <a class="anchor" id="a61a68178eefa2589ead95491ac079139"></a><!-- doxytag: member="pp::Size::height" ref="a61a68178eefa2589ead95491ac079139" args="() const " -->
 180 <div class="memitem">
 181 <div class="memproto">
 182 <table class="memname">
 183 <tr>
 184 <td class="memname">int <a class="el" href="classpp_1_1_size.html#a61a68178eefa2589ead95491ac079139">pp::Size::height</a> </td>
 185 <td>(</td>
 186 <td class="paramname"></td><td>)</td>
 187 <td> const<code> [inline]</code></td>
 188 </tr>
 189 </table>
 190 </div>
 191 <div class="memdoc">
 192 <p>Getter function for returning the value of height. </p>
 193 <dl class="return"><dt><b>Returns:</b></dt><dd>The value of height for this <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code>. </dd></dl>
 194 </div>
 195 </div>
 196 <a class="anchor" id="a11e791714686761966773adcc94218bb"></a><!-- doxytag: member="pp::Size::IsEmpty" ref="a11e791714686761966773adcc94218bb" args="() const " -->
 197 <div class="memitem">
 198 <div class="memproto">
 199 <table class="memname">
 200 <tr>
 201 <td class="memname">bool <a class="el" href="classpp_1_1_size.html#a11e791714686761966773adcc94218bb">pp::Size::IsEmpty</a> </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><a class="el" href="classpp_1_1_size.html#a11e791714686761966773adcc94218bb" title="IsEmpty() determines if the size is zero.">IsEmpty()</a> determines if the size is zero. </p>
 210 <dl class="return"><dt><b>Returns:</b></dt><dd>true if the size is zero. </dd></dl>
 211 </div>
 212 </div>
 213 <a class="anchor" id="a72cbb6066dd37615daaa3d3c1a0c595a"></a><!-- doxytag: member="pp::Size::operator PP_Size" ref="a72cbb6066dd37615daaa3d3c1a0c595a" args="()" -->
 214 <div class="memitem">
 215 <div class="memproto">
 216 <table class="memname">
 217 <tr>
 218 <td class="memname">pp::Size::operator PP_Size </td>
 219 <td>(</td>
 220 <td class="paramname"></td><td>)</td>
 221 <td><code> [inline]</code></td>
 222 </tr>
 223 </table>
 224 </div>
 225 <div class="memdoc">
 226 <p>PP_Size() allows implicit conversion of a <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code> to a <code>PP_Size</code>. </p>
 227 <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a>. </dd></dl>
 228 </div>
 229 </div>
 230 <a class="anchor" id="ad61947a5f2a3bbe90dc62c62cc799174"></a><!-- doxytag: member="pp::Size::pp_size" ref="ad61947a5f2a3bbe90dc62c62cc799174" args="() const " -->
 231 <div class="memitem">
 232 <div class="memproto">
 233 <table class="memname">
 234 <tr>
 235 <td class="memname">const PP_Size&amp; <a class="el" href="classpp_1_1_size.html#ad61947a5f2a3bbe90dc62c62cc799174">pp::Size::pp_size</a> </td>
 236 <td>(</td>
 237 <td class="paramname"></td><td>)</td>
 238 <td> const<code> [inline]</code></td>
 239 </tr>
 240 </table>
 241 </div>
 242 <div class="memdoc">
 243 <p>Getter function for returning the internal <code>PP_Size</code> struct. </p>
 244 <dl class="return"><dt><b>Returns:</b></dt><dd>A const reference to the internal <code>PP_Size</code> struct. </dd></dl>
 245 </div>
 246 </div>
 247 <a class="anchor" id="ae20ce070c015adec8b5411b047db5917"></a><!-- doxytag: member="pp::Size::pp_size" ref="ae20ce070c015adec8b5411b047db5917" args="()" -->
 248 <div class="memitem">
 249 <div class="memproto">
 250 <table class="memname">
 251 <tr>
 252 <td class="memname">PP_Size&amp; <a class="el" href="classpp_1_1_size.html#ad61947a5f2a3bbe90dc62c62cc799174">pp::Size::pp_size</a> </td>
 253 <td>(</td>
 254 <td class="paramname"></td><td>)</td>
 255 <td><code> [inline]</code></td>
 256 </tr>
 257 </table>
 258 </div>
 259 <div class="memdoc">
 260 <p>Getter function for returning the internal <code>PP_Size</code> struct. </p>
 261 <dl class="return"><dt><b>Returns:</b></dt><dd>A mutable reference to the <code>PP_Size</code> struct. </dd></dl>
 262 </div>
 263 </div>
 264 <a class="anchor" id="a2805413bf372ad033fcf505c8d3cce34"></a><!-- doxytag: member="pp::Size::set_height" ref="a2805413bf372ad033fcf505c8d3cce34" args="(int h)" -->
 265 <div class="memitem">
 266 <div class="memproto">
 267 <table class="memname">
 268 <tr>
 269 <td class="memname">void <a class="el" href="classpp_1_1_size.html#a2805413bf372ad033fcf505c8d3cce34">pp::Size::set_height</a> </td>
 270 <td>(</td>
 271 <td class="paramtype">int&#160;</td>
 272 <td class="paramname"><em>h</em></td><td>)</td>
 273 <td><code> [inline]</code></td>
 274 </tr>
 275 </table>
 276 </div>
 277 <div class="memdoc">
 278 <p>Setter function for setting the value of height. </p>
 279 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 280 <table class="params">
 281 <tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A new height value. </td></tr>
 282 </table>
 283 </dd>
 284 </dl>
 285 </div>
 286 </div>
 287 <a class="anchor" id="a104cf1f6a95c1430f7cd15a26815e82a"></a><!-- doxytag: member="pp::Size::set_width" ref="a104cf1f6a95c1430f7cd15a26815e82a" args="(int w)" -->
 288 <div class="memitem">
 289 <div class="memproto">
 290 <table class="memname">
 291 <tr>
 292 <td class="memname">void <a class="el" href="classpp_1_1_size.html#a104cf1f6a95c1430f7cd15a26815e82a">pp::Size::set_width</a> </td>
 293 <td>(</td>
 294 <td class="paramtype">int&#160;</td>
 295 <td class="paramname"><em>w</em></td><td>)</td>
 296 <td><code> [inline]</code></td>
 297 </tr>
 298 </table>
 299 </div>
 300 <div class="memdoc">
 301 <p>Setter function for setting the value of width. </p>
 302 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 303 <table class="params">
 304 <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>A new width value. </td></tr>
 305 </table>
 306 </dd>
 307 </dl>
 308 </div>
 309 </div>
 310 <a class="anchor" id="a25d85979d55798a9b672ca73c1d48222"></a><!-- doxytag: member="pp::Size::SetSize" ref="a25d85979d55798a9b672ca73c1d48222" args="(int w, int h)" -->
 311 <div class="memitem">
 312 <div class="memproto">
 313 <table class="memname">
 314 <tr>
 315 <td class="memname">void <a class="el" href="classpp_1_1_size.html#a25d85979d55798a9b672ca73c1d48222">pp::Size::SetSize</a> </td>
 316 <td>(</td>
 317 <td class="paramtype">int&#160;</td>
 318 <td class="paramname"><em>w</em>, </td>
 319 </tr>
 320 <tr>
 321 <td class="paramkey"></td>
 322 <td></td>
 323 <td class="paramtype">int&#160;</td>
 324 <td class="paramname"><em>h</em>&#160;</td>
 325 </tr>
 326 <tr>
 327 <td></td>
 328 <td>)</td>
 329 <td></td><td><code> [inline]</code></td>
 330 </tr>
 331 </table>
 332 </div>
 333 <div class="memdoc">
 334 <p><a class="el" href="classpp_1_1_size.html#a25d85979d55798a9b672ca73c1d48222" title="SetSize() sets the value of width and height.">SetSize()</a> sets the value of width and height. </p>
 335 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 336 <table class="params">
 337 <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>A new width value. </td></tr>
 338 <tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>A new height value. </td></tr>
 339 </table>
 340 </dd>
 341 </dl>
 342 </div>
 343 </div>
 344 <a class="anchor" id="af043a504c701e32c504c63b9e91ac500"></a><!-- doxytag: member="pp::Size::width" ref="af043a504c701e32c504c63b9e91ac500" args="() const " -->
 345 <div class="memitem">
 346 <div class="memproto">
 347 <table class="memname">
 348 <tr>
 349 <td class="memname">int <a class="el" href="classpp_1_1_size.html#af043a504c701e32c504c63b9e91ac500">pp::Size::width</a> </td>
 350 <td>(</td>
 351 <td class="paramname"></td><td>)</td>
 352 <td> const<code> [inline]</code></td>
 353 </tr>
 354 </table>
 355 </div>
 356 <div class="memdoc">
 357 <p>Getter function for returning the value of width. </p>
 358 <dl class="return"><dt><b>Returns:</b></dt><dd>The value of width for this <code><a class="el" href="classpp_1_1_size.html" title="A size of an object based on width and height.">Size</a></code>. </dd></dl>
 359 </div>
 360 </div>
 361 <hr />The documentation for this class was generated from the following file:<ul>
 362 <li><a class="el" href="size_8h.html">size.h</a></li>
 363 </ul>
 364 </div><!-- contents -->
 365 </div>
 366 {{/partials.standard_nacl_article}}