1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class image2d</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 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.image.image2d_hpp" title="Header <boost/compute/image/image2d.hpp>"> 9<link rel="prev" href="image1d.html" title="Class image1d"> 10<link rel="next" href="image3d.html" title="Class image3d"> 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="image1d.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image2d_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="image3d.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.image2d"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class image2d</span></h2> 29<p>boost::compute::image2d — An OpenCL 2D image 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: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.image.image2d_hpp" title="Header <boost/compute/image/image2d.hpp>">boost/compute/image/image2d.hpp</a>> 33 34</span> 35<span class="keyword">class</span> <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">compute</span><span class="special">::</span><span class="identifier">image_object</span> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="image2d.html#boost.compute.image2dconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="image2d.html#idm45549385253776-bb"><span class="identifier">image2d</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 39 <a class="link" href="image2d.html#idm45549385252480-bb"><span class="identifier">image2d</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</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">&</span><span class="special">,</span> 40 <span class="identifier">cl_mem_flags</span> <span class="special">=</span> <span class="identifier">read_write</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">size_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 41 <a class="link" href="image2d.html#idm45549385243840-bb"><span class="identifier">image2d</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 42 <a class="link" href="image2d.html#idm45549385237504-bb"><span class="identifier">image2d</span></a><span class="special">(</span><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 43 <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> <a class="link" href="image2d.html#idm45549385240960-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> <a class="link" href="image2d.html#idm45549385235200-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 45 <a class="link" href="image2d.html#idm45549385231888-bb"><span class="special">~</span><span class="identifier">image2d</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 46 47 <span class="comment">// <a class="link" href="image2d.html#idm45549385269232-bb">public member functions</a></span> 48 <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special"><</span> <span class="number">2</span> <span class="special">></span> <a class="link" href="image2d.html#idm45549385268672-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special"><</span> <span class="number">2</span> <span class="special">></span> <a class="link" href="image2d.html#idm45549385266944-bb"><span class="identifier">origin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a class="link" href="image2d.html#idm45549385264336-bb"><span class="identifier">get_info</span></a><span class="special">(</span><span class="identifier">cl_image_info</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 51 <span class="keyword">template</span><span class="special"><</span><span class="keyword">int</span> Enum<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a class="link" href="image2d.html#idm45549385260160-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> 52 <a class="link" href="image2d.html" title="Class image2d">image2d</a> <a class="link" href="image2d.html#idm45549385257232-bb"><span class="identifier">clone</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 54 <span class="comment">// <a class="link" href="image2d.html#idm45549385230592-bb">public static functions</a></span> 55 <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">></span> 56 <a class="link" href="image2d.html#idm45549385230032-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">&</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> 57 <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="image2d.html#idm45549385225232-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">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&</span><span class="special">,</span> 58 <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> 59<span class="special">}</span><span class="special">;</span></pre></div> 60<div class="refsect1"> 61<a name="idm45849509976080"></a><h2>Description</h2> 62<p>For example, to create a 640x480 8-bit RGBA image:</p> 63<pre class="programlisting"></pre> 64<p> </p> 65<p><span class="bold"><strong>See Also:</strong></span></p> 66<p><a class="link" href="image_format.html" title="Class image_format">image_format</a>, <a class="link" href="image3d.html" title="Class image3d">image3d</a> </p> 67<p> 68</p> 69<p> 70</p> 71<div class="refsect2"> 72<a name="idm45849509972032"></a><h3> 73<a name="boost.compute.image2dconstruct-copy-destruct"></a><code class="computeroutput">image2d</code> 74 public 75 construct/copy/destruct</h3> 76<div class="orderedlist"><ol class="orderedlist" type="1"> 77<li class="listitem"> 78<pre class="literallayout"><a name="idm45549385253776-bb"></a><span class="identifier">image2d</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates a null <code class="computeroutput"><a class="link" href="image2d.html" title="Class image2d">image2d</a></code> object. </li> 79<li class="listitem"> 80<pre class="literallayout"><a name="idm45549385252480-bb"></a><span class="identifier">image2d</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&</span> context<span class="special">,</span> <span class="identifier">size_t</span> image_width<span class="special">,</span> <span class="identifier">size_t</span> image_height<span class="special">,</span> 81 <span class="keyword">const</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">&</span> format<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> 82 <span class="keyword">void</span> <span class="special">*</span> host_ptr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">size_t</span> image_row_pitch <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> 83<p>Creates a new <code class="computeroutput"><a class="link" href="image2d.html" title="Class image2d">image2d</a></code> object.</p> 84<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateImage.html" target="_top">clCreateImage()</a> for more information. </p> 85</li> 86<li class="listitem"> 87<pre class="literallayout"><a name="idm45549385243840-bb"></a><span class="identifier">image2d</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new <code class="computeroutput"><a class="link" href="image2d.html" title="Class image2d">image2d</a></code> as a copy of <code class="computeroutput">other</code>. </li> 88<li class="listitem"> 89<pre class="literallayout"><a name="idm45549385237504-bb"></a><span class="identifier">image2d</span><span class="special">(</span><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&&</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Move-constructs a new image object from <code class="computeroutput">other</code>. </li> 90<li class="listitem"> 91<pre class="literallayout"><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> <a name="idm45549385240960-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the <code class="computeroutput"><a class="link" href="image2d.html" title="Class image2d">image2d</a></code> from <code class="computeroutput">other</code>. </li> 92<li class="listitem"> 93<pre class="literallayout"><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&</span> <a name="idm45549385235200-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="image2d.html" title="Class image2d">image2d</a> <span class="special">&&</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Move-assigns the image from <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li> 94<li class="listitem"> 95<pre class="literallayout"><a name="idm45549385231888-bb"></a><span class="special">~</span><span class="identifier">image2d</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="image2d.html" title="Class image2d">image2d</a></code> object. </li> 96</ol></div> 97</div> 98<div class="refsect2"> 99<a name="idm45849509902784"></a><h3> 100<a name="idm45549385269232-bb"></a><code class="computeroutput">image2d</code> public member functions</h3> 101<div class="orderedlist"><ol class="orderedlist" type="1"> 102<li class="listitem"> 103<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special"><</span> <span class="number">2</span> <span class="special">></span> <a name="idm45549385268672-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 size (width, height) of the image. </li> 104<li class="listitem"> 105<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special"><</span> <span class="number">2</span> <span class="special">></span> <a name="idm45549385266944-bb"></a><span class="identifier">origin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the origin of the image (<code class="computeroutput">0</code>, <code class="computeroutput">0</code>). </li> 106<li class="listitem"> 107<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <a name="idm45549385264336-bb"></a><span class="identifier">get_info</span><span class="special">(</span><span class="identifier">cl_image_info</span> info<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 108<p>Returns information about the image.</p> 109<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> 110</li> 111<li class="listitem"> 112<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">int</span> Enum<span class="special">></span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="idm45549385260160-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> 113<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> 114</li> 115<li class="listitem"> 116<pre class="literallayout"><a class="link" href="image2d.html" title="Class image2d">image2d</a> <a name="idm45549385257232-bb"></a><span class="identifier">clone</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 117<p>Creates a new image with a copy of the data in <code class="computeroutput">*this</code>. Uses <code class="computeroutput">queue</code> to perform the copy operation. </p> 118</li> 119</ol></div> 120</div> 121<div class="refsect2"> 122<a name="idm45849509858960"></a><h3> 123<a name="idm45549385230592-bb"></a><code class="computeroutput">image2d</code> public static functions</h3> 124<div class="orderedlist"><ol class="orderedlist" type="1"> 125<li class="listitem"> 126<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"><</span> <a class="link" href="image_format.html" title="Class image_format">image_format</a> <span class="special">></span> 127<a name="idm45549385230032-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">&</span> context<span class="special">,</span> 128 <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> 129<p>Returns the supported image formats for the context.</p> 130<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> 131</li> 132<li class="listitem"> 133<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm45549385225232-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">&</span> format<span class="special">,</span> 134 <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&</span> context<span class="special">,</span> 135 <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> 136<p>Returns <code class="computeroutput">true</code> if <code class="computeroutput">format</code> is a supported 2D image format for <code class="computeroutput">context</code>. </p> 137</li> 138</ol></div> 139</div> 140</div> 141</div> 142<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 143<td align="left"></td> 144<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 145 Distributed under the Boost Software License, Version 1.0. (See accompanying 146 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>) 147 </p> 148</div></td> 149</tr></table> 150<hr> 151<div class="spirit-nav"> 152<a accesskey="p" href="image1d.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image2d_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="image3d.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 153</div> 154</body> 155</html> 156
