/usr/share/doc/opencl-1.2-html-doc/clEnqueueCopyBufferToImage.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 | <?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>clEnqueueCopyBufferToImage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
<meta name="keywords" content="clEnqueueCopyBufferToImage" />
</head>
<body>
<div class="refentry">
<a id="idp48982320"></a>
<div class="titlepage"></div>
<div xmlns="" class="refnamediv">
<a xmlns="http://www.w3.org/1999/xhtml" id="clEnqueueCopyBufferToImage"></a>
<h1>
clEnqueueCopyBufferToImage
</h1>
<p>
Enqueues a command to copy a buffer object to an image object.
</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">clEnqueueCopyBufferToImage</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">src_buffer</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_mem</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">dst_image</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">src_offset</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">*dst_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">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. The OpenCL context associated with
<code class="varname">command_queue</code>, <code class="varname">src_buffer</code>, and
<code class="varname">dst_image</code> must be the same.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> src_buffer </code> </span>
</dt>
<dd>
<p>
A valid buffer object.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> dst_image </code> </span>
</dt>
<dd>
<p>
A valid image object.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> src_offset </code> </span>
</dt>
<dd>
<p>
The offset where to begin copying data from <code class="varname">src_buffer</code>.
</p>
</dd>
<dt>
<span class="term"> <code class="varname"> dst_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 dst_image
is a 2D image object, <code class="varname">dst_origin</code>[2] must be 0.
If <code class="varname">dst_image</code> is a 1D image or 1D image buffer object,
<code class="varname">dst_origin</code>[1] and <code class="varname">dst_origin</code>[2]
must be 0. If <code class="varname">dst_image</code> is a 1D image array object,
<code class="varname">dst_origin</code>[2] must be 0. If <code class="varname">dst_image</code>
is a 1D image array object, <code class="varname">dst_origin</code>[1] describes
the image index in the 1D image array. If <code class="varname">dst_image</code>
is a 2D image array object, <code class="varname">dst_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">dst_image</code>
is a 2D image object, <code class="varname">region</code>[2] must be 1. If
<code class="varname">dst_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">dst_image</code> is a 1D image array object,
<code class="varname">region</code>[2] must be 1.
</p>
<p>
The size in bytes of the region to be copied
from <code class="varname">src_buffer</code> referred to as
<code class="varname">src_cb</code> is computed as <code class="varname">width</code>
* <code class="varname">height</code> * <code class="varname">depth</code> *
<code class="varname">bytes</code>/<code class="varname">image_element</code> if
<code class="varname">dst_image</code> is a 3D image object, is computed
as <code class="varname">width</code> * <code class="varname">height</code> *
<code class="varname">bytes</code>/<code class="varname">image_element</code>
if <code class="varname">dst_image</code> is a 2D
image, is computed as <code class="varname">width</code> *
<code class="varname">height</code> * <code class="varname">arraysize</code> *
<code class="varname">bytes</code>/<code class="varname">image_element</code>
if <code class="varname">dst_image</code> is a 2D image array
object, is computed as <code class="varname">width</code> *
<code class="varname">bytes</code>/<code class="varname">image_element</code> if
<code class="varname">dst_image</code> is a 1D image or 1D image buffer object and
is computed as <code class="varname">width</code> * <code class="varname">arraysize</code>
* <code class="varname">bytes</code>/<code class="varname">image_element</code> if
<code class="varname">dst_image</code> is a 1D image array object.
</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 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 event_wait_list 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.
<a class="citerefentry" href="clEnqueueBarrierWithWaitList.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueBarrierWithWaitList</span></span></a>
can be used instead. 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>
</dl>
</div>
</div>
<div class="refsect1">
<a id="errors"></a>
<h2>Errors</h2>
<p>
<code class="function">clEnqueueCopyBufferToImage</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>, <code class="varname">src_buffer</code> and
<code class="varname">dst_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">src_buffer</code> is
not a valid buffer object and <code class="varname">dst_image</code> is not a valid image
object or if <code class="varname">dst_image</code> is a 1D image buffer object created
from <code class="varname">src_buffer</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if the 1D, 2D, or 3D rectangular region
specified by <code class="varname">dst_origin</code> and <code class="varname">dst_origin</code> +
<code class="varname">region</code> refers to a region outside <code class="varname">dst_origin</code>,
or if the region specified by <code class="varname">src_offset</code> and
<code class="varname">src_offset</code> + <code class="varname">src_cb</code> refers to a region
outside <code class="varname">src_buffer</code>.
</li>
<li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values in <code class="varname">dst_origin</code>
and <code class="varname">region</code> do not follow rules described in the argument
description for <code class="varname">dst_origin</code> and <code class="varname">region</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">src_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_INVALID_IMAGE_SIZE</span> if image dimensions (image width,
height, specified or compute row and/or slice pitch) for <code class="varname">dst_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">dst_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_MEM_OBJECT_ALLOCATION_FAILURE</span> if there is a failure
to allocate memory for data store associated with <code class="varname">src_buffer</code>
or <code class="varname">dst_image</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.
CL_DEVICE_IMAGE_SUPPORT 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 CL_FALSE).
</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=110" target="OpenCL Spec">OpenCL Specification</a>
</p>
</div>
<div class="refsect1">
<a id="seealso"></a>
<h2>Also see</h2>
<p>
<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="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueCopyBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBuffer</span></span></a>,
<a class="citerefentry" href="clEnqueueCopyImageToBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyImageToBuffer</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>
|