1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class opengl_buffer</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_buffer_hpp" title="Header <boost/compute/interop/opengl/opengl_buffer.hpp>"> 9<link rel="prev" href="opengl_c_idm45549384990432.html" title="Function opengl_create_shared_context"> 10<link rel="next" href="opengl_renderbuffer.html" title="Class opengl_renderbuffer"> 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_c_idm45549384990432.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_buffer_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="opengl_renderbuffer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.opengl_buffer"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class opengl_buffer</span></h2> 29<p>boost::compute::opengl_buffer</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_buffer_hpp" title="Header <boost/compute/interop/opengl/opengl_buffer.hpp>">boost/compute/interop/opengl/opengl_buffer.hpp</a>> 33 34</span> 35<span class="keyword">class</span> <a class="link" href="opengl_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">buffer</span> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="opengl_buffer.html#boost.compute.opengl_bufferconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="opengl_buffer.html#idm45549384977312-bb"><span class="identifier">opengl_buffer</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_buffer.html#idm45549384976720-bb"><span class="identifier">opengl_buffer</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_buffer.html#idm45549384973744-bb"><span class="identifier">opengl_buffer</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">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> 41 <a class="link" href="opengl_buffer.html#idm45549384968240-bb"><span class="identifier">opengl_buffer</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 42 <a class="link" href="opengl_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span> <a class="link" href="opengl_buffer.html#idm45549384966048-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_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 43 <a class="link" href="opengl_buffer.html#idm45549384963296-bb"><span class="special">~</span><span class="identifier">opengl_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="opengl_buffer.html#idm45549384983312-bb">public member functions</a></span> 46 <span class="identifier">GLuint</span> <a class="link" href="opengl_buffer.html#idm45549384982752-bb"><span class="identifier">get_opengl_object</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 47 <span class="identifier">cl_gl_object_type</span> <a class="link" href="opengl_buffer.html#idm45549384980112-bb"><span class="identifier">get_opengl_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48<span class="special">}</span><span class="special">;</span></pre></div> 49<div class="refsect1"> 50<a name="idm45849508681952"></a><h2>Description</h2> 51<p>A OpenCL buffer for accessing an OpenGL memory object. </p> 52<div class="refsect2"> 53<a name="idm45849508681216"></a><h3> 54<a name="boost.compute.opengl_bufferconstruct-copy-destruct"></a><code class="computeroutput">opengl_buffer</code> 55 public 56 construct/copy/destruct</h3> 57<div class="orderedlist"><ol class="orderedlist" type="1"> 58<li class="listitem"> 59<pre class="literallayout"><a name="idm45549384977312-bb"></a><span class="identifier">opengl_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates a null OpenGL buffer object. </li> 60<li class="listitem"> 61<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45549384976720-bb"></a><span class="identifier">opengl_buffer</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 buffer object for <code class="computeroutput">mem</code>. </li> 62<li class="listitem"> 63<pre class="literallayout"><a name="idm45549384973744-bb"></a><span class="identifier">opengl_buffer</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">GLuint</span> bufobj<span class="special">,</span> 64 <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> 65<p>Creates a new OpenGL buffer object in <code class="computeroutput">context</code> for <code class="computeroutput">bufobj</code> with <code class="computeroutput">flags</code>.</p> 66<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clCreateFromGLBuffer.html" target="_top">clCreateFromGLBuffer()</a> for more information. </p> 67</li> 68<li class="listitem"> 69<pre class="literallayout"><a name="idm45549384968240-bb"></a><span class="identifier">opengl_buffer</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="opengl_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new OpenGL buffer object as a copy of <code class="computeroutput">other</code>. </li> 70<li class="listitem"> 71<pre class="literallayout"><a class="link" href="opengl_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span> <a name="idm45549384966048-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_buffer.html" title="Class opengl_buffer">opengl_buffer</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copies the OpenGL buffer object from <code class="computeroutput">other</code>. </li> 72<li class="listitem"> 73<pre class="literallayout"><a name="idm45549384963296-bb"></a><span class="special">~</span><span class="identifier">opengl_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the OpenGL buffer object. </li> 74</ol></div> 75</div> 76<div class="refsect2"> 77<a name="idm45849508633552"></a><h3> 78<a name="idm45549384983312-bb"></a><code class="computeroutput">opengl_buffer</code> public member functions</h3> 79<div class="orderedlist"><ol class="orderedlist" type="1"> 80<li class="listitem"> 81<pre class="literallayout"><span class="identifier">GLuint</span> <a name="idm45549384982752-bb"></a><span class="identifier">get_opengl_object</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 82<p>Returns the OpenGL memory object ID.</p> 83<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetGLObjectInfo.html" target="_top">clGetGLObjectInfo()</a> for more information. </p> 84</li> 85<li class="listitem"> 86<pre class="literallayout"><span class="identifier">cl_gl_object_type</span> <a name="idm45549384980112-bb"></a><span class="identifier">get_opengl_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 87<p>Returns the OpenGL memory object type.</p> 88<p>See the documentation for <a href="http://www.khronos.org/registry/cl/sdk/1.2/docs/man/xhtml/clGetGLObjectInfo.html" target="_top">clGetGLObjectInfo()</a> for more information. </p> 89</li> 90</ol></div> 91</div> 92</div> 93</div> 94<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 95<td align="left"></td> 96<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 97 Distributed under the Boost Software License, Version 1.0. (See accompanying 98 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>) 99 </p> 100</div></td> 101</tr></table> 102<hr> 103<div class="spirit-nav"> 104<a accesskey="p" href="opengl_c_idm45549384990432.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_buffer_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="opengl_renderbuffer.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 105</div> 106</body> 107</html> 108
