To create a program object for a context and loads the information related to the built-in kernels into that object, call the function
cl_program clCreateProgramWithBuiltInKernels( cl_context context, cl_uint num_devices, const cl_device_id* device_list, const char* kernel_names, cl_int* errcode_ret);
context must be a valid OpenCL context.
num_devices is the number of devices listed in device_list.
device_list is a pointer to a list of devices that are in context. device_list must be a non-
NULLvalue. The built-in kernels are loaded for devices specified in this list.
kernel_names is a semi-colon separated list of built-in kernel names.
The devices associated with the program object will be the list of devices specified by device_list. The list of devices specified by device_list must be devices associated with context.
clCreateProgramWithBuiltInKernels returns a valid non-zero program object
and errcode_ret is set to
CL_SUCCESS if the program object is created
Otherwise, it returns a
NULL value with one of the following error values
returned in errcode_ret:
CL_INVALID_CONTEXTif context is not a valid context.
CL_INVALID_VALUEif device_list is
NULLor num_devices is zero.
CL_INVALID_VALUEif kernel_names is
NULLor kernel_names contains a kernel name that is not supported by any of the devices in device_list.
CL_INVALID_DEVICEif any device in device_list is not in the list of devices associated with context.
CL_OUT_OF_RESOURCESif there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.
Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.