oracular (3) clCreateProgramWithBuiltInKernels.3clc.gz

Provided by: opencl-1.2-man-doc_1.0~svn33624-5_all bug

NAME
       clCreateProgramWithBuiltInKernels - Creates a program object for a context, and loads the information
       related to the built-in kernels into a program object.

       cl_program clCreateProgramWithBuiltInKernels(cl_context context, cl_uint num_devices,
                                                    const cl_device_id *device_list, const char *kernel_names,
                                                    cl_int *errcode_ret);


PARAMETERS
        context
           Must be a valid OpenCL context.

        num_devices
           The number of devices listed in device_list.

        device_list
           A pointer to a list of devices that are in context.  device_list must be a non-NULL value. The
           built-in kernels are loaded for devices specified in this list.

           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.

        kernel_names
           A semi-colon separated list of built-in kernel names.


ERRORS
       Returns a valid non-zero program object and errcode_ret is set to CL_SUCCESS if the program object is
       created successfully. Otherwise, it returns a NULL value with one of the following error values returned
       in errcode_ret:

       •   CL_INVALID_CONTEXT if context is not a valid context.

       •   CL_INVALID_VALUE if device_list is NULL or num_devices is zero;

       •   CL_INVALID_VALUE if kernel_names is NULL or kernel_names contains a kernel name that is not supported
           by any of the devices in device_list.

       •   CL_INVALID_DEVICE if devices listed in device_list are not in the list of devices associated with
           context.

       •   CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation
           on the device.

       •   CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL
           implementation on the host.


SPECIFICATION
       OpenCL Specification[1]


SEE ALSO
       clCreateProgramWithSource(3clc), clReleaseProgram(3clc), clRetainProgram(3clc), classDiagram(3clc)


AUTHORS
       The Khronos Group


       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or
       associated documentation files (the "Materials"), to deal in the Materials without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
       copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to
       the condition that this copyright notice and permission notice shall be included in all copies or
       substantial portions of the Materials.


NOTES
        1. OpenCL Specification
           page 135, section 5.6.1 - Creating Program Objects