← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/doc/man/GL/gl/getstring.3gl

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/doc/man/GL/gl/getstring.3gl
 
1
'\" e
 
2
'\"! eqn | mmdoc
 
3
'\"macro stdmacro
 
4
.ds Vn Version 1.2
 
5
.ds Dt 24 September 1999
 
6
.ds Re Release 1.2.1
 
7
.ds Dp Jan 14 18:30
 
8
.ds Dm 01 getstring
 
9
.ds Xs 56397 5 getstring.gl
 
10
.TH GLGETSTRING 3G
 
11
.SH NAME
 
12
.B "\- return a string describing the current GL connection
 
13
 
 
14
.SH C SPECIFICATION
 
15
const GLubyte* \f3glGetString\fP(
 
16
GLenum \fIname\fP )
 
17
.SH PARAMETERS
 
18
.TP \w'\fIname\fP\ \ 'u 
 
19
\f2name\fP
 
20
Specifies a symbolic constant, one of 
 
21
\%\f3GL_VENDOR\fP, \%\f3GL_RENDERER\fP, \%\f3GL_VERSION\fP, or \%\f3GL_EXTENSIONS\fP.
 
22
.SH DESCRIPTION
 
23
\%\f3glGetString\fP returns a pointer to a static string
 
24
describing some aspect of the current GL connection.
 
25
\f2name\fP can be one of the following:
 
26
.TP 20
 
27
\%\f3GL_VENDOR\fP
 
28
Returns the company responsible for this GL implementation.
 
29
This name does not change from release to release.
 
30
.TP
 
31
\%\f3GL_RENDERER\fP
 
32
Returns the name of the renderer.
 
33
This name is typically specific to a particular configuration of a hardware
 
34
platform.
 
35
It does not change from release to release.
 
36
.TP
 
37
\%\f3GL_VERSION\fP
 
38
Returns a version or release number.
 
39
.TP
 
40
\%\f3GL_EXTENSIONS\fP
 
41
Returns a space-separated list of supported extensions to GL.
 
42
.P
 
43
Because the GL does not include queries for the performance
 
44
characteristics of an implementation, some applications are written to
 
45
recognize known platforms and modify their GL usage based on known
 
46
performance characteristics of these platforms.
 
47
Strings \%\f3GL_VENDOR\fP and \%\f3GL_RENDERER\fP together uniquely specify
 
48
a platform. They do not change from release to release and should be used
 
49
by platform-recognition algorithms. 
 
50
.P
 
51
Some applications want to make use of features that
 
52
are not part of the standard GL. These features
 
53
may be implemented as extensions to the standard GL.
 
54
The \%\f3GL_EXTENSIONS\fP string is a space-separated
 
55
list of supported GL extensions.
 
56
(Extension names never contain a space character.)
 
57
.P
 
58
The \%\f3GL_VERSION\fP string begins with a version number.
 
59
The version number uses one
 
60
of these forms: 
 
61
.P
 
62
\f2major_number.minor_number\fP  
 
63
.br
 
64
\f2major_number.minor_number.release_number\fP
 
65
.P
 
66
Vendor-specific information may follow the version
 
67
number. Its  depends on the implementation, but 
 
68
a space always separates the version number and 
 
69
the vendor-specific information.
 
70
.P
 
71
All strings are null-terminated.
 
72
.SH NOTES
 
73
If an error is generated, \%\f3glGetString\fP returns 0.
 
74
.P
 
75
The client and server may support different versions or extensions.
 
76
\%\f3glGetString\fP always returns a compatible version number or list of extensions. 
 
77
The release number always describes the server.
 
78
.SH ERRORS
 
79
\%\f3GL_INVALID_ENUM\fP is generated if \f2name\fP is not an accepted value.
 
80
.P
 
81
\%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glGetString\fP
 
82
is executed between the execution of \%\f3glBegin\fP
 
83
and the corresponding execution of \%\f3glEnd\fP.