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
|
<?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">[
<!ENTITY imageFunctionsInc SYSTEM "imageFunctionsInc.xml">
]>
<refentry>
<refentryinfo>
<keywordset>
<keyword>Image Read and Write Functions</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>Image Read, Write, and Query Functions</refentrytitle>
<refmiscinfo>
<copyright>
<year>2007-2011</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>
<refnamediv>
<refname>Image Read and Write Functions</refname>
<refpurpose>Built-in functions to read, write, and query image memory objects. Click an item in the table below for details about that function.</refpurpose>
</refnamediv>
<refsect1 id="springboard">
<title></title>
<informaltable frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colnum="1" colwidth="2*" colname="col1" />
<colspec colnum="2" colwidth="8*" colname="col2" />
<tbody>
<!-- 1D FUNCTIONS -->
<row>
<entry><citerefentry href="read_imagef1d"> <refentrytitle>read_imagef</refentrytitle></citerefentry> for 1D</entry>
<entry>
Do an element lookup in the 1D image object with or without a sampler,
returning floating-point values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imagei1d"> <refentrytitle>read_image{i|ui}</refentrytitle></citerefentry> for 1D</entry>
<entry>
Do an element lookup in the 1D image object with or without a sampler,
returning unnormalized signed integer and unsigned integer values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imageh1d"> <refentrytitle>read_imageh</refentrytitle></citerefentry> for 1D</entry>
<entry>
OPTIONAL function to do an element lookup in the 1D image object
with or without a sampler, returning floating-point values. Enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<row>
<entry><citerefentry href="write_image1d"> <refentrytitle>write_image {f|i|ui|h}</refentrytitle>
</citerefentry> for 1D
</entry>
<entry>
Write <varname>color</varname> value to location in the 2D image object.
The <type>half</type> type is enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<!-- 2D FUNCTIONS -->
<row>
<entry><citerefentry href="read_imagef2d"> <refentrytitle>read_imagef</refentrytitle></citerefentry> for 2D</entry>
<entry>
Do an element lookup in the 2D image object with or without a sampler,
returning floating-point values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imagei2d"> <refentrytitle>read_image{i|ui}</refentrytitle></citerefentry> for 2D
</entry>
<entry>
Do an element lookup in the 2D image object with or without a sampler,
returning unnormalized signed integer and unsigned integer values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imageh2d"> <refentrytitle>read_imageh</refentrytitle></citerefentry> for 2D</entry>
<entry>
OPTIONAL function to do an element lookup in the 2D image object with
or without a sampler, returning floating-point values. Enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<row>
<entry><citerefentry href="write_image2d">
<refentrytitle>write_image {f|i|ui|h}</refentrytitle>
</citerefentry> for 2D
</entry>
<entry>
Write <varname>color</varname> value to location in the 2D image object.
The <type>half</type> type is enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<!-- 3D FUNCTIONS -->
<row>
<entry><citerefentry href="read_imagef3d">
<refentrytitle>read_imagef</refentrytitle></citerefentry> for 3D
</entry>
<entry>
Do an element lookup in the 3D image object with or without a sampler,
returning floating-point values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imagei3d">
<refentrytitle>read_image{i|ui}</refentrytitle></citerefentry> for 3D
</entry>
<entry>
Do an element lookup in the 3D image object with or without a sampler,
returning unnormalized signed integer and unsigned integer values.
</entry>
</row>
<row>
<entry><citerefentry href="read_imageh3d">
<refentrytitle>read_imageh</refentrytitle></citerefentry> for 3D
</entry>
<entry>
OPTIONAL function to do an element lookup in the 3D image object with or
without a sampler, returning floating-point values. Enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<row>
<entry><citerefentry href="write_image3d">
<refentrytitle>write_image {f|i|ui|h}</refentrytitle>
</citerefentry> for 3D
</entry>
<entry>
Write <varname>color</varname> value to location in the 2D image object.
The <type>half</type> type is enabled with
<citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>.
</entry>
</row>
<!-- <row>
<entry><citerefentry href="cl_khr_3d_image_writes">
<refentrytitle>write_image{f|i|ui}</refentrytitle></citerefentry> for 3D</entry>
<entry>OPTIONAL function to write <varname>color</varname> value in a 3D object. Enabled with <citerefentry><refentrytitle>cl_khr_3d_image_writes</refentrytitle></citerefentry>.</entry>
</row> -->
<!-- IMAGE QUERY FUNCTIONS -->
<row>
<entry><citerefentry> <refentrytitle>get_image_width</refentrytitle> </citerefentry></entry>
<entry>Return the image width in pixels</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_height</refentrytitle> </citerefentry></entry>
<entry>Return the image height in pixels.</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_depth</refentrytitle> </citerefentry></entry>
<entry>Return the 3D image depth in pixels</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_channel_data_type</refentrytitle> </citerefentry></entry>
<entry>Return the image channel data type</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_channel_order</refentrytitle> </citerefentry></entry>
<entry>Return the image channel order</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_dim</refentrytitle> </citerefentry></entry>
<entry>Return the image dimensions</entry>
</row>
<row>
<entry><citerefentry> <refentrytitle>get_image_array_size</refentrytitle> </citerefentry></entry>
<entry>Return the number of images in an image array</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
&imageFunctionsInc;
</refsect1>
<!-- ================================ SPECIFICATION -->
<refsect1 id="specification"><title>Specification</title>
<para>
<imageobject>
<imagedata fileref="pdficon_small1.gif" format="gif" />
</imageobject>
<olink uri="imageFunctions">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry><refentrytitle>sampler_t</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>cl_khr_3d_image_writes</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>
|
