com.jogamp.opencl.llb
Interface CLKernelBinding

All Known Subinterfaces:
CL, CLGL
All Known Implementing Classes:
CLAbstractImpl, CLImpl

public interface CLKernelBinding

Java bindings to OpenCL kernels.

Author:
Michael Bien, GlueGen, et al.

Field Summary
static int CL_KERNEL_COMPILE_WORK_GROUP_SIZE
           
static int CL_KERNEL_CONTEXT
           
static int CL_KERNEL_FUNCTION_NAME
           
static int CL_KERNEL_LOCAL_MEM_SIZE
           
static int CL_KERNEL_NUM_ARGS
           
static int CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE
           
static int CL_KERNEL_PRIVATE_MEM_SIZE
           
static int CL_KERNEL_PROGRAM
           
static int CL_KERNEL_REFERENCE_COUNT
           
static int CL_KERNEL_WORK_GROUP_SIZE
           
 
Method Summary
 long clCreateKernel(long program, String kernel_name, int[] errcode_ret, int errcode_ret_offset)
          Interface to C language function:
cl_kernel clCreateKernel(cl_program program, const char * kernel_name, cl_int * errcode_ret);
 long clCreateKernel(long program, String kernel_name, IntBuffer errcode_ret)
          Interface to C language function:
cl_kernel clCreateKernel(cl_program program, const char * kernel_name, cl_int * errcode_ret);
 int clCreateKernelsInProgram(long program, int num_kernels, PointerBuffer kernels, IntBuffer num_kernels_ret)
          Interface to C language function:
cl_int clCreateKernelsInProgram(cl_program program, cl_uint num_kernels, cl_kernel * kernels, cl_uint * num_kernels_ret);
 int clGetKernelInfo(long kernel, int param_name, long param_value_size, Buffer param_value, PointerBuffer param_value_size_ret)
          Interface to C language function:
cl_int clGetKernelInfo(cl_kernel kernel, cl_kernel_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret);
 int clGetKernelWorkGroupInfo(long kernel, long device, int param_name, long param_value_size, Buffer param_value, PointerBuffer param_value_size_ret)
          Interface to C language function:
cl_int clGetKernelWorkGroupInfo(cl_kernel kernel, cl_device_id device, cl_kernel_work_group_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret);
 int clReleaseKernel(long kernel)
          Interface to C language function:
cl_int clReleaseKernel(cl_kernel kernel);
 int clRetainKernel(long kernel)
          Interface to C language function:
cl_int clRetainKernel(cl_kernel kernel);
 int clSetKernelArg(long kernel, int arg_index, long arg_size, Buffer arg_value)
          Interface to C language function:
cl_int clSetKernelArg(cl_kernel kernel, cl_uint arg_index, size_t arg_size, const void * arg_value);
 

Field Detail

CL_KERNEL_FUNCTION_NAME

static final int CL_KERNEL_FUNCTION_NAME
See Also:
Constant Field Values

CL_KERNEL_NUM_ARGS

static final int CL_KERNEL_NUM_ARGS
See Also:
Constant Field Values

CL_KERNEL_REFERENCE_COUNT

static final int CL_KERNEL_REFERENCE_COUNT
See Also:
Constant Field Values

CL_KERNEL_CONTEXT

static final int CL_KERNEL_CONTEXT
See Also:
Constant Field Values

CL_KERNEL_PROGRAM

static final int CL_KERNEL_PROGRAM
See Also:
Constant Field Values

CL_KERNEL_WORK_GROUP_SIZE

static final int CL_KERNEL_WORK_GROUP_SIZE
See Also:
Constant Field Values

CL_KERNEL_COMPILE_WORK_GROUP_SIZE

static final int CL_KERNEL_COMPILE_WORK_GROUP_SIZE
See Also:
Constant Field Values

CL_KERNEL_LOCAL_MEM_SIZE

static final int CL_KERNEL_LOCAL_MEM_SIZE
See Also:
Constant Field Values

CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE

static final int CL_KERNEL_PREFERRED_WORK_GROUP_SIZE_MULTIPLE
See Also:
Constant Field Values

CL_KERNEL_PRIVATE_MEM_SIZE

static final int CL_KERNEL_PRIVATE_MEM_SIZE
See Also:
Constant Field Values
Method Detail

clCreateKernel

long clCreateKernel(long program,
                    String kernel_name,
                    IntBuffer errcode_ret)
Interface to C language function:
cl_kernel clCreateKernel(cl_program program, const char * kernel_name, cl_int * errcode_ret);

Parameters:
errcode_ret - a direct or array-backed IntBuffer

clCreateKernel

long clCreateKernel(long program,
                    String kernel_name,
                    int[] errcode_ret,
                    int errcode_ret_offset)
Interface to C language function:
cl_kernel clCreateKernel(cl_program program, const char * kernel_name, cl_int * errcode_ret);


clCreateKernelsInProgram

int clCreateKernelsInProgram(long program,
                             int num_kernels,
                             PointerBuffer kernels,
                             IntBuffer num_kernels_ret)
Interface to C language function:
cl_int clCreateKernelsInProgram(cl_program program, cl_uint num_kernels, cl_kernel * kernels, cl_uint * num_kernels_ret);

Parameters:
kernels - a direct only PointerBuffer
num_kernels_ret - a direct only IntBuffer

clGetKernelInfo

int clGetKernelInfo(long kernel,
                    int param_name,
                    long param_value_size,
                    Buffer param_value,
                    PointerBuffer param_value_size_ret)
Interface to C language function:
cl_int clGetKernelInfo(cl_kernel kernel, cl_kernel_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret);

Parameters:
param_value - a direct only Buffer
param_value_size_ret - a direct only PointerBuffer

clGetKernelWorkGroupInfo

int clGetKernelWorkGroupInfo(long kernel,
                             long device,
                             int param_name,
                             long param_value_size,
                             Buffer param_value,
                             PointerBuffer param_value_size_ret)
Interface to C language function:
cl_int clGetKernelWorkGroupInfo(cl_kernel kernel, cl_device_id device, cl_kernel_work_group_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret);

Parameters:
param_value - a direct only Buffer
param_value_size_ret - a direct only PointerBuffer

clReleaseKernel

int clReleaseKernel(long kernel)
Interface to C language function:
cl_int clReleaseKernel(cl_kernel kernel);


clRetainKernel

int clRetainKernel(long kernel)
Interface to C language function:
cl_int clRetainKernel(cl_kernel kernel);


clSetKernelArg

int clSetKernelArg(long kernel,
                   int arg_index,
                   long arg_size,
                   Buffer arg_value)
Interface to C language function:
cl_int clSetKernelArg(cl_kernel kernel, cl_uint arg_index, size_t arg_size, const void * arg_value);

Parameters:
arg_value - a direct only Buffer