To creates a program object for a context and load source code into that object, call the function
cl_program clCreateProgramWithSource( cl_context context, cl_uint count, const char** strings, const size_t* lengths, cl_int* errcode_ret);
context must be a valid OpenCL context.
strings is an array of count pointers to optionally null-terminated character strings that make up the source code.
lengths argument is an array with the number of chars in each string (the string length). If an element in lengths is zero, its accompanying string is null-terminated. If lengths is
NULL, all strings in the strings argument are considered null-terminated. Any length value passed in that is greater than zero excludes the null terminator in its count.
errcode_ret will return an appropriate error code. If errcode_ret is
NULL, no error code is returned.
The source code specified by strings will be loaded into the program object.
The devices associated with the program object are the devices associated with context. The source code specified by strings is either an OpenCL C program source, header or implementation-defined source for custom devices that support an online compiler. OpenCL C++ is not supported as an online-compiled kernel language through this interface.
clCreateProgramWithSource 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 count is zero or if strings or any entry in strings is
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.