Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
4 | <refentry id="glGetRenderbufferParameter">\r | |
5 | <refmeta>\r | |
6 | <refmetainfo>\r | |
7 | <copyright>\r | |
8 | <year>2010</year>\r | |
9 | <holder>Khronos Group</holder>\r | |
10 | </copyright>\r | |
11 | </refmetainfo>\r | |
12 | <refentrytitle>glGetRenderbufferParameteriv</refentrytitle>\r | |
13 | <manvolnum>3G</manvolnum>\r | |
14 | </refmeta>\r | |
15 | <refnamediv>\r | |
16 | <refname>glGetRenderbufferParameteriv</refname>\r | |
17 | <refpurpose>retrieve information about a bound renderbuffer object</refpurpose>\r | |
18 | </refnamediv>\r | |
19 | <refsynopsisdiv><title>C Specification</title>\r | |
20 | <funcsynopsis>\r | |
21 | <funcprototype>\r | |
22 | <funcdef>void <function>glGetRenderbufferParameteriv</function></funcdef>\r | |
23 | <paramdef>GLenum <parameter>target</parameter></paramdef>\r | |
24 | <paramdef>GLenum <parameter>pname</parameter></paramdef>\r | |
25 | <paramdef>GLint *<parameter>params</parameter></paramdef>\r | |
26 | </funcprototype>\r | |
27 | </funcsynopsis>\r | |
28 | </refsynopsisdiv>\r | |
29 | <!-- eqn: ignoring delim $$ -->\r | |
30 | <refsect1 id="parameters"><title>Parameters</title>\r | |
31 | <variablelist>\r | |
32 | <varlistentry>\r | |
33 | <term><parameter>target</parameter></term>\r | |
34 | <listitem>\r | |
35 | <para>\r | |
36 | Specifies the target of the query operation. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.\r | |
37 | </para>\r | |
38 | </listitem>\r | |
39 | </varlistentry>\r | |
40 | <varlistentry>\r | |
41 | <term><parameter>pname</parameter></term>\r | |
42 | <listitem>\r | |
43 | <para>\r | |
44 | Specifies the parameter whose value to retrieve from the renderbuffer bound to <parameter>target</parameter>.\r | |
45 | </para>\r | |
46 | </listitem>\r | |
47 | </varlistentry>\r | |
48 | <varlistentry>\r | |
49 | <term><parameter>params</parameter></term>\r | |
50 | <listitem>\r | |
51 | <para>\r | |
52 | Specifies the address of an array to receive the value of the queried parameter.\r | |
53 | </para>\r | |
54 | </listitem>\r | |
55 | </varlistentry>\r | |
56 | </variablelist>\r | |
57 | </refsect1>\r | |
58 | <refsect1 id="description"><title>Description</title>\r | |
59 | <para>\r | |
60 | <function>glGetRenderbufferParameteriv</function> retrieves information about a bound renderbuffer object. <parameter>target</parameter>\r | |
61 | specifies the target of the query operation and must be <constant>GL_RENDERBUFFER</constant>. <parameter>pname</parameter> specifies\r | |
62 | the parameter whose value to query and must be one of <constant>GL_RENDERBUFFER_WIDTH</constant>, <constant>GL_RENDERBUFFER_HEIGHT</constant>,\r | |
63 | <constant>GL_RENDERBUFFER_INTERNAL_FORMAT</constant>, <constant>GL_RENDERBUFFER_RED_SIZE</constant>, <constant>GL_RENDERBUFFER_GREEN_SIZE</constant>,\r | |
64 | <constant>GL_RENDERBUFFER_BLUE_SIZE</constant>, <constant>GL_RENDERBUFFER_ALPHA_SIZE</constant>, <constant>GL_RENDERBUFFER_DEPTH_SIZE</constant>,\r | |
65 | <constant>GL_RENDERBUFFER_DEPTH_SIZE</constant>, <constant>GL_RENDERBUFFER_STENCIL_SIZE</constant>, or <constant>GL_RENDERBUFFER_SAMPLES</constant>.\r | |
66 | </para>\r | |
67 | <para>\r | |
68 | Upon a successful return from <function>glGetRenderbufferParameteriv</function>, if <parameter>pname</parameter> is <constant>GL_RENDERBUFFER_WIDTH</constant>,\r | |
69 | <constant>GL_RENDERBUFFER_HEIGHT</constant>, <constant>GL_RENDERBUFFER_INTERNAL_FORMAT</constant>, or <constant>GL_RENDERBUFFER_SAMPLES</constant>,\r | |
70 | then <parameter>params</parameter> will contain the width in pixels, the height in pixels, the internal format, or the number of samples, respectively,\r | |
71 | of the image of the renderbuffer currently bound to <parameter>target</parameter>.\r | |
72 | </para>\r | |
73 | <para>\r | |
74 | If <parameter>pname</parameter> is <constant>GL_RENDERBUFFER_RED_SIZE</constant>, <constant>GL_RENDERBUFFER_GREEN_SIZE</constant>,\r | |
75 | <constant>GL_RENDERBUFFER_BLUE_SIZE</constant>, <constant>GL_RENDERBUFFER_ALPHA_SIZE</constant>, <constant>GL_RENDERBUFFER_DEPTH_SIZE</constant>,\r | |
76 | or <constant>GL_RENDERBUFFER_STENCIL_SIZE</constant>, then <parameter>params</parameter> will contain the actual resolutions (not the resolutions\r | |
77 | specified when the image array was defined) for the red, green, blue, alpha depth, or stencil components, respectively, of the image of the\r | |
78 | renderbuffer currently bound to <parameter>target</parameter>.\r | |
79 | </para>\r | |
80 | </refsect1>\r | |
81 | <refsect1 id="errors"><title>Errors</title>\r | |
82 | <para>\r | |
83 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one of the accepted tokens.\r | |
84 | </para>\r | |
85 | </refsect1>\r | |
86 | <refsect1 id="seealso"><title>See Also</title>\r | |
87 | <para>\r | |
88 | <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r | |
89 | <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r | |
90 | <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,\r | |
91 | <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,\r | |
92 | <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>\r | |
93 | </para>\r | |
94 | </refsect1>\r | |
95 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
96 | <para>\r | |
97 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
98 | This material may be distributed subject to the terms and conditions set forth in \r | |
99 | the Open Publication License, v 1.0, 8 June 1999.\r | |
100 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
101 | </para>\r | |
102 | </refsect1>\r | |
103 | </refentry>\r |