blob: c0ae0ee46b8208c227b46d2343c56b228fd23398 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<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>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clIcdGetPlatformIDsKHR">
<refpurpose>Obtain the list of platforms accessible through the Khronos ICD Loader.</refpurpose>
<refsynopsisdiv xmlns:xlink=""><title></title>
<link xlink:href="scalarDataTypes.html">cl_int</link>
<link xlink:href="scalarDataTypes.html">cl_uint</link>
<link xlink:href="abstractDataTypes.html">cl_platform_id</link>
<link xlink:href="scalarDataTypes.html">cl_uint</link>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters"><title>Parameters</title>
The number of <type>cl_platform_id</type> entries that can
be added to <varname>platforms</varname>. If <varname>platforms</varname>
is not NULL, then <varname>num_entries</varname> must be greater than zero.
Returns a list of OpenCL platforms available for access through the
Khronos ICD Loader. The <type>cl_platform_id</type> values returned in
<varname>platforms</varname> are ICD compatible and can be used to
identify a specific OpenCL platform. If the <varname>platforms</varname>
argument is NULL, then this argument is ignored. The number of
OpenCL platforms returned is the minimum of the value specified by
<varname>num_entries</varname> or the number of OpenCL platforms available.
Returns the number of OpenCL platforms available. If
<varname>num_platforms</varname> is NULL, then this argument is ignored.
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
This function is enabled by the <citerefentry><refentrytitle>cl_khr_icd</refentrytitle></citerefentry>
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns <errorname>CL_SUCCESS</errorname> if the function is executed
successfully. Otherwise, it returns the following:
<itemizedlist mark="disc">
<errorname>CL_PLATFORM_NOT_FOUND_KHR</errorname> if zero platforms are available.
<errorname>CL_INVALID_VALUE</errorname> if <varname>num_entries</varname>
is equal to zero and <varname>platforms</varname> is not NULL or if both
<varname>num_platforms</varname> and <varname>platforms</varname> are NULL.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ 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="clIcdGetPlatformIDsKHR">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 27-Oct-2011 -->