►Open  CL
►1 C API Reference
▼1.3 The Open  CL Runtime
On this page:
cl  Create  Kernel
cl  Create  Kernels  In  Program:  count
cl  Create  Kernels  In  Program
cl  Create  Kernels  In  Program:  vector
cl  Retain  Kernel
cl  Release  Kernel
cl  Set  Kernel  Arg:  _  cl_  mem
cl  Set  Kernel  Arg:  _  cl_  uint
cl  Set  Kernel  Arg:  _  cl_  int
cl  Set  Kernel  Arg:  _  cl_  char
cl  Set  Kernel  Arg:  _  cl_  uchar
cl  Set  Kernel  Arg:  _  cl_  short
cl  Set  Kernel  Arg:  _  cl_  ushort
cl  Set  Kernel  Arg:  _  cl_  long
cl  Set  Kernel  Arg:  _  cl_  ulong
cl  Set  Kernel  Arg:  _  cl_  float
cl  Set  Kernel  Arg:  _  cl_  double
cl  Set  Kernel  Arg:  local
cl  Get  Kernel  Info
cl  Get  Kernel  Info:  length
cl  Get  Kernel  Info:  _  cl_  uint
cl  Get  Kernel  Info:  _  cl_  context
cl  Get  Kernel  Info:  _  cl_  program
cl  Get  Kernel  Info:  _  char*
cl  Get  Kernel  Info/  c
cl  Get  Kernel  Info:  generic
cl  Get  Kernel  Work  Group  Info
cl  Get  Kernel  Work  Group  Info:  length
cl  Get  Kernel  Work  Group  Info:  _  size_  t
cl  Get  Kernel  Work  Group  Info:  _  cl_  ulong
cl  Get  Kernel  Work  Group  Info:  _  size_  t*
cl  Get  Kernel  Work  Group  Info/  c
cl  Get  Kernel  Work  Group  Info:  generic
  top  contents    up   

1.3.5 Kernel Objects🔗ℹ

 (require opencl/c/5-5) package: opencl

procedure

(clCreateKernel program kernel-name) → _cl_kernel/c

  program : _cl_program/c
  kernel-name : bytes?

procedure

(clCreateKernelsInProgram:count program) → _cl_uint/c

  program : _cl_program/c
Returns how many results clCreateKernelsInProgram may return for these arguments.

procedure

(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.

procedure

(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.

procedure

(clRetainKernel kernel) → void

  kernel : _cl_kernel/c

procedure

(clReleaseKernel kernel) → void

  kernel : _cl_kernel/c

procedure

(clSetKernelArg:_cl_mem kernel arg-num val) → void

  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_mem/c

procedure

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

  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_uint/c

procedure

(clSetKernelArg:_cl_int kernel arg-num val) → void

  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_int/c

procedure

(clSetKernelArg:_cl_char kernel arg-num val) → void

  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_char/c

procedure

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

procedure

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

procedure

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

procedure

(clSetKernelArg:_cl_long kernel arg-num val) → void

  kernel : _cl_kernel/c
  arg-num : _cl_uint/c
  val : _cl_long/c

procedure

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

procedure

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

procedure

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

procedure

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

value

clGetKernelInfo : procedure?

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

procedure

(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.

procedure

(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).

procedure

(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).

procedure

(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).

procedure

(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).

value

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?).

procedure

(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.

value

clGetKernelWorkGroupInfo : procedure?

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

procedure

(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.

procedure

(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).

procedure

(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).

procedure

(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).

value

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).

procedure

(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.

  top  contents    up