/usr/share/doc/opencl-1.2-html-doc/imageDescriptor.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 | <?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>imageDescriptor</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
<meta name="keywords" content="imageDescriptor" />
</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="cl_image_format"></a>
<h1>imageDescriptor</h1>
<p>
The image descriptor structure describes the type and dimensions of the image or image array and is defined as:
</p>
</div>
<div class="refsect2">
<a id="synopsis"></a>
<h3>
</h3>
<div class="informaltable">
<table class="informaltable" border="0">
<colgroup>
<col align="left" class="col1" />
</colgroup>
<tbody>
<tr>
<td align="left">typedef struct _cl_image_desc {
cl_mem_object_type image_type;
size_t image_width;
size_t image_height;
size_t image_depth;
size_t image_array_size;
size_t image_row_pitch;
size_t image_slice_pitch;
cl_uint num_mip_levels;
cl_uint num_samples;
cl_mem buffer;
} cl_image_desc;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1">
<a id="parameters"></a>
<h2>Members</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">image_type</span>
</dt>
<dd>
<p>
Describes the image type and must be either
<code class="constant">CL_MEM_OBJECT_IMAGE1D</code>,
<code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code>,
<code class="constant">CL_MEM_OBJECT_IMAGE1D_ARRAY</code>,
<code class="constant">CL_MEM_OBJECT_IMAGE2D</code>,
<code class="constant">CL_MEM_OBJECT_IMAGE2D_ARRAY</code>, or
<code class="constant">CL_MEM_OBJECT_IMAGE3D</code>.
</p>
</dd>
<dt>
<span class="term">image_width</span>
</dt>
<dd>
<p>
The width of the image in pixels. For a 2D
image and image array, the image width must be ≤
<code class="constant">CL_DEVICE_IMAGE2D_MAX_WIDTH</code>. For a 3D image, the image
width must be ≤ <code class="constant">CL_DEVICE_IMAGE3D_MAX_WIDTH</code>. For
a 1D image buffer, the image width must be ≤
<code class="constant">CL_DEVICE_IMAGE_MAX_BUFFER_SIZE</code>. For
a 1D image and 1D image array, the image width must be ≤
<code class="constant">CL_DEVICE_IMAGE2D_MAX_WIDTH</code>.
</p>
</dd>
<dt>
<span class="term">image_height</span>
</dt>
<dd>
<p>
The height of the image in pixels. This is only used if the image is a 2D, 3D
or 2D image array. For a 2D image or image array, the image height must be
≤ <code class="constant">CL_DEVICE_IMAGE2D_MAX_HEIGHT</code>. For a 3D image, the
image height must be ≤ <code class="constant">CL_DEVICE_IMAGE3D_MAX_HEIGHT</code>.
</p>
</dd>
<dt>
<span class="term">image_depth</span>
</dt>
<dd>
<p>
The depth of the image in pixels. This is only used if the
image is a 3D image and must be a value ≥ 1 and ≤
<code class="constant">CL_DEVICE_IMAGE3D_MAX_DEPTH</code>.
</p>
</dd>
<dt>
<span class="term">image_array_size</span>
</dt>
<dd>
<p>
The number of images in the image array. This is only
used if the image is a 1D or 2D image array. The values for
<code class="varname">image_array_size</code>, if specified, must be a value ≥
1 and ≤ <code class="constant">CL_DEVICE_IMAGE_MAX_ARRAY_SIZE</code>.
</p>
<p>
Note that reading and writing 2D image arrays from a kernel with
<code class="varname">image_array_size</code> = 1 may be lower performance than
2D images.
</p>
</dd>
<dt>
<span class="term">image_row_pitch</span>
</dt>
<dd>
<p>
The scan-line pitch in bytes. This must be 0 if <code class="varname">host_ptr</code>
is NULL and can be either 0 or ≥ image_width * size of element in bytes if
<code class="varname">host_ptr</code> is not NULL. If <code class="varname">host_ptr</code>
is not NULL and <code class="varname">image_row_pitch</code> =
0, <code class="varname">image_row_pitch</code> is calculated as
<code class="varname">image_width</code> * size of element in bytes. If
<code class="varname">image_row_pitch</code> is not 0, it must be a multiple of
the image element size in bytes.
</p>
</dd>
<dt>
<span class="term">image_slice_pitch</span>
</dt>
<dd>
<p>
The size in bytes of each 2D slice in the 3D image or the size in
bytes of each image in a 1D or 2D image array. This must be 0 if
<code class="varname">host_ptr</code> is NULL. If <code class="varname">host_ptr</code>
is not NULL, <code class="varname">image_slice_pitch</code> can
be either 0 or ≥ <code class="varname">image_row_pitch</code> *
<code class="varname">image_height</code> for a 2D image array or 3D image
and can be either 0 or ≥ <code class="varname">image_row_pitch</code>
for a 1D image array. If <code class="varname">host_ptr</code>
is not NULL and <code class="varname">image_slice_pitch</code> =
0, <code class="varname">image_slice_pitch</code> is calculated as
<code class="varname">image_row_pitch</code> * <code class="varname">image_height</code>
for a 2D image array or 3D image and <code class="varname">image_row_pitch</code>
for a 1D image array. If <code class="varname">image_slice_pitch</code> is not 0,
it must be a multiple of the <code class="varname">image_row_pitch</code>.
</p>
</dd>
<dt>
<span class="term">num_mip_level, </span>
<span class="term">num_samples</span>
</dt>
<dd>
<p>
Must be 0.
</p>
</dd>
<dt>
<span class="term">buffer</span>
</dt>
<dd>
<p>
Refers to a valid buffer memory object if <code class="varname">image_type</code>
is <code class="constant">CL_MEM_OBJECT_IMAGE1D_BUFFER</code>. Otherwise it must
be NULL. For a 1D image buffer object, the image pixels are taken from
the buffer object's data store. When the contents of a buffer object's
data store are modified, those changes are reflected in the contents of
the 1D image buffer object and vice-versa at corresponding sychronization
points. The <code class="varname">image_width</code> * size of element in bytes
must be ≤ size of buffer object data store.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1">
<a id="note"></a>
<h2>Note</h2>
<p>
Concurrent reading from, writing to and copying between both a buffer object and 1D image
buffer object associated with the buffer object is undefined. Only reading from both
a buffer object and 1D image buffer object associated with the buffer object is defined.
</p>
</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=95" 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_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</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>
|