cl::BufferRenderGL Class Reference

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

#include <cl.hpp>

Inheritance diagram for cl::BufferRenderGL:

Public Member Functions
	BufferRenderGL (const Context &context, cl_mem_flags flags, GLuint bufobj, cl_int *err=NULL)
	Constructs a BufferRenderGL in a specified context, from a given GL Renderbuffer.
	BufferRenderGL ()
	Default constructor - initializes to NULL.
	BufferRenderGL (const BufferGL &buffer)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	BufferRenderGL (const cl_mem &buffer)
	Constructor from cl_mem - takes ownership.
BufferRenderGL &	operator= (const BufferRenderGL &rhs)
	Assignment from BufferGL - performs shallow copy.
BufferRenderGL &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
cl_int	getObjectInfo (cl_gl_object_type *type, GLuint *gl_object_name)
	Wrapper for clGetGLObjectInfo().
Public Member Functions inherited from cl::Buffer
	Buffer (const Context &context, cl_mem_flags flags, ::size_t size, void *host_ptr=NULL, cl_int *err=NULL)
	Constructs a Buffer in a specified context.
	Buffer (cl_mem_flags flags, ::size_t size, void *host_ptr=NULL, cl_int *err=NULL)
	Constructs a Buffer in the default context.
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.
	Buffer ()
	Default constructor - initializes to NULL.
	Buffer (const Buffer &buffer)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Buffer (const cl_mem &buffer)
	Constructor from cl_mem - takes ownership.
Buffer &	operator= (const Buffer &rhs)
	Assignment from Buffer - performs shallow copy.
Buffer &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
Public Member Functions inherited from cl::Memory
	~Memory ()
	Destructor.
	Memory ()
	Default constructor - initializes to NULL.
	Memory (const Memory &memory)
	Copy constructor - performs shallow copy.
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership.
Memory &	operator= (const Memory &rhs)
	Assignment operator from Memory.
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership.
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.
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
cl_type	operator() () const
cl_type &	operator() ()

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 Render Buffer Memory Objects.

This is provided to facilitate interoperability with OpenGL.

See Memory for details about copy semantics, etc.

See also

Memory

Constructor & Destructor Documentation

BufferRenderGL() [1/3]

cl::BufferRenderGL::BufferRenderGL ( const Context &  context, cl_mem_flags  flags, GLuint  bufobj, cl_int *  err = NULL  )

inline

Constructs a BufferRenderGL in a specified context, from a given GL Renderbuffer.

Wraps clCreateFromGLRenderbuffer().

BufferRenderGL() [2/3]

cl::BufferRenderGL::BufferRenderGL ( const BufferGL &  buffer )

inline

Copy constructor - performs shallow copy.

See Memory for further details.

BufferRenderGL() [3/3]

__CL_EXPLICIT_CONSTRUCTORS cl::BufferRenderGL::BufferRenderGL ( const cl_mem &  buffer )

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Member Function Documentation

operator=() [1/2]

BufferRenderGL & cl::BufferRenderGL::operator= ( const BufferRenderGL &  rhs )

inline

Assignment from BufferGL - performs shallow copy.

See Memory for further details.

References cl::Buffer::operator=().

operator=() [2/2]

BufferRenderGL & cl::BufferRenderGL::operator= ( const cl_mem &  rhs )

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

References cl::Buffer::operator=().