Class interface for Buffer Memory Objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Buffer:

Public Member Functions
	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. More...

	Buffer (cl_mem_flags flags,::size_t 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. More...

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. More...

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 represent contiguous data. More...

	Buffer ()
	Default constructor - initializes to NULL. More...

__CL_EXPLICIT_CONSTRUCTORS	Buffer (const cl_mem &buffer)
	Constructor from cl_mem - takes ownership. More...

	Buffer (const Buffer &buf)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...

Buffer &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy. More...

Buffer &	operator= (const Buffer &buf)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...

Public Member Functions inherited from cl::Memory
template<typename T >
cl_int	getInfo (cl_mem_info name, T *param) const
	Wrapper for clGetMemObjectInfo(). More...

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. More...

	Memory ()
	Default constructor - initializes to NULL. More...

__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership. More...

	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC. More...

Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership. More...

Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...

Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
cl_type	operator() () const

cl_type &	operator() ()

Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)

Wrapper< cl_type > &	operator= (const cl_type &rhs)

	Wrapper ()

	Wrapper (const cl_type &obj)

	Wrapper (const Wrapper< cl_type > &rhs)

	~Wrapper ()

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	release () const

cl_int	retain () const

Protected Attributes inherited from cl::detail::Wrapper< cl_mem >
cl_type	object_

Detailed Description

Class interface for Buffer Memory Objects.

See Memory for details about copy semantics, etc.

See also: Memory

Definition at line 3140 of file cl.hpp.

Constructor & Destructor Documentation

cl::Buffer::Buffer	(	const Context &	context,
		cl_mem_flags	flags,
		::size_t	size,
		void *	host_ptr = `NULL`,
		cl_int *	err = `NULL`
	)

inline

Constructs a Buffer in a specified context.

Wraps clCreateBuffer().

Parameters

host_ptr Storage to be used if the CL_MEM_USE_HOST_PTR flag was specified. Note alignment & exclusivity requirements.

Definition at line 3151 of file cl.hpp.

cl::Buffer::Buffer	(	cl_mem_flags	flags,
		::size_t	size,
		void *	host_ptr = `NULL`,
		cl_int *	err = `NULL`
	)

inline

Constructs a Buffer in the default context.

Wraps clCreateBuffer().

Parameters

host_ptr Storage to be used if the CL_MEM_USE_HOST_PTR flag was specified. Note alignment & exclusivity requirements.

See also: Context::getDefault()

Definition at line 3176 of file cl.hpp.

template<typename IteratorType >

cl::Buffer::Buffer	(	IteratorType	startIterator,
		IteratorType	endIterator,
		bool	readOnly,
		bool	useHostPtr = `false`,
		cl_int *	err = `NULL`
	)

inline

Construct a Buffer from a host container via iterators. IteratorType must be random access. If useHostPtr is specified iterators must represent contiguous data.

Definition at line 3200 of file cl.hpp.

template<typename IteratorType >

cl::Buffer::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 >

cl::Buffer::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 represent contiguous data.

Definition at line 6653 of file cl.hpp.

cl::Buffer::Buffer ( )

inline

Default constructor - initializes to NULL.

Definition at line 3263 of file cl.hpp.

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

inline

Constructor from cl_mem - takes ownership.

See Memory for further details.

Definition at line 3269 of file cl.hpp.

cl::Buffer::Buffer ( const Buffer & buf )

inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 3284 of file cl.hpp.

Member Function Documentation

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

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3275 of file cl.hpp.

Buffer& cl::Buffer::operator= ( const Buffer & buf )

inline

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 3289 of file cl.hpp.

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

cl.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation