Blame |
Last modification |
View Log
| RSS feed
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glXQueryDrawable">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXQueryDrawable</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXQueryDrawable</refname>
<refpurpose>returns an attribute assoicated with a GLX drawable</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>glXQueryDrawable</function></funcdef>
<paramdef>Display * <parameter>dpy</parameter></paramdef>
<paramdef>GLXDrawable <parameter>draw</parameter></paramdef>
<paramdef>int <parameter>attribute</parameter></paramdef>
<paramdef>unsigned int * <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>dpy</parameter></term>
<listitem>
<para>
Specifies the connection to the X server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>draw</parameter></term>
<listitem>
<para>
Specifies the GLX drawable to be queried.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
Specifies the attribute to be returned. Must be one of
<constant>GLX_WIDTH</constant>,
<constant>GLX_HEIGHT</constant>,
<constant>GLX_PRESERVED_CONTENTS</constant>,
<constant>GLX_LARGEST_PBUFFER</constant>, or
<constant>GLX_FBCONFIG_ID</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
Contains the return value for
<parameter>attribute</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXQueryDrawable</function> sets
<parameter>value</parameter> to the value of
<parameter>attribute</parameter> with respect to the GLXDrawable
<parameter>draw</parameter>.
</para>
<para>
<parameter>attribute</parameter> may be one of the following:
</para>
<variablelist>
<varlistentry>
<term><constant>GLX_WIDTH</constant></term>
<listitem>
<para>
Returns the width of <parameter>ctx</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GLX_HEIGHT</constant></term>
<listitem>
<para>
Returns the height of <parameter>ctx</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GLX_PRESERVED_CONTENTS</constant></term>
<listitem>
<para>
Returns <constant>True</constant> if the contents
of a GLXPbuffer are preserved when a resource
conflict occurs; <constant>False</constant> otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GLX_LARGEST_PBUFFER</constant></term>
<listitem>
<para>
Returns the value set when
<function>glXCreatePbuffer</function> was called to
create the GLXPbuffer. If
<constant>False</constant> is returned, then the
call to <function>glXCreatePbuffer</function> will
fail to create a GLXPbuffer if the requested size
is larger than the implementation maximum or
available resources. If <constant>True</constant>
is returned, a GLXPbuffer of the maximum availble
size (if less than the requested width and height)
is created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GLX_FBCONFIG_ID</constant></term>
<listitem>
<para>
Returns the XID for <parameter>draw</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If <parameter>draw</parameter> is a GLXWindow or GLXPixmap and
<parameter>attribute</parameter> is set to
<constant>GLX_PRESERVED_CONTENTS</constant> or
<constant>GLX_LARGETST_PBUFFER</constant>, the contents of
<parameter>value</parameter> are undefined. If
<parameter>attribute</parameter> is not one of the attributes
listed above, the contents of <parameter>value</parameter> are
unedfined.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
A <constant>GLXBadDrawable</constant> is generated if
<parameter>draw</parameter> is not a valid GLXDrawable.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXCreateWindow</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXCreatePixmap</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXCreatePbuffer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
</para>
</refsect1>
</refentry>