update upstream sources
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glFramebufferTextureLayer.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 -->
c7b31271 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>glFramebufferTextureLayer - 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="glFramebufferTextureLayer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFramebufferTextureLayer — attach a single layer of a texture to a framebuffer</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">glFramebufferTextureLayer</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>, </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>
7faf1d71
AW
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>texture</code></em></span></dt><dd><p>
13 Specifies the texture object to attach to the framebuffer attachment point named by <em class="parameter"><code>attachment</code></em>.
14 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
15 Specifies the mipmap level of <em class="parameter"><code>texture</code></em> to attach.
16 </p></dd><dt><span class="term"><em class="parameter"><code>layer</code></em></span></dt><dd><p>
17 Specifies the layer of <em class="parameter"><code>texture</code></em> to attach.
18 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
19 <code class="function">glFramebufferTextureLayer</code> operates like <a href="glFramebufferTexture.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
20 except that only a single layer of the texture level, given by <em class="parameter"><code>layer</code></em>, is attached to the attachment point.
21 If <em class="parameter"><code>texture</code></em> is not zero, <em class="parameter"><code>layer</code></em> must be greater than or equal to zero.
22 <em class="parameter"><code>texture</code></em> must either be zero or the name of an existing three-dimensional texture, one- or two-dimensional array texture,
23 or multisample array texture.
24 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
25 <code class="function">glFramebufferTextureLayer</code> is available only if the GL version is 3.2 or greater.
26 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
27 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the accepted tokens.
28 </p><p>
29 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>attachment</code></em> is not one of the accepted tokens.
30 </p><p>
31 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not zero or the name of an existing
32 texture object.
33 </p><p>
34 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not zero and <em class="parameter"><code>layer</code></em>
35 is negative.
36 </p><p>
37 <code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
38 </p><p>
39 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>texture</code></em> is not zero or the name of an existing cube map texture.
40 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
41 <a href="glGenFramebuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
42 <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
43 <a href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
44 <a href="glFramebufferTexture.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
45 <a href="glFramebufferTextureFace.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureFace</span></span></a>
46 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
47 Copyright <span class="trademark"></span>© 2010 Khronos Group.
48 This material may be distributed subject to the terms and conditions set forth in
49 the Open Publication License, v 1.0, 8 June 1999.
50 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
51 </p></div></div></body></html>