'\" t
.\"     Title: clCreateProgramWithBuiltInKernels
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLCREATEPROGRAMWITHB" "3clc" "01/14/2021" "The Khronos Group" "OpenCL Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
clCreateProgramWithBuiltInKernels \- Creates a program object for a context, and loads the information related to the built\-in kernels into a program object\&.
.SH ""
.HP \w'cl_program\ clCreateProgramWithBuiltInKernels('u
.BI "cl_program clCreateProgramWithBuiltInKernels(cl_context\ " "context" ", cl_uint\ " "num_devices" ", const\ cl_device_id\ *" "device_list" ", const\ char\ *" "kernel_names" ", cl_int\ *" "errcode_ret" ");"
.SH "PARAMETERS"
.PP
\fI context \fR
.RS 4
Must be a valid OpenCL context\&.
.RE
.PP
\fI num_devices \fR
.RS 4
The number of devices listed in
\fIdevice_list\fR\&.
.RE
.PP
\fI device_list \fR
.RS 4
A pointer to a list of devices that are in
\fIcontext\fR\&.
\fIdevice_list\fR
must be a non\-NULL value\&. The built\-in kernels are loaded for devices specified in this list\&.
.sp
The devices associated with the program object will be the list of devices specified by
\fIdevice_list\fR\&. The list of devices specified by
\fIdevice_list\fR
must be devices associated with context\&.
.RE
.PP
\fI kernel_names \fR
.RS 4
A semi\-colon separated list of built\-in kernel names\&.
.RE
.SH "ERRORS"
.PP
Returns a valid non\-zero program object and
\fIerrcode_ret\fR
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
\fIerrcode_ret\fR:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_CONTEXT if \fIcontext\fR is not
a valid context\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIdevice_list\fR is NULL
or \fInum_devices\fR is zero;
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIkernel_names\fR is NULL
or \fIkernel_names\fR contains a kernel name that is not supported
by any of the devices in \fIdevice_list\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_DEVICE if devices listed in
\fIdevice_list\fR are not in the list of devices associated with
\fIcontext\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBclCreateProgramWithSource\fR(3clc),
\fBclReleaseProgram\fR(3clc),
\fBclRetainProgram\fR(3clc),
\fBclassDiagram\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
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.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 135, section 5.6.1 - Creating Program Objects
.RE