Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / compute / doc / html / boost / compute / opengl_texture.html
index 4253427..9639b02 100644 (file)
 <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>
 <span class="keyword">public</span><span class="special">:</span>
   <span class="comment">// <a class="link" href="opengl_texture.html#boost.compute.opengl_textureconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="opengl_texture.html#idm46676580431664-bb"><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="opengl_texture.html#idm46676580431072-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>
-  <a class="link" href="opengl_texture.html#idm46676580428080-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">&amp;</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> 
+  <a class="link" href="opengl_texture.html#idm46009692395600-bb"><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="opengl_texture.html#idm46009692395008-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>
+  <a class="link" href="opengl_texture.html#idm46009692392016-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">&amp;</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> 
                  <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>
-  <a class="link" href="opengl_texture.html#idm46676580421200-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">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&amp;</span> <a class="link" href="opengl_texture.html#idm46676580419008-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">&amp;</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="opengl_texture.html#idm46676580416256-bb"><span class="special">~</span><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="opengl_texture.html#idm46009692385136-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&amp;</span> <a class="link" href="opengl_texture.html#idm46009692382944-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">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="opengl_texture.html#idm46009692380192-bb"><span class="special">~</span><span class="identifier">opengl_texture</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="opengl_texture.html#idm46676580440896-bb">public member functions</a></span>
-  <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a class="link" href="opengl_texture.html#idm46676580440336-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a class="link" href="opengl_texture.html#idm46676580438608-bb"><span class="identifier">origin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a class="link" href="opengl_texture.html#idm46676580436000-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>
+  <span class="comment">// <a class="link" href="opengl_texture.html#idm46009692404832-bb">public member functions</a></span>
+  <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a class="link" href="opengl_texture.html#idm46009692404272-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a class="link" href="opengl_texture.html#idm46009692402544-bb"><span class="identifier">origin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a class="link" href="opengl_texture.html#idm46009692399936-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>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm46094061273136"></a><h2>Description</h2>
+<a name="idm46113320251056"></a><h2>Description</h2>
 <p>A OpenCL <a class="link" href="image2d.html" title="Class image2d">image2d</a> for accessing an OpenGL texture object. </p>
 <div class="refsect2">
-<a name="idm46094061271632"></a><h3>
+<a name="idm46113320249488"></a><h3>
 <a name="boost.compute.opengl_textureconstruct-copy-destruct"></a><code class="computeroutput">opengl_texture</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580431664-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>
+<pre class="literallayout"><a name="idm46009692395600-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>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46676580431072-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>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009692395008-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>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580428080-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">&amp;</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> 
+<pre class="literallayout"><a name="idm46009692392016-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">&amp;</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> 
                <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>
 <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>
 <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>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580421200-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">&amp;</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>
+<pre class="literallayout"><a name="idm46009692385136-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">&amp;</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>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&amp;</span> <a name="idm46676580419008-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">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the OpenGL texture object from <code class="computeroutput">other</code>. </li>
+<pre class="literallayout"><a class="link" href="opengl_texture.html" title="Class opengl_texture">opengl_texture</a> <span class="special">&amp;</span> <a name="idm46009692382944-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">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the OpenGL texture object from <code class="computeroutput">other</code>. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm46676580416256-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>
+<pre class="literallayout"><a name="idm46009692380192-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>
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm46094038947168"></a><h3>
-<a name="idm46676580440896-bb"></a><code class="computeroutput">opengl_texture</code> public member functions</h3>
+<a name="idm46113320199152"></a><h3>
+<a name="idm46009692404832-bb"></a><code class="computeroutput">opengl_texture</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a name="idm46676580440336-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>
+<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a name="idm46009692404272-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>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a name="idm46676580438608-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>
+<pre class="literallayout"><a class="link" href="extents.html" title="Class template extents">extents</a><span class="special">&lt;</span> <span class="number">2</span> <span class="special">&gt;</span> <a name="idm46009692402544-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>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a name="idm46676580436000-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>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">T</span> <a name="idm46009692399936-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>
 <p>Returns information about the texture.</p>
 <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>
 </li>