HCoop / clinton / guile-figl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
update upstream sources
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glFramebufferTexture.xml
CommitLineData
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>glFramebufferTexture - 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="glFramebufferTexture"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFramebufferTexture — attach a level of a texture object as a logical buffer to the currently bound framebuffer object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">void <b class="fsfunc">glFramebufferTexture</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">void <b class="fsfunc">glFramebufferTexture1D</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">textarget</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">void <b class="fsfunc">glFramebufferTexture2D</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">textarget</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glFramebufferTexture3D</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">textarget</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">layer</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 framebuffer target. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
6 <code class="constant">GL_READ_FRAMEBUFFER</code>, or <code class="constant">GL_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code>
7 is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
8 </p></dd><dt><span class="term"><em class="parameter"><code>attachment</code></em></span></dt><dd><p>
9 Specifies the attachment point of the framebuffer. <em class="parameter"><code>attachment</code></em> must be
10 <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code>, <code class="constant">GL_DEPTH_ATTACHMENT</code>,
c7b31271 11 <code class="constant">GL_STENCIL_ATTACHMENT</code> or <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>.
7faf1d71
AW		 12 </p></dd><dt><span class="term"><em class="parameter"><code>textarget</code></em></span></dt><dd><p>
13 For <code class="function">glFramebufferTexture1D</code>, <code class="function">glFramebufferTexture2D</code> and
14 <code class="function">glFramebufferTexture3D</code>, specifies what type of texture is expected
15 in the <em class="parameter"><code>texture</code></em> parameter, or for cube map textures, which face is to be attached.
16 </p></dd><dt><span class="term"><em class="parameter"><code>texture</code></em></span></dt><dd><p>
17 Specifies the texture object to attach to the framebuffer attachment point named by <em class="parameter"><code>attachment</code></em>.
18 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
19 Specifies the mipmap level of <em class="parameter"><code>texture</code></em> to attach.
20 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
21 <code class="function">glFramebufferTexture</code>, <code class="function">glFramebufferTexture1D</code>, <code class="function">glFramebufferTexture2D</code>,
22 and <code class="function">glFramebufferTexture</code> attach a selected mipmap level or image of a texture object as one of the
23 logical buffers of the framebuffer object currently bound to <em class="parameter"><code>target</code></em>. <em class="parameter"><code>target</code></em> must
24 be <code class="constant">GL_DRAW_FRAMEBUFFER</code>, <code class="constant">GL_READ_FRAMEBUFFER</code>, or <code class="constant">GL_FRAMEBUFFER</code>.
25 <code class="constant">GL_FRAMEBUFFER</code> is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
26 </p><p>
27 <em class="parameter"><code>attachment</code></em> specifies the logical attachment of the framebuffer and must be
28 <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code>, <code class="constant">GL_DEPTH_ATTACHMENT</code>,
c7b31271 29 <code class="constant">GL_STENCIL_ATTACHMENT</code> or <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>.
7faf1d71
AW		 30 <span class="emphasis"><em>i</em></span> in <code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code> may range from zero to
31 the value of <code class="constant">GL_MAX_COLOR_ATTACHMENTS</code> - 1. Attaching a level of a texture to
32 <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code> is equivalent to attaching that level to both the
33 <code class="constant">GL_DEPTH_ATTACHMENT</code> <span class="emphasis"><em>and</em></span> the <code class="constant">GL_STENCIL_ATTACHMENT</code>
34 attachment points simultaneously.
35 </p><p>
36 <em class="parameter"><code>textarget</code></em> specifies what type of texture is named by <em class="parameter"><code>texture</code></em>, and for
37 cube map textures, specifies the face that is to be attached. If <em class="parameter"><code>texture</code></em> is not zero, it
38 must be the name of an existing texture with type <em class="parameter"><code>textarget</code></em>, unless it is a cube map
39 texture, in which case <em class="parameter"><code>textarget</code></em> must be <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>
40 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
41 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>, or
42 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>.
43 </p><p>
44 If <em class="parameter"><code>texture</code></em> is non-zero, the specified <em class="parameter"><code>level</code></em> of the texture object named
45 <em class="parameter"><code>texture</code></em> is attached to the framebfufer attachment point named by <em class="parameter"><code>attachment</code></em>.
46 For <code class="function">glFramebufferTexture1D</code>, <code class="function">glFramebufferTexture2D</code>, and
47 <code class="function">glFramebufferTexture3D</code>, <em class="parameter"><code>texture</code></em> must be zero or the name of an existing
48 texture with a target of <em class="parameter"><code>textarget</code></em>, or <em class="parameter"><code>texture</code></em> must be the name
49 of an existing cube-map texture and <em class="parameter"><code>textarget</code></em> must be one of <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
50 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
51 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>, or
52 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>.
53 </p><p>
54 If <em class="parameter"><code>textarget</code></em> is <code class="constant">GL_TEXTURE_RECTANGLE</code>, <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>,
55 or <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>, then <em class="parameter"><code>level</code></em> must be zero. If <em class="parameter"><code>textarget</code></em>
56 is <code class="constant">GL_TEXTURE_3D</code>, then level must be greater than or equal to zero and less than or equal to log<sub>2</sub>
57 of the value of <code class="constant">GL_MAX_3D_TEXTURE_SIZE</code>. If <em class="parameter"><code>textarget</code></em> is one of <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
58 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
59 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>, or <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, then <em class="parameter"><code>level</code></em> must be greater
60 than or equal to zero and less than or equal to log<sub>2</sub> of the value of <code class="constant">GL_MAX_CUBE_MAP_TEXTURE_SIZE</code>. For all other
61 values of <em class="parameter"><code>textarget</code></em>, <em class="parameter"><code>level</code></em> must be greater than or equal to zero and no larger than log<sub>2</sub>
62 of the value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
63 </p><p>
64 <em class="parameter"><code>layer</code></em> specifies the layer of a 2-dimensional image within a 3-dimensional texture.
65 </p><p>
66 For <code class="function">glFramebufferTexture1D</code>, if <em class="parameter"><code>texture</code></em> is not zero, then <em class="parameter"><code>textarget</code></em> must
67 be <code class="constant">GL_TEXTURE_1D</code>. For <code class="function">glFramebufferTexture2D</code>, if <em class="parameter"><code>texture</code></em> is not zero,
68 <em class="parameter"><code>textarget</code></em> must be one of <code class="constant">GL_TEXTURE_2D</code>, <code class="constant">GL_TEXTURE_RECTANGLE</code>,
69 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
70 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>, <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, or
71 <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>. For <code class="function">glFramebufferTexture3D</code>, if <em class="parameter"><code>texture</code></em> is
72 not zero, then <em class="parameter"><code>textarget</code></em> must be <code class="constant">GL_TEXTURE_3D</code>.
73 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
74 <code class="function">glFramebufferTexture</code> is available only if the GL version is 3.2 or greater.
75 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
76 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the accepted tokens.
77 </p><p>
78 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>renderbuffertarget</code></em> is not <code class="constant">GL_RENDERBUFFER</code>.
79 </p><p>
80 <code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
81 </p><p>
82 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>textarget</code></em> and <em class="parameter"><code>texture</code></em>
83 are not compatible.
84 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
85 <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
86 <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
87 <a href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
88 <a href="glFramebufferTexture.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
89 <a href="glFramebufferTexture1D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture1D</span></span></a>,
90 <a href="glFramebufferTexture2D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture2D</span></span></a>,
91 <a href="glFramebufferTexture3D.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture3D</span></span></a>
92 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
93 Copyright <span class="trademark"></span>© 2010 Khronos Group.
94 This material may be distributed subject to the terms and conditions set forth in
95 the Open Publication License, v 1.0, 8 June 1999.
96 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
97 </p></div></div></body></html>
Unnamed repository; edit this file 'description' to name the repository.