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
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="imageLoad">
<info>
<copyright>
<year>2011-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>imageLoad</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>imageLoad</refname>
<refpurpose>load a single texel from an image</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Declaration</title>
<funcsynopsis>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage1D <parameter>image</parameter></paramdef>
<paramdef>int <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage2D <parameter>image</parameter></paramdef>
<paramdef>ivec2 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage3D <parameter>image</parameter></paramdef>
<paramdef>ivec3 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage2DRect <parameter>image</parameter></paramdef>
<paramdef>ivec2 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimageCube <parameter>image</parameter></paramdef>
<paramdef>ivec3 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gbufferImage <parameter>image</parameter></paramdef>
<paramdef>int <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage1DArray <parameter>image</parameter></paramdef>
<paramdef>ivec2 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage2DArray <parameter>image</parameter></paramdef>
<paramdef>ivec3 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimageCubeArray <parameter>image</parameter></paramdef>
<paramdef>ivec3 <parameter>P</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage2DMS <parameter>image</parameter></paramdef>
<paramdef>ivec2 <parameter>P</parameter></paramdef>
<paramdef>int <parameter>sample</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>gvec4 <function>imageLoad</function></funcdef>
<paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>
<paramdef>ivec3 <parameter>P</parameter></paramdef>
<paramdef>int <parameter>sample</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>image</parameter></term>
<listitem>
<para>
Specify the image unit from which to load a texel.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>P</parameter></term>
<listitem>
<para>
Specify the coordinate from which to load the texel.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sample</parameter></term>
<listitem>
<para>
When present, specifies the sample within the image to load
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>imageLoad</function> loads the texel at the coordinate <parameter>P</parameter> from the image
unit <parameter>image</parameter>. For multi-sample loads, the sample number is given by <parameter>sample</parameter>. When
<parameter>image</parameter>, <parameter>P</parameter>, <parameter>sample</parameter> 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.
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry>imageLoad</entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='42']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 2011-2014 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.
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
