Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?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> | |
5 | Specifies the target to which the texture is bound. | |
6 | Must be either | |
7 | <code class="constant">GL_TEXTURE_1D</code>, | |
8 | <code class="constant">GL_TEXTURE_2D</code>, | |
9 | <code class="constant">GL_TEXTURE_3D</code>, or | |
10 | <code class="constant">GL_TEXTURE_1D_ARRAY</code>, | |
11 | <code class="constant">GL_TEXTURE_2D_ARRAY</code>, | |
12 | <code class="constant">GL_TEXTURE_RECTANGLE</code>, | |
13 | <code class="constant">GL_TEXTURE_CUBE_MAP</code>, | |
14 | <code class="constant">GL_TEXTURE_BUFFER</code>, | |
15 | <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> or | |
16 | <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>. | |
17 | </p></dd><dt><span class="term"><em class="parameter"><code>texture</code></em></span></dt><dd><p> | |
18 | Specifies the name of a texture. | |
19 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
20 | <code class="function">glBindTexture</code> lets you create or use a named texture. Calling <code class="function">glBindTexture</code> with | |
21 | <em class="parameter"><code>target</code></em> set to | |
22 | <code class="constant">GL_TEXTURE_1D</code>, | |
23 | <code class="constant">GL_TEXTURE_2D</code>, | |
24 | <code class="constant">GL_TEXTURE_3D</code>, or | |
25 | <code class="constant">GL_TEXTURE_1D_ARRAY</code>, | |
26 | <code class="constant">GL_TEXTURE_2D_ARRAY</code>, | |
27 | <code class="constant">GL_TEXTURE_RECTANGLE</code>, | |
28 | <code class="constant">GL_TEXTURE_CUBE_MAP</code>, | |
29 | <code class="constant">GL_TEXTURE_BUFFER</code>, | |
30 | <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> or | |
31 | <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> | |
32 | and <em class="parameter"><code>texture</code></em> set to the name of the new texture binds the texture name to the target. | |
33 | When a texture is bound to a target, the previous binding for that target is automatically broken. | |
34 | </p><p> | |
35 | Texture names are unsigned integers. The value zero is reserved to | |
36 | represent the default texture for each texture target. | |
37 | Texture names and the corresponding texture contents are local to | |
38 | the shared object space of the current GL rendering context; | |
39 | two rendering contexts share texture names only if they | |
40 | explicitly enable sharing between contexts through the appropriate GL windows interfaces functions. | |
41 | </p><p> | |
42 | 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. | |
43 | </p><p> | |
44 | When a texture is first bound, it assumes the specified target: | |
45 | A texture first bound to <code class="constant">GL_TEXTURE_1D</code> becomes one-dimensional texture, a | |
46 | texture first bound to <code class="constant">GL_TEXTURE_2D</code> becomes two-dimensional texture, a | |
47 | texture first bound to <code class="constant">GL_TEXTURE_3D</code> becomes three-dimensional texture, a | |
48 | texture first bound to <code class="constant">GL_TEXTURE_1D_ARRAY</code> becomes one-dimensional array texture, a | |
49 | texture first bound to <code class="constant">GL_TEXTURE_2D_ARRAY</code> becomes two-dimensional arary texture, a | |
50 | texture first bound to <code class="constant">GL_TEXTURE_RECTANGLE</code> becomes rectangle texture, a, | |
51 | texture first bound to <code class="constant">GL_TEXTURE_CUBE_MAP</code> becomes a cube-mapped texture, a | |
52 | texture first bound to <code class="constant">GL_TEXTURE_BUFFER</code> becomes a buffer texture, a | |
53 | texture first bound to <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> becomes a two-dimensional multisampled texture, and a | |
54 | texture first bound to <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> becomes a two-dimensional multisampled array texture. | |
55 | The state of a one-dimensional texture immediately after it is first bound is equivalent to the state of the | |
56 | default <code class="constant">GL_TEXTURE_1D</code> at GL initialization, and similarly for the other texture types. | |
57 | </p><p> | |
58 | While a texture is bound, GL operations on the target to which it is | |
59 | bound affect the bound texture, and queries of the target to which it | |
60 | is bound return state from the bound texture. | |
61 | In effect, the texture targets become aliases for the textures currently | |
62 | bound to them, and the texture name zero refers to the default textures | |
63 | that were bound to them at initialization. | |
64 | </p><p> | |
65 | A texture binding created with <code class="function">glBindTexture</code> remains active until a different | |
66 | texture is bound to the same target, or until the bound texture is | |
67 | deleted with <a href="glDeleteTextures.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>. | |
68 | </p><p> | |
69 | Once created, a named texture may be re-bound to its same original target as often as needed. | |
70 | It is usually much faster to use <code class="function">glBindTexture</code> to bind an existing named | |
71 | texture to one of the texture targets than it is to reload the texture image | |
72 | 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>, | |
73 | <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> or another similar function. | |
74 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
75 | The <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code> and <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> targets are available | |
76 | only if the GL version is 3.2 or higher. | |
77 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
78 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable | |
79 | values. | |
80 | </p><p> | |
81 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not a name returned from | |
82 | a previous call to <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>. | |
83 | </p><p> | |
84 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>texture</code></em> was previously created with a target | |
85 | that doesn't match that of <em class="parameter"><code>target</code></em>. | |
86 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
87 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_BINDING_1D</code>, | |
88 | <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>, | |
89 | <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>, | |
90 | or <code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</code>. | |
91 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
92 | <a href="glDeleteTextures.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>, | |
93 | <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>, | |
94 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>, | |
95 | <a href="glGetTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexParameter</span></span></a>, | |
96 | <a href="glIsTexture.xml"><span class="citerefentry"><span class="refentrytitle">glIsTexture</span></span></a>, | |
97 | <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>, | |
98 | <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>, | |
99 | <a href="glTexImage2DMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2DMultisample</span></span></a>, | |
100 | <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>, | |
101 | <a href="glTexImage3DMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3DMultisample</span></span></a>, | |
102 | <a href="glTexBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glTexBuffer</span></span></a>, | |
103 | <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a> | |
104 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
105 | Copyright <span class="trademark"></span>© 1991-2006 | |
106 | Silicon Graphics, Inc. This document is licensed under the SGI | |
107 | Free Software B License. For details, see | |
108 | <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
109 | </p></div></div></body></html> |