-
Notifications
You must be signed in to change notification settings - Fork 94
/
glFramebufferTextureLayer.xhtml
50 lines (50 loc) · 6.24 KB
/
glFramebufferTextureLayer.xhtml
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
<div class="refentry"><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 class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glFramebufferTextureLayer</strong>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">attachment</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">texture</var>, </td></tr><tr><td> </td><td>GLint <var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLint <var class="pdparam">layer</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
Specifies the framebuffer target. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_DRAW_FRAMEBUFFER</code>,
<code class="constant">GL_READ_FRAMEBUFFER</code>, or <code class="constant">GL_FRAMEBUFFER</code>. <code class="constant">GL_FRAMEBUFFER</code>
is equivalent to <code class="constant">GL_DRAW_FRAMEBUFFER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>attachment</code></em></span></dt><dd><p>
Specifies the attachment point of the framebuffer. <em class="parameter"><code>attachment</code></em> must be
<code class="constant">GL_COLOR_ATTACHMENT<span class="emphasis"><em>i</em></span></code>, <code class="constant">GL_DEPTH_ATTACHMENT</code>,
<code class="constant">GL_STENCIL_ATTACHMENT</code> or <code class="constant">GL_DEPTH_STENCIL_ATTACHMENT</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>texture</code></em></span></dt><dd><p>
Specifies the texture object to attach to the framebuffer attachment point named by <em class="parameter"><code>attachment</code></em>.
</p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
Specifies the mipmap level of <em class="parameter"><code>texture</code></em> to attach.
</p></dd><dt><span class="term"><em class="parameter"><code>layer</code></em></span></dt><dd><p>
Specifies the layer of <em class="parameter"><code>texture</code></em> to attach.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glFramebufferTextureLayer</code> operates like <a class="citerefentry" href="glFramebufferTexture"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
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.
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.
<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,
or multisample array texture.
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glFramebufferTextureLayer</code> is available only if the GL version is 3.2 or greater.
</p></div><div class="refsect1"><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 accepted tokens.
</p><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>attachment</code></em> is not one of the accepted tokens.
</p><p>
<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
texture object.
</p><p>
<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>
is negative.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
</p><p>
<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.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glGenFramebuffers"><span class="citerefentry"><span class="refentrytitle">glGenFramebuffers</span></span></a>,
<a class="citerefentry" href="glBindFramebuffer"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>,
<a class="citerefentry" href="glGenRenderbuffers"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
<a class="citerefentry" href="glFramebufferTexture"><span class="citerefentry"><span class="refentrytitle">glFramebufferTexture</span></span></a>,
<a class="citerefentry" href="glFramebufferTextureFace"><span class="citerefentry"><span class="refentrytitle">glFramebufferTextureFace</span></span></a>
</p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>