Wrapper for an OpenCL Buffer. More...

#include <CLBuffer.h>

Inheritance diagram for icl::utils::CLBuffer:

Public Member Functions
	CLBuffer ()
	default constructor (creates null instance) More...

	CLBuffer (const CLBuffer &other)
	copy constructor (always performs shallow copy) More...

CLBuffer &	operator= (const CLBuffer &other)
	assignment operator (always performs a shallow copy) More...

	~CLBuffer ()
	destructor More...

void	copy (CLBuffer &dst, int len, int src_offset=0, int dst_offset=0)
	copies the content of this buffer into the given buffer More...

void	read (void *dst, int len, int offset=0, bool block=true)
	reads buffer from graphics memory into given destination pointer More...

void	write (const void *src, int len, int offset=0, bool block=true)
	writes source data into the graphics memory More...

bool	isNull () const
	checks whether buffer is null More...

	operator bool () const
	checks whether buffer is not null More...

Public Member Functions inherited from icl::utils::CLMemory
	CLMemory (CLMemory const &other)
	CLMemory default copy constructor. More...

CLMemory &	operator= (CLMemory const &other)
	operator = default assignment operator More...

virtual	~CLMemory ()
	Destructor. More...

CLBuffer *	asCLBuffer ()
	asCLBuffer Casting function to cast to CLBuffer pointer (reinterpret_cast) More...

CLImage2D *	asCLImage2D ()
	asCLImage2D Casting function to cast to CLImage2D pointer (reinterpret_cast) More...

const std::vector< icl32s >	getDimensions () const
	returns the dimensions (3Dim-std::vector for x,y,z dimensions) More...

const icl64s	getSize () const
	returns total size of the memory (xyz) More...

const icl32s	getByteDepth () const
	returns the bytedepth of the used data type (e.g. float32 = 4byte) More...

Private Member Functions
	CLBuffer (cl::Context &context, cl::CommandQueue &cmdQueue, const string &accessMode, size_t size, const void *src=NULL)
	private constructor (buffer can only be created by CLProgram instances) More...

	CLBuffer (cl::Context &context, cl::CommandQueue &cmdQueue, const string &accessMode, size_t length, size_t byte_depth, const void *src=NULL)

cl::Buffer &	getBuffer ()
	provides access to the underlying cl-buffer More...

const cl::Buffer &	getBuffer () const

Private Attributes
Impl *	impl
	internal hidden implementation type More...

Friends
class	CLProgram
	for tight integration with CLProgram instances More...

class	CLKernel
	for tight integration with CLKernel instances More...

class	CLDeviceContext
	for tight integration with CLDeviceContext instances More...

Additional Inherited Members
Public Types inherited from icl::utils::CLMemory
enum	MemoryType { Buffer, Image2D, Invalid }
	Memorys type available. More...

typedef SmartPtr< CLMemory >	Ptr
	smart pointer to this class type More...

Protected Member Functions inherited from icl::utils::CLMemory
	CLMemory (MemoryType const type=Invalid)
	CLMemory Default constructor. Only inherit classes can use this constructor. More...

void	setDimensions (icl32s const &x, icl32s const &y, icl32s const &z)
	sets the dimensions x,y,z and total size More...

Protected Attributes inherited from icl::utils::CLMemory
std::vector< icl32s >	m_dimensions
	size of each dimension x,y,z More...

icl64s	m_size
	size in total xyz More...

icl32s	m_byte_depth
	byte depth of the data type used (e.g. float32 = 4byte) More...

Detailed Description

Wrapper for an OpenCL Buffer.

Valid CLBuffer instances can only be created by a CLProgram instance.

See also: CLProgram for more details

Constructor & Destructor Documentation

◆ CLBuffer() [1/4]

icl::utils::CLBuffer::CLBuffer	(	cl::Context &	context,
		cl::CommandQueue &	cmdQueue,
		const string &	accessMode,
		size_t	size,
		const void *	src = `NULL`
	)

private

private constructor (buffer can only be created by CLProgram instances)

◆ CLBuffer() [2/4]

icl::utils::CLBuffer::CLBuffer	(	cl::Context &	context,
		cl::CommandQueue &	cmdQueue,
		const string &	accessMode,
		size_t	length,
		size_t	byte_depth,
		const void *	src = `NULL`
	)

private

◆ CLBuffer() [3/4]

icl::utils::CLBuffer::CLBuffer ( )

default constructor (creates null instance)

◆ CLBuffer() [4/4]

icl::utils::CLBuffer::CLBuffer ( const CLBuffer & other )

copy constructor (always performs shallow copy)

◆ ~CLBuffer()

icl::utils::CLBuffer::~CLBuffer ( )

destructor

Member Function Documentation

◆ copy()

void icl::utils::CLBuffer::copy	(	CLBuffer &	dst,
		int	len,
		int	src_offset = `0`,
		int	dst_offset = `0`
	)

copies the content of this buffer into the given buffer

◆ getBuffer() [1/2]

cl::Buffer& icl::utils::CLBuffer::getBuffer ( )

private

provides access to the underlying cl-buffer

◆ getBuffer() [2/2]

const cl::Buffer& icl::utils::CLBuffer::getBuffer ( ) const

private

◆ isNull()

bool icl::utils::CLBuffer::isNull ( ) const

inline

checks whether buffer is null

◆ operator bool()

icl::utils::CLBuffer::operator bool ( ) const

inline

checks whether buffer is not null

◆ operator=()

CLBuffer& icl::utils::CLBuffer::operator= ( const CLBuffer & other )

assignment operator (always performs a shallow copy)

◆ read()

void icl::utils::CLBuffer::read	(	void *	dst,
		int	len,
		int	offset = `0`,
		bool	block = `true`
	)

reads buffer from graphics memory into given destination pointer

◆ write()

void icl::utils::CLBuffer::write	(	const void *	src,
		int	len,
		int	offset = `0`,
		bool	block = `true`
	)

writes source data into the graphics memory

Friends And Related Function Documentation

◆ CLDeviceContext

friend class CLDeviceContext

friend

for tight integration with CLDeviceContext instances

◆ CLKernel

friend class CLKernel

friend

for tight integration with CLKernel instances

◆ CLProgram

friend class CLProgram

friend

for tight integration with CLProgram instances

Member Data Documentation

◆ impl

Impl* icl::utils::CLBuffer::impl

private

internal hidden implementation type

internal implemetation

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

/Users/alneuman/vm/icl/ICLUtils/src/ICLUtils/CLBuffer.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CLBuffer() [1/4]

◆ CLBuffer() [2/4]

◆ CLBuffer() [3/4]

◆ CLBuffer() [4/4]

◆ ~CLBuffer()

Member Function Documentation

◆ copy()

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ isNull()

◆ operator bool()

◆ operator=()

◆ read()

◆ write()

Friends And Related Function Documentation

◆ CLDeviceContext

◆ CLKernel

◆ CLProgram

Member Data Documentation

◆ impl