1.3.5 Kernel Objects

(require (planet jaymccarthy/opencl:1:=0/c/5-5))

(clCreateKernel program kernel-name) → _cl_kernel/c
program : _cl_program/c
kernel-name : bytes?

(clCreateKernelsInProgram:count program) → _cl_uint/c
program : _cl_program/c

Returns how many results clCreateKernelsInProgram may return for these arguments.

(clCreateKernelsInProgram program how-many)
→
_cl_kernel_vector/c _cl_uint/c
program : _cl_program/c
how-many : _cl_uint/c

Returns the minimum of how-many and how-many-possible values in rets.

(clCreateKernelsInProgram:vector program) → _cl_kernel_vector/c
program : _cl_program/c

Returns all possible results from clCreateKernelsInProgram using clCreateKernelsInProgram:count to extract the number available.

(clRetainKernel kernel) → void
kernel : _cl_kernel/c

(clReleaseKernel kernel) → void
kernel : _cl_kernel/c

(clSetKernelArg:_cl_mem kernel arg-num val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_mem/c

(clSetKernelArg:_cl_uint kernel arg-num val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_uint/c

(clSetKernelArg:_cl_int kernel arg-num val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_int/c

(clSetKernelArg:_cl_char kernel arg-num val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_char/c

(clSetKernelArg:_cl_uchar kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_uchar/c

(clSetKernelArg:_cl_short kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_short/c

(clSetKernelArg:_cl_ushort kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_ushort/c

(clSetKernelArg:_cl_long kernel arg-num val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_long/c

(clSetKernelArg:_cl_ulong kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_ulong/c

(clSetKernelArg:_cl_float kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_float/c

(clSetKernelArg:_cl_double kernel
arg-num
val) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_double/c

(clSetKernelArg:local kernel
arg-num
arg_size) → void
  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  arg_size : _size_t/c

clGetKernelInfo : procedure?

A dummy Racket function that refers callers to the other clGetKernelInfo-based functions which access the true C function.

(clGetKernelInfo:length kernel param_name) → _size_t/c
kernel : _cl_kernel/c
param_name : _cl_kernel_info/c

Returns the size of param_name field of the argument(s). Calls clGetKernelInfo with values for param_value_size and param_value such that param_value_size_ret is queried.

(clGetKernelInfo:_cl_uint kernel
param_name) → _cl_uint/c
kernel : _cl_kernel/c
param_name : _cl_kernel_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelInfo with param_value_size set to (ctype-sizeof _cl_uint) so that the value is queried. Valid param_names are '(CL_KERNEL_NUM_ARGS CL_KERNEL_REFERENCE_COUNT).

(clGetKernelInfo:_cl_context kernel
param_name) → _cl_context/c
kernel : _cl_kernel/c
param_name : _cl_kernel_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelInfo with param_value_size set to (ctype-sizeof _cl_context) so that the value is queried. Valid param_names are '(CL_KERNEL_CONTEXT).

(clGetKernelInfo:_cl_program kernel
param_name) → _cl_program/c
kernel : _cl_kernel/c
param_name : _cl_kernel_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelInfo with param_value_size set to (ctype-sizeof _cl_program) so that the value is queried. Valid param_names are '(CL_KERNEL_PROGRAM).

(clGetKernelInfo:_char* kernel
param_name
param_value_size) → bytes?
  kernel : _cl_kernel/c
  param_name : _cl_kernel_info/c
  param_value_size : _size_t/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelInfo with param_value_size passed explicitly. Valid param_names are '(CL_KERNEL_FUNCTION_NAME).

clGetKernelInfo/c : contract?

A contract for the return values of clGetKernelInfo:generic. Its definition is: (or/c _cl_uint/c _cl_context/c _cl_program/c bytes?).

(clGetKernelInfo:generic kernel param_name) → clGetKernelInfo/c
kernel : _cl_kernel/c
param_name : _cl_kernel_info/c

Returns the value associated with param_name for the argument(s). Selects the appropriate clGetKernelInfo-based function to extract the appropriate value, automatically providing the right length for variable length functions.

clGetKernelWorkGroupInfo : procedure?

A dummy Racket function that refers callers to the other clGetKernelWorkGroupInfo-based functions which access the true C function.

(clGetKernelWorkGroupInfo:length kernel
device
param_name) → _size_t/c
  kernel : _cl_kernel/c
  device : _cl_device_id/c
  param_name : _cl_kernel_work_group_info/c

Returns the size of param_name field of the argument(s). Calls clGetKernelWorkGroupInfo with values for param_value_size and param_value such that param_value_size_ret is queried.

(clGetKernelWorkGroupInfo:_size_t kernel
device
param_name) → _size_t/c
  kernel : _cl_kernel/c
  device : _cl_device_id/c
  param_name : _cl_kernel_work_group_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelWorkGroupInfo with param_value_size set to (ctype-sizeof _size_t) so that the value is queried. Valid param_names are '(CL_KERNEL_WORK_GROUP_SIZE).

(clGetKernelWorkGroupInfo:_cl_ulong kernel
device
param_name) → _cl_ulong/c
  kernel : _cl_kernel/c
  device : _cl_device_id/c
  param_name : _cl_kernel_work_group_info/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelWorkGroupInfo with param_value_size set to (ctype-sizeof _cl_ulong) so that the value is queried. Valid param_names are '(CL_KERNEL_LOCAL_MEM_SIZE).

(clGetKernelWorkGroupInfo:_size_t* kernel
device
param_name
param_value_size)
→ _size_t_vector/c
  kernel : _cl_kernel/c
  device : _cl_device_id/c
  param_name : _cl_kernel_work_group_info/c
  param_value_size : _size_t/c

Returns the value associated with param_name for the argument(s). Implemented by clGetKernelWorkGroupInfo with param_value_size passed explicitly. Valid param_names are '(CL_KERNEL_COMPILE_WORK_GROUP_SIZE).

clGetKernelWorkGroupInfo/c : contract?

A contract for the return values of clGetKernelWorkGroupInfo:generic. Its definition is: (or/c _size_t/c _cl_ulong/c _size_t_vector/c).

(clGetKernelWorkGroupInfo:generic kernel
device
param_name)
→ clGetKernelWorkGroupInfo/c
  kernel : _cl_kernel/c
  device : _cl_device_id/c
  param_name : _cl_kernel_work_group_info/c

Returns the value associated with param_name for the argument(s). Selects the appropriate clGetKernelWorkGroupInfo-based function to extract the appropriate value, automatically providing the right length for variable length functions.

← prev up next →

1.1	Types
1.2	The Open CL Platform Layer
1.3	The Open CL Runtime

1.3.1	Command Queues
1.3.2	Memory Objects
1.3.3	Sampler Objects
1.3.4	Program Objects
1.3.5	Kernel Objects
1.3.6	Executing Kernels
1.3.7	Event Objects
1.3.8	Out-of-order Execution of Kernels and Memory Object Commands
1.3.9	Profiling Operations on Memory Objects and Kernels
1.3.10	Flush and Finish