1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
<refentryinfo>
<keywordset>
<keyword>clCreateProgramWithBuiltInKernels</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>
clCreateProgramWithBuiltInKernels
</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</year>
<holder>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.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clCreateProgramWithBuiltInKernels">
<refname>
clCreateProgramWithBuiltInKernels
</refname>
<refpurpose>
Creates a program object for a context, and loads the information related to the built-in kernels
into a program object.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="abstractDataTypes.html">cl_program</link> <function>clCreateProgramWithBuiltInKernels</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_uint</link><parameter>num_devices</parameter></paramdef>
<paramdef>const <link xlink:href="abstractDataTypes.html">cl_device_id</link><parameter>*device_list</parameter></paramdef>
<paramdef>const <link xlink:href="scalarDataTypes.html">char</link><parameter>*kernel_names</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>*errcode_ret</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term> <varname> context </varname> </term>
<listitem>
<para>
Must be a valid OpenCL context.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> num_devices </varname> </term>
<listitem>
<para>
The number of devices listed in <varname>device_list</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> device_list </varname> </term>
<listitem>
<para>
A pointer to a list of devices that are in <varname>context</varname>.
<varname>device_list</varname> must be a non-NULL
value. The built-in kernels are loaded for devices specified in this list.
</para>
<para>
The devices associated with the program object will be the list of devices specified by
<varname>device_list</varname>. The list of devices specified by
<varname>device_list</varname> must be devices associated with context.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> kernel_names </varname> </term>
<listitem>
<para>
A semi-colon separated list of built-in kernel names.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<!--
<refsect1 id="notes"><title>Notes</title>
</refsect1>
-->
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
Returns a valid non-zero program object and <varname>errcode_ret</varname> is set
to <errorname>CL_SUCCESS</errorname> if the program object is created successfully.
Otherwise, it returns a NULL value with one of the following error values returned
in <varname>errcode_ret</varname>:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>device_list</varname> is NULL
or <varname>num_devices</varname> is zero;
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>kernel_names</varname> is NULL
or <varname>kernel_names</varname> contains a kernel name that is not supported
by any of the devices in <varname>device_list</varname>.
</listitem>
<listitem>
<errorname>CL_INVALID_DEVICE</errorname> if devices listed in
<varname>device_list</varname> are not in the list of devices associated with
<varname>context</varname>.
</listitem>
<listitem>
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</listitem>
<listitem>
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</listitem>
</itemizedlist>
</refsect1>
<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
<refsect2 id="example1">
<title>
Example
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>
Example goes here - it will be set in "code" type with white space preserved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
-->
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="clCreateProgramWithBuiltInKernels">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clCreateProgramWithSource</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clReleaseProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clRetainProgram</refentrytitle></citerefentry>,
<citerefentry href="classDiagram"><refentrytitle>Cardinality Diagram</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ================================ COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 21-Oct-2011 -->
</refentry>
|
