HCoop / clinton / guile-figl.git / blame
| 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="glXQueryDrawable">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>1991-2006</year>\r | |
| 9 | <holder>Silicon Graphics, Inc.</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>glXQueryDrawable</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glXQueryDrawable</refname>\r | |
| 17 | <refpurpose>returns an attribute assoicated with a GLX drawable</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>int <function>glXQueryDrawable</function></funcdef>\r | |
| 23 | <paramdef>Display * <parameter>dpy</parameter></paramdef>\r | |
| 24 | <paramdef>GLXDrawable <parameter>draw</parameter></paramdef>\r | |
| 25 | <paramdef>int <parameter>attribute</parameter></paramdef>\r | |
| 26 | <paramdef>unsigned int * <parameter>value</parameter></paramdef>\r | |
| 27 | </funcprototype>\r | |
| 28 | </funcsynopsis>\r | |
| 29 | </refsynopsisdiv>\r | |
| 30 | <!-- eqn: ignoring delim $$ -->\r | |
| 31 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 32 | <variablelist>\r | |
| 33 | <varlistentry>\r | |
| 34 | <term><parameter>dpy</parameter></term>\r | |
| 35 | <listitem>\r | |
| 36 | <para>\r | |
| 37 | Specifies the connection to the X server.\r | |
| 38 | </para>\r | |
| 39 | </listitem>\r | |
| 40 | </varlistentry>\r | |
| 41 | <varlistentry>\r | |
| 42 | <term><parameter>draw</parameter></term>\r | |
| 43 | <listitem>\r | |
| 44 | <para>\r | |
| 45 | Specifies the GLX drawable to be queried.\r | |
| 46 | </para>\r | |
| 47 | </listitem>\r | |
| 48 | </varlistentry>\r | |
| 49 | <varlistentry>\r | |
| 50 | <term><parameter>attribute</parameter></term>\r | |
| 51 | <listitem>\r | |
| 52 | <para>\r | |
| 53 | Specifies the attribute to be returned. Must be one of\r | |
| 54 | <constant>GLX_WIDTH</constant>,\r | |
| 55 | <constant>GLX_HEIGHT</constant>,\r | |
| 56 | <constant>GLX_PRESERVED_CONTENTS</constant>,\r | |
| 57 | <constant>GLX_LARGEST_PBUFFER</constant>, or\r | |
| 58 | <constant>GLX_FBCONFIG_ID</constant>.\r | |
| 59 | </para>\r | |
| 60 | </listitem>\r | |
| 61 | </varlistentry>\r | |
| 62 | <varlistentry>\r | |
| 63 | <term><parameter>value</parameter></term>\r | |
| 64 | <listitem>\r | |
| 65 | <para>\r | |
| 66 | Contains the return value for\r | |
| 67 | <parameter>attribute</parameter>. \r | |
| 68 | </para>\r | |
| 69 | </listitem>\r | |
| 70 | </varlistentry>\r | |
| 71 | </variablelist>\r | |
| 72 | </refsect1>\r | |
| 73 | <refsect1 id="description"><title>Description</title>\r | |
| 74 | <para>\r | |
| 75 | <function>glXQueryDrawable</function> sets\r | |
| 76 | <parameter>value</parameter> to the value of\r | |
| 77 | <parameter>attribute</parameter> with respect to the GLXDrawable\r | |
| 78 | <parameter>draw</parameter>.\r | |
| 79 | </para>\r | |
| 80 | <para>\r | |
| 81 | <parameter>attribute</parameter> may be one of the following:\r | |
| 82 | </para>\r | |
| 83 | <variablelist>\r | |
| 84 | <varlistentry>\r | |
| 85 | <term><constant>GLX_WIDTH</constant></term>\r | |
| 86 | <listitem>\r | |
| 87 | <para>\r | |
| 88 | Returns the width of <parameter>ctx</parameter>.\r | |
| 89 | </para>\r | |
| 90 | </listitem>\r | |
| 91 | </varlistentry>\r | |
| 92 | <varlistentry>\r | |
| 93 | <term><constant>GLX_HEIGHT</constant></term>\r | |
| 94 | <listitem>\r | |
| 95 | <para>\r | |
| 96 | Returns the height of <parameter>ctx</parameter>.\r | |
| 97 | </para>\r | |
| 98 | </listitem>\r | |
| 99 | </varlistentry>\r | |
| 100 | <varlistentry>\r | |
| 101 | <term><constant>GLX_PRESERVED_CONTENTS</constant></term>\r | |
| 102 | <listitem>\r | |
| 103 | <para>\r | |
| 104 | Returns <constant>True</constant> if the contents\r | |
| 105 | of a GLXPbuffer are preserved when a resource\r | |
| 106 | conflict occurs; <constant>False</constant> otherwise.\r | |
| 107 | </para>\r | |
| 108 | </listitem>\r | |
| 109 | </varlistentry>\r | |
| 110 | <varlistentry>\r | |
| 111 | <term><constant>GLX_LARGEST_PBUFFER</constant></term>\r | |
| 112 | <listitem>\r | |
| 113 | <para>\r | |
| 114 | Returns the value set when\r | |
| 115 | <function>glXCreatePbuffer</function> was called to\r | |
| 116 | create the GLXPbuffer. If\r | |
| 117 | <constant>False</constant> is returned, then the\r | |
| 118 | call to <function>glXCreatePbuffer</function> will\r | |
| 119 | fail to create a GLXPbuffer if the requested size\r | |
| 120 | is larger than the implementation maximum or\r | |
| 121 | available resources. If <constant>True</constant>\r | |
| 122 | is returned, a GLXPbuffer of the maximum availble\r | |
| 123 | size (if less than the requested width and height)\r | |
| 124 | is created.\r | |
| 125 | </para>\r | |
| 126 | </listitem>\r | |
| 127 | </varlistentry>\r | |
| 128 | <varlistentry>\r | |
| 129 | <term><constant>GLX_FBCONFIG_ID</constant></term>\r | |
| 130 | <listitem>\r | |
| 131 | <para>\r | |
| 132 | Returns the XID for <parameter>draw</parameter>.\r | |
| 133 | </para>\r | |
| 134 | </listitem>\r | |
| 135 | </varlistentry>\r | |
| 136 | </variablelist>\r | |
| 137 | <para>\r | |
| 138 | If <parameter>draw</parameter> is a GLXWindow or GLXPixmap and\r | |
| 139 | <parameter>attribute</parameter> is set to\r | |
| 140 | <constant>GLX_PRESERVED_CONTENTS</constant> or\r | |
| 141 | <constant>GLX_LARGETST_PBUFFER</constant>, the contents of\r | |
| 142 | <parameter>value</parameter> are undefined. If\r | |
| 143 | <parameter>attribute</parameter> is not one of the attributes\r | |
| 144 | listed above, the contents of <parameter>value</parameter> are\r | |
| 145 | unedfined.\r | |
| 146 | </para>\r | |
| 147 | </refsect1>\r | |
| 148 | <refsect1 id="errors"><title>Errors</title>\r | |
| 149 | <para>\r | |
| 150 | A <constant>GLXBadDrawable</constant> is generated if\r | |
| 151 | <parameter>draw</parameter> is not a valid GLXDrawable.\r | |
| 152 | </para>\r | |
| 153 | </refsect1>\r | |
| 154 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 155 | <para>\r | |
| 156 | <citerefentry><refentrytitle>glXCreateWindow</refentrytitle></citerefentry>,\r | |
| 157 | <citerefentry><refentrytitle>glXCreatePixmap</refentrytitle></citerefentry>,\r | |
| 158 | <citerefentry><refentrytitle>glXCreatePbuffer</refentrytitle></citerefentry>,\r | |
| 159 | <citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry>,\r | |
| 160 | <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>\r | |
| 161 | </para>\r | |
| 162 | </refsect1>\r | |
| 163 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 164 | <para>\r | |
| 165 | Copyright <trademark class="copyright"></trademark> 1991-2006\r | |
| 166 | Silicon Graphics, Inc. This document is licensed under the SGI\r | |
| 167 | Free Software B License. For details, see\r | |
| 168 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.\r | |
| 169 | </para>\r | |
| 170 | </refsect1>\r | |
| 171 | </refentry>\r |