src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_compositor.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::Compositor 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::Compositor" --><!-- doxytag: inherits="pp::Resource" --><div class="dynheader">
  14 Inheritance diagram for pp::Compositor:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_compositor__inherit__graph.png" border="0" usemap="#pp_1_1_compositor_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_compositor_inherit__map" id="pp_1_1_compositor_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="13,5,117,35"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_compositor-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">Compositor</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#a0dc88d1d68ca2ab34f0c8ffa1a0b2f4b">Compositor</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#a30abcad5657f2b7779c20764f9026460">Compositor</a> (const <a class="el" href="classpp_1_1_compositor.html">Compositor</a> &amp;other)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#ad1130a511519ff5a5bc7bfae44cb0b6d">Compositor</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;resource)</td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#a43e403e54998200768d198ae95571461">Compositor</a> (<a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>, PP_Resource resource)</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#abf2a4c7ef3a0a727d1b80a5cd2f39729">~Compositor</a> ()</td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#adddfb226d04f6169def30afe3639c15d">AddLayer</a> ()</td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#ad9171e29e89900cccd7c10cc4654cae1">CommitLayers</a> (const <a class="el" href="classpp_1_1_completion_callback.html">CompletionCallback</a> &amp;cc)</td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#a178daa26f7dd593a6905235fa840d54b">ResetLayers</a> ()</td></tr>
  33 </table><h2>
  34 Static Public Member Functions</h2><table class="memberdecls">
  35 <tr><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_compositor.html#ab699455da240e4a7ed01740b4c05d81f">IsCompositor</a> (const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;resource)</td></tr>
  36 </table>
  37 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  38 <div class="textblock"><p>The <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code> interface is used for setting <code><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a></code> layers to the Chromium compositor for compositing. </p>
  39 <p>This allows a plugin to combine different sources of visual data efficiently, such as <code><a class="el" href="classpp_1_1_image_data.html">ImageData</a></code> images and OpenGL textures. See also <code><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a></code> for more information. </p>
  40 </div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
  41 <a class="anchor" id="abe16adaeaac2569518d28e070ce487b2"></a><!-- doxytag: member="pp::Compositor::Compositor" ref="abe16adaeaac2569518d28e070ce487b2" args="()" -->
  42 <div class="memitem">
  43 <div class="memproto">
  44 <table class="memname">
  45 <tr>
  46 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">pp::Compositor::Compositor</a> </td>
  47 <td>(</td>
  48 <td class="paramname"></td><td>)</td>
  49 <td></td>
  50 </tr>
  51 </table>
  52 </div>
  53 <div class="memdoc">
  54 <p>Default constructor for creating an <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code> object. </p>
  55 </div>
  56 </div>
  57 <a class="anchor" id="a0dc88d1d68ca2ab34f0c8ffa1a0b2f4b"></a><!-- doxytag: member="pp::Compositor::Compositor" ref="a0dc88d1d68ca2ab34f0c8ffa1a0b2f4b" args="(const InstanceHandle &amp;instance)" -->
  58 <div class="memitem">
  59 <div class="memproto">
  60 <table class="memname">
  61 <tr>
  62 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">pp::Compositor::Compositor</a> </td>
  63 <td>(</td>
  64 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  65 <td class="paramname"><em>instance</em></td><td>)</td>
  66 <td><code> [explicit]</code></td>
  67 </tr>
  68 </table>
  69 </div>
  70 <div class="memdoc">
  71 <p>A constructor for creating and initializing a compositor. </p>
  72 <p>On failure, the object will be <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a>. </p>
  73 </div>
  74 </div>
  75 <a class="anchor" id="a30abcad5657f2b7779c20764f9026460"></a><!-- doxytag: member="pp::Compositor::Compositor" ref="a30abcad5657f2b7779c20764f9026460" args="(const Compositor &amp;other)" -->
  76 <div class="memitem">
  77 <div class="memproto">
  78 <table class="memname">
  79 <tr>
  80 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">pp::Compositor::Compositor</a> </td>
  81 <td>(</td>
  82 <td class="paramtype">const <a class="el" href="classpp_1_1_compositor.html">Compositor</a> &amp;&#160;</td>
  83 <td class="paramname"><em>other</em></td><td>)</td>
  84 <td></td>
  85 </tr>
  86 </table>
  87 </div>
  88 <div class="memdoc">
  89 <p>The copy constructor for <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code>. </p>
  90 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  91 <table class="params">
  92 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>A reference to a <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code>. </td></tr>
  93 </table>
  94 </dd>
  95 </dl>
  96 </div>
  97 </div>
  98 <a class="anchor" id="ad1130a511519ff5a5bc7bfae44cb0b6d"></a><!-- doxytag: member="pp::Compositor::Compositor" ref="ad1130a511519ff5a5bc7bfae44cb0b6d" args="(const Resource &amp;resource)" -->
  99 <div class="memitem">
 100 <div class="memproto">
 101 <table class="memname">
 102 <tr>
 103 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">pp::Compositor::Compositor</a> </td>
 104 <td>(</td>
 105 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
 106 <td class="paramname"><em>resource</em></td><td>)</td>
 107 <td><code> [explicit]</code></td>
 108 </tr>
 109 </table>
 110 </div>
 111 <div class="memdoc">
 112 <p>Constructs a <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code> from a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code>. </p>
 113 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 114 <table class="params">
 115 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_Compositor</code> resource. </td></tr>
 116 </table>
 117 </dd>
 118 </dl>
 119 </div>
 120 </div>
 121 <a class="anchor" id="a43e403e54998200768d198ae95571461"></a><!-- doxytag: member="pp::Compositor::Compositor" ref="a43e403e54998200768d198ae95571461" args="(PassRef, PP_Resource resource)" -->
 122 <div class="memitem">
 123 <div class="memproto">
 124 <table class="memname">
 125 <tr>
 126 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abe16adaeaac2569518d28e070ce487b2">pp::Compositor::Compositor</a> </td>
 127 <td>(</td>
 128 <td class="paramtype"><a class="el" href="namespacepp.html#a339083c1beec620267bf8b3c55decaa5">PassRef</a>&#160;</td>
 129 <td class="paramname">, </td>
 130 </tr>
 131 <tr>
 132 <td class="paramkey"></td>
 133 <td></td>
 134 <td class="paramtype">PP_Resource&#160;</td>
 135 <td class="paramname"><em>resource</em>&#160;</td>
 136 </tr>
 137 <tr>
 138 <td></td>
 139 <td>)</td>
 140 <td></td><td></td>
 141 </tr>
 142 </table>
 143 </div>
 144 <div class="memdoc">
 145 <p>A constructor used when you have received a <code>PP_Resource</code> as a return value that has had 1 ref added on behalf of the caller. </p>
 146 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 147 <table class="params">
 148 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PPB_Compositor</code> resource. </td></tr>
 149 </table>
 150 </dd>
 151 </dl>
 152 </div>
 153 </div>
 154 <a class="anchor" id="abf2a4c7ef3a0a727d1b80a5cd2f39729"></a><!-- doxytag: member="pp::Compositor::~Compositor" ref="abf2a4c7ef3a0a727d1b80a5cd2f39729" args="()" -->
 155 <div class="memitem">
 156 <div class="memproto">
 157 <table class="memname">
 158 <tr>
 159 <td class="memname"><a class="el" href="classpp_1_1_compositor.html#abf2a4c7ef3a0a727d1b80a5cd2f39729">pp::Compositor::~Compositor</a> </td>
 160 <td>(</td>
 161 <td class="paramname"></td><td>)</td>
 162 <td></td>
 163 </tr>
 164 </table>
 165 </div>
 166 <div class="memdoc">
 167 <p>Destructor. </p>
 168 </div>
 169 </div>
 170 <hr /><h2>Member Function Documentation</h2>
 171 <a class="anchor" id="adddfb226d04f6169def30afe3639c15d"></a><!-- doxytag: member="pp::Compositor::AddLayer" ref="adddfb226d04f6169def30afe3639c15d" args="()" -->
 172 <div class="memitem">
 173 <div class="memproto">
 174 <table class="memname">
 175 <tr>
 176 <td class="memname"><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a> <a class="el" href="classpp_1_1_compositor.html#adddfb226d04f6169def30afe3639c15d">pp::Compositor::AddLayer</a> </td>
 177 <td>(</td>
 178 <td class="paramname"></td><td>)</td>
 179 <td></td>
 180 </tr>
 181 </table>
 182 </div>
 183 <div class="memdoc">
 184 <p>Creates a new <code><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a></code> and adds it to the end of the layer stack. </p>
 185 <p>A <code><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a></code> containing the layer is returned. It is uninitialized, <code>SetColor()</code>, <code>SetTexture</code> or <code>SetImage</code> should be used to initialize it. The layer will appear above other pre-existing layers. If <code>ResetLayers</code> is called or the <code>PPB_Compositor</code> is released, the returned layer will be invalidated, and any further calls on the layer will return <code>PP_ERROR_BADRESOURCE</code>.</p>
 186 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code><a class="el" href="classpp_1_1_compositor_layer.html">CompositorLayer</a></code> containing the compositor layer resource. </dd></dl>
 187 </div>
 188 </div>
 189 <a class="anchor" id="ad9171e29e89900cccd7c10cc4654cae1"></a><!-- doxytag: member="pp::Compositor::CommitLayers" ref="ad9171e29e89900cccd7c10cc4654cae1" args="(const CompletionCallback &amp;cc)" -->
 190 <div class="memitem">
 191 <div class="memproto">
 192 <table class="memname">
 193 <tr>
 194 <td class="memname">int32_t <a class="el" href="classpp_1_1_compositor.html#ad9171e29e89900cccd7c10cc4654cae1">pp::Compositor::CommitLayers</a> </td>
 195 <td>(</td>
 196 <td class="paramtype">const <a class="el" href="classpp_1_1_completion_callback.html">CompletionCallback</a> &amp;&#160;</td>
 197 <td class="paramname"><em>cc</em></td><td>)</td>
 198 <td></td>
 199 </tr>
 200 </table>
 201 </div>
 202 <div class="memdoc">
 203 <p>Commits layers added by <code><a class="el" href="classpp_1_1_compositor.html#adddfb226d04f6169def30afe3639c15d" title="Creates a new CompositorLayer and adds it to the end of the layer stack.">AddLayer()</a></code> to the chromium compositor. </p>
 204 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 205 <table class="params">
 206 <tr><td class="paramdir">[in]</td><td class="paramname">cc</td><td>A <code><a class="el" href="classpp_1_1_completion_callback.html" title="This API enables you to implement and receive callbacks when Pepper operations complete asynchronousl...">CompletionCallback</a></code> to be called when layers have been represented on screen.</td></tr>
 207 </table>
 208 </dd>
 209 </dl>
 210 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing a result code from <code>pp_errors.h</code>. </dd></dl>
 211 </div>
 212 </div>
 213 <a class="anchor" id="ab699455da240e4a7ed01740b4c05d81f"></a><!-- doxytag: member="pp::Compositor::IsCompositor" ref="ab699455da240e4a7ed01740b4c05d81f" args="(const Resource &amp;resource)" -->
 214 <div class="memitem">
 215 <div class="memproto">
 216 <table class="memname">
 217 <tr>
 218 <td class="memname">static bool <a class="el" href="classpp_1_1_compositor.html#ab699455da240e4a7ed01740b4c05d81f">pp::Compositor::IsCompositor</a> </td>
 219 <td>(</td>
 220 <td class="paramtype">const <a class="el" href="classpp_1_1_resource.html">Resource</a> &amp;&#160;</td>
 221 <td class="paramname"><em>resource</em></td><td>)</td>
 222 <td><code> [static]</code></td>
 223 </tr>
 224 </table>
 225 </div>
 226 <div class="memdoc">
 227 <p>Checks whether a <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> is a compositor, to test whether it is appropriate for use with the <code><a class="el" href="classpp_1_1_compositor.html" title="The Compositor interface is used for setting CompositorLayer layers to the Chromium compositor for co...">Compositor</a></code> constructor. </p>
 228 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 229 <table class="params">
 230 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code><a class="el" href="classpp_1_1_resource.html" title="A reference counted module resource.">Resource</a></code> to test.</td></tr>
 231 </table>
 232 </dd>
 233 </dl>
 234 <dl class="return"><dt><b>Returns:</b></dt><dd>True if <code>resource</code> is a compositor. </dd></dl>
 235 </div>
 236 </div>
 237 <a class="anchor" id="a178daa26f7dd593a6905235fa840d54b"></a><!-- doxytag: member="pp::Compositor::ResetLayers" ref="a178daa26f7dd593a6905235fa840d54b" args="()" -->
 238 <div class="memitem">
 239 <div class="memproto">
 240 <table class="memname">
 241 <tr>
 242 <td class="memname">int32_t <a class="el" href="classpp_1_1_compositor.html#a178daa26f7dd593a6905235fa840d54b">pp::Compositor::ResetLayers</a> </td>
 243 <td>(</td>
 244 <td class="paramname"></td><td>)</td>
 245 <td></td>
 246 </tr>
 247 </table>
 248 </div>
 249 <div class="memdoc">
 250 <p>Resets layers added by <code><a class="el" href="classpp_1_1_compositor.html#adddfb226d04f6169def30afe3639c15d" title="Creates a new CompositorLayer and adds it to the end of the layer stack.">AddLayer()</a></code> </p>
 251 <dl class="return"><dt><b>Returns:</b></dt><dd>An int32_t containing a result code from <code>pp_errors.h</code>. </dd></dl>
 252 </div>
 253 </div>
 254 <hr />The documentation for this class was generated from the following file:<ul>
 255 <li><a class="el" href="compositor_8h.html">compositor.h</a></li>
 256 </ul>
 257 </div><!-- contents -->
 258 </div>
 259 {{/partials.standard_nacl_api}}