1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class image_object</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.image_object_hpp" title="Header <boost/compute/image/image_object.hpp>"> 9<link rel="prev" href="image_format.html" title="Class image_format"> 10<link rel="next" href="image_sampler.html" title="Class image_sampler"> 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_format.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_object_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_sampler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.image_object"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class image_object</span></h2> 29<p>boost::compute::image_object — Base-class for image objects. </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.image_object_hpp" title="Header <boost/compute/image/image_object.hpp>">boost/compute/image/image_object.hpp</a>> 33 34</span> 35<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> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="image_object.html#boost.compute.image_objectconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="image_object.html#idm45549385090384-bb"><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 39 <span class="keyword">explicit</span> <a class="link" href="image_object.html#idm45549385090096-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> 40 <a class="link" href="image_object.html#idm45549385087872-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">&</span><span class="special">)</span><span class="special">;</span> 41 <a class="link" href="image_object.html#idm45549385084448-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">&&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 42 <a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&</span> <a class="link" href="image_object.html#idm45549385086448-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">&</span><span class="special">)</span><span class="special">;</span> 43 <a class="link" href="image_object.html#idm45549385082912-bb"><span class="special">~</span><span class="identifier">image_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="image_object.html#idm45549385102912-bb">public member functions</a></span> 46 <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="image_object.html#idm45549385102352-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> 47 <a class="link" href="image_format.html" title="Class image_format">image_format</a> <a class="link" href="image_object.html#idm45549385098160-bb"><span class="identifier">format</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48 <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm45549385096608-bb"><span class="identifier">width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm45549385095184-bb"><span class="identifier">height</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50 <span class="identifier">size_t</span> <a class="link" href="image_object.html#idm45549385092864-bb"><span class="identifier">depth</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="image_object.html#idm45549385082320-bb">public static functions</a></span> 53 <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> 54 <a class="link" href="image_object.html#idm45549385081760-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_object_type</span><span class="special">,</span> 55 <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> 56 <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="image_object.html#idm45549385075376-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> 57 <span class="identifier">cl_mem_object_type</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="idm45849509258384"></a><h2>Description</h2> 62<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> 63<p><span class="bold"><strong>See Also:</strong></span></p> 64<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> 65<p> 66</p> 67<p> 68</p> 69<div class="refsect2"> 70<a name="idm45849509253216"></a><h3> 71<a name="boost.compute.image_objectconstruct-copy-destruct"></a><code class="computeroutput">image_object</code> 72 public 73 construct/copy/destruct</h3> 74<div class="orderedlist"><ol class="orderedlist" type="1"> 75<li class="listitem"><pre class="literallayout"><a name="idm45549385090384-bb"></a><span class="identifier">image_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> 76<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45549385090096-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> 77<li class="listitem"><pre class="literallayout"><a name="idm45549385087872-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">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> 78<li class="listitem"><pre class="literallayout"><a name="idm45549385084448-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">&&</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> 79<li class="listitem"><pre class="literallayout"><a class="link" href="image_object.html" title="Class image_object">image_object</a> <span class="special">&</span> <a name="idm45549385086448-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">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> 80<li class="listitem"> 81<pre class="literallayout"><a name="idm45549385082912-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> 82</ol></div> 83</div> 84<div class="refsect2"> 85<a name="idm45849509215792"></a><h3> 86<a name="idm45549385102912-bb"></a><code class="computeroutput">image_object</code> public member functions</h3> 87<div class="orderedlist"><ol class="orderedlist" type="1"> 88<li class="listitem"> 89<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="idm45549385102352-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> 90<p>Returns information about the image object.</p> 91<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> 92</li> 93<li class="listitem"> 94<pre class="literallayout"><a class="link" href="image_format.html" title="Class image_format">image_format</a> <a name="idm45549385098160-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> 95<li class="listitem"> 96<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549385096608-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> 97<li class="listitem"> 98<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549385095184-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> 99<p>Returns the height of the image.</p> 100<p>For 1D images, this function will return <code class="computeroutput">1</code>. </p> 101</li> 102<li class="listitem"> 103<pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45549385092864-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> 104<p>Returns the depth of the image.</p> 105<p>For 1D and 2D images, this function will return <code class="computeroutput">1</code>. </p> 106</li> 107</ol></div> 108</div> 109<div class="refsect2"> 110<a name="idm45849509181008"></a><h3> 111<a name="idm45549385082320-bb"></a><code class="computeroutput">image_object</code> public static functions</h3> 112<div class="orderedlist"><ol class="orderedlist" type="1"> 113<li class="listitem"> 114<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> 115<a name="idm45549385081760-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> <span class="identifier">cl_mem_object_type</span> type<span class="special">,</span> 116 <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> 117<p>Returns the supported image formats for the <code class="computeroutput">type</code> in <code class="computeroutput">context</code>.</p> 118<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> 119</li> 120<li class="listitem"> 121<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idm45549385075376-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> 122 <span class="keyword">const</span> <span class="identifier">context</span> <span class="special">&</span> context<span class="special">,</span> 123 <span class="identifier">cl_mem_object_type</span> type<span class="special">,</span> 124 <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> 125<p>Returns <code class="computeroutput">true</code> if <code class="computeroutput">format</code> is a supported image format for <code class="computeroutput">type</code> in <code class="computeroutput">context</code> with <code class="computeroutput">flags</code>. </p> 126</li> 127</ol></div> 128</div> 129</div> 130</div> 131<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 132<td align="left"></td> 133<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 134 Distributed under the Boost Software License, Version 1.0. (See accompanying 135 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>) 136 </p> 137</div></td> 138</tr></table> 139<hr> 140<div class="spirit-nav"> 141<a accesskey="p" href="image_format.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.image.image_object_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_sampler.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 142</div> 143</body> 144</html> 145
