libs/compute/doc/html/boost/compute/image_sampler.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class image_sampler</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.image.image_sampler_hpp" title="Header &lt;boost/compute/image/image_sampler.hpp&gt;">
   9 <link rel="prev" href="image_object.html" title="Class image_object">
  10 <link rel="next" href="opengl_e_idm46009692495472.html" title="Function opengl_enqueue_acquire_gl_objects">
  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="image_object.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_sampler_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="opengl_e_idm46009692495472.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.image_sampler"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class image_sampler</span></h2>
  29 <p>boost::compute::image_sampler &#8212; An OpenCL image sampler object. </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.image.image_sampler_hpp" title="Header &lt;boost/compute/image/image_sampler.hpp&gt;">boost/compute/image/image_sampler.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37
  38   <span class="keyword">enum</span> <a name="boost.compute.image_sampler.addressing_mode"></a>addressing_mode <span class="special">{</span> none = = CL_ADDRESS_NONE,
  39                          clamp_to_edge = = CL_ADDRESS_CLAMP_TO_EDGE,
  40                          clamp = = CL_ADDRESS_CLAMP,
  41                          repeat = = CL_ADDRESS_REPEAT <span class="special">}</span><span class="special">;</span>
  42
  43   <span class="keyword">enum</span> <a name="boost.compute.image_sampler.filter_mode"></a>filter_mode <span class="special">{</span> nearest = = CL_FILTER_NEAREST,
  44                      linear = = CL_FILTER_LINEAR <span class="special">}</span><span class="special">;</span>
  45   <span class="comment">// <a class="link" href="image_sampler.html#boost.compute.image_samplerconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="image_sampler.html#idm46009692513216-bb"><span class="identifier">image_sampler</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="image_sampler.html#idm46009692512928-bb"><span class="identifier">image_sampler</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="identifier">cl_addressing_mode</span><span class="special">,</span> <span class="identifier">cl_filter_mode</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">explicit</span> <a class="link" href="image_sampler.html#idm46009692509888-bb"><span class="identifier">image_sampler</span></a><span class="special">(</span><span class="identifier">cl_sampler</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span>
  49   <a class="link" href="image_sampler.html#idm46009692507664-bb"><span class="identifier">image_sampler</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="image_sampler.html#idm46009692502272-bb"><span class="identifier">image_sampler</span></a><span class="special">(</span><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  51   <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> <a class="link" href="image_sampler.html#idm46009692505472-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> <a class="link" href="image_sampler.html#idm46009692500736-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  53   <a class="link" href="image_sampler.html#idm46009692498624-bb"><span class="special">~</span><span class="identifier">image_sampler</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="image_sampler.html#idm46009692532368-bb">public member functions</a></span>
  56   <span class="identifier">cl_sampler</span> <span class="special">&amp;</span> <a class="link" href="image_sampler.html#idm46009692531808-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="identifier">context</span> <a class="link" href="image_sampler.html#idm46009692529952-bb"><span class="identifier">get_context</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a class="link" href="image_sampler.html#idm46009692528512-bb"><span class="identifier">get_info</span></a><span class="special">(</span><span class="identifier">cl_sampler_info</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">int</span> Enum<span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="image_sampler.html#idm46009692524336-bb"><span class="identifier">get_info</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <span class="keyword">bool</span> <a class="link" href="image_sampler.html#idm46009692521408-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">bool</span> <a class="link" href="image_sampler.html#idm46009692517952-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62   <a class="link" href="image_sampler.html#idm46009692514496-bb"><span class="keyword">operator</span> <span class="identifier">cl_sampler</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63 <span class="special">}</span><span class="special">;</span></pre></div>
  64 <div class="refsect1">
  65 <a name="idm46113320902560"></a><h2>Description</h2>
  66 <p><span class="bold"><strong>See Also:</strong></span></p>
  67 <p><a class="link" href="image2d.html" title="Class image2d">image2d</a>, <a class="link" href="image_format.html" title="Class image_format">image_format</a> </p>
  68 <p>
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idm46113320899264"></a><h3>
  74 <a name="boost.compute.image_samplerconstruct-copy-destruct"></a><code class="computeroutput">image_sampler</code>
  75         public
  76        construct/copy/destruct</h3>
  77 <div class="orderedlist"><ol class="orderedlist" type="1">
  78 <li class="listitem"><pre class="literallayout"><a name="idm46009692513216-bb"></a><span class="identifier">image_sampler</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  79 <li class="listitem"><pre class="literallayout"><a name="idm46009692512928-bb"></a><span class="identifier">image_sampler</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&amp;</span> context<span class="special">,</span> <span class="keyword">bool</span> normalized_coords<span class="special">,</span>
  80               <span class="identifier">cl_addressing_mode</span> addressing_mode<span class="special">,</span> <span class="identifier">cl_filter_mode</span> filter_mode<span class="special">)</span><span class="special">;</span></pre></li>
  81 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692509888-bb"></a><span class="identifier">image_sampler</span><span class="special">(</span><span class="identifier">cl_sampler</span> sampler<span class="special">,</span> <span class="keyword">bool</span> retain <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre></li>
  82 <li class="listitem">
  83 <pre class="literallayout"><a name="idm46009692507664-bb"></a><span class="identifier">image_sampler</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new image sampler object as a copy of <code class="computeroutput">other</code>. </li>
  84 <li class="listitem"><pre class="literallayout"><a name="idm46009692502272-bb"></a><span class="identifier">image_sampler</span><span class="special">(</span><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  85 <li class="listitem">
  86 <pre class="literallayout"><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> <a name="idm46009692505472-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the image sampler object from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
  87 <li class="listitem"><pre class="literallayout"><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> <a name="idm46009692500736-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
  88 <li class="listitem">
  89 <pre class="literallayout"><a name="idm46009692498624-bb"></a><span class="special">~</span><span class="identifier">image_sampler</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the image sampler object. </li>
  90 </ol></div>
  91 </div>
  92 <div class="refsect2">
  93 <a name="idm46113320841552"></a><h3>
  94 <a name="idm46009692532368-bb"></a><code class="computeroutput">image_sampler</code> public member functions</h3>
  95 <div class="orderedlist"><ol class="orderedlist" type="1">
  96 <li class="listitem">
  97 <pre class="literallayout"><span class="identifier">cl_sampler</span> <span class="special">&amp;</span> <a name="idm46009692531808-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the underlying <code class="computeroutput">cl_sampler</code> object. </li>
  98 <li class="listitem">
  99 <pre class="literallayout"><span class="identifier">context</span> <a name="idm46009692529952-bb"></a><span class="identifier">get_context</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the context for the image sampler object. </li>
 100 <li class="listitem">
 101 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a name="idm46009692528512-bb"></a><span class="identifier">get_info</span><span class="special">(</span><span class="identifier">cl_sampler_info</span> info<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 102 <p>Returns information about the sampler.</p>
 103 <p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetSamplerInfo.html" target="_top">clGetSamplerInfo()</a> for more information. </p>
 104 </li>
 105 <li class="listitem">
 106 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">int</span> Enum<span class="special">&gt;</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm46009692524336-bb"></a><span class="identifier">get_info</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 107 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 108 </li>
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692521408-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the sampler is the same at <code class="computeroutput">other</code>. </li>
 111 <li class="listitem">
 112 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692517952-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_sampler.html" title="Class image_sampler">image_sampler</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns <code class="computeroutput">true</code> if the sampler is different from <code class="computeroutput">other</code>. </li>
 113 <li class="listitem"><pre class="literallayout"><a name="idm46009692514496-bb"></a><span class="keyword">operator</span> <span class="identifier">cl_sampler</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
 114 </ol></div>
 115 </div>
 116 </div>
 117 </div>
 118 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 119 <td align="left"></td>
 120 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 121         Distributed under the Boost Software License, Version 1.0. (See accompanying
 122         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>)
 123       </p>
 124 </div></td>
 125 </tr></table>
 126 <hr>
 127 <div class="spirit-nav">
 128 <a accesskey="p" href="image_object.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_sampler_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="opengl_e_idm46009692495472.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 129 </div>
 130 </body>
 131 </html>