Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / image_object.html

diff --git a/libs/compute/doc/html/boost/compute/image_object.html b/libs/compute/doc/html/boost/compute/image_object.html
index 6406a4e..db2619f 100644 (file)
--- a/libs/compute/doc/html/boost/compute/image_object.html
+++ b/libs/compute/doc/html/boost/compute/image_object.html
@@ -35,30 +35,30 @@
 <span class="keyword">class</span> <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">memory_object</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="image_object.html#boost.compute.image_objectconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="image_object.html#idm46676580602144-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="image_object.html#idm46676580601856-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="identifier">cl_mem</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>
-  <a class="link" href="image_object.html#idm46676580599632-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="image_object.html#idm46676580596208-bb"><span class="identifier">image_object</span></a><span class="special">(</span><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> <a class="link" href="image_object.html#idm46676580598208-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_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="image_object.html#idm46676580594672-bb"><span class="special">~</span><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="image_object.html#idm46009692566080-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="image_object.html#idm46009692565792-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="identifier">cl_mem</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>
+  <a class="link" href="image_object.html#idm46009692563568-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="image_object.html#idm46009692560144-bb"><span class="identifier">image_object</span></a><span class="special">(</span><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> <a class="link" href="image_object.html#idm46009692562144-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_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="image_object.html#idm46009692558608-bb"><span class="special">~</span><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="image_object.html#idm46676580614672-bb">public member functions</a></span>
-  <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_object.html#idm46676580614112-bb"><span class="identifier">get_image_info</span></a><span class="special">(</span><span class="identifier">cl_mem_info</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <a class="link" href="image_format.html" title="Class image_format">image_format</a> <a class="link" href="image_object.html#idm46676580609920-bb"><span class="identifier">format</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46676580608368-bb"><span class="identifier">width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46676580606944-bb"><span class="identifier">height</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46676580604624-bb"><span class="identifier">depth</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="image_object.html#idm46009692578608-bb">public member functions</a></span>
+  <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_object.html#idm46009692578048-bb"><span class="identifier">get_image_info</span></a><span class="special">(</span><span class="identifier">cl_mem_info</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <a class="link" href="image_format.html" title="Class image_format">image_format</a> <a class="link" href="image_object.html#idm46009692573856-bb"><span class="identifier">format</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46009692572304-bb"><span class="identifier">width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46009692570880-bb"><span class="identifier">height</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm46009692568560-bb"><span class="identifier">depth</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="image_object.html#idm46676580594080-bb">public static functions</a></span>
+  <span class="comment">// <a class="link" href="image_object.html#idm46009692558016-bb">public static functions</a></span>
   <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&gt;</span> 
-  <a class="link" href="image_object.html#idm46676580593520-bb"><span class="identifier">get_supported_formats</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="identifier">cl_mem_object_type</span><span class="special">,</span> 
+  <a class="link" href="image_object.html#idm46009692557456-bb"><span class="identifier">get_supported_formats</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="identifier">cl_mem_object_type</span><span class="special">,</span> 
                         <span class="identifier">cl_mem_flags</span> <span class="special">=</span> <span class="identifier">read_write</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="image_object.html#idm46676580587136-bb"><span class="identifier">is_supported_format</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span><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">static</span> <span class="keyword">bool</span> <a class="link" href="image_object.html#idm46009692551072-bb"><span class="identifier">is_supported_format</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span><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="identifier">cl_mem_object_type</span><span class="special">,</span> 
                                   <span class="identifier">cl_mem_flags</span> <span class="special">=</span> <span class="identifier">read_write</span><span class="special">)</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094039963472"></a><h2>Description</h2>
+<a name="idm46113321133776"></a><h2>Description</h2>
 <p>The <a class="link" href="image_object.html" title="Class image_object">image_object</a> class is the base-class for image objects on compute devices.</p>
 <p><span class="bold"><strong>See Also:</strong></span></p>
 <p><a class="link" href="image1d.html" title="Class image1d">image1d</a>, <a class="link" href="image2d.html" title="Class image2d">image2d</a>, <a class="link" href="image3d.html" title="Class image3d">image3d</a> </p>
@@ -67,58 +67,58 @@
 <p>
 </p>
 <div class="refsect2">
-<a name="idm46094039958304"></a><h3>
+<a name="idm46113321128608"></a><h3>
 <a name="boost.compute.image_objectconstruct-copy-destruct"></a><code class="computeroutput">image_object</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
-<li class="listitem"><pre class="literallayout"><a name="idm46676580602144-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676580601856-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="identifier">cl_mem</span> mem<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>
-<li class="listitem"><pre class="literallayout"><a name="idm46676580599632-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a name="idm46676580596208-bb"></a><span class="identifier">image_object</span><span class="special">(</span><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
-<li class="listitem"><pre class="literallayout"><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> <a name="idm46676580598208-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_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692566080-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692565792-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="identifier">cl_mem</span> mem<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>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692563568-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a name="idm46009692560144-bb"></a><span class="identifier">image_object</span><span class="special">(</span><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
+<li class="listitem"><pre class="literallayout"><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> <a name="idm46009692562144-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_object.html" title="Class image_object">image_object</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580594672-bb"></a><span class="special">~</span><span class="identifier">image_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the image object. </li>
+<pre class="literallayout"><a name="idm46009692558608-bb"></a><span class="special">~</span><span class="identifier">image_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the image object. </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094039921056"></a><h3>
-<a name="idm46676580614672-bb"></a><code class="computeroutput">image_object</code> public member functions</h3>
+<a name="idm46113321091040"></a><h3>
+<a name="idm46009692578608-bb"></a><code class="computeroutput">image_object</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<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="idm46676580614112-bb"></a><span class="identifier">get_image_info</span><span class="special">(</span><span class="identifier">cl_mem_info</span> info<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<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="idm46009692578048-bb"></a><span class="identifier">get_image_info</span><span class="special">(</span><span class="identifier">cl_mem_info</span> info<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>Returns information about the image object.</p>
 <p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetImageInfo.html" target="_top">clGetImageInfo()</a> for more information. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="image_format.html" title="Class image_format">image_format</a> <a name="idm46676580609920-bb"></a><span class="identifier">format</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the format for the image. </li>
+<pre class="literallayout"><a class="link" href="image_format.html" title="Class image_format">image_format</a> <a name="idm46009692573856-bb"></a><span class="identifier">format</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the format for the image. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46676580608368-bb"></a><span class="identifier">width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the width of the image. </li>
+<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009692572304-bb"></a><span class="identifier">width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the width of the image. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46676580606944-bb"></a><span class="identifier">height</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009692570880-bb"></a><span class="identifier">height</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>Returns the height of the image.</p>
 <p>For 1D images, this function will return <code class="computeroutput">1</code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46676580604624-bb"></a><span class="identifier">depth</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm46009692568560-bb"></a><span class="identifier">depth</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>Returns the depth of the image.</p>
 <p>For 1D and 2D images, this function will return <code class="computeroutput">1</code>. </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094039886464"></a><h3>
-<a name="idm46676580594080-bb"></a><code class="computeroutput">image_object</code> public static functions</h3>
+<a name="idm46113321056128"></a><h3>
+<a name="idm46009692558016-bb"></a><code class="computeroutput">image_object</code> public static functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&gt;</span> 
-<a name="idm46676580593520-bb"></a><span class="identifier">get_supported_formats</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="identifier">cl_mem_object_type</span> type<span class="special">,</span> 
+<a name="idm46009692557456-bb"></a><span class="identifier">get_supported_formats</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="identifier">cl_mem_object_type</span> type<span class="special">,</span> 
                       <span class="identifier">cl_mem_flags</span> flags <span class="special">=</span> <span class="identifier">read_write</span><span class="special">)</span><span class="special">;</span></pre>
 <p>Returns the supported image formats for the <code class="computeroutput">type</code> in <code class="computeroutput">context</code>.</p>
 <p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetSupportedImageFormats.html" target="_top">clGetSupportedImageFormats()</a> for more information. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm46676580587136-bb"></a><span class="identifier">is_supported_format</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> format<span class="special">,</span> 
+<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm46009692551072-bb"></a><span class="identifier">is_supported_format</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> format<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="identifier">cl_mem_object_type</span> type<span class="special">,</span> 
                                 <span class="identifier">cl_mem_flags</span> flags <span class="special">=</span> <span class="identifier">read_write</span><span class="special">)</span><span class="special">;</span></pre>