| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| <!-- saved from url=(0013)about:internet --> | |
| <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <style xmlns="" type="text/css"> | |
| /* This style sets a margin around the entire page */ | |
| html, body { | |
| margin: 10px; | |
| } | |
| p { | |
| font: normal 16px verdana, sans-serif; | |
| margin: 0; | |
| padding-bottom:12px; | |
| } | |
| h1 { | |
| font: bold 25px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h2 { | |
| font: bold 19px verdana, sans-serif; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h3 { | |
| font: bold 19px verdana, sans-serif !important; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| li { | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 18px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| .pdparam { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| .term { | |
| font: italic 16px verdana, sans-serif; | |
| font-weight: normal; | |
| } | |
| .type { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| a:link, a:visited { | |
| color: blue; | |
| text-decoration: none; | |
| font: normal 16px; | |
| } | |
| a:hover { | |
| background-color: #FFFF99; | |
| font: normal 16px; | |
| } | |
| div.funcsynopsis { | |
| text-align: left; | |
| background-color: #e6e6e6; | |
| font: normal 16px verdana, sans-serif; | |
| padding-top: 10px; | |
| padding-bottom: 10px; | |
| } | |
| div.funcsynopsis table { | |
| border-collapse: separate; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.funcsynopsis td { | |
| background-color: #e6e6e6; | |
| border: 0 solid #000; | |
| padding: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 { | |
| font-family: verdana, sans-serif; | |
| font-size: 16px; | |
| } | |
| code.constant { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| span.errorname { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| code.function { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| b.fsfunc { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| code.varname { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| code.replaceable { | |
| font: italic 16px courier new, monospace; | |
| } | |
| code.funcdef { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .citerefentry { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| code.fsfunc { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| /* PARAMETER: This style controls spacing between the terms in Parameter section */ | |
| dt { | |
| margin-top: 15px; | |
| } | |
| /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ | |
| div.refsect1 table { | |
| width: 100%; | |
| margin-top: 10px; | |
| background-color: #FFF; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 th { | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: bold 16px verdana, sans-serif; | |
| } | |
| div.refsect1 td { | |
| background-color: #FFF; | |
| padding: 5px; | |
| vertical-align: text-top; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 p{ | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 8px; | |
| margin-bottom: 8px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| /* EXAMPLE: These styles apply only to the Example section */ | |
| div.refsect2 { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 table { | |
| margin-top: 0; | |
| background-color: #e6e6e6; | |
| width: 100%; | |
| border: 0 solid #000; | |
| padding: 2px; | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 td { | |
| background-color: #e6e6e6; | |
| font: normal 16px courier new, monospace !important; | |
| white-space:pre; | |
| } | |
| /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ | |
| div.refsect3 { | |
| font: normal 11px verdana, sans-serif; | |
| margin-top: 50px; | |
| margin-bottom: 20px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| </style> | |
| <title>clCreateProgramWithBinary</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clCreateProgramWithBinary" /> | |
| </head> | |
| <body> | |
| <div class="refentry"> | |
| <a id="id-1"></a> | |
| <div class="titlepage"></div> | |
| <div xmlns="" class="refnamediv"> | |
| <a xmlns="http://www.w3.org/1999/xhtml" id="clCreateProgramWithBinary"></a> | |
| <h1> | |
| clCreateProgramWithBinary | |
| </h1> | |
| <p> | |
| Creates a program object for a context, and loads the binary bits specified by | |
| <code xmlns="http://www.w3.org/1999/xhtml" class="varname">binary</code> into the program object. | |
| </p> | |
| </div> | |
| <div class="refsynopsisdiv"> | |
| <h2></h2> | |
| <div class="funcsynopsis"> | |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> | |
| <tr valign="bottom"> | |
| <td> | |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"> | |
| <a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_program</a> <strong class="fsfunc">clCreateProgramWithBinary</strong> | |
| (</code> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td> | |
| </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_devices</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_device_id</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*device_list</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*lengths</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">unsigned char</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">**binaries</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*binary_status</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*errcode_ret</var><code>)</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="parameters"></a> | |
| <h2>Parameters</h2> | |
| <div class="variablelist"> | |
| <dl class="variablelist"> | |
| <dt> | |
| <span class="term"> <code class="varname"> context </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Must be a valid OpenCL context. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> device_list </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to a list of devices that are in <code class="varname">context</code>. | |
| <code class="varname">device_list</code> must be a non-NULL | |
| value. The binaries are loaded for devices specified in this list. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> num_devices </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| The number of devices listed in <code class="varname">device_list</code>. | |
| </p> | |
| <p> | |
| The devices associated with the program object | |
| will be the list of devices specified by | |
| <code class="varname">device_list</code>. The list of devices | |
| specified by <code class="varname">device_list</code> | |
| must be devices associated with <code class="varname">context</code>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> lengths </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| An array of the size in bytes of the program binaries | |
| to be loaded for devices specified by <code class="varname">device_list</code>. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> binaries </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| An array of pointers to program binaries to be loaded for devices | |
| specified by <code class="varname">device_list</code>. For each device given | |
| by <code class="varname">device_list</code>[i], the pointer to the program | |
| binary for that device is given by <code class="varname">binaries</code>[i] | |
| and the length of this corresponding binary is given by | |
| <code class="varname">lengths</code>[i]. <code class="varname">lengths</code>[i] cannot be | |
| zero and <code class="varname">binaries</code>[i] cannot be a NULL pointer. | |
| </p> | |
| <p> | |
| The program binaries specified by <code class="varname">binaries</code> | |
| contain the bits that describe one of the following: | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem" style="list-style-type: disc"> | |
| a program executable to be run on the device(s) associated | |
| with <code class="varname">context</code>, | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"> | |
| a compiled program for device(s) associated | |
| with <code class="varname">context</code>, or | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"> | |
| a library of compiled programs for device(s) associated with | |
| <code class="varname">context</code>. | |
| </li> | |
| </ul> | |
| </div> | |
| <p> | |
| </p> | |
| <p> | |
| 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. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> binary_status </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Returns whether the program binary for each device specified | |
| in <code class="varname">device_list</code> was loaded successfully | |
| or not. It is an array of <code class="varname">num_devices</code> | |
| entries and returns <code class="constant">CL_SUCCESS</code> in | |
| <code class="varname">binary_status</code>[i] if binary was successfully | |
| loaded for device specified by <code class="varname">device_list</code>[i]; | |
| otherwise returns <code class="constant">CL_INVALID_VALUE</code> if | |
| <code class="varname">lengths</code>[i] is zero or if <code class="varname">binaries</code>[i] | |
| is a NULL value or <code class="constant">CL_INVALID_BINARY</code> in | |
| <code class="varname">binary_status</code>[i] if program binary is not a valid | |
| binary for the specified device. If <code class="varname">binary_status</code> | |
| is NULL, it is ignored. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> errcode_ret </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Returns an appropriate error code. If <code class="varname">errcode_ret</code> | |
| is NULL, no error code is returned. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="notes"></a> | |
| <h2>Notes</h2> | |
| <p> | |
| 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. | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| Returns a valid non-zero program object and <code class="varname">errcode_ret</code> is set to | |
| <span class="errorname">CL_SUCCESS</span> if the program object is created successfully. | |
| Otherwise, it returns a NULL value with one of the following error values returned in | |
| <code class="varname">errcode_ret</code>: | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not | |
| a valid context. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">device_list</code> is NULL | |
| or <code class="varname">num_devices</code> is zero. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_DEVICE</span> if OpenCL devices listed in | |
| <code class="varname">device_list</code> are not in the list of devices associated with | |
| <code class="varname">context</code>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if or if <code class="varname">lengths</code> or | |
| <code class="varname">binaries</code> are NULL or if any entry in <code class="varname">lengths</code>[i] | |
| or <code class="varname">binaries</code>[i] is NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_BINARY</span> if an invalid program binary was encountered | |
| for any device. <code class="varname">binary_status</code> will return specific status for | |
| each device. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the device. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the host. | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="specification"></a> | |
| <h2>Specification</h2> | |
| <p> | |
| <img src="pdficon_small1.gif" /> | |
| <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#page=196" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clCreateProgramWithSource.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithSource</span></span></a>, | |
| <a class="citerefentry" href="clCreateProgramWithBuiltInKernels.html"><span class="citerefentry"><span class="refentrytitle">clCreateProgramWithBuiltInKernels</span></span></a>, | |
| <a class="citerefentry" href="clReleaseProgram.html"><span class="citerefentry"><span class="refentrytitle">clReleaseProgram</span></span></a>, | |
| <a class="citerefentry" href="clRetainProgram.html"><span class="citerefentry"><span class="refentrytitle">clRetainProgram</span></span></a>, | |
| <a class="citerefentry" href="classDiagram.html"><span class="citerefentry"><span class="refentrytitle">Cardinality Diagram</span></span></a> | |
| </p> | |
| </div> | |
| <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2015 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. | |
| </div> | |
| </div> | |
| </body> | |
| </html> |