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
|
<?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>get_image_channel_data_type</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>get_image_channel_data_type</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>
<!-- ================================ SYNOPSIS -->
<refnamediv id="get_image_channel_data_type">
<refname>get_image_channel_data_type</refname>
<refpurpose>
Return the channel data type.
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image1d_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image1d_buffer_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image1d_array_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">int</link>
<function>
get_image_channel_data_type
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_array_t</link>
<parameter>image</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
Return the channel data type. Valid values are:<literallayout>
CLK_SNORM_INT8
CLK_SNORM_INT16
CLK_UNORM_INT8
CLK_UNORM_INT16
CLK_UNORM_SHORT_565
CLK_UNORM_SHORT_555
CLK_UNORM_SHORT_101010
CLK_SIGNED_INT8
CLK_SIGNED_INT16
CLK_SIGNED_INT32
CLK_UNSIGNED_INT8
CLK_UNSIGNED_INT16
CLK_UNSIGNED_INT32
CLK_HALF_FLOAT
CLK_FLOAT</literallayout>
</para>
</refsect1>
<!-- ================================ NOTES -->
<!-- This table could be in an included file, shared with other functions. -->
<refsect1 id="notes"><title>Notes</title>
<para>
The values returned by <function>get_image_channel_order</function>
as shown above with the <constant>CLK_</constant> prefixes correspond
to the <constant>CL_</constant> prefixes used to describe the image
channel order and data type in the table of supported names and values in
<citerefentry><refentrytitle>clCreateSubBuffer</refentrytitle></citerefentry>
and list of supported Image Channel Order Values for
<citerefentry><refentrytitle>clCreateImage</refentrytitle></citerefentry>. For
example, both <constant>CL_UNORM_INT8</constant> and <constant>CLK_UNORM_INT8</constant>
refer to an image channel data type that is an unnormalized unsigned 8-bit integer.
</para>
<para>
The following table describes the mapping of the number of channels of an image
element to the appropriate components in the float4, int4 or uint4 vector data type
for the color values returned by <function>read_image{f|i|ui}</function> or supplied
to <function>write_image{f|i|ui}</function>. The unmapped components will be set
to <constant>0.0</constant> for red, green and blue channels and will be set to
<constant>1.0</constant> for the alpha channel.
</para>
<para>
<informaltable frame="all">
<tgroup cols="2" align="center" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" />
<colspec colname="col2" colnum="2" />
<thead>
<row>
<entry>Channel Order</entry>
<entry><type>float4</type>, <type>int4</type> or <type>unsigned int4</type> components of channel data</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>CL_R</constant>, <constant>CL_Rx</constant></entry>
<entry><constant>(r, 0.0, 0.0, 1.0)</constant></entry>
</row>
<row>
<entry><constant>CL_A</constant></entry>
<entry><constant>(0.0, 0.0, 0.0, a)</constant></entry>
</row>
<row>
<entry><constant>CL_RG</constant>, <constant>CL_RGx</constant></entry>
<entry><constant>(r, g, 0.0, 1.0)</constant></entry>
</row>
<row>
<entry><constant>CL_RA</constant></entry>
<entry><constant>(r, 0.0, 0.0, a)</constant></entry>
</row>
<row>
<entry><constant>CL_RGB</constant>, <constant>CL_RGBx</constant></entry>
<entry><constant>(r, g, b, 1.0)</constant></entry>
</row>
<row>
<entry><constant>CL_RGBA, CL_BGRA, CL_ARGB</constant></entry>
<entry><constant>(r, g, b, a)</constant></entry>
</row>
<row>
<entry><constant>CL_INTENSITY</constant></entry>
<entry><constant>(I, I, I, I)</constant></entry>
</row>
<row>
<entry><constant>CL_LUMINANCE</constant></entry>
<entry><constant>(L, L, L, 1.0)</constant></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
A kernel that uses a sampler with the <constant>CL_ADDRESS_CLAMP</constant> addressing
mode with multiple images may result in additional samplers being used internally by an
implementation. If the same sampler is used with multiple images called via <citerefentry
href="read_imagef2d"><refentrytitle>read_image{f|i|ui}</refentrytitle></citerefentry>,
then it is possible that an implementation may need to allocate an additional
sampler to handle the different border color values that may be needed depending
on the image formats being used. These implementation allocated samplers
will count against the maximum sampler values supported by the device and
given by <constant>CL_DEVICE_MAX_SAMPLERS</constant>. Enqueuing a kernel that
requires more samplers than the implementation can support will result in a
<constant>CL_OUT_OF_RESOURCES</constant> error being returned.
</para>
</refsect1>
<!-- ================================ 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>
<olink uri="imageFunctions">OpenCL Specification</olink>
</para>
</refsect1>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<para>
<citerefentry href="imageFunctions"><refentrytitle>Image Functions</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>
<!-- 24-Oct-2011 -->
</refentry>
|
