Image Component Library (ICL)
|
Wrapper for an OpenCL Image2D. More...
#include <CLImage2D.h>
Public Member Functions | |
CLImage2D () | |
default constructor (creates null instance) | |
CLImage2D (const CLImage2D &other) | |
copy constructor (always performs shallow copy) | |
CLImage2D & | operator= (const CLImage2D &other) |
assignment operator (always performs a shallow copy) | |
~CLImage2D () | |
destructor | |
void | read (void *dst, const utils::Rect ®ion=utils::Rect::null, bool block=true) throw (CLBufferException) |
reads image from graphics memory into given destination pointer | |
void | write (const void *src, const utils::Rect ®ion=utils::Rect::null, bool block=true) throw (CLBufferException) |
writes source data into the graphics memory | |
bool | isNull () const |
checks whether image is null | |
operator bool () const | |
checks whether image is not null | |
Private Member Functions | |
CLImage2D (cl::Context &context, cl::CommandQueue &cmdQueue, const string &accessMode, const size_t width, const size_t height, int depth, const void *src=NULL) throw (CLBufferException) | |
private constructor (image can only be created by CLProgram instances) | |
cl::Image2D | getImage2D () |
provides access to the underlying cl-Image2D object | |
const cl::Image2D | getImage2D () const |
Private Attributes | |
Impl * | impl |
internal hidden implementation type | |
Friends | |
class | CLProgram |
for tight integration with CLProgram instances | |
class | CLKernel |
for tight integration with CLKernel instances |
Wrapper for an OpenCL Image2D.
Valid CLImage2D instances can only be created by a CLProgram instance.
icl::utils::CLImage2D::CLImage2D | ( | cl::Context & | context, |
cl::CommandQueue & | cmdQueue, | ||
const string & | accessMode, | ||
const size_t | width, | ||
const size_t | height, | ||
int | depth, | ||
const void * | src = NULL |
||
) | throw (CLBufferException) [private] |
private constructor (image can only be created by CLProgram instances)
default constructor (creates null instance)
icl::utils::CLImage2D::CLImage2D | ( | const CLImage2D & | other | ) |
copy constructor (always performs shallow copy)
destructor
cl::Image2D icl::utils::CLImage2D::getImage2D | ( | ) | [private] |
provides access to the underlying cl-Image2D object
const cl::Image2D icl::utils::CLImage2D::getImage2D | ( | ) | const [private] |
bool icl::utils::CLImage2D::isNull | ( | ) | const [inline] |
checks whether image is null
icl::utils::CLImage2D::operator bool | ( | ) | const [inline] |
checks whether image is not null
assignment operator (always performs a shallow copy)
void icl::utils::CLImage2D::read | ( | void * | dst, |
const utils::Rect & | region = utils::Rect::null , |
||
bool | block = true |
||
) | throw (CLBufferException) |
reads image from graphics memory into given destination pointer
region defines the accessed image area. When no region is provided the complete image is addressed(initial width, height and (0, 0) as origin
void icl::utils::CLImage2D::write | ( | const void * | src, |
const utils::Rect & | region = utils::Rect::null , |
||
bool | block = true |
||
) | throw (CLBufferException) |
writes source data into the graphics memory
region defines the accessed image area. When no region is provided the complete image is addressed(initial width, height and (0, 0) as origin
Impl* icl::utils::CLImage2D::impl [private] |
internal hidden implementation type
internal implemetation