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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
xmlns="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glTexSubImage2D</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glTexSubImage1D.3G.xml" title="glTexSubImage1D"/><link rel="next" href="glTexSubImage3D.3G.xml" title="glTexSubImage3D"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glTexSubImage2D</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glTexSubImage1D.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glTexSubImage3D.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glTexSubImage2D.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glTexSubImage2D.3G-name"/><h2>Name</h2><p>glTexSubImage2D, glTexSubImage2Db, glTexSubImage2Df, glTexSubImage2Di, glTexSubImage2Ds, glTexSubImage2Dub, glTexSubImage2Dui, glTexSubImage2Dus — specify a two-dimensional texture subimage</p></div><div class="refsynopsisdiv"><a name="glTexSubImage2D.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glTexSubImage2D</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>target</tt></i>, GLint<i><tt>level</tt></i>, GLint<i><tt>xoffset</tt></i>, GLint<i><tt>yoffset</tt></i>, GLsizei<i><tt>width</tt></i>, GLsizei<i><tt>height</tt></i>, GLenum<i><tt>format</tt></i>, GLenum<i><tt>type</tt></i>, constGLvoid*<i><tt>pixels</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glTexSubImage2D.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glTexSubImage2D</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>width</tt></i>, <i><tt>height</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Db</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Df</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Di</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Ds</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Dub</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Dui</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr><tr><td valign="top"><code><tt>glTexSubImage2Dus</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>level</tt></i>, <i><tt>xoffset</tt></i>, <i><tt>yoffset</tt></i>, <i><tt>format</tt></i>, <i><tt>type</tt></i>, <i><tt>pixels</tt></i>[][][]) →<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>target</tt></i></span></dt><dd>
Specifies the target texture. Must be <tt>GL_TEXTURE_2D</tt>.
</dd><dt><span class="term"><i><tt>level</tt></i></span></dt><dd>
Specifies the level-of-detail number. Level 0 is the base image level. Level <span class="emphasis"><em>n</em></span> is the
<span class="emphasis"><em>n</em></span>th mipmap reduction image.
</dd><dt><span class="term"><i><tt>xoffset</tt></i></span></dt><dd>
Specifies a texel offset in the x direction within the texture array.
</dd><dt><span class="term"><i><tt>yoffset</tt></i></span></dt><dd>
Specifies a texel offset in the y direction within the texture array.
</dd><dt><span class="term"><i><tt>width</tt></i></span></dt><dd>
Specifies the width of the texture subimage.
</dd><dt><span class="term"><i><tt>height</tt></i></span></dt><dd>
Specifies the height of the texture subimage.
</dd><dt><span class="term"><i><tt>format</tt></i></span></dt><dd>
Specifies the of the pixel data. The following symbolic values are accepted:
<tt>GL_COLOR_INDEX</tt>, <tt>GL_RED</tt>, <tt>GL_GREEN</tt>,
<tt>GL_BLUE</tt>, <tt>GL_ALPHA</tt>, <tt>GL_RGB</tt>,
<tt>GL_BGR</tt>, <tt>GL_RGBA</tt>, <tt>GL_BGRA</tt>,
<tt>GL_LUMINANCE</tt>, and <tt>GL_LUMINANCE_ALPHA</tt>.
</dd><dt><span class="term"><i><tt>type</tt></i></span></dt><dd>
Specifies the data type of the pixel data. The following symbolic values are accepted:
<tt>GL_UNSIGNED_BYTE</tt>, <tt>GL_BYTE</tt>, <tt>GL_BITMAP</tt>,
<tt>GL_UNSIGNED_SHORT</tt>, <tt>GL_SHORT</tt>,
<tt>GL_UNSIGNED_INT</tt>, <tt>GL_INT</tt>, <tt>GL_FLOAT</tt>,
<tt>GL_UNSIGNED_BYTE_3_3_2</tt>, <tt>GL_UNSIGNED_BYTE_2_3_3_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_6_5</tt>, <tt>GL_UNSIGNED_SHORT_5_6_5_REV</tt>,
<tt>GL_UNSIGNED_SHORT_4_4_4_4</tt>, <tt>GL_UNSIGNED_SHORT_4_4_4_4_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_5_5_1</tt>, <tt>GL_UNSIGNED_SHORT_1_5_5_5_REV</tt>,
<tt>GL_UNSIGNED_INT_8_8_8_8</tt>, <tt>GL_UNSIGNED_INT_8_8_8_8_REV</tt>,
<tt>GL_UNSIGNED_INT_10_10_10_2</tt>, and <tt>GL_UNSIGNED_INT_2_10_10_10_REV</tt>.
</dd><dt><span class="term"><i><tt>pixels</tt></i></span></dt><dd>
Specifies a pointer to the image data in memory.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-description"/><h2>Description</h2><p>
Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To
enable and disable two-dimensional texturing, call <a href="glEnable.3G.xml"><tt>glEnable</tt></a> and <a href="glEnable.3G.xml"><tt>glDisable</tt></a> with argument <tt>GL_TEXTURE_2D</tt>.
</p><p>
<tt>glTexSubImage2D</tt> redefines a contiguous subregion of an existing two-dimensional texture image. The
texels referenced by <i><tt>pixels</tt></i> replace the portion of the existing texture array with x indices
<i><tt>xoffset</tt></i> and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:mi>xoffset</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi>width</mml:mi>
<mml:mo>-</mml:mo>
<mml:mn>1</mml:mn>
</mml:mrow>
</mml:math>, inclusive, and y indices <i><tt>yoffset</tt></i> and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:mi>yoffset</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi>height</mml:mi>
<mml:mo>-</mml:mo>
<mml:mn>1</mml:mn>
</mml:mrow>
</mml:math>, inclusive. This region may not include any texels outside the range of the texture array as it was
originally specified. It is not an error to specify a subtexture with zero width or height, but such a specification
has no effect.
</p></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-notes"/><h2>Notes</h2><p>
<tt>glTexSubImage2D</tt> is available only if the GL version is 1.1 or greater.
</p><p>
Texturing has no effect in color index mode.
</p><p>
<tt>glPixelStore</tt> and <tt>glPixelTransfer</tt>
modes affect texture images in exactly the way they affect <a href="glDrawPixels.3G.xml"><tt>glDrawPixels</tt></a>.
</p><p>
Formats <tt>GL_BGR</tt>, and <tt>GL_BGRA</tt> and types
<tt>GL_UNSIGNED_BYTE_3_3_2</tt>, <tt>GL_UNSIGNED_BYTE_2_3_3_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_6_5</tt>, <tt>GL_UNSIGNED_SHORT_5_6_5_REV</tt>,
<tt>GL_UNSIGNED_SHORT_4_4_4_4</tt>, <tt>GL_UNSIGNED_SHORT_4_4_4_4_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_5_5_1</tt>, <tt>GL_UNSIGNED_SHORT_1_5_5_5_REV</tt>,
<tt>GL_UNSIGNED_INT_8_8_8_8</tt>, <tt>GL_UNSIGNED_INT_8_8_8_8_REV</tt>,
<tt>GL_UNSIGNED_INT_10_10_10_2</tt>, and <tt>GL_UNSIGNED_INT_2_10_10_10_REV</tt> are available
only if the GL version is 1.2 or greater.
</p><p>
When the <tt>GL_ARB_multitexture</tt> extension is supported, <tt>glTexSubImage2D</tt>
specifies a two-dimensional sub texture for the current texture unit, specified with <a href="glActiveTextureARB.3G.xml"><tt>glActiveTextureARB</tt></a>.
</p><p>
When the <tt>GL_ARB_imaging</tt> extension is supported, the RGBA components specified in
<i><tt>pixels</tt></i> may be processed by the imaging pipeline. See <a href="glTexImage1D.3G.xml"><tt>glTexImage1D</tt></a> for specific details.
</p></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-errors"/><h2>Errors</h2><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>target</tt></i> is not
<tt>GL_TEXTURE_2D</tt>.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if the texture array has not been defined by a previous
<a href="glTexImage2D.3G.xml"><tt>glTexImage2D</tt></a> operation.
</p><p>
<tt>GL_INVALID_VALUE</tt> is generated if <i><tt>level</tt></i> is less than 0.
</p><p>
<tt>GL_INVALID_VALUE</tt> may be generated if <i><tt>level</tt></i> is greater than <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:msub>
<mml:mo>log</mml:mo>
<mml:mn>2</mml:mn>
</mml:msub>
</mml:math><i><tt>max</tt></i>, where <i><tt>max</tt></i> is the returned value of
<tt>GL_MAX_TEXTURE_SIZE</tt>.
</p><p>
<tt>GL_INVALID_VALUE</tt> is generated if <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:mi>xoffset</mml:mi>
<mml:mo><</mml:mo>
<mml:mo>-b</mml:mo>
</mml:mrow>
</mml:math>, <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mfenced separator=",">
<mml:mrow>
<mml:mi>xoffset</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi>width</mml:mi>
</mml:mrow>
</mml:mfenced>
<mml:mo>></mml:mo>
<mml:mfenced separator=",">
<mml:mrow>
<mml:mi>w</mml:mi>
<mml:mo>-</mml:mo>
<mml:mi>b</mml:mi>
</mml:mrow>
</mml:mfenced>
</mml:math>, <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:mi>yoffset</mml:mi>
<mml:mo><</mml:mo>
<mml:mo>-b</mml:mo>
</mml:mrow>
</mml:math>, or <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:mo>(</mml:mo>
<mml:mi>yoffset</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi>height</mml:mi>
<mml:mo>)</mml:mo>
<mml:mo>></mml:mo>
<mml:mo>(</mml:mo>
<mml:mi>h</mml:mi>
<mml:mo>-</mml:mo>
<mml:mi>b</mml:mi>
<mml:mo>)</mml:mo>
</mml:mrow>
</mml:math>, where <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>w</mml:mi>
</mml:math> is the <tt>GL_TEXTURE_WIDTH</tt>, <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>h</mml:mi>
</mml:math> is the <tt>GL_TEXTURE_HEIGHT</tt>, and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>b</mml:mi>
</mml:math> is the border width of the texture image being modified. Note that <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>w</mml:mi>
</mml:math> and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mi>h</mml:mi>
</mml:math> include twice the border width.
</p><p>
<tt>GL_INVALID_VALUE</tt> is generated if <i><tt>width</tt></i> or <i><tt>height</tt></i> is
less than 0.
</p><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>format</tt></i> is not an accepted constant.
</p><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>type</tt></i> is not a type constant.
</p><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>type</tt></i> is <tt>GL_BITMAP</tt> and
<i><tt>format</tt></i> is not <tt>GL_COLOR_INDEX</tt>.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glTexSubImage2D</tt> is executed between the
execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <i><tt>type</tt></i> is one of
<tt>GL_UNSIGNED_BYTE_3_3_2</tt>, <tt>GL_UNSIGNED_BYTE_2_3_3_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_6_5</tt>, or <tt>GL_UNSIGNED_SHORT_5_6_5_REV</tt> and
<i><tt>format</tt></i> is not <tt>GL_RGB</tt>.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <i><tt>type</tt></i> is one of
<tt>GL_UNSIGNED_SHORT_4_4_4_4</tt>, <tt>GL_UNSIGNED_SHORT_4_4_4_4_REV</tt>,
<tt>GL_UNSIGNED_SHORT_5_5_5_1</tt>, <tt>GL_UNSIGNED_SHORT_1_5_5_5_REV</tt>,
<tt>GL_UNSIGNED_INT_8_8_8_8</tt>, <tt>GL_UNSIGNED_INT_8_8_8_8_REV</tt>,
<tt>GL_UNSIGNED_INT_10_10_10_2</tt>, or <tt>GL_UNSIGNED_INT_2_10_10_10_REV</tt> and
<i><tt>format</tt></i> is neither <tt>GL_RGBA</tt> nor <tt>GL_BGRA</tt>.
</p></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-associated_gets"/><h2>Associated Gets</h2><p>
<a href="glGetTexImage.3G.xml"><tt>glGetTexImage</tt></a>
</p><p>
<a href="glIsEnabled.3G.xml"><tt>glIsEnabled</tt></a> with argument <tt>GL_TEXTURE_2D</tt>
</p></div><div class="refsect1" lang="en"><a name="glTexSubImage2D.3G-see_also"/><h2>See Also</h2><p>
<span class="simplelist"><a href="glActiveTextureARB.3G.xml">glActiveTextureARB</a>, <a href="glCopyTexImage1D.3G.xml">glCopyTexImage1D</a>, <a href="glCopyTexImage2D.3G.xml">glCopyTexImage2D</a>, <a href="glCopyTexSubImage1D.3G.xml">glCopyTexSubImage1D</a>, <a href="glCopyTexSubImage2D.3G.xml">glCopyTexSubImage2D</a>, <a href="glCopyTexSubImage3D.3G.xml">glCopyTexSubImage3D</a>, <a href="glDrawPixels.3G.xml">glDrawPixels</a>, <a href="glPixelStore.3G.xml">glPixelStore</a>, <a href="glPixelTransfer.3G.xml">glPixelTransfer</a>, <a href="glTexEnv.3G.xml">glTexEnv</a>, <a href="glTexGen.3G.xml">glTexGen</a>, <a href="glTexImage1D.3G.xml">glTexImage1D</a>, <a href="glTexImage2D.3G.xml">glTexImage2D</a>, <a href="glTexImage3D.3G.xml">glTexImage3D</a>, <a href="glTexSubImage1D.3G.xml">glTexSubImage1D</a>, <a href="glTexSubImage3D.3G.xml">glTexSubImage3D</a>, <a href="glTexParameter.3G.xml">glTexParameter</a></span>
</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glTexSubImage1D.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glTexSubImage3D.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glTexSubImage1D</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glTexSubImage3D</td></tr></table></div></body></html>
|
