1 //---------------------------------------------------------------------------//
2 // Copyright (c) 2013-2014 Kyle Lutz <kyle.r.lutz@gmail.com>
4 // Distributed under the Boost Software License, Version 1.0
5 // See accompanying file LICENSE_1_0.txt or copy at
6 // http://www.boost.org/LICENSE_1_0.txt
8 // See http://boostorg.github.com/compute for more information.
9 //---------------------------------------------------------------------------//
11 #ifndef BOOST_COMPUTE_INTEROP_OPENGL_OPENGL_RENDERBUFFER_HPP
12 #define BOOST_COMPUTE_INTEROP_OPENGL_OPENGL_RENDERBUFFER_HPP
14 #include <boost/compute/image/image_object.hpp>
15 #include <boost/compute/interop/opengl/gl.hpp>
16 #include <boost/compute/interop/opengl/cl_gl.hpp>
17 #include <boost/compute/type_traits/type_name.hpp>
18 #include <boost/compute/utility/extents.hpp>
23 /// \class opengl_renderbuffer
25 /// A OpenCL buffer for accessing an OpenGL renderbuffer object.
26 class opengl_renderbuffer : public image_object
29 /// Creates a null OpenGL renderbuffer object.
35 /// Creates a new OpenGL renderbuffer object for \p mem.
36 explicit opengl_renderbuffer(cl_mem mem, bool retain = true)
37 : image_object(mem, retain)
41 /// Creates a new OpenGL renderbuffer object in \p context for
42 /// \p renderbuffer with \p flags.
44 /// \see_opencl_ref{clCreateFromGLRenderbuffer}
45 opengl_renderbuffer(const context &context,
47 cl_mem_flags flags = read_write)
51 m_mem = clCreateFromGLRenderbuffer(
52 context, flags, renderbuffer, &error
56 BOOST_THROW_EXCEPTION(opencl_error(error));
60 /// Creates a new OpenGL renderbuffer object as a copy of \p other.
61 opengl_renderbuffer(const opengl_renderbuffer &other)
66 /// Copies the OpenGL renderbuffer object from \p other.
67 opengl_renderbuffer& operator=(const opengl_renderbuffer &other)
70 image_object::operator=(other);
76 /// Destroys the OpenGL buffer object.
77 ~opengl_renderbuffer()
81 /// Returns the size (width, height) of the renderbuffer.
82 extents<2> size() const
85 size[0] = get_image_info<size_t>(CL_IMAGE_WIDTH);
86 size[1] = get_image_info<size_t>(CL_IMAGE_HEIGHT);
90 /// Returns the origin of the renderbuffer (\c 0, \c 0).
91 extents<2> origin() const
96 /// Returns the OpenGL memory object ID.
98 /// \see_opencl_ref{clGetGLObjectInfo}
99 GLuint get_opengl_object() const
102 clGetGLObjectInfo(m_mem, 0, &object);
106 /// Returns the OpenGL memory object type.
108 /// \see_opencl_ref{clGetGLObjectInfo}
109 cl_gl_object_type get_opengl_type() const
111 cl_gl_object_type type;
112 clGetGLObjectInfo(m_mem, &type, 0);
119 // set_kernel_arg() specialization for opengl_renderbuffer
121 struct set_kernel_arg<opengl_renderbuffer> : public set_kernel_arg<image_object> { };
123 } // end detail namespace
124 } // end compute namespace
125 } // end boost namespace
127 BOOST_COMPUTE_TYPE_NAME(boost::compute::opengl_renderbuffer, image2d_t)
129 #endif // BOOST_COMPUTE_INTEROP_OPENGL_OPENGL_RENDERBUFFER_HPP