46d1f7920e0cbf643060bf1c1be133d4b4921ba3
[clinton/guile-figl.git] / upstream-man-pages / man3 / xhtml / glGetRenderbufferParameter.xml
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>glGetRenderbufferParameteriv</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glGetRenderbufferParameteriv"><a id="glGetRenderbufferParameter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetRenderbufferParameteriv — retrieve information about a bound renderbuffer object</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glGetRenderbufferParameteriv</b>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint *<var class="pdparam">params</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><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 of the query operation. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_RENDERBUFFER</code>.
6 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
7 Specifies the parameter whose value to retrieve from the renderbuffer bound to <em class="parameter"><code>target</code></em>.
8 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
9 Specifies the address of an array to receive the value of the queried parameter.
10 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
11 <code class="function">glGetRenderbufferParameteriv</code> retrieves information about a bound renderbuffer object. <em class="parameter"><code>target</code></em>
12 specifies the target of the query operation and must be <code class="constant">GL_RENDERBUFFER</code>. <em class="parameter"><code>pname</code></em> specifies
13 the parameter whose value to query and must be one of <code class="constant">GL_RENDERBUFFER_WIDTH</code>, <code class="constant">GL_RENDERBUFFER_HEIGHT</code>,
14 <code class="constant">GL_RENDERBUFFER_INTERNAL_FORMAT</code>, <code class="constant">GL_RENDERBUFFER_RED_SIZE</code>, <code class="constant">GL_RENDERBUFFER_GREEN_SIZE</code>,
15 <code class="constant">GL_RENDERBUFFER_BLUE_SIZE</code>, <code class="constant">GL_RENDERBUFFER_ALPHA_SIZE</code>, <code class="constant">GL_RENDERBUFFER_DEPTH_SIZE</code>,
16 <code class="constant">GL_RENDERBUFFER_DEPTH_SIZE</code>, <code class="constant">GL_RENDERBUFFER_STENCIL_SIZE</code>, or <code class="constant">GL_RENDERBUFFER_SAMPLES</code>.
17 </p><p>
18 Upon a successful return from <code class="function">glGetRenderbufferParameteriv</code>, if <em class="parameter"><code>pname</code></em> is <code class="constant">GL_RENDERBUFFER_WIDTH</code>,
19 <code class="constant">GL_RENDERBUFFER_HEIGHT</code>, <code class="constant">GL_RENDERBUFFER_INTERNAL_FORMAT</code>, or <code class="constant">GL_RENDERBUFFER_SAMPLES</code>,
20 then <em class="parameter"><code>params</code></em> will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively,
21 of the image of the renderbuffer currently bound to <em class="parameter"><code>target</code></em>.
22 </p><p>
23 If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_RENDERBUFFER_RED_SIZE</code>, <code class="constant">GL_RENDERBUFFER_GREEN_SIZE</code>,
24 <code class="constant">GL_RENDERBUFFER_BLUE_SIZE</code>, <code class="constant">GL_RENDERBUFFER_ALPHA_SIZE</code>, <code class="constant">GL_RENDERBUFFER_DEPTH_SIZE</code>,
25 or <code class="constant">GL_RENDERBUFFER_STENCIL_SIZE</code>, then <em class="parameter"><code>params</code></em> will contain the actual resolutions (not the resolutions
26 specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the
27 renderbuffer currently bound to <em class="parameter"><code>target</code></em>.
28 </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
29 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the accepted tokens.
30 </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
31 <a class="citerefentry" href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
32 <a class="citerefentry" href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
33 <a class="citerefentry" href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>,
34 <a class="citerefentry" href="glRenderbufferStorage.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorage</span></span></a>,
35 <a class="citerefentry" href="glRenderbufferStorageMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorageMultisample</span></span></a>
36 </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
37 Copyright <span class="trademark"></span>© 2010 Khronos Group.
38 This material may be distributed subject to the terms and conditions set forth in
39 the Open Publication License, v 1.0, 8 June 1999.
40 <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
41 </p></div></div></body></html>