libs/compute/doc/html/boost/compute/image_format.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class image_format</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_format_hpp" title="Header &lt;boost/compute/image/image_format.hpp&gt;">
   9 <link rel="prev" href="image3d.html" title="Class image3d">
  10 <link rel="next" href="image_object.html" title="Class image_object">
  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="image3d.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_format_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="image_object.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.image_format"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class image_format</span></h2>
  29 <p>boost::compute::image_format &#8212; A OpenCL image format. </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_format_hpp" title="Header &lt;boost/compute/image/image_format.hpp&gt;">boost/compute/image/image_format.hpp</a>&gt;
  33
  34 </span>
  35 <span class="keyword">class</span> <a class="link" href="image_format.html" title="Class image_format">image_format</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_format.channel_order"></a>channel_order <span class="special">{</span> r = = CL_R, a = = CL_A, intensity = = CL_INTENSITY,
  39                        luminance = = CL_LUMINANCE, rg = = CL_RG, ra = = CL_RA,
  40                        rgb = = CL_RGB, rgba = = CL_RGBA, argb = = CL_ARGB,
  41                        bgra = = CL_BGRA <span class="special">}</span><span class="special">;</span>
  42
  43   <span class="keyword">enum</span> <a name="boost.compute.image_format.channel_data_type"></a>channel_data_type <span class="special">{</span> snorm_int8 = = CL_SNORM_INT8,
  44                            snorm_int16 = = CL_SNORM_INT16,
  45                            unorm_int8 = = CL_UNORM_INT8,
  46                            unorm_int16 = = CL_UNORM_INT16,
  47                            unorm_short_565 = = CL_UNORM_SHORT_565,
  48                            unorm_short_555 = = CL_UNORM_SHORT_555,
  49                            unorm_int_101010 = = CL_UNORM_INT_101010,
  50                            signed_int8 = = CL_SIGNED_INT8,
  51                            signed_int16 = = CL_SIGNED_INT16,
  52                            signed_int32 = = CL_SIGNED_INT32,
  53                            unsigned_int8 = = CL_UNSIGNED_INT8,
  54                            unsigned_int16 = = CL_UNSIGNED_INT16,
  55                            unsigned_int32 = = CL_UNSIGNED_INT32,
  56                            float16 = = CL_HALF_FLOAT, float32 = = CL_FLOAT <span class="special">}</span><span class="special">;</span>
  57   <span class="comment">// <a class="link" href="image_format.html#boost.compute.image_formatconstruct-copy-destruct">construct/copy/destruct</a></span>
  58   <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>
  59   <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>
  60   <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>
  61   <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>
  62   <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>
  63
  64   <span class="comment">// <a class="link" href="image_format.html#idm46009692608416-bb">public member functions</a></span>
  65   <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>
  66   <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>
  67   <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>
  68 <span class="special">}</span><span class="special">;</span></pre></div>
  69 <div class="refsect1">
  70 <a name="idm46113321330320"></a><h2>Description</h2>
  71 <p>For example, to create a format for a 8-bit RGBA image: </p>
  72 <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>
  73 </pre>
  74 <p>After being constructed, <a class="link" href="image_format.html" title="Class image_format">image_format</a> objects are usually passed to the constructor of the various image classes (e.g. <a class="link" href="image2d.html" title="Class image2d">image2d</a>, <a class="link" href="image3d.html" title="Class image3d">image3d</a>) to create an image object on a compute device.</p>
  75 <p>Image formats supported by a context can be queried with the static get_supported_formats() in each image class. For example: </p>
  76 <pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">image_format</span><span class="special">&gt;</span> <span class="identifier">formats</span> <span class="special">=</span> <span class="identifier">image2d</span><span class="special">::</span><span class="identifier">get_supported_formats</span><span class="special">(</span><span class="identifier">ctx</span><span class="special">)</span><span class="special">;</span>
  77 </pre>
  78 <p><span class="bold"><strong>See Also:</strong></span></p>
  79 <p><a class="link" href="image2d.html" title="Class image2d">image2d</a> </p>
  80 <p>
  81 </p>
  82 <p>
  83 </p>
  84 <div class="refsect2">
  85 <a name="idm46113321307952"></a><h3>
  86 <a name="boost.compute.image_formatconstruct-copy-destruct"></a><code class="computeroutput">image_format</code>
  87         public
  88        construct/copy/destruct</h3>
  89 <div class="orderedlist"><ol class="orderedlist" type="1">
  90 <li class="listitem">
  91 <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>
  92 <li class="listitem">
  93 <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>
  94 <li class="listitem">
  95 <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>
  96 <li class="listitem">
  97 <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>
  98 <li class="listitem">
  99 <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>
 100 </ol></div>
 101 </div>
 102 <div class="refsect2">
 103 <a name="idm46113321269840"></a><h3>
 104 <a name="idm46009692608416-bb"></a><code class="computeroutput">image_format</code> public member functions</h3>
 105 <div class="orderedlist"><ol class="orderedlist" type="1">
 106 <li class="listitem">
 107 <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>
 108 <li class="listitem">
 109 <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>
 110 <li class="listitem">
 111 <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>
 112 </ol></div>
 113 </div>
 114 </div>
 115 </div>
 116 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 117 <td align="left"></td>
 118 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 119         Distributed under the Boost Software License, Version 1.0. (See accompanying
 120         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>)
 121       </p>
 122 </div></td>
 123 </tr></table>
 124 <hr>
 125 <div class="spirit-nav">
 126 <a accesskey="p" href="image3d.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_format_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="image_object.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 127 </div>
 128 </body>
 129 </html>