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
|
<?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>write_image2d</keyword>
</keywordset>
</refentryinfo>
<refmeta>
<refentrytitle>write_image (2D)</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="write_image2d">
<refname>write_image</refname>
<refpurpose>
Write <varname>color</varname> value to location in a 2D image object.
</refpurpose>
</refnamediv>
<!-- FLOAT -->
<refsynopsisdiv xmlns:xlink="http://www.w3.org/1999/xlink"><title></title>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imagef
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int2</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">float4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imagef
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_array_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">float4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<!-- INT -->
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imagei
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int2</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imagei
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_array_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<!-- UINT -->
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imageui
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int2</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">uint4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imageui
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_array_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">uint4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<!-- HALF -->
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imageh
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int2</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">half4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis>
<funcprototype>
<funcdef>
<link xlink:href="scalarDataTypes.html">void</link>
<function>
write_imageh
</function>
</funcdef>
<paramdef>
<link xlink:href="otherDataTypes.html">image2d_array_t</link>
<parameter>image</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">int4</link>
<parameter>coord</parameter>
</paramdef>
<paramdef>
<link xlink:href="vectorDataTypes.html">half4</link>
<parameter>color</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
<para>
<function>write_imagef</function> can only be used with image objects created with
<varname>image_channel_data_type</varname> set to one of the pre-defined packed formats
or set to <constant>CL_SNORM_INT8</constant>, <constant>CL_UNORM_INT8</constant>,
<constant>CL_SNORM_INT16</constant>, <constant>CL_UNORM_INT16</constant>,
<constant>CL_HALF_FLOAT</constant> or <constant>CL_FLOAT</constant>. Appropriate data
format conversion will be done to convert channel data from a floating-point value to
actual data format in which the channels are stored.
</para>
<para>
<function>write_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>,
and <constant>CL_SIGNED_INT32</constant>.
</para>
<para>
<function>write_imageui</function> functions 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>,
or <constant>CL_UNSIGNED_INT32</constant>.
</para>
<para>
An application that wants to use <type>half</type> and
<type>half<replaceable>n</replaceable></type> types will need to include the <code>#pragma
OPENCL EXTENSION <citerefentry><refentrytitle>cl_khr_fp16</refentrytitle></citerefentry>
: enable</code> directive.
</para>
<para>
<function>write_imageh</function> can only be used with image objects created with
<varname>image_channel_data_type</varname> set to one of the pre-defined packed formats
or set to <constant>CL_SNORM_INT8</constant>, <constant>CL_UNORM_INT8</constant>,
<constant>CL_SNORM_INT16</constant>, <constant>CL_UNORM_INT16</constant> or
<constant>CL_HALF_FLOAT</constant>.
</para>
<bridgehead>Functions that take image2d_t</bridgehead>
<para>
For the functions that take an image_2d_t image, write color value to location specified by
<emphasis>coord.xy</emphasis> in the 2D image object specified by <varname>image</varname>.
Appropriate data format conversion to the specified image format is done before writing
the color value. <emphasis>coord.x</emphasis> and <emphasis>coord.y</emphasis> are
considered to be unnormalized coordinates and must be in the range 0 …
image width - 1, and 0 … image height - 1.
</para>
<para>
For functions that take image_2d_t, the behavior of <function>write_imagef</function>,
<function>write_imagei</function>, <function>write_imageui</function>,
and <function>write_imageh</function> for image objects created with
<varname>image_channel_data_type</varname> values not specified in the description
above or with <emphasis>(x, y)</emphasis> coordinate values that are not in the range
(0 … image width - 1, 0 … image height - 1), respectively, is undefined.
</para>
<bridgehead>Functions that take image2d_array_t</bridgehead>
<para>
For the functions that take an image_2d_array_t image, write color value
to location specified by <emphasis>coord.xy</emphasis> in the 2D image
identified by <emphasis>coord.z</emphasis> in the 2D image array specified by
<varname>image</varname>. Appropriate data format conversion to the specified
image format is done before writing the color value. <emphasis>coord.x</emphasis>,
<emphasis>coord.y</emphasis> and <emphasis>coord.z</emphasis> are considered to be
unnormalized coordinates and must be in the range 0 … image width - 1, 0 … image
height - 1 and 0 … image number of layers - 1.
</para>
<para>
For functions that take image_2d_array_t, the behavior of
<function>write_imagef</function>, <function>write_imagei</function>,
<function>write_imageui</function>, and <function>write_imageh</function> for image
objects created with <varname>image_channel_data_type</varname> values not specified in
the description above or with <emphasis>(x, y, z)</emphasis> coordinate values that are
not in the range (0 … image width - 1, 0 … image height - 1), respectively, is undefined.
</para>
</refsect1>
<!-- ================================ NOTES -->
<refsect1 id="notes"><title>Notes</title>
&imageFunctionsInc;
</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>
<!-- 12-Oct-2011 -->
</refentry>
|