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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
<?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>clGetDeviceIDs</keyword></keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>clGetDeviceIDs</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>
<refnamediv id="clGetDeviceIDs">
<refname>clGetDeviceIDs</refname>
<refpurpose>Obtain the list of devices available on a platform.</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">cl_int</link>
<function>clGetDeviceIDs</function>
</funcdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_platform_id</link>
<parameter>platform</parameter>
</paramdef>
<paramdef>
<link xlink:href="enums.html#cl_device_type">cl_device_type</link>
<parameter>device_type</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">cl_uint</link>
<parameter>num_entries</parameter>
</paramdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_device_id</link>
<parameter>*devices</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">cl_uint</link>
<parameter>*num_devices</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><varname>platform</varname></term>
<listitem>
<para>
Refers to the platform ID returned by
<citerefentry><refentrytitle>clGetPlatformIDs</refentrytitle></citerefentry>
or can be NULL. If <varname>platform</varname> is NULL, the behavior is
implementation-defined.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>device_type</varname></term>
<listitem>
<para>
A bitfield that identifies the type of OpenCL device. The
<varname>device_type</varname> can be used to query specific OpenCL devices or
all OpenCL devices available. The valid values for <varname>device_type</varname>
are specified in the following table.
</para>
<informaltable frame="all"><tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<thead>
<row>
<entry>cl_device_type</entry> <entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_DEVICE_TYPE_CPU</constant></entry> <entry>
An OpenCL device that is the host processor. The host processor
runs the OpenCL implementations and is a single or multi-core CPU.
</entry>
</row>
<row>
<entry><constant>CL_DEVICE_TYPE_GPU</constant></entry>
<entry>
An OpenCL device that is a GPU. By this we mean that the device can also be used
to accelerate a 3D API such as OpenGL or DirectX.
</entry>
</row>
<row>
<entry><constant>CL_DEVICE_TYPE_ACCELERATOR</constant></entry>
<entry>
Dedicated OpenCL accelerators (for example the IBM CELL Blade). These devices
communicate with the host processor using a peripheral interconnect such as PCIe.
</entry>
</row>
<row>
<entry><constant>CL_DEVICE_TYPE_CUSTOM</constant></entry>
<entry>
Dedicated accelerators that do not support programs written in OpenCL C.
</entry>
</row>
<row>
<entry><constant>CL_DEVICE_TYPE_DEFAULT</constant></entry>
<entry>
The default OpenCL device in the system. The default device cannot
be a <constant>CL_DEVICE_TYPE_CUSTOM</constant> device.
</entry>
</row>
<row>
<entry><constant>CL_DEVICE_TYPE_ALL</constant></entry>
<entry>
All OpenCL devices available in the system except
<constant>CL_DEVICE_TYPE_CUSTOM</constant> devices.
</entry>
</row>
</tbody>
</tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>num_entries</varname></term>
<listitem>
<para>
The number of <type>cl_device_id</type> entries that can be added to
<varname>devices</varname>. If <varname>devices</varname> is not NULL,
the <varname>num_entries</varname> must be greater than zero.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>devices</varname></term>
<listitem>
<para>
A list of OpenCL devices found. The <type>cl_device_id</type> values returned in
<varname>devices</varname> can be used to identify a specific OpenCL device.
If <varname>devices</varname> argument is NULL, this argument is ignored.
The number of OpenCL devices returned is the mininum of the value specified
by <varname>num_entries</varname> or the number of OpenCL devices whose type
matches <varname>device_type</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>num_devices</varname></term>
<listitem>
<para>
The number of OpenCL devices available that match <varname>device_type</varname>.
If <varname>num_devices</varname> is NULL, this argument is ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>clGetDeviceIDs</function> may return all or a subset of the actual
physical devices present in the platform and that match <varname>device_type</varname>.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<function>clGetDeviceIDs</function> returns <errorname>CL_SUCCESS</errorname> if the
function is executed successfully. Otherwise it returns one of the following:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_PLATFORM</errorname> if <varname>platform</varname> is not
a valid platform.
</listitem>
<listitem>
<errorname>CL_INVALID_DEVICE_TYPE</errorname> if <varname>device_type</varname>
is not a valid value.
</listitem>
<listitem>
<errorname>CL_INVALID_VALUE</errorname> if <varname>num_entries</varname> is equal to
zero and <varname>devices</varname> is not NULL or if both <varname>num_devices</varname>
and <varname>devices</varname> are NULL.
</listitem>
<listitem>
<errorname>CL_DEVICE_NOT_FOUND</errorname> if no OpenCL devices that matched
<varname>device_type</varname> were found.
</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>
<refsect1 id="specification"><title>Specification</title>
<para><imageobject><imagedata fileref="pdficon_small1.gif" format="gif" /></imageobject>
<olink uri="clGetDeviceIDs">OpenCL Specification</olink>
</para>
</refsect1>
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clGetDeviceInfo</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetPlatformIDs</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateContext</refentrytitle></citerefentry>,
<citerefentry href="classDiagram"><refentrytitle>Cardinality Diagram</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
</refentry>
|
