/usr/share/doc/opencl-1.2-html-doc/clEnqueueMapImage.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 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 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 | <?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>clEnqueueMapImage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clEnqueueMapImage" />
</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="clEnqueueMapImage"></a>
<h1>
clEnqueueMapImage
</h1>
<p>
Enqueues a command to map a region of an image object into the host address
space and returns a pointer to this mapped region.
</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">void</a> * <strong class="fsfunc">clEnqueueMapImage </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">image</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_map</var>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_map_flags" target="pagedisplay">cl_map_flags</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">map_flags</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">* 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">*image_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">*image_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">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>
, </td>
</tr>
<tr valign="top">
<td> </td>
<td>
<a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*errcode_ret</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>
Must be a valid command-queue.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> image </code> </span>
</dt>
<dd>
<p>
A valid image object. The OpenCL context associated with
<code class="varname">command_queue</code> and <code class="varname">image</code> must be
the same.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> blocking_map </code> </span>
</dt>
<dd>
<p>
Indicates if the map operation is <code class="varname">blocking</code> or
<code class="varname">non-blocking</code>.
</p>
<p>
If <code class="varname">blocking_map</code> is <code class="constant">CL_TRUE</code>,
<code class="function">clEnqueueMapImage</code> does not return until the specified
region in <code class="varname">image</code> is mapped into the host address space
and the application can access the contents of the mapped region using
the pointer returned by <code class="function">clEnqueueMapImage</code>.
</p>
<p>
If <code class="varname">blocking_map</code> is <code class="constant">CL_FALSE</code>
i.e. map operation is non-blocking, the pointer to the mapped region
returned by <code class="function">clEnqueueMapImage</code> cannot be used until
the map command has completed. The <code class="varname">event</code> argument
returns an event object which can be used to query the execution status
of the map command. When the map command is completed, the application
can access the contents of the mapped region using the pointer returned
by <code class="function">clEnqueueMapImage</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">map_flags</code>
</span>
</dt>
<dd>
<p>
A bit-bield with the following supported values.
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="left" class="col1" />
<col align="left" class="col2" />
</colgroup>
<thead>
<tr>
<th align="left">cl_map_flags</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
<code class="constant">CL_MAP_READ</code>
</td>
<td align="left">
<p>
This flag specifies that the region being mapped in the memory object
is being mapped for reading.
</p>
<p>
The pointer returned by
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> or
<code class="function">clEnqueueMapImage</code> is guaranteed to contain the
latest bits in the region being mapped when the
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> or
<code class="function">clEnqueueMapImage</code> command has completed
</p>
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_MAP_WRITE</code>
</td>
<td align="left">
<p>
This flag specifies that the region being mapped in the memory
object is being mapped for writing.
</p>
<p>
The pointer returned by
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> or
<code class="function">clEnqueueMapImage</code> is guaranteed to contain the latest bits in
the region being mapped when the
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> or
<code class="function">clEnqueueMapImage</code> command has completed.
</p>
</td>
</tr>
<tr>
<td align="left">
<code class="constant">CL_MAP_WRITE_INVALIDATE_REGION</code>
</td>
<td align="left">
<p>
This flag specifies that the region being mapped in the memory
object is being mapped for writing.
</p>
<p>
The contents of the region being mapped are to be discarded. This is typically the case
when the region being mapped is overwritten by the host. This
flag allows the implementation
to no longer guarantee that the pointer returned by
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> or
<code class="function">clEnqueueMapImage</code> contains the latest bits in the region being
mapped which can be a significant performance enhancement.
</p>
<p>
<code class="constant">CL_MAP_READ</code> or <code class="constant">CL_MAP_WRITE</code>
and <code class="constant">CL_MAP_WRITE_INVALIDATE_REGION</code>
are mutually exclusive.
</p>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
<dt>
<span class="term"> <code class="varname"> origin </code> </span>
</dt>
<dd>
<p>
Defines the (x, y, z) offset in pixels in the 1D, 2D or 3D image, the
(x, y) offset and the image index in the 2D image array or the (x) offset
and the image index in the 1D image array. If <code class="varname">image</code>
is a 2D image object, <code class="varname">origin</code>[2] must be 0.
If <code class="varname">image</code> is a 1D image or 1D image buffer object,
<code class="varname">origin</code>[1] and <code class="varname">origin</code>[2]
must be 0. If <code class="varname">image</code> is a 1D image array object,
<code class="varname">origin</code>[2] must be 0. If <code class="varname">image</code>
is a 1D image array object, <code class="varname">origin</code>[1] describes the
image index in the 1D image array. If <code class="varname">image</code> is a 2D
image array object, <code class="varname">origin</code>[2] describes the image
index in the 2D image array.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> region </code> </span>
</dt>
<dd>
<p>
Defines the (width, height, depth) in pixels of the 1D, 2D or 3D rectangle,
the (width, height) in pixels of the 2D rectangle and the number of images of
a 2D image array or the (width) in pixels of the 1D rectangle and the number
of images of a 1D image array. If <code class="varname">image</code> is a 2D image
object, <code class="varname">region</code>[2] must be 1. If <code class="varname">image</code>
is a 1D image or 1D image buffer object, <code class="varname">region</code>[1]
and <code class="varname">region</code>[2] must be 1. If <code class="varname">image</code>
is a 1D image array object, <code class="varname">region</code>[2] must be 1.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> image_row_pitch </code> </span>
</dt>
<dd>
<p>
Returns the scan-line pitch in bytes for the mapped region. This must be a non-NULL value.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> image_slice_pitch </code> </span>
</dt>
<dd>
<p>
Returns the size in bytes of each 2D slice of a 3D image or the size of
each 1D or 2D image in a 1D or 2D image array for the mapped region. For
a 1D and 2D image, zero is returned if this argument is not NULL. For a
3D image, 1D, and 2D image array, <code class="varname">image_slice_pitch</code>
must be a non-NULL value.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">
event_wait_list
,</code>
<code class="varname">
num_events_in_wait_list
</code>
</span>
</dt>
<dd>
<p>
Specify events that need to complete before
<code class="function">clEnqueueMapImage</code> can be executed. If
<code class="varname">event_wait_list</code> is NULL, then
<code class="function">clEnqueueMapImage</code> 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 copy 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 <code class="varname">event</code>
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>
<dt>
<span class="term"> <code class="varname"> errcode_ret </code> </span>
</dt>
<dd>
<p>
Returns an appropriate error code. If <code class="varname">errcode_ret</code>
is NULL, no error code is returned.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="notes"></a>
<h2>Notes</h2>
<p>
The pointer returned maps a 1D, 2D or 3D region starting at <code class="varname">origin</code>
and is at least <code class="varname">region</code>[0] pixels in size for a 1D image,
1D image buffer or 1D image array, (<code class="varname">image_row_pitch</code> *
<code class="varname">region</code>[1]) pixels in size for a 2D image or 2D image array, and
(<code class="varname">image_slice_pitch</code> * <code class="varname">region</code>[2]) pixels in size
for a 3D image. The result of a memory access outside this region is undefined.
</p>
<p>
If the image object is created with <code class="constant">CL_MEM_USE_HOST_PTR</code>
set in <code class="varname">mem_flags</code>, the following will be true:
</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem" style="list-style-type: disc">
The <code class="varname">host_ptr</code> specified in
<a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>
is guaranteed to contain the latest bits in the region being mapped when the
<code class="function">clEnqueueMapImage</code> command has completed.
</li>
<li class="listitem" style="list-style-type: disc">
The pointer value returned by <code class="function">clEnqueueMapImage</code> will be derived
from the <code class="varname">host_ptr</code> specified when the image object is created.
</li>
</ul>
</div>
<p>
Mapped image objects are unmapped using
<a class="citerefentry" href="clEnqueueUnmapMemObject.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueUnmapMemObject</span></span></a>.
</p>
<p>
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>
and <code class="function">clEnqueueMapImage</code> increment the mapped count of the memory
object. The initial mapped count value of a memory object is zero. Multiple calls to
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>
or <code class="function">clEnqueueMapImage</code> on the same memory object
will increment this mapped count by appropriate number of calls.
<code class="function">clEnqueueUnmapMemObject</code> decrements the mapped count of the
memory object.
</p>
<p>
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> and
<code class="function">clEnqueueMapImage</code> act as synchronization points for a region of
the buffer object being mapped.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
<code class="function">clEnqueueMapImage</code> will return a pointer to the mapped region
if the function is executed successfully. The <code class="varname">errcode_ret</code> is set
to <span class="errorname">CL_SUCCESS</span>.
</p>
<p>
A NULL pointer is returned otherwise with one of the following error values returned
in <code class="varname">errcode_ret</code>:
</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">image</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">image</code> is not a valid image object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if region being mapped given by
(<code class="varname">origin</code>, <code class="varname">origin</code>+<code class="varname">region</code>)
is out of bounds or if values specified in <code class="varname">map_flags</code> are not valid.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values in <code class="varname">origin</code> and
<code class="varname">region</code> do not follow rules described in the argument description
for <code class="varname">origin</code> and <code class="varname">region</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">image_row_pitch</code> is NULL.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">image</code> is a 3D image,
1D or 2D image array object and <code class="varname">image_slice_pitch</code> is NULL.
</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_INVALID_IMAGE_SIZE</span> if image dimensions (image width,
height, specified or compute row and/or slice pitch) for <code class="varname">image</code>
are not supported by device associated with <code class="varname">queue</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT</span> if image format (image channel
order and data type) for <code class="varname">image</code> are not supported by device
associated with <code class="varname">queue</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MAP_FAILURE</span> if there is a failure to map the
requested region into the host address space. This error cannot occur for
image objects created with <code class="constant">CL_MEM_USE_HOST_PTR</code> or
<code class="constant">CL_MEM_ALLOC_HOST_PTR</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
map operation is 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 the device
associated with <code class="varname">command_queue</code> does not support
images (i.e. <code class="constant">CL_DEVICE_IMAGE_SUPPORT</code>
specified in the table of OpenCL Device Queries for
<a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>
is <code class="constant">CL_FALSE</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if <code class="varname">image</code>
has been created with <code class="constant">CL_MEM_HOST_WRITE_ONLY</code> or
<code class="constant">CL_MEM_HOST_NO_ACCESS</code> and <code class="constant">CL_MAP_READ</code>
is set in <code class="varname">map_flags</code> or if <code class="varname">image</code>
has been created with <code class="constant">CL_MEM_HOST_READ_ONLY</code> or
<code class="constant">CL_MEM_HOST_NO_ACCESS</code> and <code class="constant">CL_MAP_WRITE</code>
or <code class="constant">CL_MAP_WRITE_INVALIDATE_REGION</code> is set in
<code class="varname">map_flags</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=112" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueUnmapMemObject.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueUnmapMemObject</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>
|