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
|
<?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">
<!ENTITY imageMappingInc SYSTEM "imageMappingInc.xml">
]>
<refentry>
<refentryinfo>
<keywordset>
<keyword>read_imagei (3D)</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>read_imagei (3D)</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="read_image2d">
<refname>read_imagei (3D)</refname>
<refpurpose>
Do an element lookup in the 3D image object, returning unnormalized signed integer and unsigned integer values
</refpurpose>
</refnamediv>
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<function>
read_imagei
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="sampler_t.html">sampler_t</link>
<parameter>sampler</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<function>
read_imagei
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="sampler_t.html">sampler_t</link>
<parameter>sampler</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">float4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">uint4</link>
<function>
read_imageui
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="sampler_t.html">sampler_t</link>
<parameter>sampler</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">uint4</link>
<function>
read_imageui
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="sampler_t.html">sampler_t</link>
<parameter>sampler</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">float4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<!-- SAMPLER-LESS FORMS -->
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<function>
read_imagei
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="vectorDataTypes.html">uint4</link>
<function>
read_imageui
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image3d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
<!-- core spec pp. 293 and 300, section 6.12.14.2 --> The forms that take
a <type>sampler_t</type> use the coordinate <emphasis>(coord.x, coord.y,
coord.z))</emphasis> to do an element lookup in the 3D image object specified by
<varname>image</varname>. <varname>coord.w</varname> is ignored.
</para>
<para>
<!-- core spec p. 298, section 6.12.14.3 --> The samplerless read image functions behave
exactly as the corresponding read image functions that take integer coordinates and a
sampler with filter mode set to <constant>CLK_FILTER_NEAREST</constant>, normalized
coordinates set to <constant>CLK_NORMALIZED_COORDS_FALSE</constant> and addressing
mode to <constant>CLK_ADDRESS_NONE</constant>.
</para>
<para>
<function>read_imagei</function> and <function>read_imageui</function> return
unnormalized signed integer and unsigned integer values respectively. Each channel
will be stored in a 32-bit integer.
</para>
<para>
<function>read_imagei</function> can only be used with image objects created with
<varname>image_channel_data_type</varname> set to one of the following values:
<constant>CL_SIGNED_INT8</constant>, <constant>CL_SIGNED_INT16</constant>, or
<constant>CL_SIGNED_INT32</constant>. If the <varname>image_channel_data_type</varname>
is not one of the above values, the values returned by <function>read_imagei</function>
are undefined.
</para>
<para>
<function>read_imageui</function> can only be used with image objects created with
<varname>image_channel_data_type</varname> set to one of the following values:
<constant>CL_UNSIGNED_INT8</constant>, <constant>CL_UNSIGNED_INT16</constant>, and
<constant>CL_UNSIGNED_INT32</constant>. If the <varname>image_channel_data_type</varname>
is not one of the above values, the values returned by <function>read_imageui</function>
are undefined.
</para>
<para>
The <function>read_imageui</function> calls support a nearest filter
only. The filter_mode specified in <varname>sampler</varname> must be set to
<constant>CLK_FILTER_NEAREST</constant>; otherwise the values returned are undefined.
</para>
<para>
Furthermore, the <function>read_image{i|ui}</function> calls that take
integer coordinates must use a sampler with normalized coordinates set to
<constant>CLK_NORMALIZED_COORDS_FALSE</constant> and addressing mode set to
<constant>CLK_ADDRESS_CLAMP_TO_EDGE</constant>, <constant>CLK_ADDRESS_CLAMP</constant>
or <constant>CLK_ADDRESS_NONE</constant>; otherwise the values returned are undefined.
</para>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
&imageFunctionsInc;
&imageMappingInc;
</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>
<!-- 13-Oct-2011 -->
</refentry>
|