<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>imageLoad - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="imageLoad"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>imageLoad — load a single texel from an image</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gimage1D <var class="pdparam">image</var>, int <var class="pdparam">P</var><code>)</code>;</p><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gimage2D <var class="pdparam">image</var>, ivec2 <var class="pdparam">P</var><code>)</code>;</p><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gimage3D <var class="pdparam">image</var>, ivec3 <var class="pdparam">P</var><code>)</code>;</p><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gimage2DRect <var class="pdparam">image</var>, ivec2 <var class="pdparam">P</var><code>)</code>;</p><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gimageCube <var class="pdparam">image</var>, ivec3 <var class="pdparam">P</var><code>)</code>;</p><p><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code>gbufferImage <var class="pdparam">image</var>, int <var class="pdparam">P</var><code>)</code>;</p><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code></td><td>gimage1DArray  </td><td><var class="pdparam">image</var>, </td></tr><tr><td> </td><td>ivec2  </td><td><var class="pdparam">P</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code></td><td>gimage2DArray  </td><td><var class="pdparam">image</var>, </td></tr><tr><td> </td><td>ivec3  </td><td><var class="pdparam">P</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code></td><td>gimageCubeArray  </td><td><var class="pdparam">image</var>, </td></tr><tr><td> </td><td>ivec3  </td><td><var class="pdparam">P</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code></td><td>gimage2DMS  </td><td><var class="pdparam">image</var>, </td></tr><tr><td> </td><td>ivec2  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">sample</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">gvec4 <b class="fsfunc">imageLoad</b>(</code></td><td>gimage2DMSArray  </td><td><var class="pdparam">image</var>, </td></tr><tr><td> </td><td>ivec3  </td><td><var class="pdparam">P</var>, </td></tr><tr><td> </td><td>int  </td><td><var class="pdparam">sample</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>image</code></em></span></dt><dd><p>
                    Specify the image unit from which to load a texel.
                </p></dd><dt><span class="term"><em class="parameter"><code>P</code></em></span></dt><dd><p>
                    Specify the coordinate from which to load the texel.
                </p></dd><dt><span class="term"><em class="parameter"><code>sample</code></em></span></dt><dd><p>
                    When present, specifies the sample within the image to load
                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
            <code class="function">imageLoad</code> loads the texel at the coordinate <em class="parameter"><code>P</code></em> from the image 
            unit <em class="parameter"><code>image</code></em>.  For multi-sample loads, the sample number is given by <em class="parameter"><code>sample</code></em>.  When 
            <em class="parameter"><code>image</code></em>, <em class="parameter"><code>P</code></em>, <em class="parameter"><code>sample</code></em> identify a valid texel, the bits used 
            to represent the selected texel in memory are converted to a vec4, ivec4, or uvec4 in the manner described in the OpenGL 
            Specification and returned.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">imageLoad</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
            <a href="imageStore.xml"><span class="citerefentry"><span class="refentrytitle">imageStore</span></span></a>,
            <a href="imageAtomicAdd.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicAdd</span></span></a>,
            <a href="imageAtomicMin.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicMin</span></span></a>,
            <a href="imageAtomicMax.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicMax</span></span></a>,
            <a href="imageAtomicAnd.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicAnd</span></span></a>,
            <a href="imageAtomicOr.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicOr</span></span></a>,
            <a href="imageAtomicXor.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicXor</span></span></a>,
            <a href="imageAtomicExchange.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicExchange</span></span></a>,
            <a href="imageAtomicCompSwap.xml"><span class="citerefentry"><span class="refentrytitle">imageAtomicCompSwap</span></span></a>
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2011 Khronos Group. 
            This material may be distributed subject to the terms and conditions set forth in 
            the Open Publication License, v 1.0, 8 June 1999.
            <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p></div></div></body></html>
