1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
xmlns="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glGetString</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GL.xml" title="GL"/><link rel="previous" href="glGetSeparableFilter.3G.xml" title="glGetSeparableFilter"/><link rel="next" href="glGetTexEnv.3G.xml" title="glGetTexEnv"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glGetString</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glGetSeparableFilter.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glGetTexEnv.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glGetString.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glGetString.3G-name"/><h2>Name</h2><p>glGetString — return a string describing the current GL connection</p></div><div class="refsynopsisdiv"><a name="glGetString.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>constGLubyte *<tt>glGetString</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>name</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glGetString.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glGetString</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>name</tt></i>) →<i><tt>value</tt></i></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glGetString.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>name</tt></i></span></dt><dd>
Specifies a symbolic constant, one of <tt>GL_VENDOR</tt>, <tt>GL_RENDERER</tt>,
<tt>GL_VERSION</tt>, or <tt>GL_EXTENSIONS</tt>.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="glGetString.3G-description"/><h2>Description</h2><p>
<tt>glGetString</tt> returns a pointer to a static string describing some aspect of the current GL
connection. <i><tt>name</tt></i> can be one of the following:
</p><div class="variablelist"><dl><dt><span class="term"><tt>GL_VENDOR</tt></span></dt><dd>
Returns the company responsible for this GL implementation. This name does not change from release to
release.
</dd><dt><span class="term"><tt>GL_RENDERER</tt></span></dt><dd>
Returns the name of the renderer. This name is typically specific to a particular configuration of a
hardware platform. It does not change from release to release.
</dd><dt><span class="term"><tt>GL_VERSION</tt></span></dt><dd>
Returns a version or release number.
</dd><dt><span class="term"><tt>GL_EXTENSIONS</tt></span></dt><dd>
Returns a space-separated list of supported extensions to GL.
</dd></dl></div><p>
Because the GL does not include queries for the performance characteristics of an implementation, some applications are
written to recognize known platforms and modify their GL usage based on known performance characteristics of these
platforms. Strings <tt>GL_VENDOR</tt> and <tt>GL_RENDERER</tt> together uniquely specify a
platform. They do not change from release to release and should be used by platform-recognition algorithms.
</p><p>
Some applications want to make use of features that are not part of the standard GL. These features may be implemented
as extensions to the standard GL. The <tt>GL_EXTENSIONS</tt> string is a space-separated list of supported
GL extensions. (Extension names never contain a space character.)
</p><p>
The <tt>GL_VERSION</tt> string begins with a version number. The version number uses one of these forms:
</p><p>
<i><tt>major_number.minor_number</tt></i>
</p><p>
<i><tt>major_number.minor_number.release_number</tt></i>
</p><p>
Vendor-specific information may follow the version number. Its depends on the implementation, but a space always
separates the version number and the vendor-specific information.
</p><p>
All strings are <tt>NULL</tt>-terminated.
</p></div><div class="refsect1" lang="en"><a name="glGetString.3G-notes"/><h2>Notes</h2><p>
If an error is generated, <tt>glGetString</tt> returns 0.
</p><p>
The client and server may support different versions or extensions. <tt>glGetString</tt> always returns a
compatible version number or list of extensions. The release number always describes the server.
</p></div><div class="refsect1" lang="en"><a name="glGetString.3G-errors"/><h2>Errors</h2><p>
<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>name</tt></i> is not an accepted value.
</p><p>
<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glGetString</tt> is executed between the
execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glGetSeparableFilter.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glGetTexEnv.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glGetSeparableFilter</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glGetTexEnv</td></tr></table></div></body></html>
|
