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

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::Resource Class Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7
   8 </div>
   9 <!--header-->
  10 <div class="contents">
  11 <!-- doxytag: class="pp::Resource" --><div class="dynheader">
  12 Inheritance diagram for pp::Resource:</div>
  13 <div class="dyncontent">
  14 <div class="center"><img src="classpp_1_1_resource__inherit__graph.png" border="0" usemap="#pp_1_1_resource_inherit__map" alt="Inheritance graph" /></div>
  15 <map name="pp_1_1_resource_inherit__map" id="pp_1_1_resource_inherit__map">
  16 <area shape="rect" id="node3" href="classpp_1_1_audio.html" title="An audio resource." alt="" coords="193,5,276,35"></area><area shape="rect" id="node5" href="classpp_1_1_audio_config.html" title="A 16 bit stereo AudioConfig resource." alt="" coords="173,59,296,88"></area><area shape="rect" id="node7" href="classpp_1_1_file_i_o.html" title="The FileIO class represents a regular file." alt="" coords="196,112,273,141"></area><area shape="rect" id="node9" href="classpp_1_1_file_ref.html" title='The FileRef class represents a "weak pointer" to a file in a file system.' alt="" coords="192,165,277,195"></area><area shape="rect" id="node11" href="classpp_1_1_file_system.html" title="The FileSystem class identifies the file system type associated with a file." alt="" coords="177,219,292,248"></area><area shape="rect" id="node13" href="classpp_1_1_graphics2_d.html" title="pp::Graphics2D" alt="" coords="175,272,295,301"></area><area shape="rect" id="node15" href="classpp_1_1_graphics3_d.html" title="This class represents a 3D rendering context in the browser." alt="" coords="175,325,295,355"></area><area shape="rect" id="node17" href="classpp_1_1_host_resolver.html" title="The HostResolver class supports host name resolution." alt="" coords="171,379,299,408"></area><area shape="rect" id="node19" href="classpp_1_1_image_data.html" title="pp::ImageData" alt="" coords="176,432,293,461"></area><area shape="rect" id="node21" href="classpp_1_1_input_event.html" title="This class represents an input event resource." alt="" coords="177,485,292,515"></area><area shape="rect" id="node33" href="classpp_1_1_message_loop.html" title="A message loop allows PPAPI calls to be issued on a thread." alt="" coords="168,539,301,568"></area><area shape="rect" id="node35" href="classpp_1_1_net_address.html" title="The NetAddress class represents a network address." alt="" coords="175,592,295,621"></area><area shape="rect" id="node37" href="classpp_1_1_network_list.html" title="pp::NetworkList" alt="" coords="175,645,295,675"></area><area shape="rect" id="node39" href="classpp_1_1_network_monitor.html" title="pp::NetworkMonitor" alt="" coords="161,699,308,728"></area><area shape="rect" id="node41" href="classpp_1_1_t_c_p_socket.html" title="The TCPSocket class provides TCP socket operations." alt="" coords="179,752,291,781"></area><area shape="rect" id="node43" href="classpp_1_1_u_d_p_socket.html" title="The UDPSocket class provides UDP socket operations." alt="" coords="176,805,293,835"></area><area shape="rect" id="node45" href="classpp_1_1_u_r_l_loader.html" title="URLLoader provides an API for loading URLs." alt="" coords="177,859,292,888"></area><area shape="rect" id="node47" href="classpp_1_1_u_r_l_request_info.html" title="URLRequestInfo provides an API for creating and manipulating URL requests." alt="" coords="163,912,307,941"></area><area shape="rect" id="node49" href="classpp_1_1_u_r_l_response_info.html" title="URLResponseInfo provides an API for examining URL responses." alt="" coords="157,965,312,995"></area><area shape="rect" id="node51" href="classpp_1_1_view.html" title="This class represents the state of the view for an instance and contains functions for retrieving the..." alt="" coords="197,1019,272,1048"></area><area shape="rect" id="node53" href="classpp_1_1_web_socket.html" title="The WebSocket class providing bi-directional, full-duplex, communications over a single TCP socket..." alt="" coords="177,1072,292,1101"></area><area shape="rect" id="node23" href="classpp_1_1_i_m_e_input_event.html" title="pp::IMEInputEvent" alt="" coords="379,379,515,408"></area><area shape="rect" id="node25" href="classpp_1_1_keyboard_input_event.html" title="pp::KeyboardInputEvent" alt="" coords="360,432,533,461"></area><area shape="rect" id="node27" href="classpp_1_1_mouse_input_event.html" title="This class handles mouse events." alt="" coords="369,485,524,515"></area><area shape="rect" id="node29" href="classpp_1_1_touch_input_event.html" title="pp::TouchInputEvent" alt="" coords="372,539,521,568"></area><area shape="rect" id="node31" href="classpp_1_1_wheel_input_event.html" title="pp::WheelInputEvent" alt="" coords="371,592,523,621"></area></map>
  17 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  18 <p><a href="classpp_1_1_resource-members.html">List of all members.</a></p>
  19 <h2>
  20 Public Member Functions</h2><table class="memberdecls">
  21
  22 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a56679e93a58101c8dce5dc510811a094">Resource</a> ()</td></tr>
  23 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#ab0f664099ca06367180f220ea7e0b831">Resource</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;other)</td></tr>
  24 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a081165265e2bd8217eaa2be2aeeb3aa3">~Resource</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#aaf808a98bdaa7998d82e19514aa87423">operator=</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;other)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9">is_null</a> () const </td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">PP_Resource&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a46a6123de0b007ad3fcb6f666534ccb4">pp_resource</a> () const </td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">PP_Resource&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a81b9246381bdddacca3ac25f6ded2bfd">detach</a> ()</td></tr>
  29 </table><h2>
  30 Protected Member Functions</h2><table class="memberdecls">
  31 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a555de93fdf4793f7db1183bf71d20580">Resource</a> (PP_Resource resource)</td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a907d3d6b7e292587c8cb9ff30d0a418d">Resource</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  33 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#a3eda014529127a818df8d5bb5ec2fdf0">PassRefFromConstructor</a> (PP_Resource resource)</td></tr>
  34 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#ad4016f37d3022863ca0188acb26ac9c4">Clear</a> ()</td></tr>
  35 </table><h2>
  36 Friends</h2><table class="memberdecls">
  37 <tr><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_resource.html#aef268205011788a4a9f05ed201384ace">VarResource_Dev</a></td></tr>
  38 </table>
  39 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  40 <div class="textblock"><p>A reference counted module resource. </p>
  41 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  42 <a class="anchor" id="a56679e93a58101c8dce5dc510811a094"></a><!-- doxytag: member="pp::Resource::Resource" ref="a56679e93a58101c8dce5dc510811a094" args="()" -->
  43 <div class="memitem">
  44 <div class="memproto">
  45 <table class="memname">
  46 <tr>
  47 <td class="memname"><a class="el" href="classpp_1_1_resource.html#a56679e93a58101c8dce5dc510811a094">pp::Resource::Resource</a> </td>
  48 <td>(</td>
  49 <td class="paramname"></td><td>)</td>
  50 <td></td>
  51 </tr>
  52 </table>
  53 </div>
  54 <div class="memdoc">
  55 <p>The default constructor. </p>
  56 </div>
  57 </div>
  58 <a class="anchor" id="ab0f664099ca06367180f220ea7e0b831"></a><!-- doxytag: member="pp::Resource::Resource" ref="ab0f664099ca06367180f220ea7e0b831" args="(const Resource &amp;other)" -->
  59 <div class="memitem">
  60 <div class="memproto">
  61 <table class="memname">
  62 <tr>
  63 <td class="memname"><a class="el" href="classpp_1_1_resource.html#a56679e93a58101c8dce5dc510811a094">pp::Resource::Resource</a> </td>
  64 <td>(</td>
  65 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
  66 <td class="paramname"><em>other</em></td><td>)</td>
  67 <td></td>
  68 </tr>
  69 </table>
  70 </div>
  71 <div class="memdoc">
  72 <p>A constructor for copying a resource. </p>
  73 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  74 <table class="params">
  75 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </td></tr>
  76 </table>
  77 </dd>
  78 </dl>
  79 </div>
  80 </div>
  81 <a class="anchor" id="a081165265e2bd8217eaa2be2aeeb3aa3"></a><!-- doxytag: member="pp::Resource::~Resource" ref="a081165265e2bd8217eaa2be2aeeb3aa3" args="()" -->
  82 <div class="memitem">
  83 <div class="memproto">
  84 <table class="memname">
  85 <tr>
  86 <td class="memname">virtual <a class="el" href="classpp_1_1_resource.html#a081165265e2bd8217eaa2be2aeeb3aa3">pp::Resource::~Resource</a> </td>
  87 <td>(</td>
  88 <td class="paramname"></td><td>)</td>
  89 <td><code> [virtual]</code></td>
  90 </tr>
  91 </table>
  92 </div>
  93 <div class="memdoc">
  94 <p>Destructor. </p>
  95 </div>
  96 </div>
  97 <a class="anchor" id="a555de93fdf4793f7db1183bf71d20580"></a><!-- doxytag: member="pp::Resource::Resource" ref="a555de93fdf4793f7db1183bf71d20580" args="(PP_Resource resource)" -->
  98 <div class="memitem">
  99 <div class="memproto">
 100 <table class="memname">
 101 <tr>
 102 <td class="memname"><a class="el" href="classpp_1_1_resource.html#a56679e93a58101c8dce5dc510811a094">pp::Resource::Resource</a> </td>
 103 <td>(</td>
 104 <td class="paramtype">PP_Resource&#160;</td>
 105 <td class="paramname"><em>resource</em></td><td>)</td>
 106 <td><code> [explicit, protected]</code></td>
 107 </tr>
 108 </table>
 109 </div>
 110 <div class="memdoc">
 111 <p>A constructor used when a <code>PP_Resource</code> is provided as a return value whose reference count we need to increment. </p>
 112 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 113 <table class="params">
 114 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a resource. </td></tr>
 115 </table>
 116 </dd>
 117 </dl>
 118 </div>
 119 </div>
 120 <a class="anchor" id="a907d3d6b7e292587c8cb9ff30d0a418d"></a><!-- doxytag: member="pp::Resource::Resource" ref="a907d3d6b7e292587c8cb9ff30d0a418d" args="(PassRef, PP_Resource resource)" -->
 121 <div class="memitem">
 122 <div class="memproto">
 123 <table class="memname">
 124 <tr>
 125 <td class="memname"><a class="el" href="classpp_1_1_resource.html#a56679e93a58101c8dce5dc510811a094">pp::Resource::Resource</a> </td>
 126 <td>(</td>
 127 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 128 <td class="paramname">, </td>
 129 </tr>
 130 <tr>
 131 <td class="paramkey"></td>
 132 <td></td>
 133 <td class="paramtype">PP_Resource&#160;</td>
 134 <td class="paramname"><em>resource</em>&#160;</td>
 135 </tr>
 136 <tr>
 137 <td></td>
 138 <td>)</td>
 139 <td></td><td><code> [protected]</code></td>
 140 </tr>
 141 </table>
 142 </div>
 143 <div class="memdoc">
 144 <p>Constructor used when a <code>PP_Resource</code> already has a ref count assigned. </p>
 145 <p>Add additional refcount is not taken. </p>
 146 </div>
 147 </div>
 148 <hr /><h2>Member Function Documentation</h2>
 149 <a class="anchor" id="ad4016f37d3022863ca0188acb26ac9c4"></a><!-- doxytag: member="pp::Resource::Clear" ref="ad4016f37d3022863ca0188acb26ac9c4" args="()" -->
 150 <div class="memitem">
 151 <div class="memproto">
 152 <table class="memname">
 153 <tr>
 154 <td class="memname">void <a class="el" href="classpp_1_1_resource.html#ad4016f37d3022863ca0188acb26ac9c4">pp::Resource::Clear</a> </td>
 155 <td>(</td>
 156 <td class="paramname"></td><td>)</td>
 157 <td><code> [protected]</code></td>
 158 </tr>
 159 </table>
 160 </div>
 161 <div class="memdoc">
 162 <p>Sets this resource to null. This releases ownership of the resource. </p>
 163 </div>
 164 </div>
 165 <a class="anchor" id="a81b9246381bdddacca3ac25f6ded2bfd"></a><!-- doxytag: member="pp::Resource::detach" ref="a81b9246381bdddacca3ac25f6ded2bfd" args="()" -->
 166 <div class="memitem">
 167 <div class="memproto">
 168 <table class="memname">
 169 <tr>
 170 <td class="memname">PP_Resource <a class="el" href="classpp_1_1_resource.html#a81b9246381bdddacca3ac25f6ded2bfd">pp::Resource::detach</a> </td>
 171 <td>(</td>
 172 <td class="paramname"></td><td>)</td>
 173 <td></td>
 174 </tr>
 175 </table>
 176 </div>
 177 <div class="memdoc">
 178 <p>This function releases ownership of this resource and returns it to the caller. </p>
 179 <p>Note that the reference count on the resource is unchanged and the caller needs to release the resource.</p>
 180 <dl class="return"><dt><b>Returns:</b></dt><dd>The detached <code>PP_Resource</code>. </dd></dl>
 181 </div>
 182 </div>
 183 <a class="anchor" id="a859068e34cdc2dc0b78754c255323aa9"></a><!-- doxytag: member="pp::Resource::is_null" ref="a859068e34cdc2dc0b78754c255323aa9" args="() const " -->
 184 <div class="memitem">
 185 <div class="memproto">
 186 <table class="memname">
 187 <tr>
 188 <td class="memname">bool <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9">pp::Resource::is_null</a> </td>
 189 <td>(</td>
 190 <td class="paramname"></td><td>)</td>
 191 <td> const<code> [inline]</code></td>
 192 </tr>
 193 </table>
 194 </div>
 195 <div class="memdoc">
 196 <p>This functions determines if this resource is invalid or uninitialized. </p>
 197 <dl class="return"><dt><b>Returns:</b></dt><dd>true if this resource is invalid or uninitialized. </dd></dl>
 198 </div>
 199 </div>
 200 <a class="anchor" id="aaf808a98bdaa7998d82e19514aa87423"></a><!-- doxytag: member="pp::Resource::operator=" ref="aaf808a98bdaa7998d82e19514aa87423" args="(const Resource &amp;other)" -->
 201 <div class="memitem">
 202 <div class="memproto">
 203 <table class="memname">
 204 <tr>
 205 <td class="memname"><a class="el" href="classpp_1_1_resource.html">Resource</a>&amp; pp::Resource::operator= </td>
 206 <td>(</td>
 207 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
 208 <td class="paramname"><em>other</em></td><td>)</td>
 209 <td></td>
 210 </tr>
 211 </table>
 212 </div>
 213 <div class="memdoc">
 214 <p>This function assigns one <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> to another <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </p>
 215 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 216 <table class="params">
 217 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A <a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a>.</td></tr>
 218 </table>
 219 </dd>
 220 </dl>
 221 <dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a> containing the assigned <a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a>. </dd></dl>
 222 </div>
 223 </div>
 224 <a class="anchor" id="a3eda014529127a818df8d5bb5ec2fdf0"></a><!-- doxytag: member="pp::Resource::PassRefFromConstructor" ref="a3eda014529127a818df8d5bb5ec2fdf0" args="(PP_Resource resource)" -->
 225 <div class="memitem">
 226 <div class="memproto">
 227 <table class="memname">
 228 <tr>
 229 <td class="memname">void <a class="el" href="classpp_1_1_resource.html#a3eda014529127a818df8d5bb5ec2fdf0">pp::Resource::PassRefFromConstructor</a> </td>
 230 <td>(</td>
 231 <td class="paramtype">PP_Resource&#160;</td>
 232 <td class="paramname"><em>resource</em></td><td>)</td>
 233 <td><code> [protected]</code></td>
 234 </tr>
 235 </table>
 236 </div>
 237 <div class="memdoc">
 238 <p>PassRefFromConstructor is called by derived class' constructors to initialize this <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> with a <code>PP_Resource</code> that has already had its reference count incremented by <code><a class="el" href="classpp_1_1_core.html#a09c663df7fcb527b3e5e71ea07531899" title="AddRefResource() increments the reference count for the provided resource.">Core::AddRefResource</a></code>. </p>
 239 <p>It also assumes this object has no current resource.</p>
 240 <p>The intended usage of this function that the derived class constructor will call the default <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> constructor, then make a call to create a resource. It then wants to assign the new resource (which, since it was returned by the browser, already had its reference count increased).</p>
 241 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 242 <table class="params">
 243 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to a resource. </td></tr>
 244 </table>
 245 </dd>
 246 </dl>
 247 </div>
 248 </div>
 249 <a class="anchor" id="a46a6123de0b007ad3fcb6f666534ccb4"></a><!-- doxytag: member="pp::Resource::pp_resource" ref="a46a6123de0b007ad3fcb6f666534ccb4" args="() const " -->
 250 <div class="memitem">
 251 <div class="memproto">
 252 <table class="memname">
 253 <tr>
 254 <td class="memname">PP_Resource <a class="el" href="classpp_1_1_resource.html#a46a6123de0b007ad3fcb6f666534ccb4">pp::Resource::pp_resource</a> </td>
 255 <td>(</td>
 256 <td class="paramname"></td><td>)</td>
 257 <td> const<code> [inline]</code></td>
 258 </tr>
 259 </table>
 260 </div>
 261 <div class="memdoc">
 262 </div>
 263 </div>
 264 <hr /><h2>Friends And Related Function Documentation</h2>
 265 <a class="anchor" id="aef268205011788a4a9f05ed201384ace"></a><!-- doxytag: member="pp::Resource::VarResource_Dev" ref="aef268205011788a4a9f05ed201384ace" args="" -->
 266 <div class="memitem">
 267 <div class="memproto">
 268 <table class="memname">
 269 <tr>
 270 <td class="memname">friend class <a class="el" href="classpp_1_1_resource.html#aef268205011788a4a9f05ed201384ace">VarResource_Dev</a><code> [friend]</code></td>
 271 </tr>
 272 </table>
 273 </div>
 274 <div class="memdoc">
 275 </div>
 276 </div>
 277 <hr />The documentation for this class was generated from the following file:<ul>
 278 <li><a class="el" href="resource_8h.html">resource.h</a></li>
 279 </ul>
 280 </div><!-- contents -->
 281 {{/partials.standard_nacl_article}}