ccl_image Struct Reference

Image wrapper class. More...

Inheritance diagram for ccl_image:

Collaboration diagram for ccl_image:

Public Member Functions
void	ccl_image_destroy (CCLImage *img)
	Decrements the reference count of the wrapper object. More...
CCLEvent *	ccl_image_enqueue_copy (CCLImage *src_img, CCLImage *dst_img, CCLQueue *cq, const size_t *src_origin, const size_t *dst_origin, const size_t *region, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Copy image objects. More...
CCLEvent *	ccl_image_enqueue_copy_to_buffer (CCLImage *src_img, CCLBuffer *dst_buf, CCLQueue *cq, const size_t *src_origin, const size_t *region, size_t dst_offset, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Copy an image object to a buffer object. More...
CCLEvent *	ccl_image_enqueue_fill (CCLImage *img, CCLQueue *cq, const void *fill_color, const size_t *origin, const size_t *region, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Fill an image object with a specified color. More...
void *	ccl_image_enqueue_map (CCLImage *img, CCLQueue *cq, cl_bool blocking_map, cl_map_flags map_flags, const size_t *origin, const size_t *region, size_t *image_row_pitch, size_t *image_slice_pitch, CCLEventWaitList *evt_wait_lst, CCLEvent **evt, CCLErr **err)
	Map a region of the image into the host address space and return a pointer to this mapped region. More...
CCLEvent *	ccl_image_enqueue_read (CCLImage *img, CCLQueue *cq, cl_bool blocking_read, const size_t *origin, const size_t *region, size_t row_pitch, size_t slice_pitch, void *ptr, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Read from an image or image array object to host memory. More...
CCLEvent *	ccl_image_enqueue_write (CCLImage *img, CCLQueue *cq, cl_bool blocking_write, const size_t *origin, const size_t *region, size_t input_row_pitch, size_t input_slice_pitch, void *ptr, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Write to an image or image array object from host memory. More...
CCLImage *	ccl_image_new (CCLContext *ctx, cl_mem_flags flags, const cl_image_format *image_format, void *host_ptr, CCLErr **err,...)
	Creates a new image wrapper object using a variable list of key-value pairs which describe the image. More...
CCLImage *	ccl_image_new_v (CCLContext *ctx, cl_mem_flags flags, const cl_image_format *image_format, const CCLImageDesc *img_dsc, void *host_ptr, CCLErr **err)
	Creates a new image wrapper object. More...
Public Member Functions inherited from ccl_memobj
CCLEvent *	ccl_memobj_enqueue_migrate (CCLMemObj **mos, cl_uint num_mos, CCLQueue *cq, cl_mem_migration_flags flags, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Enqueues a command to indicate which device a set of memory objects should be associated with. More...
CCLEvent *	ccl_memobj_enqueue_unmap (CCLMemObj *mo, CCLQueue *cq, void *mapped_ptr, CCLEventWaitList *evt_wait_lst, CCLErr **err)
	Enqueues a command to unmap a previously mapped region of a memory object. More...
cl_uint	ccl_memobj_get_opencl_version (CCLMemObj *mo, CCLErr **err)
	Get the OpenCL version of the platform associated with this memory object. More...
cl_bool	ccl_memobj_set_destructor_callback (CCLMemObj *mo, ccl_memobj_destructor_callback pfn_notify, void *user_data, CCLErr **err)
	Wrapper for OpenCL clSetMemObjectDestructorCallback() function. More...
Public Member Functions inherited from ccl_wrapper
CCLWrapperInfo *	ccl_wrapper_get_info (CCLWrapper *wrapper1, CCLWrapper *wrapper2, cl_uint param_name, size_t min_size, CCLInfo info_type, cl_bool use_cache, CCLErr **err)
	Get information about any wrapped OpenCL object. More...
size_t	ccl_wrapper_get_info_size (CCLWrapper *wrapper1, CCLWrapper *wrapper2, cl_uint param_name, size_t min_size, CCLInfo info_type, cl_bool use_cache, CCLErr **err)
	Get information size. More...
void *	ccl_wrapper_get_info_value (CCLWrapper *wrapper1, CCLWrapper *wrapper2, cl_uint param_name, size_t min_size, CCLInfo info_type, cl_bool use_cache, CCLErr **err)
	Get pointer to information value. More...
cl_bool	ccl_wrapper_memcheck ()
	Debug function which checks if memory allocated by wrappers has been properly freed. More...
void	ccl_wrapper_ref (CCLWrapper *wrapper)
	Increase the reference count of the wrapper object. More...
int	ccl_wrapper_ref_count (CCLWrapper *wrapper)
	Returns the wrapper object reference count. More...
void *	ccl_wrapper_unwrap (CCLWrapper *wrapper)
	Get the wrapped OpenCL object. More...

Protected Member Functions
CCLImage *	ccl_image_new_wrap (cl_mem mem_object)
	Get the image wrapper for the given OpenCL image. More...

Additional Inherited Members
Public Types inherited from ccl_memobj
typedef void(*	ccl_memobj_destructor_callback )(cl_mem memobj, void *user_data)
	Prototype for memory object destructor callback functions. More...
typedef void(*	ccl_memobj_destructor_callback )(cl_mem memobj, void *user_data)
	Prototype for memory object destructor callback functions. More...

Detailed Description

Image wrapper class.

Examples:

ca.c, image_fill.c, and image_filter.c.

Definition at line 40 of file ccl_image_wrapper.c.