Class interface for Buffer Memory Objects. More...

#include <cl.hpp>

Inheritance diagram for cl::Buffer:

[legend]

Collaboration diagram for cl::Buffer:

[legend]

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.
	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.
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.
	Buffer ()
	Default constructor - initializes to NULL.
__CL_EXPLICIT_CONSTRUCTORS	Buffer (const cl_mem &buffer)
	Constructor from cl_mem - takes ownership.
Buffer &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
	Buffer (const Buffer &buf)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Buffer &	operator= (const Buffer &buf)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC.
	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.
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.
	Buffer ()
	Default constructor - initializes to NULL.
__CL_EXPLICIT_CONSTRUCTORS	Buffer (const cl_mem &buffer)
	Constructor from cl_mem - takes ownership.
Buffer &	operator= (const cl_mem &rhs)
	Assignment from cl_mem - performs shallow copy.
	Buffer (const Buffer &buf)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Buffer &	operator= (const Buffer &buf)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC.
Public Member Functions inherited from cl::Memory
	Memory ()
	Default constructor - initializes to NULL.
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership.
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership.
	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy 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.
	Memory ()
	Default constructor - initializes to NULL.
__CL_EXPLICIT_CONSTRUCTORS	Memory (const cl_mem &memory)
	Constructor from cl_mem - takes ownership.
Memory &	operator= (const cl_mem &rhs)
	Assignment operator from cl_mem - takes ownership.
	Memory (const Memory &mem)
	Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Memory &	operator= (const Memory &mem)
	Copy assignment to forward copy 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.
Public Member Functions inherited from cl::detail::Wrapper< cl_mem >
	Wrapper ()
	~Wrapper ()
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
cl_type	operator() () const

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

See Memory for details about copy semantics, etc.

See also: Memory

Definition at line 3017 of file cl.hpp.

Constructor & Destructor Documentation

◆ Buffer() [1/16]

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 3028 of file cl.hpp.

◆ Buffer() [2/16]

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 3053 of file cl.hpp.

◆ Buffer() [3/16]

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 3077 of file cl.hpp.

◆ Buffer() [4/16]

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.

◆ Buffer() [5/16]

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 6530 of file cl.hpp.

◆ Buffer() [6/16]

cl::Buffer::Buffer ( )

inline

Default constructor - initializes to NULL.

Definition at line 3140 of file cl.hpp.

◆ Buffer() [7/16]

__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 3146 of file cl.hpp.

◆ Buffer() [8/16]

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

inline

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

Definition at line 3161 of file cl.hpp.

◆ Buffer() [9/16]

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 3028 of file cl.hpp.

◆ Buffer() [10/16]

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 3053 of file cl.hpp.

◆ Buffer() [11/16]

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 3077 of file cl.hpp.

◆ Buffer() [12/16]

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.

◆ Buffer() [13/16]

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.

◆ Buffer() [14/16]

cl::Buffer::Buffer ( )

inline

Default constructor - initializes to NULL.

Definition at line 3140 of file cl.hpp.

◆ Buffer() [15/16]

__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 3146 of file cl.hpp.

◆ Buffer() [16/16]

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

inline

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

Definition at line 3161 of file cl.hpp.

Member Function Documentation

◆ operator=() [1/4]

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

inline

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

Definition at line 3166 of file cl.hpp.

◆ operator=() [2/4]

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

inline

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

Definition at line 3166 of file cl.hpp.

◆ operator=() [3/4]

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

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3152 of file cl.hpp.

◆ operator=() [4/4]

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

inline

Assignment from cl_mem - performs shallow copy.

See Memory for further details.

Definition at line 3152 of file cl.hpp.

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

/build/asl-FBaFQT/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp
/build/asl-FBaFQT/asl-0.1.7/src/acl/cl.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Buffer() [1/16]

◆ Buffer() [2/16]

◆ Buffer() [3/16]

◆ Buffer() [4/16]

◆ Buffer() [5/16]

◆ Buffer() [6/16]

◆ Buffer() [7/16]

◆ Buffer() [8/16]

◆ Buffer() [9/16]

◆ Buffer() [10/16]

◆ Buffer() [11/16]

◆ Buffer() [12/16]

◆ Buffer() [13/16]

◆ Buffer() [14/16]

◆ Buffer() [15/16]

◆ Buffer() [16/16]

Member Function Documentation

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]