1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class opengl_texture</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.interop.opengl.opengl_texture_hpp" title="Header <boost/compute/interop/opengl/opengl_texture.hpp>"> 9<link rel="prev" href="opengl_renderbuffer.html" title="Class opengl_renderbuffer"> 10<link rel="next" href="buffer_iterator.html" title="Class template buffer_iterator"> 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="opengl_renderbuffer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.interop.opengl.opengl_texture_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="buffer_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.opengl_texture"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class opengl_texture</span></h2> 29<p>boost::compute::opengl_texture</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.interop.opengl.opengl_texture_hpp" title="Header <boost/compute/interop/opengl/opengl_texture.hpp>">boost/compute/interop/opengl/opengl_texture.hpp</a>> 33 34</span> 35<span class="keyword">class</span> <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</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="opengl_texture.html#boost.compute.opengl_textureconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="opengl_texture.html#idm45549384919904-bb"><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 39 <span class="keyword">explicit</span> <a class="link" href="opengl_texture.html#idm45549384919312-bb"><span class="identifier">opengl_texture</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="opengl_texture.html#idm45549384916320-bb"><span class="identifier">opengl_texture</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">GLenum</span><span class="special">,</span> <span class="identifier">GLint</span><span class="special">,</span> <span class="identifier">GLuint</span><span class="special">,</span> 41 <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> 42 <a class="link" href="opengl_texture.html#idm45549384909440-bb"><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 43 <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span> <a class="link" href="opengl_texture.html#idm45549384907248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <a class="link" href="opengl_texture.html#idm45549384904496-bb"><span class="special">~</span><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 45 46 <span class="comment">// <a class="link" href="opengl_texture.html#idm45549384929136-bb">public member functions</a></span> 47 <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="opengl_texture.html#idm45549384928576-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</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="opengl_texture.html#idm45549384926848-bb"><span class="identifier">origin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <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="opengl_texture.html#idm45549384924240-bb"><span class="identifier">get_texture_info</span></a><span class="special">(</span><span class="identifier">cl_gl_texture_info</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50<span class="special">}</span><span class="special">;</span></pre></div> 51<div class="refsect1"> 52<a name="idm45849508375552"></a><h2>Description</h2> 53<p>A OpenCL <a class="link" href="image2d.html" title="Class image2d">image2d</a> for accessing an OpenGL texture object. </p> 54<div class="refsect2"> 55<a name="idm45849508373984"></a><h3> 56<a name="boost.compute.opengl_textureconstruct-copy-destruct"></a><code class="computeroutput">opengl_texture</code> 57 public 58 construct/copy/destruct</h3> 59<div class="orderedlist"><ol class="orderedlist" type="1"> 60<li class="listitem"> 61<pre class="literallayout"><a name="idm45549384919904-bb"></a><span class="identifier">opengl_texture</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates a null OpenGL texture object. </li> 62<li class="listitem"> 63<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45549384919312-bb"></a><span class="identifier">opengl_texture</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>Creates a new OpenGL texture object for <code class="computeroutput">mem</code>. </li> 64<li class="listitem"> 65<pre class="literallayout"><a name="idm45549384916320-bb"></a><span class="identifier">opengl_texture</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">GLenum</span> texture_target<span class="special">,</span> <span class="identifier">GLint</span> miplevel<span class="special">,</span> 66 <span class="identifier">GLuint</span> texture<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> 67<p>Creates a new OpenGL texture object in <code class="computeroutput">context</code> for <code class="computeroutput">texture</code> with <code class="computeroutput">flags</code>.</p> 68<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLTexture.html" target="_top">clCreateFromGLTexture()</a> for more information. </p> 69</li> 70<li class="listitem"> 71<pre class="literallayout"><a name="idm45549384909440-bb"></a><span class="identifier">opengl_texture</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new OpenGL texture object as a copy of <code class="computeroutput">other</code>. </li> 72<li class="listitem"> 73<pre class="literallayout"><a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span> <a name="idm45549384907248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the OpenGL texture object from <code class="computeroutput">other</code>. </li> 74<li class="listitem"> 75<pre class="literallayout"><a name="idm45549384904496-bb"></a><span class="special">~</span><span class="identifier">opengl_texture</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the texture object. </li> 76</ol></div> 77</div> 78<div class="refsect2"> 79<a name="idm45849508323552"></a><h3> 80<a name="idm45549384929136-bb"></a><code class="computeroutput">opengl_texture</code> public member functions</h3> 81<div class="orderedlist"><ol class="orderedlist" type="1"> 82<li class="listitem"> 83<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="idm45549384928576-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 texture. </li> 84<li class="listitem"> 85<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="idm45549384926848-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 texture (<code class="computeroutput">0</code>, <code class="computeroutput">0</code>). </li> 86<li class="listitem"> 87<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="idm45549384924240-bb"></a><span class="identifier">get_texture_info</span><span class="special">(</span><span class="identifier">cl_gl_texture_info</span> info<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 88<p>Returns information about the texture.</p> 89<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetGLTextureInfo.html" target="_top">clGetGLTextureInfo()</a> for more information. </p> 90</li> 91</ol></div> 92</div> 93</div> 94</div> 95<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 96<td align="left"></td> 97<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 98 Distributed under the Boost Software License, Version 1.0. (See accompanying 99 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>) 100 </p> 101</div></td> 102</tr></table> 103<hr> 104<div class="spirit-nav"> 105<a accesskey="p" href="opengl_renderbuffer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.interop.opengl.opengl_texture_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="buffer_iterator.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 106</div> 107</body> 108</html> 109
