File: glCopyTexSubImage1D.3G.xml

package info (click to toggle)
pyopengl 2.0.1.08-5.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 19,484 kB
  • ctags: 9,036
  • sloc: pascal: 64,950; xml: 28,088; ansic: 20,696; python: 19,761; tcl: 668; makefile: 240; sh: 25
file content (120 lines) | stat: -rw-r--r-- 10,745 bytes parent folder | download
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
<?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>glCopyTexSubImage1D</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="glCopyTexImage2D.3G.xml" title="glCopyTexImage2D"/><link rel="next" href="glCopyTexSubImage2D.3G.xml" title="glCopyTexSubImage2D"/></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">glCopyTexSubImage1D</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glCopyTexImage2D.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glCopyTexSubImage2D.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glCopyTexSubImage1D.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glCopyTexSubImage1D.3G-name"/><h2>Name</h2><p>glCopyTexSubImage1D &#8212; copy a one-dimensional texture subimage</p></div><div class="refsynopsisdiv"><a name="glCopyTexSubImage1D.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glCopyTexSubImage1D</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>x</tt></i>, GLint<i><tt>y</tt></i>, GLsizei<i><tt>width</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glCopyTexSubImage1D.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glCopyTexSubImage1D</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>x</tt></i>, <i><tt>y</tt></i>, <i><tt>width</tt></i>) &#8594;<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glCopyTexSubImage1D.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_1D</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 <i><tt>n</tt></i> is
						the <i><tt>n</tt></i>th mipmap reduction image.
					</dd><dt><span class="term"><i><tt>xoffset</tt></i></span></dt><dd>
						Specifies the texel offset within the texture array.
					</dd><dt><span class="term"><i><tt>x</tt></i>, <i><tt>y</tt></i></span></dt><dd>
						Specify the window coordinates of the left corner of the row of pixels to be copied.
					</dd><dt><span class="term"><i><tt>width</tt></i></span></dt><dd>
						Specifies the width of the texture subimage.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glCopyTexSubImage1D.3G-description"/><h2>Description</h2><p>
			<tt>glCopyTexSubImage1D</tt> replaces a portion of a one-dimensional texture image with pixels from the
			current <tt>GL_READ_BUFFER</tt> (rather than from main memory, as is the case for <a href="glTexSubImage1D.3G.xml"><tt>glTexSubImage1D</tt></a>).
		</p><p>
			The screen-aligned pixel row with left corner at (<i><tt>x</tt></i>,<i><tt>y</tt></i>), and with length
			<i><tt>width</tt></i> replaces the portion of the texture array with x indices <i><tt>xoffset</tt></i>
			through <i><tt>xoffset</tt></i>&#8201;+&#8201;<i><tt>width</tt></i>&#8201;-&#8201;1, inclusive. The
			destination in the texture array may not include any texels outside the texture array as it was originally specified.
		</p><p>
			The pixels in the row are processed exactly as if <a href="glCopyPixels.3G.xml"><tt>glCopyPixels</tt></a> had been
			called, but the process stops just before final conversion. At this point all pixel component values are clamped to the
			range <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mfenced separator="," open="[" close="]">
						<mml:mn>0</mml:mn>
						<mml:mn>1</mml:mn>
					</mml:mfenced>
				</mml:math> and then converted to the texture's internal for storage in the texel array.
		</p><p>
			It is not an error to specify a subtexture with zero width, but such a specification has no effect. If any of the
			pixels within the specified row of the current <tt>GL_READ_BUFFER</tt> are outside the read window
			associated with the current rendering context, then the values obtained for those pixels are undefined.
		</p><p>
			No change is made to the <i><tt>internalformat</tt></i>, <i><tt>width</tt></i>, or
			<i><tt>border</tt></i> parameters of the specified texture array or to texel values outside the specified
			subregion.
		</p></div><div class="refsect1" lang="en"><a name="glCopyTexSubImage1D.3G-notes"/><h2>Notes</h2><p>
			<tt>glCopyTexSubImage1D</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>
			When the <tt>GL_ARB_imaging</tt> extension is supported, the RGBA components copied from the framebuffer
			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="glCopyTexSubImage1D.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>target</tt></i> is not
			<tt>GL_TEXTURE_1D</tt>.
		</p><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if the texture array has not been defined by a previous
			<a href="glTexImage1D.3G.xml"><tt>glTexImage1D</tt></a> or <a href="glCopyTexImage1D.3G.xml"><tt>glCopyTexImage1D</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><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mo>&gt;</mml:mo>
					<mml:msub>
						<mml:mi>log</mml:mi>
						<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 <i><tt>y</tt></i><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mo>&lt;</mml:mo>
					<mml:mo>-</mml:mo>
					<mml:mi>b</mml:mi>
				</mml:math> or if <i><tt>width</tt></i><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mo>&lt;</mml:mo>
					<mml:mo>-</mml:mo>
					<mml:mi>b</mml:mi>
				</mml:math>, where <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 array.
		</p><p>
			<tt>GL_INVALID_VALUE</tt> is generated if <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mi>xoffset</mml:mi>
					<mml:mo>&lt;</mml:mo>
					<mml:mo>-</mml:mo>
					<mml:mi>b</mml:mi>
				</mml:math>, or <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>&gt;</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>, 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>, and <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
					<mml:mi>b</mml:mi>
				</mml:math> is the <tt>GL_TEXTURE_BORDER</tt> 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> includes twice the border width.
		</p></div><div class="refsect1" lang="en"><a name="glCopyTexSubImage1D.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_1D</tt>
		</p></div><div class="refsect1" lang="en"><a name="glCopyTexSubImage1D.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glCopyPixels.3G.xml">glCopyPixels</a>, <a href="glCopyTexImage1D.3G.xml">glCopyTexImage1D</a>, <a href="glCopyTexImage2D.3G.xml">glCopyTexImage2D</a>, <a href="glCopyTexSubImage2D.3G.xml">glCopyTexSubImage2D</a>, <a href="glCopyTexSubImage3D.3G.xml">glCopyTexSubImage3D</a>, <a href="glPixelStore.3G.xml">glPixelStore</a>, <a href="glPixelTransfer.3G.xml">glPixelTransfer</a>, <a href="glReadBuffer.3G.xml">glReadBuffer</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="glTexParameter.3G.xml">glTexParameter</a>, <a href="glTexSubImage1D.3G.xml">glTexSubImage1D</a>, <a href="glTexSubImage2D.3G.xml">glTexSubImage2D</a>, <a href="glTexSubImage3D.3G.xml">glTexSubImage3D</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="glCopyTexImage2D.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="glCopyTexSubImage2D.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glCopyTexImage2D</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glCopyTexSubImage2D</td></tr></table></div></body></html>