/usr/share/doc/opencl-1.2-html-doc/clEnqueueReleaseDX9MediaSurfacesKHR.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 | <?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>clEnqueueReleaseDX9MediaSurfacesKHR</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clEnqueueReleaseDX9MediaSurfacesKHR" />
</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="clEnqueueReleaseDX9MediaSurfacesKHR"></a>
<h1>clEnqueueReleaseDX9MediaSurfacesKHR</h1>
<p>Release OpenCL memory objects that have been created from media surfaces.</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">clEnqueueReleaseDX9MediaSurfacesKHR</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="scalarDataTypes.html" target="pagedisplay">cl_uint</a>
<var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_objects</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_mem</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*mem_objects</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>
A valid command-queue.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">num_objects</code>
</span>
</dt>
<dd>
<p>
The number of memory objects to be released in <code class="varname">mem_objects</code>.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">mem_objects</code>
</span>
</dt>
<dd>
<p>
A pointer to a list of OpenCL memory objects that were created from
media surfaces.
</p>
</dd>
<dt>
<span class="term"><code class="varname">num_events_in_wait_list</code>, <code class="varname">event_wait_list</code></span>
</dt>
<dd>
<p>
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</code> returns an event object
that identifies this particular 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>
Used to release OpenCL memory objects that have been created from media
surfaces. The media surfaces are released by the OpenCL context associated with
<code class="varname">command_queue</code>.
</p>
<p>
OpenCL memory objects created from media surfaces which have been acquired by OpenCL must
be released by OpenCL before they may be accessed by the media adapter API. Accessing
a media surface while its corresponding OpenCL memory object is acquired is in error
and will result in undefined behavior, including but not limited to possible OpenCL
errors, data corruption, and program termination.
</p>
<p>
If <code class="constant">CL_CONTEXT_INTEROP_USER_SYNC</code> is not
specified as <code class="constant">CL_TRUE</code> during context creation,
<code class="function">clEnqueueReleaseDX9MediaSurfacesKHR</code> provides the
synchronization guarantee that any calls to media adapter APIs involving
the interop device(s) used in the OpenCL context made after the call to
<code class="function">clEnqueueReleaseDX9MediaSurfacesKHR</code> will not start executing until
after all events in <code class="varname">event_wait_list</code> are complete and all work already
submitted to <code class="varname">command_queue</code> completes execution. If the context was
created with properties specifying <code class="constant">CL_CONTEXT_INTEROP_USER_SYNC</code>
as <code class="constant">CL_TRUE</code>, the user is responsible for guaranteeing that any
media adapter API calls involving the interop device(s) used in the OpenCL context made
after <code class="function">clEnqueueReleaseDX9MediaSurfacesKHR</code> will not start executing
until after event returned by <code class="function">clEnqueueReleaseDX9MediaSurfacesKHR</code>
reports completion.
</p>
<p>
The goal of this extension is to allow applications
to use media surfaces as OpenCL memory objects. This allows efficient sharing of data
between OpenCL and selected adapter APIs (only DX9 for now). If this extension is supported,
an OpenCL image object can be created from a media surface and the OpenCL API can be used
to execute kernels that read and/or write memory objects that are media surfaces. Note
that OpenCL memory objects may be created from the adapter media surface if and only if
the OpenCL context has been created from that adapter.
</p>
<p>
If this extension is supported by
an implementation, the string "cl_khr_media_sharing" will be present in the
<code class="constant">CL_PLATFORM_EXTENSIONS</code> or <code class="constant">CL_DEVICE_EXTENSIONS</code>
string described in the table of allowed values for <code class="varname">param_name</code> for
<a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>.
</p>
<p>
As currently proposed the interfaces for this
extension would be provided in <code class="code">cl_dx9_media_sharing.h</code>.
</p>
<p>
This section includes the D3D surface formats
that are supported when the adapter type is one of the Direct 3D lineage . Using a D3D
surface format not listed here is an error. To extend the use of this extension to support
media adapters beyond DirectX9 tables similar to the ones in this section will need to be
defined for the surface formats supported by the new media adapter. All implementations
that support this extension are required to support the NV12 surface format, the other
surface formats supported are the same surface formats that the adapter you are sharing
with supports as long as they are listed in the two tables below.
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="center" class="col1" />
<col align="center" class="col2" />
</colgroup>
<thead>
<tr>
<th align="center">FOUR CC code</th>
<th align="center">CL image format (channel order, channel data type)</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">FOURCC('N', 'V', '1', '2'), Plane 0</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('N', 'V', '1', '2'), Plane 1</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 0</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 1</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">FOURCC('Y', 'V', '1', '2'), Plane 2</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
</tbody>
</table>
</div>
<p>
In the table above, NV12 Plane 0 corresponds to the luminance (Y) channel and Plane 1
corresponds to the UV channels. The YV12 Plane 0 corresponds to the Y channel, Plane
1 to the U channel and Plane 2 to the V channel. Note that the YUV formats map to
<code class="constant">CL_R</code> and <code class="constant">CL_RG</code> but do not perform any YUV to
RGB conversion and vice-versa.
</p>
<div class="informaltable">
<table class="informaltable" border="1">
<colgroup>
<col align="center" class="col1" />
<col align="center" class="col2" />
</colgroup>
<thead>
<tr>
<th align="center">D3D format</th>
<th align="center">CL image format (channel order, channel data type)</th>
</tr>
</thead>
<tbody>
<tr>
<td align="center">D3DFMT_R32F</td>
<td align="center">
<code class="constant">CL_R, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_R16F</td>
<td align="center">
<code class="constant">CL_R, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_L16</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8</td>
<td align="center">
<code class="constant">CL_A, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_L8</td>
<td align="center">
<code class="constant">CL_R, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G32R32F</td>
<td align="center">
<code class="constant">CL_RG, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G16R16F</td>
<td align="center">
<code class="constant">CL_RG, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_G16R16</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8L8</td>
<td align="center">
<code class="constant">CL_RG, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A32B32G32R32F</td>
<td align="center">
<code class="constant">CL_RGBA, CL_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A16B16G16R16F</td>
<td align="center">
<code class="constant">CL_RGBA, CL_HALF_FLOAT</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A16B16G16R16</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT16</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8B8G8R8</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_X8B8G8R8</td>
<td align="center">
<code class="constant">CL_RGBA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_A8R8G8B8</td>
<td align="center">
<code class="constant">CL_BGRA, CL_UNORM_INT8</code>
</td>
</tr>
<tr>
<td align="center">D3DFMT_X8R8G8B8</td>
<td align="center">
<code class="constant">CL_BGRA, CL_UNORM_INT8</code>
</td>
</tr>
</tbody>
</table>
</div>
<p>
Note that D3D9 format names seem to imply that the order of the color channels are switched
relative to OpenCL but this is not the case. For example, layout of channels for each pixel
for D3DFMT_A32FB32FG32FR32F is the same as <code class="constant">CL_RGBA</code>, <code class="constant">CL_FLOAT</code>.
</p>
<p>
Properties of media surface objects may be queried using
<a class="citerefentry" href="clGetMemObjectInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetMemObjectInfo</span></span></a>
and <a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a> with
<code class="varname">param_name</code> <code class="constant">CL_MEM_MEDIA_ADAPTER_TYPE_KHR</code>,
<code class="constant">CL_MEM_MEDIA_SURFACE_INFO_KHR</code> and
<code class="constant">CL_IMAGE_MEDIA_SURFACE_PLANE_KHR</code> as described for
<a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a> and in the
information below about accessing mapped regions of a memory object.
</p>
<h4><a id="idm221"></a>Accessing mapped regions of a memory object</h4>
<p>
This section describes the behavior of OpenCL commands that access
mapped regions of a memory object.
</p>
<p>
The contents of the region of a memory object and associated memory objects
(sub-buffer objects or 1D image buffer objects that overlap this region) mapped
for writing (i.e. <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>
argument to <a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>
or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>) are
considered to be undefined until this region is unmapped.
</p>
<p>
Multiple commands in command-queues can map a region or overlapping regions of a memory
object and associated memory objects (sub-buffer objects or 1D image buffer objects that
overlap this region) for reading (i.e. <code class="varname">map_flags</code> = <code class="constant">CL_MAP_READ</code>).
The contents of the regions of a memory object mapped for reading can also be read by kernels
and other OpenCL commands (such as
<a class="citerefentry" href="clEnqueueCopyBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBuffer</span></span></a>) executing on a device(s).
</p>
<p>
Mapping (and unmapping) overlapped regions in a memory object and/or associated memory
objects (sub-buffer objects or 1D image buffer objects that overlap this region) for writing
is an error and will result in <code class="constant">CL_INVALID_OPERATION</code> error returned by
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>
or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>.
</p>
<p>
If a memory object is currently mapped for writing, the application must ensure that the memory
object is unmapped before any enqueued kernels or commands that read from or write to this
memory object or any of its associated memory objects (sub-buffer or 1D image buffer objects)
or its parent object (if the memory object is a sub-buffer or 1D image buffer object) begin
execution; otherwise the behavior is undefined.
</p>
<p>
If a memory object is currently mapped for reading, the application must ensure that the memory
object is unmapped before any enqueued kernels or commands that write to this memory object
or any of its associated memory objects (sub-buffer or 1D image buffer objects) or its parent
object (if the memory object is a sub-buffer or 1D image buffer object) begin execution;
otherwise the behavior is undefined.
</p>
<p>
Accessing the contents of the memory region referred to by the mapped pointer that has
been unmapped is undefined.
</p>
<p>
The mapped pointer returned by
<a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>
or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a> can be used as
<code class="varname">ptr</code> argument value to
<a class="citerefentry" href="clEnqueueReadBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueWriteBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueReadBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBufferRect</span></span></a>,
<a class="citerefentry" href="clEnqueueWriteBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBufferRect</span></span></a>,
<a class="citerefentry" href="clEnqueueReadImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadImage</span></span></a>, and
<a class="citerefentry" href="clEnqueueWriteImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteImage</span></span></a>,
provided the rules described above are adhered to.
</p>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
Returns <span class="errorname">CL_SUCCESS</span> returns <span class="errorname">CL_SUCCESS</span>
if the function is executed successfully. If <code class="varname">num_objects</code> is 0 and
<<code class="varname">mem_objects</code>> is NULL then the function does nothing and returns
<span class="errorname">CL_SUCCESS</span>. 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_VALUE</span> if <code class="varname">num_objects</code> is zero and
<code class="varname">mem_objects</code> is not a NULL value or if <code class="varname">num_objects</code>
> 0 and <code class="varname">mem_objects</code> is NULL.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> if memory objects in <code class="varname">mem_objects</code>
are not valid OpenCL memory objects or if memory objects in <code class="varname">mem_objects</code> have
not been created from media surfaces.
</li>
<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 context associated with
<code class="varname">command_queue</code> was not created from a media object.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_DX9_MEDIA_SURFACE_NOT_ACQUIRED_KHR</span> if memory objects in
<code class="varname">mem_objects</code> have not been previously been acquired using
<code class="function">clEnqueueAcquireDX9MediaSurfacesKHR</code> or have been released using
<a class="citerefentry" href="clEnqueueReleaseDX9MediaSurfacesKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseDX9MediaSurfacesKHR</span></span></a>
since the last time that they were acquired.
</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_event_in_wait_list</code> > 0, or <code class="varname">event_wait_list</code>
is not NULL and <code class="varname">num_event_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_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-extensions.pdf#page=93" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<a class="citerefentry" href="cl_khr_dx9_media_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_dx9_media_sharing</span></span></a>,
<a class="citerefentry" href="clGetDeviceIDsFromDX9MediaAdapterKHR.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDsFromDX9MediaAdapterKHR</span></span></a>,
<a class="citerefentry" href="clCreateFromDX9MediaSurfaceKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromDX9MediaSurfaceKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueAcquireDX9MediaSurfacesKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueAcquireDX9MediaSurfacesKHR</span></span></a>,
<a class="citerefentry" href="clEnqueueReleaseDX9MediaSurfacesKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseDX9MediaSurfacesKHR</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>
|