libs/compute/doc/html/boost/compute/local_buffer.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template local_buffer</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.memory.local_buffer_hpp" title="Header &lt;boost/compute/memory/local_buffer.hpp&gt;">
   9 <link rel="prev" href="make_zip_iterator.html" title="Function template make_zip_iterator">
  10 <link rel="next" href="svm_ptr.html" title="Class template svm_ptr">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="make_zip_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.memory.local_buffer_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="svm_ptr.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.local_buffer"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template local_buffer</span></h2>
  29 <p>boost::compute::local_buffer &#8212; Represents a local memory buffer on the device. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.memory.local_buffer_hpp" title="Header &lt;boost/compute/memory/local_buffer.hpp&gt;">boost/compute/memory/local_buffer.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="local_buffer.html#boost.compute.local_bufferconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="local_buffer.html#idp49506432-bb"><span class="identifier">local_buffer</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="local_buffer.html#idp49508160-bb"><span class="identifier">local_buffer</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span> <a class="link" href="local_buffer.html#idp49510352-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="local_buffer.html#idp49513536-bb"><span class="special">~</span><span class="identifier">local_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="local_buffer.html#idp49504272-bb">public member functions</a></span>
  44   <span class="identifier">size_t</span> <a class="link" href="local_buffer.html#idp49504832-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idp109980752"></a><h2>Description</h2>
  48 <p>The <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> class represents a block of local memory on a compute device.</p>
  49 <p>This class is most commonly used to set local memory arguments for compute kernels: </p>
  50 <pre class="programlisting"><span class="comment">// set argument to a local buffer with storage for 32 float's</span>
  51 <span class="identifier">kernel</span><span class="special">.</span><span class="identifier">set_arg</span><span class="special">(</span><span class="number">0</span><span class="special">,</span> <span class="identifier">local_buffer</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span><span class="special">(</span><span class="number">32</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  52 </pre>
  53 <p><span class="bold"><strong>See Also:</strong></span></p>
  54 <p>buffer, kernel </p>
  55 <p>
  56 </p>
  57 <div class="refsect2">
  58 <a name="idp109993408"></a><h3>
  59 <a name="boost.compute.local_bufferconstruct-copy-destruct"></a><code class="computeroutput">local_buffer</code>
  60         public
  61        construct/copy/destruct</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1">
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idp49506432-bb"></a><span class="identifier">local_buffer</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_t</span> size<span class="special">)</span><span class="special">;</span></pre>Creates a local buffer object for <code class="computeroutput">size</code> elements. </li>
  65 <li class="listitem">
  66 <pre class="literallayout"><a name="idp49508160-bb"></a><span class="identifier">local_buffer</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a local buffer object as a copy of <code class="computeroutput">other</code>. </li>
  67 <li class="listitem">
  68 <pre class="literallayout"><a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span> <a name="idp49510352-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="local_buffer.html" title="Class template local_buffer">local_buffer</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
  69 <li class="listitem">
  70 <pre class="literallayout"><a name="idp49513536-bb"></a><span class="special">~</span><span class="identifier">local_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the local memory object. </li>
  71 </ol></div>
  72 </div>
  73 <div class="refsect2">
  74 <a name="idp110021920"></a><h3>
  75 <a name="idp49504272-bb"></a><code class="computeroutput">local_buffer</code> public member functions</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  77 <pre class="literallayout"><span class="identifier">size_t</span> <a name="idp49504832-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of elements in the local buffer. </li></ol></div>
  78 </div>
  79 </div>
  80 </div>
  81 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  82 <td align="left"></td>
  83 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
  84         Distributed under the Boost Software License, Version 1.0. (See accompanying
  85         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  86       </p>
  87 </div></td>
  88 </tr></table>
  89 <hr>
  90 <div class="spirit-nav">
  91 <a accesskey="p" href="make_zip_iterator.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.memory.local_buffer_hpp"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="svm_ptr.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  92 </div>
  93 </body>
  94 </html>