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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetString - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><a id="glGetString"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetString — return a string describing the current GL connection</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">const GLubyte* <strong class="fsfunc">glGetString</strong>(</code></td><td>GLenum <var class="pdparam">name</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">const GLubyte* <strong class="fsfunc">glGetStringi</strong>(</code></td><td>GLenum <var class="pdparam">name</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">index</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
Specifies a symbolic constant, one of
<code class="constant">GL_VENDOR</code>, <code class="constant">GL_RENDERER</code>,
<code class="constant">GL_VERSION</code>, or <code class="constant">GL_SHADING_LANGUAGE_VERSION</code>.
Additionally, <code class="function">glGetStringi</code> accepts the <code class="constant">GL_EXTENSIONS</code> token.
</p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
For <code class="function">glGetStringi</code>, specifies the index of the string to return.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetString</code> returns a pointer to a static string
describing some aspect of the current GL connection.
<em class="parameter"><code>name</code></em> can be one of the following:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="constant">GL_VENDOR</code></span></dt><dd><p>
Returns the company responsible for this GL implementation.
This name does not change from release to release.
</p></dd><dt><span class="term"><code class="constant">GL_RENDERER</code></span></dt><dd><p>
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.
</p></dd><dt><span class="term"><code class="constant">GL_VERSION</code></span></dt><dd><p>
Returns a version or release number.
</p></dd><dt><span class="term"><code class="constant">GL_SHADING_LANGUAGE_VERSION</code></span></dt><dd><p>
Returns a version or release number for the shading language.
</p></dd></dl></div><p>
<code class="function">glGetStringi</code> returns a pointer to a static string
indexed by <em class="parameter"><code>index</code></em>.
<em class="parameter"><code>name</code></em> can be one of the following:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="constant">GL_EXTENSIONS</code></span></dt><dd><p>
For <code class="function">glGetStringi</code> only, returns the extension string
supported by the implementation at <em class="parameter"><code>index</code></em>.
</p></dd></dl></div><p>
Strings <code class="constant">GL_VENDOR</code> and <code class="constant">GL_RENDERER</code> together uniquely specify
a platform. They do not change from release to release and should be used
by platform-recognition algorithms.
</p><p>
The <code class="constant">GL_VERSION</code> and <code class="constant">GL_SHADING_LANGUAGE_VERSION</code> strings begin with a version number.
The version number uses one
of these forms:
</p><p>
<span class="emphasis"><em>major_number.minor_number</em></span>
<span class="emphasis"><em>major_number.minor_number.release_number</em></span>
</p><p>
Vendor-specific information may follow the version
number. Its format depends on the implementation, but
a space always separates the version number and
the vendor-specific information.
</p><p>
All strings are null-terminated.
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated, <code class="function">glGetString</code> returns 0.
</p><p>
The client and server may support different versions.
<code class="function">glGetString</code> always returns a compatible version number.
The release number always describes the server.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>name</code></em> is not an accepted value.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated by <code class="function">glGetStringi</code> if
<em class="parameter"><code>index</code></em> is outside the valid range for indexed state <em class="parameter"><code>name</code></em>.
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 1991-2006 Silicon Graphics, Inc.
Copyright <span class="trademark"></span>© 2010-2013 Khronos Group.
This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></body></html>
|
