Uses of Class
org.jocl.cl_mem

Uses of cl_mem in org.jocl

Fields in org.jocl declared as cl_mem

Modifier and Type	Field	Description
cl_mem	cl_image_desc.buffer	buffer refers to a valid buffer memory object if image_type is CL_MEM_OBJECT_IMAGE1D_BUFFER.

Methods in org.jocl that return cl_mem

Modifier and Type	Method	Description
static cl_mem	CL.clCreateBuffer(cl_context context, long flags, long size, Pointer host_ptr, int[] errcode_ret)	Creates a buffer object.
static cl_mem	CL.clCreateFromGLBuffer(cl_context context, long flags, int bufobj, int[] errcode_ret)	Creates an OpenCL buffer object from an OpenGL buffer object.
static cl_mem	CL.clCreateFromGLRenderbuffer(cl_context context, long flags, int renderbuffer, int[] errcode_ret)	Creates an OpenCL 2D image object from an OpenGL renderbuffer object.
static cl_mem	CL.clCreateFromGLTexture(cl_context context, long flags, int target, int miplevel, int texture, int[] errcode_ret)	Creates an OpenCL image object, image array object, or image buffer object from an OpenGL texture object, texture array object, texture buffer object, or a single face of an OpenGL cubemap texture object.
static cl_mem	CL.clCreateFromGLTexture2D(cl_context context, long flags, int target, int miplevel, int texture, int[] errcode_ret)	Deprecated. As of OpenCL 1.2 and replaced by CL.clCreateFromGLTexture(cl_context, long, int, int, int, int[])
static cl_mem	CL.clCreateFromGLTexture3D(cl_context context, long flags, int target, int miplevel, int texture, int[] errcode_ret)	Deprecated. As of OpenCL 1.2 and replaced by CL.clCreateFromGLTexture(cl_context, long, int, int, int, int[])
static cl_mem	CL.clCreateImage(cl_context context, long flags, cl_image_format image_format, cl_image_desc image_desc, Pointer host_ptr, int[] errcode_ret)	Creates a 1D image, 1D image buffer, 1D image array, 2D image, 2D image array or 3D image object.
static cl_mem	CL.clCreateImage2D(cl_context context, long flags, cl_image_format[] image_format, long image_width, long image_height, long image_row_pitch, Pointer host_ptr, int[] errcode_ret)	Deprecated. As of OpenCL 1.2 and replaced by CL.clCreateImage(cl_context, long, cl_image_format, cl_image_desc, Pointer, int[])
static cl_mem	CL.clCreateImage3D(cl_context context, long flags, cl_image_format[] image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Pointer host_ptr, int[] errcode_ret)	Deprecated. As of OpenCL 1.2 and replaced by CL.clCreateImage(cl_context, long, cl_image_format, cl_image_desc, Pointer, int[])
static cl_mem	CL.clCreatePipe(cl_context context, long flags, int pipe_packet_size, int pipe_max_packets, cl_pipe_properties properties, int[] errcode_ret)	Creates a pipe object.
static cl_mem	CL.clCreateSubBuffer(cl_mem buffer, long flags, int buffer_create_type, cl_buffer_region buffer_create_info, int[] errcode_ret)	Creates a buffer object (referred to as a sub-buffer object) from an existing buffer object.
static cl_mem	CL.clCreateSubBuffer(cl_mem buffer, long flags, int buffer_create_type, Pointer buffer_create_info, int[] errcode_ret)	Deprecated. The buffer_create_info that has to be passed to this function is specific for the underlying architecture (32/64 bit).

Methods in org.jocl with parameters of type cl_mem

Modifier and Type	Method	Description
static cl_mem	CL.clCreateSubBuffer(cl_mem buffer, long flags, int buffer_create_type, cl_buffer_region buffer_create_info, int[] errcode_ret)	Creates a buffer object (referred to as a sub-buffer object) from an existing buffer object.
static cl_mem	CL.clCreateSubBuffer(cl_mem buffer, long flags, int buffer_create_type, Pointer buffer_create_info, int[] errcode_ret)	Deprecated. The buffer_create_info that has to be passed to this function is specific for the underlying architecture (32/64 bit).
static int	CL.clEnqueueAcquireGLObjects(cl_command_queue command_queue, int num_objects, cl_mem[] mem_objects, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Acquire OpenCL memory objects that have been created from OpenGL objects.
static int	CL.clEnqueueCopyBuffer(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_buffer, long src_offset, long dst_offset, long cb, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to copy from one buffer object to another.
static int	CL.clEnqueueCopyBufferRect(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_buffer, long[] src_origin, long[] dst_origin, long[] region, long src_row_pitch, long src_slice_pitch, long dst_row_pitch, long dst_slice_pitch, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to copy a rectangular region from the buffer object to another buffer object.
static int	CL.clEnqueueCopyBufferToImage(cl_command_queue command_queue, cl_mem src_buffer, cl_mem dst_image, long src_offset, long[] dst_origin, long[] region, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to copy a buffer object to an image object.
static int	CL.clEnqueueCopyImage(cl_command_queue command_queue, cl_mem src_image, cl_mem dst_image, long[] src_origin, long[] dst_origin, long[] region, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to copy image objects.
static int	CL.clEnqueueCopyImageToBuffer(cl_command_queue command_queue, cl_mem src_image, cl_mem dst_buffer, long[] src_origin, long[] region, long dst_offset, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to copy an image object to a buffer object.
static int	CL.clEnqueueFillBuffer(cl_command_queue command_queue, cl_mem buffer, Pointer pattern, long pattern_size, long offset, long size, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to fill a buffer object with a pattern of a given pattern size.
static int	CL.clEnqueueFillImage(cl_command_queue command_queue, cl_mem image, Pointer fill_color, long[] origin, long[] region, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to fill an image object with a specified color.
static ByteBuffer	CL.clEnqueueMapBuffer(cl_command_queue command_queue, cl_mem buffer, boolean blocking_map, long map_flags, long offset, long cb, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event, int[] errcode_ret)	Enqueues a command to map a region of the buffer object given by buffer into the host address space and returns a pointer to this mapped region.
static ByteBuffer	CL.clEnqueueMapImage(cl_command_queue command_queue, cl_mem image, boolean blocking_map, long map_flags, long[] origin, long[] region, long[] image_row_pitch, long[] image_slice_pitch, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event, int[] errcode_ret)	Enqueues a command to map a region of an image object into the host address space and returns a pointer to this mapped region.
static int	CL.clEnqueueMigrateMemObjects(cl_command_queue command_queue, int num_mem_objects, cl_mem[] mem_objects, long flags, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to indicate which device a set of memory objects should be associated with.
static int	CL.clEnqueueNativeKernel(cl_command_queue command_queue, EnqueueNativeKernelFunction user_func, Object args, long cb_args, int num_mem_objects, cl_mem[] mem_list, Pointer[] args_mem_loc, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to execute a native C/C++ function not compiled using the OpenCL compiler.
static int	CL.clEnqueueReadBuffer(cl_command_queue command_queue, cl_mem buffer, boolean blocking_read, long offset, long cb, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueue commands to read from a buffer object to host memory.
static int	CL.clEnqueueReadBufferRect(cl_command_queue command_queue, cl_mem buffer, boolean blocking_read, long[] buffer_offset, long[] host_offset, long[] region, long buffer_row_pitch, long buffer_slice_pitch, long host_row_pitch, long host_slice_pitch, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueue commands to read from a rectangular region from a buffer object to host memory.
static int	CL.clEnqueueReadImage(cl_command_queue command_queue, cl_mem image, boolean blocking_read, long[] origin, long[] region, long row_pitch, long slice_pitch, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to read from a 2D or 3D image object to host memory.
static int	CL.clEnqueueReleaseGLObjects(cl_command_queue command_queue, int num_objects, cl_mem[] mem_objects, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Release OpenCL memory objects that have been created from OpenGL objects.
static int	CL.clEnqueueUnmapMemObject(cl_command_queue command_queue, cl_mem memobj, ByteBuffer mapped_ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to unmap a previously mapped region of a memory object.
static int	CL.clEnqueueWriteBuffer(cl_command_queue command_queue, cl_mem buffer, boolean blocking_write, long offset, long cb, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueue commands to write to a buffer object from host memory.
static int	CL.clEnqueueWriteBufferRect(cl_command_queue command_queue, cl_mem buffer, boolean blocking_write, long[] buffer_offset, long[] host_offset, long[] region, long buffer_row_pitch, long buffer_slice_pitch, long host_row_pitch, long host_slice_pitch, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueue commands to write a rectangular region to a buffer object from host memory.
static int	CL.clEnqueueWriteImage(cl_command_queue command_queue, cl_mem image, boolean blocking_write, long[] origin, long[] region, long input_row_pitch, long input_slice_pitch, Pointer ptr, int num_events_in_wait_list, cl_event[] event_wait_list, cl_event event)	Enqueues a command to write to a 2D or 3D image object from host memory.
static int	CL.clGetGLObjectInfo(cl_mem memobj, int[] gl_object_type, int[] gl_object_name)	Query an OpenGL memory object used to create an OpenCL memory object.
static int	CL.clGetGLTextureInfo(cl_mem memobj, int param_name, long param_value_size, Pointer param_value, long[] param_value_size_ret)	Returns additional information about the GL texture object associated with a memory object.
static int	CL.clGetImageInfo(cl_mem image, int param_name, long param_value_size, Pointer param_value, long[] param_value_size_ret)	Get information specific to an image object.
static int	CL.clGetMemObjectInfo(cl_mem memobj, int param_name, long param_value_size, Pointer param_value, long[] param_value_size_ret)	Used to get information that is common to all memory objects (buffer and image objects).
static int	CL.clGetPipeInfo(cl_mem pipe, int param_name, long param_value_size, Pointer param_value, long[] param_value_size_ret)	Get information specific to a pipe object created with clCreatePipe.
static int	CL.clReleaseMemObject(cl_mem memobj)	Decrements the memory object reference count.
static int	CL.clRetainMemObject(cl_mem memobj)	Increments the memory object reference count.
static int	CL.clSetMemObjectDestructorCallback(cl_mem memobj, MemObjectDestructorCallbackFunction pfn_notify, Object user_data)	Registers a user callback function that will be called when the memory object is deleted and its resources freed.
void	MemObjectDestructorCallbackFunction.function(cl_mem memobj, Object user_data)	The function that will be called