'\" t
.\"     Title: clCreateProgramWithBinary
.\"    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"
clCreateProgramWithBinary \- Creates a program object for a context, and loads the binary bits specified by binary into the program object\&.
.SH ""
.HP \w'cl_program\ clCreateProgramWithBinary('u
.BI "cl_program clCreateProgramWithBinary(cl_context\ " "context" ", cl_uint\ " "num_devices" ", const\ cl_device_id\ *" "device_list" ", const\ size_t\ *" "lengths" ", const\ unsigned\ char\ *" "*binaries" ", cl_int\ *" "binary_status" ", cl_int\ *" "errcode_ret" ");"
.SH "PARAMETERS"
.PP
\fI context \fR
.RS 4
Must be a valid OpenCL context\&.
.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 binaries are loaded for devices specified in this list\&.
.RE
.PP
\fI num_devices \fR
.RS 4
The number of devices listed in
\fIdevice_list\fR\&.
.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
\fIcontext\fR\&.
.RE
.PP
\fI lengths \fR
.RS 4
An array of the size in bytes of the program binaries to be loaded for devices specified by
\fIdevice_list\fR\&.
.RE
.PP
\fI binaries \fR
.RS 4
An array of pointers to program binaries to be loaded for devices specified by
\fIdevice_list\fR\&. For each device given by
\fIdevice_list\fR[i], the pointer to the program binary for that device is given by
\fIbinaries\fR[i] and the length of this corresponding binary is given by
\fIlengths\fR[i]\&.
\fIlengths\fR[i] cannot be zero and
\fIbinaries\fR[i] cannot be a NULL pointer\&.
.sp
The program binaries specified by
\fIbinaries\fR
contain the bits that describe one of the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

a program executable to be run on the device(s) associated
with \fIcontext\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

a compiled program for device(s) associated with \fIcontext\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

a library of compiled programs for device(s) associated with
\fIcontext\fR\&.
.RE
.sp
The program binary can consist of either or both of device\-specific code and/or implementation\-specific intermediate representation (IR) which will be converted to the device\-specific code\&.
.RE
.PP
\fI binary_status \fR
.RS 4
Returns whether the program binary for each device specified in
\fIdevice_list\fR
was loaded successfully or not\&. It is an array of
\fInum_devices\fR
entries and returns
\fBCL_SUCCESS\fR
in
\fIbinary_status\fR[i] if binary was successfully loaded for device specified by
\fIdevice_list\fR[i]; otherwise returns
\fBCL_INVALID_VALUE\fR
if
\fIlengths\fR[i] is zero or if
\fIbinaries\fR[i] is a NULL value or
\fBCL_INVALID_BINARY\fR
in
\fIbinary_status\fR[i] if program binary is not a valid binary for the specified device\&. If
\fIbinary_status\fR
is NULL, it is ignored\&.
.RE
.PP
\fI errcode_ret \fR
.RS 4
Returns an appropriate error code\&. If
\fIerrcode_ret\fR
is NULL, no error code is returned\&.
.RE
.SH "NOTES"
.PP
OpenCL allows applications to create a program object using the program source or binary and build appropriate program executables\&. This can be very useful as it allows applications to load program source and then compile and link to generate a program executable online on its first instance for appropriate OpenCL devices in the system\&. These executables can now be queried and cached by the application\&. Future instances of the application launching will no longer need to compile and link the program executables\&. The cached executables can be read and loaded by the application, which can help significantly reduce the application initialization time\&.
.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_DEVICE if OpenCL 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_INVALID_VALUE if or if \fIlengths\fR or
\fIbinaries\fR are NULL or if any entry in \fIlengths\fR[i]
or \fIbinaries\fR[i] is NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_BINARY if an invalid program binary was encountered
for any device\&. \fIbinary_status\fR will return specific status for
each device\&.
.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 133, section 5.6.1 - Creating Program Objects
.RE