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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry>
<refentryinfo>
<keywordset>
<keyword>imageDescriptor</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>imageDescriptor</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2010</year>
<holder>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.</holder>
</copyright>
</refmiscinfo>
<manvolnum>3</manvolnum>
</refmeta>
<!-- ================================ SYNOPSIS -->
<refnamediv id="cl_image_format">
<refname>imageDescriptor</refname>
<refpurpose>
The image descriptor structure describes the type and dimensions of the image or image array and is defined as:
</refpurpose>
</refnamediv>
<!-- ALTERNATIVE SYNTAX SYNOPSIS (NON-FUNCTION) -->
<refsect2 id="synopsis">
<title>
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>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;</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters"><title>Members</title>
<variablelist>
<varlistentry>
<term>image_type</term>
<listitem>
<para>
Describes the image type and must be either
<constant>CL_MEM_OBJECT_IMAGE1D</constant>,
<constant>CL_MEM_OBJECT_IMAGE1D_BUFFER</constant>,
<constant>CL_MEM_OBJECT_IMAGE1D_ARRAY</constant>,
<constant>CL_MEM_OBJECT_IMAGE2D</constant>,
<constant>CL_MEM_OBJECT_IMAGE2D_ARRAY</constant>, or
<constant>CL_MEM_OBJECT_IMAGE3D</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_width</term>
<listitem>
<para>
The width of the image in pixels. For a 2D
image and image array, the image width must be ≤
<constant>CL_DEVICE_IMAGE2D_MAX_WIDTH</constant>. For a 3D image, the image
width must be ≤ <constant>CL_DEVICE_IMAGE3D_MAX_WIDTH</constant>. For
a 1D image buffer, the image width must be ≤
<constant>CL_DEVICE_IMAGE_MAX_BUFFER_SIZE</constant>. For
a 1D image and 1D image array, the image width must be ≤
<constant>CL_DEVICE_IMAGE2D_MAX_WIDTH</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_height</term>
<listitem>
<para>
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
≤ <constant>CL_DEVICE_IMAGE2D_MAX_HEIGHT</constant>. For a 3D image, the
image height must be ≤ <constant>CL_DEVICE_IMAGE3D_MAX_HEIGHT</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_depth</term>
<listitem>
<para>
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 ≤
<constant>CL_DEVICE_IMAGE3D_MAX_DEPTH</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_array_size</term>
<listitem>
<para>
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
<varname>image_array_size</varname>, if specified, must be a value ≥
1 and ≤ <constant>CL_DEVICE_IMAGE_MAX_ARRAY_SIZE</constant>.
</para>
<para>
Note that reading and writing 2D image arrays from a kernel with
<varname>image_array_size</varname> = 1 may be lower performance than
2D images.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_row_pitch</term>
<listitem>
<para>
The scan-line pitch in bytes. This must be 0 if <varname>host_ptr</varname>
is NULL and can be either 0 or ≥ image_width * size of element in bytes if
<varname>host_ptr</varname> is not NULL. If <varname>host_ptr</varname>
is not NULL and <varname>image_row_pitch</varname> =
0, <varname>image_row_pitch</varname> is calculated as
<varname>image_width</varname> * size of element in bytes. If
<varname>image_row_pitch</varname> is not 0, it must be a multiple of
the image element size in bytes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>image_slice_pitch</term>
<listitem>
<para>
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
<varname>host_ptr</varname> is NULL. If <varname>host_ptr</varname>
is not NULL, <varname>image_slice_pitch</varname> can
be either 0 or ≥ <varname>image_row_pitch</varname> *
<varname>image_height</varname> for a 2D image array or 3D image
and can be either 0 or ≥ <varname>image_row_pitch</varname>
for a 1D image array. If <varname>host_ptr</varname>
is not NULL and <varname>image_slice_pitch</varname> =
0, <varname>image_slice_pitch</varname> is calculated as
<varname>image_row_pitch</varname> * <varname>image_height</varname>
for a 2D image array or 3D image and <varname>image_row_pitch</varname>
for a 1D image array. If <varname>image_slice_pitch</varname> is not 0,
it must be a multiple of the <varname>image_row_pitch</varname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>num_mip_level</term>, <term>num_samples</term>
<listitem>
<para>
Must be 0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>buffer</term>
<listitem>
<para>
Refers to a valid buffer memory object if <varname>image_type</varname>
is <constant>CL_MEM_OBJECT_IMAGE1D_BUFFER</constant>. 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 <varname>image_width</varname> * size of element in bytes
must be ≤ size of buffer object data store.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ================================ DESCRIPTION -->
<refsect1 id="note"><title>Note</title>
<para>
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.
</para>
</refsect1>
<!-- ================================ EXAMPLE -->
<!-- DO NOT DELETE IN CASE AN EXAMPLE IS ADDED IN THE FUTURE -->
<!--
<refsect2 id="example1">
<title>
Example
</title>
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
<tbody>
<row>
<entry>
Example goes here - it will be set in "code" type with white space preserved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect2>
-->
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
-->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<!-- Links to the 'Image Format Descriptor' sec of spec -->
<olink uri="imageDescriptor">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>cl_image_format</refentrytitle></citerefentry>
</para>
</refsect1>
<!-- ============================== COPYRIGHT -->
<!-- Content included from copyright.inc.xsl -->
<refsect3 id="Copyright"><title></title>
<imageobject>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
</imageobject>
<para />
</refsect3>
<!-- 16-Oct-2011 -->
</refentry>
|
