/usr/share/doc/opencl-1.2-html-doc/clSetKernelArg.html is in opencl-1.2-html-doc 1.0~svn33624-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<style xmlns="" type="text/css">
/* This style sets a margin around the entire page */
html, body {
margin: 10px;
}
p {
font: normal 16px verdana, sans-serif;
margin: 0;
padding-bottom:12px;
}
h1 {
font: bold 25px verdana, sans-serif;
margin-top: 0;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h2 {
font: bold 19px verdana, sans-serif;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
h3 {
font: bold 19px verdana, sans-serif !important;
margin-top: 28px;
margin-bottom: 3px;
padding-top: 0;
padding-bottom: 0;
}
li {
font: normal 16px verdana, sans-serif;
margin-top: 0;
margin-bottom: 18px;
padding-top: 0;
padding-bottom: 0;
}
.pdparam {
font: italic 16px verdana, sans-serif;
}
.term {
font: italic 16px verdana, sans-serif;
font-weight: normal;
}
.type {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
a:link, a:visited {
color: blue;
text-decoration: none;
font: normal 16px;
}
a:hover {
background-color: #FFFF99;
font: normal 16px;
}
div.funcsynopsis {
text-align: left;
background-color: #e6e6e6;
font: normal 16px verdana, sans-serif;
padding-top: 10px;
padding-bottom: 10px;
}
div.funcsynopsis table {
border-collapse: separate;
font: normal 16px verdana, sans-serif;
}
div.funcsynopsis td {
background-color: #e6e6e6;
border: 0 solid #000;
padding: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 {
font-family: verdana, sans-serif;
font-size: 16px;
}
code.constant {
font: normal 16px courier new, monospace !important;
}
span.errorname {
font: normal 16px verdana, sans-serif !important;
}
code.function {
font: bold 16px verdana, sans-serif !important;
}
b.fsfunc {
font: bold 16px verdana, sans-serif !important;
}
code.varname {
font: italic 16px verdana, sans-serif;
}
code.replaceable {
font: italic 16px courier new, monospace;
}
code.funcdef {
font: normal 16px verdana, sans-serif !important;
}
.citerefentry {
font: normal 16px verdana, sans-serif !important;
}
.parameter {
font-style: italic;
}
code.fsfunc {
font: normal 16px verdana, sans-serif !important;
}
/* PARAMETER: This style controls spacing between the terms in Parameter section */
dt {
margin-top: 15px;
}
/* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
div.refsect1 table {
width: 100%;
margin-top: 10px;
background-color: #FFF;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 th {
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: bold 16px verdana, sans-serif;
}
div.refsect1 td {
background-color: #FFF;
padding: 5px;
vertical-align: text-top;
border-collapse: collapse;
border-color: #000;
border-width: 1px;
font: normal 16px verdana, sans-serif;
}
div.refsect1 p{
font: normal 16px verdana, sans-serif;
margin-top: 8px;
margin-bottom: 8px;
padding-top: 0;
padding-bottom: 0;
}
/* EXAMPLE: These styles apply only to the Example section */
div.refsect2 {
font: normal 16px courier new, monospace !important;
}
div.refsect2 table {
margin-top: 0;
background-color: #e6e6e6;
width: 100%;
border: 0 solid #000;
padding: 2px;
font: normal 16px courier new, monospace !important;
}
div.refsect2 td {
background-color: #e6e6e6;
font: normal 16px courier new, monospace !important;
white-space:pre;
}
/* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
div.refsect3 {
font: normal 11px verdana, sans-serif;
margin-top: 50px;
margin-bottom: 20px;
padding-top: 0;
padding-bottom: 0;
}
</style>
<title>clSetKernelArg</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clSetKernelArg" />
</head>
<body>
<div class="refentry">
<a id="idm1"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clSetKernelArg"></a>
<h1>
clSetKernelArg
</h1>
<p>
Used to set the argument value for a specific argument of a kernel.
</p>
</div>
<div class="refsynopsisdiv">
<h2></h2>
<div class="funcsynopsis">
<table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
<tr valign="bottom">
<td>
<code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
<a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
<strong class="fsfunc">clSetKernelArg</strong>
(</code>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_kernel</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">kernel</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">arg_index</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">arg_size</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>const <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*arg_value</var><code>)</code></td>
</tr>
</table>
</div>
</div>
<div class="refsect1">
<a id="parameters"></a>
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="varname">kernel</code>
</span>
</dt>
<dd>
<p>
A valid kernel object.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">arg_index</code>
</span>
</dt>
<dd>
<p>
The argument index. Arguments to the kernel are referred by indices that
go from 0 for the leftmost argument to <span class="emphasis"><em>n</em></span> - 1, where
<span class="emphasis"><em>n</em></span> is the total number of arguments declared by a kernel.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">arg_value</code>
</span>
</dt>
<dd>
<p>
A pointer to data that should be used as the argument value for argument
specified by <code class="varname">arg_index</code>. The argument data pointed to by
<code class="varname">arg_value</code> is copied and the <code class="varname">arg_value</code>
pointer can therefore be reused by the application after
<code class="function">clSetKernelArg</code> returns. The argument value specified
is the value used by all API calls that enqueue <code class="varname">kernel</code>
(<a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>
and
<a class="citerefentry" href="clEnqueueTask.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueTask</span></span></a>)
until the argument value is changed by a call to
<code class="function">clSetKernelArg</code> for <code class="varname">kernel</code>.
</p>
<p>
If the argument is a memory object (buffer, image or image array), the
<code class="varname">arg_value</code> entry will be a pointer to the appropriate
buffer, image or image array object. The memory object must be created
with the context associated with the kernel object. If the argument
is a buffer object, the <code class="varname">arg_value</code> pointer can be
NULL or point to a NULL value in which case a NULL value will be used
as the value for the argument declared as a pointer to <a class="citerefentry" href="global.html"><span class="citerefentry"><span class="refentrytitle">__global</span></span></a>
or <a class="citerefentry" href="constant.html"><span class="citerefentry"><span class="refentrytitle">__constant</span></span></a>
memory in the kernel. If the argument is declared with the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a>
qualifier, the <code class="varname">arg_value</code> entry must be NULL. If the
argument is of type sampler_t, the <code class="varname">arg_value</code> entry
must be a pointer to the sampler object.
</p>
<p>
If the argument is declared to be a pointer of a built-in scalar or vector
type, or a user defined structure type in the global or constant address
space, the memory object specified as argument value must be a buffer
object (or NULL). If the argument is declared with the <a class="citerefentry" href="constant.html"><span class="citerefentry"><span class="refentrytitle">__constant</span></span></a>
qualifier, the size in bytes of the memory object cannot
exceed <code class="constant">CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE</code>
and the number of arguments declared as pointers to <a class="citerefentry" href="constant.html"><span class="citerefentry"><span class="refentrytitle">__constant</span></span></a>
memory cannot exceed <code class="constant">CL_DEVICE_MAX_CONSTANT_ARGS</code>.
</p>
<p>
The memory object specified as argument value must be a 2D image object if the argument is
declared to be of type <a class="link" href="abstractDataTypes.html" target="pagedisplay">image2d_t</a>. The memory object
specified as argument value must be a 3D image object if argument is declared to be of type
<a class="link" href="abstractDataTypes.html" target="pagedisplay">image3d_t</a>. The memory object specified as
argument value must be a 1D image object if the argument is declared to be of type
<a class="link" href="abstractDataTypes.html" target="pagedisplay">image1d_t</a>. The memory object specified as
argument value must be a 1D image buffer object if the argument is declared to be of type
<a class="link" href="abstractDataTypes.html" target="pagedisplay">image1d_buffer_t</a>.
The memory object specified as argument value must be a 1D image array object if argument
is declared to be of type <a class="link" href="abstractDataTypes.html" target="pagedisplay">image1d_array_t</a>.
The memory object specified as argument value must be a 2D image array object if argument is
declared to be of type <a class="link" href="abstractDataTypes.html" target="pagedisplay">image2d_array_t</a>.
</p>
<p>
For all other kernel arguments, the <code class="varname">arg_value</code> entry
must be a pointer to the actual data to be used as argument value.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">
arg_size
</code>
</span>
</dt>
<dd>
<p>
Specifies the size of the argument value. If the argument is
a memory object, the size is the size of the buffer or image
object type. For arguments declared with the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a>
qualifier, the size specified will be the size in bytes
of the buffer that must be allocated for the <a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a>
argument. If the argument is of type <span class="type">sampler_t</span>,
the <code class="varname">arg_size</code> value must be equal to
<code class="code">sizeof(cl_sampler)</code>. For all other arguments, the size will
be the size of argument type.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
A kernel object does not update the reference count for objects such as memory, sampler
objects specified as argument values by <code class="function">clSetKernelArg</code>. Users may
not rely on a kernel object to retain objects specified as argument values to the kernel.
</p>
<p>
Implementations shall not allow cl_kernel objects to hold reference counts to
cl_kernel arguments, because no mechanism is provided for the user to tell the kernel
to release that ownership right. If the kernel holds ownership rights on kernel args,
that would make it impossible for the user to tell with certainty when he may safely
release user allocated resources associated with OpenCL objects such as the cl_mem
backing store used with <code class="constant">CL_MEM_USE_HOST_PTR</code>.
</p>
<p>
An OpenCL API call is considered to be
<span class="emphasis"><em>thread-safe</em></span> if the internal state as managed by OpenCL remains
consistent when called simultaneously by multiple <span class="emphasis"><em>host</em></span> threads.
OpenCL API calls that are <span class="emphasis"><em>thread-safe</em></span> allow an application to
call these functions in multiple <span class="emphasis"><em>host</em></span> threads without having to
implement mutual exclusion across these <span class="emphasis"><em>host</em></span> threads i.e. they
are also re-entrant-safe.
</p>
<p>
All OpenCL API calls are thread-safe except
<code class="function">clSetKernelArg</code>. <code class="function">clSetKernelArg</code> is safe
to call from any host thread, and is safe to call re-entrantly so long as concurrent
calls operate on different cl_kernel objects. However, the behavior of the cl_kernel
object is undefined if <code class="function">clSetKernelArg</code> is called from multiple
host threads on the same cl_kernel object at the same time. Please note that there
are additional limitations as to which OpenCL APIs may be called from OpenCL callback
functions -- please see section 5.9.
</p>
<p>
There is an inherent race condition in the
design of OpenCL that occurs between setting a kernel argument and using the kernel
with <a class="citerefentry" href="clEnqueueNDRangeKernel.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueNDRangeKernel</span></span></a>
or <a class="citerefentry" href="clEnqueueTask.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueTask</span></span></a>. Another
host thread might change the kernel arguments between when a host thread sets the
kernel arguments and then enqueues the kernel, causing the wrong kernel arguments
to be enqueued. Rather than attempt to share cl_kernel objects among multiple host
threads, applications are strongly encouraged to make additional cl_kernel objects
for kernel functions for each host thread.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
<code class="function">clSetKernelArg</code> returns <span class="errorname">CL_SUCCESS</span> if the
function is executed successfully. Otherwise, it returns one of the following errors:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_KERNEL</span> if <code class="varname">kernel</code> is not a valid kernel object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_ARG_INDEX</span> if <code class="varname">arg_index</code> is not a valid argument index.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_ARG_VALUE</span> if <code class="varname">arg_value</code> specified is not a valid value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> for an argument declared to be a memory object when the
specified <code class="varname">arg_value</code> is not a valid memory object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_SAMPLER</span> for an argument declared to be of type
<code class="varname">sampler_t</code> when the specified <code class="varname">arg_value</code>
is not a valid sampler object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_ARG_SIZE</span> if <code class="varname">arg_size</code>
does not match the size of the data type for an argument that
is not a memory object or if the argument is a memory object and
<code class="varname">arg_size</code> != <code class="constant">sizeof(cl_mem)</code> or if
<code class="varname">arg_size</code> is zero and the argument is declared with the
<a class="citerefentry" href="local.html"><span class="citerefentry"><span class="refentrytitle">__local</span></span></a>
qualifier or if the argument is a sampler and <code class="varname">arg_size</code> !=
<code class="constant">sizeof(cl_sampler)</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_ARG_VALUE</span> if the argument is an image declared
with the <code class="constant">read_only</code> qualifier and <code class="varname">arg_value</code>
refers to an image object created with <code class="varname">cl_mem_flags</code> of
<code class="constant">CL_MEM_WRITE</code> or if the image argument is declared with
the <code class="constant">write_only</code> qualifier and <code class="varname">arg_value</code>
refers to an image object created with <code class="varname">cl_mem_flags</code> of
<code class="constant">CL_MEM_READ</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
</li>
</ul>
</div>
</div>
<div class="refsect2">
<a id="example1"></a>
<h3>
Example
</h3>
<div class="informaltable">
<table class="informaltable" border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">
kernel void
image_filter (int n, int m,
__constant float *filter_weights,
__read_only image2d_t src_image,
__write_only image2d_t dst_image)
{
...
}
</td>
</tr>
</tbody>
</table>
</div>
<p>
Argument index values for <code class="constant">image_filter</code> will
be 0 for <code class="constant">n</code>, 1 for <code class="constant">m</code>, 2 for
<code class="constant">filter_weights</code>, 3 for <code class="constant">src_image</code> and 4 for
<code class="constant">dst_image</code>.
</p>
</div>
<div class="refsect1">
<a id="specification"></a>
<h2>Specification</h2>
<p>
<img src="pdficon_small1.gif" />
<a href="http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf#page=160" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="clCreateKernel.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernel</span></span></a>,
<a class="citerefentry" href="clCreateKernelsInProgram.html"><span class="citerefentry"><span class="refentrytitle">clCreateKernelsInProgram</span></span></a>,
<a class="citerefentry" href="clReleaseKernel.html"><span class="citerefentry"><span class="refentrytitle">clReleaseKernel</span></span></a>,
<a class="citerefentry" href="clRetainKernel.html"><span class="citerefentry"><span class="refentrytitle">clRetainKernel</span></span></a>,
<a class="citerefentry" href="clGetKernelInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelInfo</span></span></a>,
<a class="citerefentry" href="clGetKernelWorkGroupInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetKernelWorkGroupInfo</span></span></a>
</p>
</div>
<div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2011 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.
</div>
</div>
</body>
</html>
|