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>glClearBuffer - OpenGL
4 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=
"glClearBuffer"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glClearBuffer — clear individual buffers of the currently bound draw 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">glClearBufferiv
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">buffer
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">drawBuffer
</var>,
</td></tr><tr><td> </td><td>const GLint *
</td><td><var class=
"pdparam">value
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glClearBufferuiv
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">buffer
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">drawBuffer
</var>,
</td></tr><tr><td> </td><td>const GLuint *
</td><td><var class=
"pdparam">value
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glClearBufferfv
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">buffer
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">drawBuffer
</var>,
</td></tr><tr><td> </td><td>const GLfloat *
</td><td><var class=
"pdparam">value
</var><code>)
</code>;
</td></tr></table></div><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glClearBufferfi
</b>(
</code></td><td>GLenum
</td><td><var class=
"pdparam">buffer
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">drawBuffer
</var>,
</td></tr><tr><td> </td><td>GLfloat
</td><td><var class=
"pdparam">depth
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">stencil
</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>buffer
</code></em></span></dt><dd><p>
5 Specify the buffer to clear.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>drawBuffer
</code></em></span></dt><dd><p>
7 Specify a particular draw buffer to clear.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>value
</code></em></span></dt><dd><p>
9 For color buffers, a pointer to a four-element vector specifying R, G, B and A values to clear the buffer to.
10 For depth buffers, a pointer to a single depth value to clear the buffer to.
11 For stencil buffers, a pointer to a single stencil value to clear the buffer to.
12 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>depth
</code></em></span></dt><dd><p>
13 The value to clear a depth render buffer to.
14 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>stencil
</code></em></span></dt><dd><p>
15 The value to clear a stencil render buffer to.
16 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
17 <code class=
"function">glClearBuffer*
</code> clears the specified buffer to the specified value(s). If
<em class=
"parameter"><code>buffer
</code></em> is
18 <code class=
"constant">GL_COLOR
</code>, a particular draw buffer
<code class=
"constant">GL_DRAWBUFFER
<em class=
"parameter"><code>i
</code></em></code> is specified
19 by passing
<em class=
"parameter"><code>i
</code></em> as
<em class=
"parameter"><code>drawBuffer
</code></em>. In this case,
<em class=
"parameter"><code>value
</code></em> points to
20 a four-element vector specifying the R, G, B and A color to clear that draw buffer to. If
<em class=
"parameter"><code>buffer
</code></em> is
21 one of
<code class=
"constant">GL_FRONT
</code>,
<code class=
"constant">GL_BACK
</code>,
<code class=
"constant">GL_LEFT
</code>,
<code class=
"constant">GL_RIGHT
</code>,
22 or
<code class=
"constant">GL_FRONT_AND_BACK
</code>, identifying multiple buffers, each selected buffer is cleared to the same value.
23 Clamping and conversion for fixed-point color buffers are performed in the same fashion as
24 <a href=
"glClearColor.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearColor
</span></span></a>.
26 If
<em class=
"parameter"><code>buffer
</code></em> is
<code class=
"constant">GL_DEPTH
</code>,
<em class=
"parameter"><code>drawBuffer
</code></em> must be zero, and
<em class=
"parameter"><code>value
</code></em>
27 points to a single value to clear the depth buffer to. Only
<code class=
"function">glClearBufferfv
</code> should be used to clear
28 depth buffers. Clamping and conversion for fixed-point depth buffers are performed in the same fashion as
29 <a href=
"glClearDepth.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearDepth
</span></span></a>.
31 If
<em class=
"parameter"><code>buffer
</code></em> is
<code class=
"constant">GL_STENCIL
</code>,
<em class=
"parameter"><code>drawBuffer
</code></em> must be zero, and
<em class=
"parameter"><code>value
</code></em>
32 points to a single value to clear the stencil buffer to. Only
<code class=
"function">glClearBufferiv
</code> should be used to clear
33 stencil buffers. Masking and type conversion are performed in the same fashion as
34 <a href=
"glClearStencil.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearStencil
</span></span></a>.
36 <code class=
"function">glClearBufferfi
</code> may be used to clear the depth and stencil buffers.
<em class=
"parameter"><code>buffer
</code></em> must be
37 <code class=
"constant">GL_DEPTH_STENCIL
</code> and
<em class=
"parameter"><code>drawBuffer
</code></em> must be zero.
<em class=
"parameter"><code>depth
</code></em> and
38 <em class=
"parameter"><code>stencil
</code></em> are the depth and stencil values, respectively.
40 The result of
<code class=
"function">glClearBuffer
</code> is undefined if no conversion between the type of
<em class=
"parameter"><code>value
</code></em>
41 and the buffer being cleared is defined. However, this is not an error.
42 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
43 <code class=
"constant">GL_INVALID_ENUM
</code> is generated by
<code class=
"function">glClearBufferif
</code>,
<code class=
"function">glClearBufferfv
</code>
44 and
<code class=
"function">glClearBufferuiv
</code> if
<em class=
"parameter"><code>buffer
</code></em> is not
<code class=
"constant">GL_COLOR
</code>,
45 <code class=
"constant">GL_FRONT
</code>,
<code class=
"constant">GL_BACK
</code>,
<code class=
"constant">GL_LEFT
</code>,
<code class=
"constant">GL_RIGHT
</code>,
46 <code class=
"constant">GL_FRONT_AND_BACK
</code>,
<code class=
"constant">GL_DEPTH
</code> or
<code class=
"constant">GL_STENCIL
</code>.
48 <code class=
"constant">GL_INVALID_ENUM
</code> is generated by
<code class=
"function">glClearBufferfi
</code> if
<em class=
"parameter"><code>buffer
</code></em>
49 is not
<code class=
"constant">GL_DEPTH_STENCIL
</code>.
51 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>buffer
</code></em> is
<code class=
"constant">GL_COLOR
</code>,
52 <code class=
"constant">GL_FRONT
</code>,
<code class=
"constant">GL_BACK
</code>,
<code class=
"constant">GL_LEFT
</code>,
<code class=
"constant">GL_RIGHT
</code>,
53 or
<code class=
"constant">GL_FRONT_AND_BACK
</code> and
<em class=
"parameter"><code>drawBuffer
</code></em> is greater than or equal to
<code class=
"constant">GL_MAX_DRAW_BUFFERS
</code>.
55 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>buffer
</code></em> is
<code class=
"constant">GL_DEPTH
</code>,
56 <code class=
"constant">GL_STENCIL
</code> or
<code class=
"constant">GL_DEPTH_STENCIL
</code> and
<em class=
"parameter"><code>drawBuffer
</code></em> is not zero.
57 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
58 <a href=
"glClearColor.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearColor
</span></span></a>,
59 <a href=
"glClearDepth.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearDepth
</span></span></a>,
60 <a href=
"glClearStencil.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClearStencil
</span></span></a>,
61 <a href=
"glClear.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClear
</span></span></a>
62 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
63 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
64 This material may be distributed subject to the terms and conditions set forth in
65 the Open Publication License, v
1.0,
8 June
1999.
66 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
67 </p></div></div></body></html>