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
|
<?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>clUnloadPlatformCompiler</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>
clUnloadPlatformCompiler
</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="clUnloadPlatformCompiler">
<refname>
clUnloadPlatformCompiler
</refname>
<refpurpose>
Allows the implementation to release the resources allocated by the OpenCL compiler for <varname>platform</varname>.
</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>clUnloadPlatformCompiler</function>
</funcdef>
<paramdef><link xlink:href="abstractDataTypes.html">cl_platform_id</link><parameter>platform</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="notes"><title>Notes</title>
<para>
This is a hint from the application and does not guarantee
that the compiler will not be used in the future or that the
compiler will actually be unloaded by the implementation. Calls to
<citerefentry><refentrytitle>clBuildProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCompileProgram</refentrytitle></citerefentry>,
or <citerefentry><refentrytitle>clLinkProgram</refentrytitle></citerefentry> after
<function>clUnloadPlatformCompiler</function> will reload the compiler, if necessary,
to build the appropriate program executable.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<function>clUnloadPlatformCompiler</function> returns <errorname>CL_SUCCESS</errorname>
if the function is executed successfully. Otherwise, it returns one of the following
errors:
</para>
<itemizedlist mark="disc">
<listitem>
<errorname>CL_INVALID_PLATFORM</errorname> if <varname>platform</varname> is not a valid platform.
</listitem>
</itemizedlist>
</refsect1>
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="clUnloadPlatformCompiler">OpenCL Specification</olink>
</para>
</refsect1>
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
</refentry>
|