/usr/share/doc/opencl-1.2-html-doc/clCreateFromDX9MediaSurfaceKHR.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 | <?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>clCreateFromDX9MediaSurfaceKHR</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="clCreateFromDX9MediaSurfaceKHR" />
</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="clCreateFromDX9MediaSurfaceKHR"></a>
<h1>clCreateFromDX9MediaSurfaceKHR</h1>
<p>Creates an OpenCL image object from a media surface.</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="abstractDataTypes.html" target="pagedisplay">cl_mem</a>
<strong class="fsfunc">clCreateFromDX9MediaSurfaceKHR</strong>
(</code>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td>
</td>
</tr>
<tr valign="top">
<td> </td>
<td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="pagedisplay">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td>
</tr>
<tr valign="top">
<td> </td>
<td>cl_dx9_media_adapter_type_khr <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">adapter_type</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">*surface_info</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">plane</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">context</code>
</span>
</dt>
<dd>
<p>
A valid OpenCL context created from a media adapter.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">flags</code>
</span>
</dt>
<dd>
<p>
A bit-field that is used to specify usage information. Refer
to the table of allowed values for <code class="varname">flags</code> for
<a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>. Only
<code class="constant">CL_MEM_READ_ONLY</code>, <code class="constant">CL_MEM_WRITE_ONLY</code>,
and <code class="constant">CL_MEM_READ_WRITE</code> values specified
in the table of allowed values for <code class="varname">flags</code> for
<a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>
can be used.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">adapter_type</code>
</span>
</dt>
<dd>
<p>
A value from enumeration of supported adapters described in the
table of <code class="varname">cl_dx9_media_adapter_type_khr</code> values for
<a class="citerefentry" href="clGetDeviceIDsFromDX9MediaAdapterKHR.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDsFromDX9MediaAdapterKHR</span></span></a>.
The type of <code class="varname">surface_info</code> is determined by the adapter
type. The implementation does not need to support all adapter types. This
approach provides flexibility to support additional adapter types in the
future. Supported adapter types are <code class="constant">CL_ADAPTER_D3D9_KHR</code>,
<code class="constant">CL_ADAPTER_D3D9EX_KHR</code>, and
<code class="constant">CL_ADAPTER_DXVA_KHR</code>.
</p>
<p>
If <code class="varname">adapter_type</code> is <code class="constant">CL_ADAPTER_D3D9_KHR</code>,
<code class="constant">CL_ADAPTER_D3D9EX_KHR</code>, or
<code class="constant">CL_ADAPTER_DXVA_KHR</code>, the <code class="varname">surface_info</code>
points to the following structure:
</p>
<p> <code class="code"><div class="literallayout"><p>typedef struct _cl_dx9_surface_info_khr<br />
{<br />
IDirect3DSurface9 *resource; HANDLE shared_handle;<br />
} cl_dx9_surface_info_khr;<br />
</p></div></code>
</p>
<p>
For D3D9 surfaces, we need both the handle to the resource and the resource
itself to have a sufficient amount of information to eliminate a copy of the
surface for sharing in cases where this is possible. Elimination of the copy
is driver dependent. <code class="varname">shared_handle</code> may be NULL and this
may result in sub-optimal performance.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">surface_info</code>
</span>
</dt>
<dd>
<p>
A pointer to one of the structures defined in the <code class="varname">adapter_type</code>
description above passed in as a <span class="type">void</span> *.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">plane</code>
</span>
</dt>
<dd>
<p>
The plane of resource to share for planar surface formats. For planar formats,
we use the plane parameter to obtain a handle to thie specific plane (Y, U or
V for example). For nonplanar formats used by media, <code class="varname">plane</code>
must be 0.
</p>
</dd>
<dt>
<span class="term">
<code class="varname">errcode_ret</code>
</span>
</dt>
<dd>
<p>
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 width and height of the returned OpenCL 2D image object are determined by the
width and height of the plane of resource. The channel type and order of the returned
image object is determined by the format and plane of resource and are described in
tables 9.10.3 and 9.10.4.
</p>
<p>
This call will increment the internal media surface count on
<code class="varname">resource</code>. The internal media surface reference count on
<code class="varname">resource</code> will be decremented when the OpenCL reference count on
the returned OpenCL memory object drops to zero.
</p>
<h4><a id="idm109"></a>DX9 Media Surface Sharing</h4>
<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="idm239"></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 a valid non-zero 2D image object and
<code class="varname">errcode_ret</code> is set to <span class="errorname">CL_SUCCESS</span> if the 2D
image object is created successfully. Otherwise, it returns a NULL value 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_CONTEXT</span> if <code class="varname">context</code> is not
a valid context.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values specified in
<code class="varname">flags</code> are not valid or if plane is not a valid plane of
<code class="varname">resource</code> specified in <code class="varname">surface_info</code>..
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_DX9_MEDIA_SURFACE_KHR</span> if
<code class="varname">resource</code> specified in <code class="varname">surface_info</code> is not
a valid resource or is not associated with <code class="varname">adapter_type</code> (e.g.,
<code class="varname">adapter_type</code> is set to <code class="constant">CL_ADAPTER_D3D9_KHR</code>
and <code class="varname">resource</code> is not a Direct3D 9 surface created in
<code class="constant">D3DPOOL_DEFAULT</code>).
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_DX9_MEDIA_SURFACE_KHR</span> if
<code class="varname">shared_handle</code> specified in <code class="varname">surface_info</code>
is not NULL or a valid handle value.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if the texture format
of <code class="varname">resource</code> is not listed in tables 9.10.3 and 9.10.4.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if there are no devices in
<code class="varname">context</code> that support <code class="varname">adapter_type</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-extensions.pdf#page=89" 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="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>
|