upstream-man-pages/manglsl/imageStore.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="imageStore">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>imageStore</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>imageStore</refname>
  17         <refpurpose>write a single texel into an image</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>imageStore</function></funcdef>
  23                 <paramdef>gimage1D <parameter>image</parameter></paramdef>
  24                 <paramdef>int <parameter>P</parameter></paramdef>
  25                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  26             </funcprototype>
  27             <funcprototype>
  28                 <funcdef>void <function>imageStore</function></funcdef>
  29                 <paramdef>gimage2D <parameter>image</parameter></paramdef>
  30                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  31                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  32             </funcprototype>
  33             <funcprototype>
  34                 <funcdef>void <function>imageStore</function></funcdef>
  35                 <paramdef>gimage3D <parameter>image</parameter></paramdef>
  36                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  37                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  38             </funcprototype>
  39             <funcprototype>
  40                 <funcdef>void <function>imageStore</function></funcdef>
  41                 <paramdef>gimage2DRect <parameter>image</parameter></paramdef>
  42                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  43                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  44             </funcprototype>
  45             <funcprototype>
  46                 <funcdef>void <function>imageStore</function></funcdef>
  47                 <paramdef>gimageCube <parameter>image</parameter></paramdef>
  48                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  49                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  50             </funcprototype>
  51             <funcprototype>
  52                 <funcdef>void <function>imageStore</function></funcdef>
  53                 <paramdef>gbufferImage <parameter>image</parameter></paramdef>
  54                 <paramdef>int <parameter>P</parameter></paramdef>
  55                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  56             </funcprototype>
  57             <funcprototype>
  58                 <funcdef>void <function>imageStore</function></funcdef>
  59                 <paramdef>gimage1DArray <parameter>image</parameter></paramdef>
  60                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  61                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  62             </funcprototype>
  63             <funcprototype>
  64                 <funcdef>void <function>imageStore</function></funcdef>
  65                 <paramdef>gimage2DArray <parameter>image</parameter></paramdef>
  66                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  67                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  68             </funcprototype>
  69             <funcprototype>
  70                 <funcdef>void <function>imageStore</function></funcdef>
  71                 <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>
  72                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  73                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  74             </funcprototype>
  75             <funcprototype>
  76                 <funcdef>void <function>imageStore</function></funcdef>
  77                 <paramdef>gimage2DMS <parameter>image</parameter></paramdef>
  78                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  79                 <paramdef>int <parameter>sample</parameter></paramdef>
  80                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  81             </funcprototype>
  82             <funcprototype>
  83                 <funcdef>void <function>imageStore</function></funcdef>
  84                 <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>
  85                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  86                 <paramdef>int <parameter>sample</parameter></paramdef>
  87                 <paramdef>gvec4 <parameter>data</parameter></paramdef>
  88             </funcprototype>
  89         </funcsynopsis>
  90     </refsynopsisdiv>
  91     <refsect1 id="parameters"><title>Parameters</title>
  92         <variablelist>
  93         <varlistentry>
  94             <term><parameter>image</parameter></term>
  95             <listitem>
  96                 <para>
  97                     Specify the image unit into which to store a texel.
  98                 </para>
  99             </listitem>
 100         </varlistentry>
 101         <varlistentry>
 102             <term><parameter>P</parameter></term>
 103             <listitem>
 104                 <para>
 105                     Specify the coordinate at which to store the texel.
 106                 </para>
 107             </listitem>
 108         </varlistentry>
 109         <varlistentry>
 110             <term><parameter>sample</parameter></term>
 111             <listitem>
 112                 <para>
 113                     When present, specifies the sample within the image to store into.
 114                 </para>
 115             </listitem>
 116         </varlistentry>
 117         <varlistentry>
 118             <term><parameter>data</parameter></term>
 119             <listitem>
 120                 <para>
 121                     Specifies the data to store into the image.
 122                 </para>
 123             </listitem>
 124         </varlistentry>
 125         </variablelist>
 126     </refsect1>
 127     <refsect1 id="description"><title>Description</title>
 128         <para>
 129             <function>imageStore</function> stores <parameter>data</parameter> into the texel at the coordinate <parameter>P</parameter> from
 130             the image specified by <parameter>image</parameter>.  For multi-sample stores, the sample number is given by <parameter>sample</parameter>.  When
 131             <parameter>image</parameter>, <parameter>P</parameter>, and <parameter>sample</parameter> identify a valid texel, the bits
 132             used to represent data are converted to the format of the image unit in the manner described in of the OpenGL Specification and stored to
 133             the specified texel.
 134         </para>
 135     </refsect1>
 136     <refsect1 id="versions"><title>Version Support</title>
 137         <informaltable frame="topbot">
 138             #VARTABLECOLS#
 139                 <thead>
 140                     #FUNCTABLEHEADER#
 141                     <row>
 142                         <entry>imageStore</entry>#newin42#
 143                     </row>
 144                 </thead>
 145             </tgroup>
 146         </informaltable>
 147     </refsect1>
 148     <refsect1 id="seealso"><title>See Also</title>
 149         <para>
 150             <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,
 151             <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,
 152             <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,
 153             <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,
 154             <citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,
 155             <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,
 156             <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,
 157             <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,
 158             <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>
 159         </para>
 160     </refsect1>
 161     <refsect1 id="Copyright"><title>Copyright</title>
 162         <para>
 163             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 164             This material may be distributed subject to the terms and conditions set forth in
 165             the Open Publication License, v 1.0, 8 June 1999.
 166             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 167         </para>
 168     </refsect1>
 169 </refentry>