/usr/share/doc/opencl-1.2-html-doc/clEnqueueReadBufferRect.html is in opencl-1.2-html-doc 1.0~svn27110-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 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 | <?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>clEnqueueReadBufferRect</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
<meta name="keywords" content="clEnqueueReadBufferRect" />
</head>
<body>
<div class="refentry">
<a id="idp30711788"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clEnqueueReadBufferRect"></a>
<h1>
clEnqueueReadBufferRect
</h1>
<p>
Enqueue commands to read from a rectangular region from a buffer object to host memory.
</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">clEnqueueReadBufferRect</strong>
(</code>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_command_queue</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">command_queue</var>
, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buffer</var>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_bool" target="pagedisplay">cl_bool</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">blocking_read</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">size_t</a>
* <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">buffer_origin</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">size_t</a>
* <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">host_origin</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">size_t</a>
* <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">region</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">buffer_row_pitch</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">buffer_slice_pitch</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">host_row_pitch</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">host_slice_pitch</var>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>
<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">*ptr</var>
, </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">num_events_in_wait_list</var>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>const
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event_wait_list</var>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event</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">command_queue</code>
</span>
</dt>
<dd>
<p>
Refers to the command-queue in which the read command will be
queued. <code class="varname">command_queue</code> and <code class="varname">buffer</code>
must be created with the same OpenCL context.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">buffer</code>
</span>
</dt>
<dd>
<p>Refers to a valid buffer object.</p>
</dd>
<dt>
<span class="term">
<code class="varname">blocking_read</code>
</span>
</dt>
<dd>
<p>
Indicates if the read operations are <code class="varname">blocking</code> or
non-blocking.
</p>
<p>
If <code class="varname">blocking_read</code> is <code class="constant">CL_TRUE</code> i.e.
the read command is blocking, <code class="function">clEnqueueReadBufferRect</code>
does not return until the buffer data has been read and copied into memory
pointed to by <code class="varname">ptr</code>.
</p>
<p>
If <code class="varname">blocking_read</code> is <code class="constant">CL_FALSE</code>
i.e. the read command is <code class="varname">non-blocking</code>,
<code class="function">clEnqueueReadBufferRect</code> queues a non-blocking read
command and returns. The contents of the buffer that <code class="varname">ptr</code>
points to cannot be used until the read command has completed. The
<code class="varname">event</code> argument argument returns an event object which
can be used to query the execution status of the read command. When the read
command has completed, the contents of the buffer that <code class="varname">ptr</code>
points to can be used by the application.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">buffer_origin</code>
</span>
</dt>
<dd>
<p>
The (<span class="emphasis"><em>x, y, z</em></span>) offset in the memory
region associated with <code class="varname">buffer</code>. For a 2D
rectangle region, the <code class="varname">z</code> value given by
<code class="varname">buffer_origin</code>[2] should be 0. The offset
in bytes is computed as <code class="varname">buffer_origin</code>[2] *
<code class="varname">buffer_slice_pitch</code> + <code class="varname">buffer_origin</code>[1]
* <code class="varname">buffer_row_pitch</code> + <code class="varname">buffer_origin</code>[0].
</p>
</dd>
<dt>
<span class="term">
<code class="varname">host_origin</code>
</span>
</dt>
<dd>
<p>
The (<span class="emphasis"><em>x, y, z</em></span>) offset in the memory region pointed to by
<code class="varname">ptr</code>. For a 2D rectangle region, the <code class="varname">z</code>
value given by <code class="varname">host_origin</code>[2] should be 0. The
offset in bytes is computed as <code class="varname">host_origin</code>[2] *
<code class="varname">host_slice_pitch</code> + <code class="varname">host_origin</code>[1]
* <code class="varname">host_row_pitch</code> + <code class="varname">host_origin</code>[0].
</p>
</dd>
<dt>
<span class="term">
<code class="varname">region</code>
</span>
</dt>
<dd>
<p>
The (<span class="emphasis"><em>width, height, depth</em></span>) in bytes of the 2D
or 3D rectangle being read or written. For a 2D rectangle copy, the
<code class="varname">depth</code> value given by <code class="varname">region</code>[2]
should be 1.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">buffer_row_pitch</code>
</span>
</dt>
<dd>
<p>
The length of each row in bytes to be used for the memory region associated
with <code class="varname">buffer</code>. If <code class="varname">buffer_row_pitch</code>
is 0, <code class="varname">buffer_row_pitch</code> is computed as
<code class="varname">region</code>[0].
</p>
</dd>
<dt>
<span class="term">
<code class="varname">buffer_slice_pitch</code>
</span>
</dt>
<dd>
<p>
The length of each 2D slice in bytes to be used for the memory region associated
with <code class="varname">buffer</code>. If <code class="varname">buffer_slice_pitch</code> is 0,
<code class="varname">buffer_slice_pitch</code> is computed as <code class="varname">region</code>[1]
* <code class="varname">buffer_row_pitch</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">host_row_pitch</code>
</span>
</dt>
<dd>
<p>
The length of each row in bytes to be used for the memory region pointed
to by <code class="varname">ptr</code>. If <code class="varname">host_row_pitch</code> is 0,
<code class="varname">host_row_pitch</code> is computed as <code class="varname">region</code>[0].
</p>
</dd>
<dt>
<span class="term">
<code class="varname">host_slice_pitch</code>
</span>
</dt>
<dd>
<p>
The length of each 2D slice in bytes to be used for the memory region pointed
to by <code class="varname">ptr</code>. If <code class="varname">host_slice_pitch</code>
is 0, <code class="varname">host_slice_pitch</code> is computed as
<code class="varname">region</code>[1] * <code class="varname">host_row_pitch</code>.
</p>
</dd>
<dt>
<span class="term"> <code class="varname">ptr </code> </span>
</dt>
<dd>
<p>
The pointer to buffer in host memory where data is to be read into.
</p>
</dd>
<dt>
<span class="term"> <code class="varname">
event_wait_list
</code>
, </span>
<span class="term">
<code class="varname">
num_events_in_wait_list
</code>
</span>
</dt>
<dd>
<p>
<code class="varname">event_wait_list</code>
and <code class="varname">num_events_in_wait_list</code> specify events that
need to complete before this particular command can be executed.
If <code class="varname">event_wait_list</code> is NULL, then this particular command
does not wait on any event to complete. If <code class="varname">event_wait_list</code>
is NULL, <code class="varname">num_events_in_wait_list</code> must be 0. If
<code class="varname">event_wait_list</code> is not NULL, the list of events
pointed to by <code class="varname">event_wait_list</code> must be valid
and <code class="varname">num_events_in_wait_list</code> must be greater
than 0. The events specified in <code class="varname">event_wait_list</code>
act as synchronization points. The context associated with events in
<code class="varname">event_wait_list</code> and <code class="varname">command_queue</code> must
be the same. The memory associated with <code class="varname">event_wait_list</code>
can be reused or freed after the function returns.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> event </code> </span>
</dt>
<dd>
<p>
Returns an event object that identifies
this particular read command and can be used to query or queue a wait
for this particular command to complete. <code class="varname">event</code> can be
NULL in which case it will not be possible for the application to query
the status of this command or queue a wait for this command to complete.
If the <code class="varname">event_wait_list</code> and the event arguments are
not NULL, the <code class="varname">event</code> argument should not refer to an
element of the <code class="varname">event_wait_list</code> array.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
Calling <code class="function">clEnqueueReadBufferRect</code> to read a region of the buffer
object with the <code class="varname">ptr</code> argument value set to <code class="varname">host_ptr</code>
and <code class="varname">host_origin</code>, <code class="varname">buffer_origin</code>
values are the same, where <code class="varname">host_ptr</code> is a pointer to the
memory region specified when the buffer object being read is created with
<code class="constant">CL_MEM_USE_HOST_PTR</code>, must meet the same requirements given for
<a class="citerefentry" href="clEnqueueReadBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBuffer</span></span></a>.
</p>
<p>
Calling <code class="function">clEnqueueWriteBufferRect</code> to update the latest
bits in a region of the buffer object with the <code class="varname">ptr</code> argument
value set to <code class="varname">host_ptr</code> and <code class="varname">host_origin</code>,
<code class="varname">buffer_origin</code> values are the same, where <code class="varname">host_ptr</code>
is a pointer to the memory region specified when the buffer object being written
is created with <code class="constant">CL_MEM_USE_HOST_PTR</code>, must meet the following
requirements in order to avoid undefined behavior:
</p>
<p>
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
The host memory region given by (<code class="varname">buffer_origin</code><code class="varname">region</code>) contains the latest bits when the enqueued write
command begins execution.
</li>
<li class="listitem">
The buffer object or memory objects created from this buffer object are not mapped.
</li>
<li class="listitem">
The buffer object or memory objects created from this buffer object are not used
by any command-queue until the write command has finished execution.
</li>
</ul>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
<code class="function">clEnqueueReadBufferRect</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_COMMAND_QUEUE</span> if <code class="varname">command_queue</code>
is not a valid command-queue.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if the context associated with
<code class="varname">command_queue</code> and <code class="varname">buffer</code> are not the same
or if the context associated with <code class="varname">command_queue</code> and events in
<code class="varname">event_wait_list</code> are not the same.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> if <code class="varname">buffer</code> is not
a valid buffer object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if the region being read
specified by (<code class="varname">buffer_origin</code>, <code class="varname">region</code>,
<code class="varname">buffer_row_pitch</code>, <code class="varname">buffer_slice_pitch</code>)
is out of bounds.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">ptr</code> is a NULL value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if any <code class="varname">region</code> array
element is 0.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">buffer_row_pitch</code>
is not 0 and is less than <code class="varname">region</code>[0].
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">host_row_pitch</code>
is not 0 and is less than <code class="varname">region</code>[0].
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">buffer_slice_pitch</code>
is not 0 and is less than <code class="varname">region</code>[1] *
<code class="varname">buffer_row_pitch</code> and not a multiple of
<code class="varname">buffer_row_pitch</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">host_slice_pitch</code> is not
0 and is less than <code class="varname">region</code>[1] * <code class="varname">host_row_pitch</code>
and not a multiple of <code class="varname">host_row_pitch</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT_WAIT_LIST</span>
if <code class="varname">event_wait_list</code> is NULL and
<code class="varname">num_events_in_wait_list</code> > 0,
or <code class="varname">event_wait_list</code> is not NULL and
<code class="varname">num_events_in_wait_list</code> is 0, or if event objects in
<code class="varname">event_wait_list</code> are not valid events.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MISALIGNED_SUB_BUFFER_OFFSET</span> if
<code class="varname">buffer</code> is a sub-buffer object and <code class="varname">offset</code>
specified when the sub-buffer object is created is not aligned to
<code class="constant">CL_DEVICE_MEM_BASE_ADDR_ALIGN</code> value for device associated
with <code class="varname">queue</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST</span> if the read
and write operations are blocking and the execution status of any of the events
in <code class="varname">event_wait_list</code> is a negative integer value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MEM_OBJECT_ALLOCATION_FAILURE</span> if there is a failure to
allocate memory for data store associated with <code class="varname">buffer</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if
<code class="function">clEnqueueReadBufferRect</code> is called on <code class="varname">buffer</code>
which has been created with <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> or
<code class="constant">CL_MEM_HOST_NO_ACCESS</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="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=74" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="clEnqueueCopyBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueCopyBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBufferRect</span></span></a>,
<a class="citerefentry" href="clEnqueueWriteBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueWriteBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBufferRect</span></span></a>,
<a class="citerefentry" href="clEnqueueReadBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBuffer</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>
|