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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
<?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>
clGetKernelInfo
</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>
clGetKernelInfo
</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="clGetKernelInfo">
<refname>
clGetKernelInfo
</refname>
<refpurpose>
Returns information about the kernel object.
</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>clGetKernelInfo</function>
</funcdef>
<paramdef>
<link xlink:href="abstractDataTypes.html">cl_kernel</link>
<parameter>kernel</parameter>
</paramdef>
<paramdef>
<link xlink:href="#cl_kernel_info">cl_kernel_info</link>
<parameter>param_name</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">size_t</link>
<parameter>param_value_size</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">void</link>
<parameter>*param_value</parameter>
</paramdef>
<paramdef>
<link xlink:href="scalarDataTypes.html">size_t</link>
<parameter>*param_value_size_ret</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term> <varname> kernel </varname> </term>
<listitem>
<para>
Specifies the kernel object being queried.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_name </varname> </term>
<listitem>
<para>
Specifies the information to query. The list of supported
<varname>param_name</varname> types and the information returned in
<varname>param_value</varname> by <function>clGetKernelInfo</function>
is described in the table below.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value </varname> </term>
<listitem>
<para>
A pointer to memory where the appropriate result being queried is returned.
If <varname>param_value</varname> is NULL, it is ignored.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value_size </varname> </term>
<listitem>
<para>
Used to specify the size in bytes of memory pointed to
by <varname>param_value</varname>.
This size must be ≥ size of return
type as described in the table below.
</para>
<!-- table 5.15 -->
<informaltable frame="all"><anchor id="cl_kernel_info"/>
<tgroup cols="3" align="left" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<colspec colname="col3" colnum="3" />
<thead>
<row>
<entry>cl_kernel_info</entry>
<entry>Return Type</entry>
<entry>Info. returned in <varname>param_value</varname></entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_KERNEL_FUNCTION_NAME</constant></entry>
<entry>char[]</entry>
<entry>
Return the kernel function name.
</entry>
</row>
<row>
<entry><constant>CL_KERNEL_NUM_ARGS</constant></entry>
<entry>cl_uint</entry>
<entry>
Return the number of arguments to <varname>kernel</varname>.
</entry>
</row>
<row>
<entry><constant>CL_KERNEL_REFERENCE_COUNT</constant></entry>
<entry>cl_uint</entry>
<entry>
<para>
Return the <varname>kernel</varname> reference count.
</para>
<para>
The reference count returned should be considered
immediately stale. It is unsuitable for general use
in applications. This feature is provided for identifying memory leaks.
</para>
</entry>
</row>
<row>
<entry><constant>CL_KERNEL_CONTEXT</constant></entry>
<entry>cl_context</entry>
<entry>
Return the context associated with <varname>kernel</varname>.
</entry>
</row>
<row>
<entry><constant>CL_KERNEL_PROGRAM</constant></entry>
<entry>cl_program</entry>
<entry>
Return the program object associated with <varname>kernel</varname>.
</entry>
</row>
<row>
<entry><constant>CL_KERNEL_ATTRIBUTES</constant></entry>
<entry>char[]</entry>
<entry>
<para>
Returns any attributes specified using the
__<citerefentry><refentrytitle>attribute</refentrytitle></citerefentry>__
qualifier with the kernel function declaration in
the program source. These attributes include those on the
__<citerefentry><refentrytitle>attribute</refentrytitle></citerefentry>__
page and other attributes supported by an implementation.
</para>
<para>
Attributes are returned as they were declared inside
__<citerefentry><refentrytitle>attribute</refentrytitle></citerefentry>__((...)),
with any surrounding whitespace and embedded newlines
removed. When multiple attributes are present, they are
returned as a single, space delimited string.
</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term> <varname> param_value_size_ret </varname> </term>
<listitem>
<para>
the actual size in bytes of data copied to <varname>param_value</varname>.
If <varname>param_value_size_ret</varname> is NULL, it is ignored.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ NOTES -->
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
<para>
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_VALUE</errorname> if <varname>param_name</varname> is not
valid, or if size in bytes specified by <varname>param_value_size</varname>
is < size of return type as described in the table above and
<varname>param_value</varname> is not NULL.
</listitem>
<listitem>
<errorname>CL_INVALID_KERNEL</errorname> if <varname>kernel</varname>
is not a valid kernel object.
</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="clGetKernelInfo">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>clCreateKernel</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clCreateKernelsInProgram</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetKernelArgInfo</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clRetainKernel</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clReleaseKernel</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clSetKernelArg</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>clGetKernelWorkGroupInfo</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>
<!-- 19-Oct-2011 -->
</refentry>
|