Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / image_format.html
index aa3a02c..e37a7da 100644 (file)
                            unsigned_int32 = = CL_UNSIGNED_INT32, 
                            float16 = = CL_HALF_FLOAT, float32 = = CL_FLOAT <span class="special">}</span><span class="special">;</span>
   <span class="comment">// <a class="link" href="image_format.html#boost.compute.image_formatconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <span class="keyword">explicit</span> <a class="link" href="image_format.html#idm46676580634112-bb"><span class="identifier">image_format</span></a><span class="special">(</span><span class="identifier">cl_channel_order</span><span class="special">,</span> <span class="identifier">cl_channel_type</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="image_format.html#idm46676580630976-bb"><span class="identifier">image_format</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="image_format.html#idm46676580628976-bb"><span class="identifier">image_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="special">;</span>
-  <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> <a class="link" href="image_format.html#idm46676580626784-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_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="image_format.html#idm46676580623600-bb"><span class="special">~</span><span class="identifier">image_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="image_format.html#idm46009692598048-bb"><span class="identifier">image_format</span></a><span class="special">(</span><span class="identifier">cl_channel_order</span><span class="special">,</span> <span class="identifier">cl_channel_type</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="image_format.html#idm46009692594912-bb"><span class="identifier">image_format</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="image_format.html#idm46009692592912-bb"><span class="identifier">image_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="special">;</span>
+  <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> <a class="link" href="image_format.html#idm46009692590720-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_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="image_format.html#idm46009692587536-bb"><span class="special">~</span><span class="identifier">image_format</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="image_format.html#idm46676580644480-bb">public member functions</a></span>
-  <span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">*</span> <a class="link" href="image_format.html#idm46676580643920-bb"><span class="identifier">get_format_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="image_format.html#idm46676580642048-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_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="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="image_format.html#idm46676580638160-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_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="special">;</span>
+  <span class="comment">// <a class="link" href="image_format.html#idm46009692608416-bb">public member functions</a></span>
+  <span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">*</span> <a class="link" href="image_format.html#idm46009692607856-bb"><span class="identifier">get_format_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="image_format.html#idm46009692605984-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_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="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="image_format.html#idm46009692602096-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_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="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094040159328"></a><h2>Description</h2>
+<a name="idm46113321330320"></a><h2>Description</h2>
 <p>For example, to create a format for a 8-bit RGBA image: </p>
 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">image_format</span> <span class="identifier">rgba8</span><span class="special">(</span><span class="identifier">CL_RGBA</span><span class="special">,</span> <span class="identifier">CL_UNSIGNED_INT8</span><span class="special">)</span><span class="special">;</span>
 </pre>
 <p>
 </p>
 <div class="refsect2">
-<a name="idm46094040136960"></a><h3>
+<a name="idm46113321307952"></a><h3>
 <a name="boost.compute.image_formatconstruct-copy-destruct"></a><code class="computeroutput">image_format</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676580634112-bb"></a><span class="identifier">image_format</span><span class="special">(</span><span class="identifier">cl_channel_order</span> order<span class="special">,</span> <span class="identifier">cl_channel_type</span> type<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object with <code class="computeroutput">order</code> and <code class="computeroutput">type</code>. </li>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692598048-bb"></a><span class="identifier">image_format</span><span class="special">(</span><span class="identifier">cl_channel_order</span> order<span class="special">,</span> <span class="identifier">cl_channel_type</span> type<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object with <code class="computeroutput">order</code> and <code class="computeroutput">type</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676580630976-bb"></a><span class="identifier">image_format</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">&amp;</span> format<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object from <code class="computeroutput">format</code>. </li>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692594912-bb"></a><span class="identifier">image_format</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">&amp;</span> format<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object from <code class="computeroutput">format</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580628976-bb"></a><span class="identifier">image_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> other<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object as a copy of <code class="computeroutput">other</code>. </li>
+<pre class="literallayout"><a name="idm46009692592912-bb"></a><span class="identifier">image_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> other<span class="special">)</span><span class="special">;</span></pre>Creates a new image format object as a copy of <code class="computeroutput">other</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> <a name="idm46676580626784-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_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the format from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
+<pre class="literallayout"><a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> <a name="idm46009692590720-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_format.html" title="Class image_format">image_format</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the format from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580623600-bb"></a><span class="special">~</span><span class="identifier">image_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the image format object. </li>
+<pre class="literallayout"><a name="idm46009692587536-bb"></a><span class="special">~</span><span class="identifier">image_format</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the image format object. </li>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094040099056"></a><h3>
-<a name="idm46676580644480-bb"></a><code class="computeroutput">image_format</code> public member functions</h3>
+<a name="idm46113321269840"></a><h3>
+<a name="idm46009692608416-bb"></a><code class="computeroutput">image_format</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">*</span> <a name="idm46676580643920-bb"></a><span class="identifier">get_format_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a pointer to the <code class="computeroutput">cl_image_format</code> object. </li>
+<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">cl_image_format</span> <span class="special">*</span> <a name="idm46009692607856-bb"></a><span class="identifier">get_format_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns a pointer to the <code class="computeroutput">cl_image_format</code> object. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46676580642048-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_format.html" title="Class image_format">image_format</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 <code class="computeroutput">*this</code> is the same as <code class="computeroutput">other</code>. </li>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692605984-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_format.html" title="Class image_format">image_format</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 <code class="computeroutput">*this</code> is the same as <code class="computeroutput">other</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46676580638160-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_format.html" title="Class image_format">image_format</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 <code class="computeroutput">*this</code> is not the same as <code class="computeroutput">other</code>. </li>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46009692602096-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_format.html" title="Class image_format">image_format</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 <code class="computeroutput">*this</code> is not the same as <code class="computeroutput">other</code>. </li>
 </ol></div>
 </div>
 </div>