OpenCL C++ Bindings
cl::BufferGL Class Reference

Class interface for GL Buffer Memory Objects. More...

Inheritance diagram for cl::BufferGL:
cl::Buffer cl::Memory cl::detail::Wrapper< cl_mem >

Public Member Functions

 BufferGL (const Context &context, cl_mem_flags flags, cl_GLuint bufobj, cl_int *err=NULL)
 Constructs a BufferGL in a specified context, from a given GL buffer. More...
 
 BufferGL ()
 Default constructor - initializes to NULL.
 
 BufferGL (const cl_mem &buffer, bool retainObject=false)
 Constructor from cl_mem - takes ownership. More...
 
BufferGLoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 BufferGL (const BufferGL &buf)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
BufferGLoperator= (const BufferGL &buf)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 BufferGL (BufferGL &&buf) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC.
 
BufferGLoperator= (BufferGL &&buf)
 Move assignment to forward move to the superclass correctly. Required for MSVC.
 
cl_int getObjectInfo (cl_gl_object_type *type, cl_GLuint *gl_object_name)
 Wrapper for clGetGLObjectInfo().
 
- Public Member Functions inherited from cl::Buffer
 Buffer (const Context &context, cl_mem_flags flags, size_type size, void *host_ptr=NULL, cl_int *err=NULL)
 Constructs a Buffer in a specified context. More...
 
 Buffer (cl_mem_flags flags, size_type size, void *host_ptr=NULL, cl_int *err=NULL)
 Constructs a Buffer in the default context. More...
 
template<typename IteratorType >
 Buffer (IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL)
 Construct a Buffer from a host container via iterators. IteratorType must be random access. If useHostPtr is specified iterators must represent contiguous data.
 
template<typename IteratorType >
 Buffer (const Context &context, IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL)
 Construct a Buffer from a host container via iterators using a specified context. IteratorType must be random access. If useHostPtr is specified iterators must represent contiguous data.
 
template<typename IteratorType >
 Buffer (const CommandQueue &queue, IteratorType startIterator, IteratorType endIterator, bool readOnly, bool useHostPtr=false, cl_int *err=NULL)
 Construct a Buffer from a host container via iterators using a specified queue. If useHostPtr is specified iterators must be random access.
 
 Buffer ()
 Default constructor - initializes to NULL.
 
 Buffer (const cl_mem &buffer, bool retainObject=false)
 Constructor from cl_mem - takes ownership. More...
 
Bufferoperator= (const cl_mem &rhs)
 Assignment from cl_mem - performs shallow copy. More...
 
 Buffer (const Buffer &buf)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
Bufferoperator= (const Buffer &buf)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 Buffer (Buffer &&buf) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC.
 
Bufferoperator= (Buffer &&buf)
 Move assignment to forward move to the superclass correctly. Required for MSVC.
 
Buffer createSubBuffer (cl_mem_flags flags, cl_buffer_create_type buffer_create_type, const void *buffer_create_info, cl_int *err=NULL)
 Creates a new buffer object from this. More...
 
- Public Member Functions inherited from cl::Memory
 Memory ()
 Default constructor - initializes to NULL.
 
 Memory (const cl_mem &memory, bool retainObject)
 Constructor from cl_mem - takes ownership. More...
 
Memoryoperator= (const cl_mem &rhs)
 Assignment operator from cl_mem - takes ownership. More...
 
 Memory (const Memory &mem)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
Memoryoperator= (const Memory &mem)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 Memory (Memory &&mem) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC.
 
Memoryoperator= (Memory &&mem)
 Move assignment to forward move to the superclass correctly. Required for MSVC.
 
template<typename T >
cl_int getInfo (cl_mem_info name, T *param) const
 Wrapper for clGetMemObjectInfo().
 
template<cl_int name>
detail::param_traits< detail::cl_mem_info, name >::param_type getInfo (cl_int *err=NULL) const
 Wrapper for clGetMemObjectInfo() that returns by value.
 
cl_int setDestructorCallback (void(CL_CALLBACK *pfn_notify)(cl_mem, void *), void *user_data=NULL)
 Registers a callback function to be called when the memory object is no longer needed. More...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
 Wrapper (const cl_type &obj, bool retainObject)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (Wrapper< cl_type > &&rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
const cl_type & operator() () const
 
cl_type & operator() ()
 
const cl_type get () const
 
cl_type get ()
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_mem >
typedef cl_mem cl_type
 
- Protected Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_int retain () const
 
cl_int release () const
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type object_
 

Detailed Description

Class interface for GL Buffer Memory Objects.

This is provided to facilitate interoperability with OpenGL.

See Memory for details about copy semantics, etc.

See also
Memory

Definition at line 3971 of file cl2.hpp.

Constructor & Destructor Documentation

cl::BufferGL::BufferGL ( const Context context,
cl_mem_flags  flags,
cl_GLuint  bufobj,
cl_int *  err = NULL 
)
inline

Constructs a BufferGL in a specified context, from a given GL buffer.

Wraps clCreateFromGLBuffer().

Definition at line 3979 of file cl2.hpp.

cl::BufferGL::BufferGL ( const cl_mem &  buffer,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_mem - takes ownership.

Parameters
retainObjectwill cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. See Memory for further details.

Definition at line 4008 of file cl2.hpp.

Member Function Documentation

BufferGL& cl::BufferGL::operator= ( const cl_mem &  rhs)
inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 4015 of file cl2.hpp.


The documentation for this class was generated from the following file: