upstream-man-pages/man4/glGetRenderbufferParameter.xml

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