rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glBindTexture.xml
diff --git a/upstream-doc/man3/xhtml/glBindTexture.xml b/upstream-doc/man3/xhtml/glBindTexture.xml
new file mode 100644 (file)
index 0000000..ff2afaa
--- /dev/null
@@ -0,0 +1,109 @@
+<?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>glBindTexture - OpenGL 3.3 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glBindTexture"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindTexture — bind a named texture to a texturing target</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBindTexture</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">texture</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>target</code></em></span></dt><dd><p>
+                    Specifies the target to which the texture is bound.
+                    Must be either
+                    <code class="constant">GL_TEXTURE_1D</code>,
+                    <code class="constant">GL_TEXTURE_2D</code>,
+                    <code class="constant">GL_TEXTURE_3D</code>, or
+                    <code class="constant">GL_TEXTURE_1D_ARRAY</code>,
+                    <code class="constant">GL_TEXTURE_2D_ARRAY</code>,
+                    <code class="constant">GL_TEXTURE_RECTANGLE</code>,
+                    <code class="constant">GL_TEXTURE_CUBE_MAP</code>,
+                    <code class="constant">GL_TEXTURE_BUFFER</code>,
+                    <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> or
+                    <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>.
+                </p></dd><dt><span class="term"><em class="parameter"><code>texture</code></em></span></dt><dd><p>
+                    Specifies the name of a texture.
+                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
+            <code class="function">glBindTexture</code> lets you create or use a named texture. Calling <code class="function">glBindTexture</code> with
+            <em class="parameter"><code>target</code></em> set to
+            <code class="constant">GL_TEXTURE_1D</code>,
+            <code class="constant">GL_TEXTURE_2D</code>,
+            <code class="constant">GL_TEXTURE_3D</code>, or
+            <code class="constant">GL_TEXTURE_1D_ARRAY</code>,
+            <code class="constant">GL_TEXTURE_2D_ARRAY</code>,
+            <code class="constant">GL_TEXTURE_RECTANGLE</code>,
+            <code class="constant">GL_TEXTURE_CUBE_MAP</code>,
+            <code class="constant">GL_TEXTURE_BUFFER</code>,
+            <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> or
+            <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>
+            and <em class="parameter"><code>texture</code></em> set to the name of the new texture binds the texture name to the target.
+            When a texture is bound to a target, the previous binding for that target is automatically broken.
+        </p><p>
+            Texture names are unsigned integers. The value zero is reserved to
+            represent the default texture for each texture target.
+            Texture names and the corresponding texture contents are local to
+            the shared object space of the current GL rendering context;
+            two rendering contexts share texture names only if they
+            explicitly enable sharing between contexts through the appropriate GL windows interfaces functions.
+        </p><p>
+            You must use <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a> to generate a set of new texture names.
+        </p><p>
+            When a texture is first bound, it assumes the specified target:
+            A texture first bound to <code class="constant">GL_TEXTURE_1D</code> becomes one-dimensional texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_2D</code> becomes two-dimensional texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_3D</code> becomes three-dimensional texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_1D_ARRAY</code> becomes one-dimensional array texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_2D_ARRAY</code> becomes two-dimensional arary texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_RECTANGLE</code> becomes rectangle texture, a,
+            texture first bound to <code class="constant">GL_TEXTURE_CUBE_MAP</code> becomes a cube-mapped texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_BUFFER</code> becomes a buffer texture, a
+            texture first bound to <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> becomes a two-dimensional multisampled texture, and a
+            texture first bound to <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> becomes a two-dimensional multisampled array texture.
+            The state of a one-dimensional texture immediately after it is first bound is equivalent to the state of the
+            default <code class="constant">GL_TEXTURE_1D</code> at GL initialization, and similarly for the other texture types.
+        </p><p>
+            While a texture is bound, GL operations on the target to which it is
+            bound affect the bound texture, and queries of the target to which it
+            is bound return state from the bound texture. 
+            In effect, the texture targets become aliases for the textures currently
+            bound to them, and the texture name zero refers to the default textures
+            that were bound to them at initialization.
+        </p><p>
+            A texture binding created with <code class="function">glBindTexture</code> remains active until a different
+            texture is bound to the same target, or until the bound texture is
+            deleted with <a href="glDeleteTextures.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>.
+        </p><p>
+            Once created, a named texture may be re-bound to its same original target as often as needed.
+            It is usually much faster to use <code class="function">glBindTexture</code> to bind an existing named
+            texture to one of the texture targets than it is to reload the texture image
+            using <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>, <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
+            <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> or another similar function.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
+            The <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> and <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> targets are available
+            only if the GL version is 3.2 or higher.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
+            <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable
+            values.
+        </p><p>
+            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not a name returned from
+            a previous call to <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>.
+        </p><p>
+            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>texture</code></em> was previously created with a target
+            that doesn't match that of <em class="parameter"><code>target</code></em>.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_BINDING_1D</code>,
+            <code class="constant">GL_TEXTURE_BINDING_2D</code>, <code class="constant">GL_TEXTURE_BINDING_3D</code>, <code class="constant">GL_TEXTURE_BINDING_1D_ARRAY</code>,
+            <code class="constant">GL_TEXTURE_BINDING_2D_ARRAY</code>, <code class="constant">GL_TEXTURE_BINDING_RECTANGLE</code>, <code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE</code>,
+            or <code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</code>.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+            <a href="glDeleteTextures.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>,
+            <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>,
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>,
+            <a href="glGetTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexParameter</span></span></a>,
+            <a href="glIsTexture.xml"><span class="citerefentry"><span class="refentrytitle">glIsTexture</span></span></a>,
+            <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
+            <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
+            <a href="glTexImage2DMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2DMultisample</span></span></a>,
+            <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
+            <a href="glTexImage3DMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3DMultisample</span></span></a>,
+            <a href="glTexBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glTexBuffer</span></span></a>,
+            <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</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>© 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
+        </p></div></div></body></html>