summaryrefslogtreecommitdiff
path: root/doc/gl-docs/GLU/getstring.3gl
diff options
context:
space:
mode:
authorMatthieu Herrb <matthieu@cvs.openbsd.org>2006-11-29 17:01:55 +0000
committerMatthieu Herrb <matthieu@cvs.openbsd.org>2006-11-29 17:01:55 +0000
commit4326795e6af251f5fef91f197bc883079fa92f99 (patch)
tree82b19811f2a17c6f1303b3d7f582b22f09bc7d38 /doc/gl-docs/GLU/getstring.3gl
parent8792f4be39d5024284e8c412d0dc92cf1f90dba1 (diff)
GLU manual pages from monolithic tree
Diffstat (limited to 'doc/gl-docs/GLU/getstring.3gl')
-rw-r--r--doc/gl-docs/GLU/getstring.3gl65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/gl-docs/GLU/getstring.3gl b/doc/gl-docs/GLU/getstring.3gl
new file mode 100644
index 000000000..3eb4b1c4d
--- /dev/null
+++ b/doc/gl-docs/GLU/getstring.3gl
@@ -0,0 +1,65 @@
+'\" e
+'\"! eqn | mmdoc
+'\"macro stdmacro
+.ds Vn Version 1.2
+.ds Dt 6 March 1997
+.ds Re Release 1.2.0
+.ds Dp May 02 11:53
+.ds Dm 37 getstring
+.ds Xs 20129 4 getstring.gl
+.TH GLUGETSTRING 3G
+.SH NAME
+.B "gluGetString
+\- return a string describing the GLU version or GLU extensions
+
+.SH C SPECIFICATION
+const GLubyte * \f3gluGetString\fP(
+GLenum \fIname\fP )
+.nf
+.fi
+
+.SH PARAMETERS
+.TP \w'\f2name\fP\ \ 'u
+\f2name\fP
+Specifies a symbolic constant, one of
+\%\f3GLU_VERSION\fP, or \%\f3GLU_EXTENSIONS\fP.
+.SH DESCRIPTION
+\%\f3gluGetString\fP returns a pointer to a static string describing the
+GLU version or the GLU extensions that are supported.
+.P
+The version number is one of the following
+forms:
+.P
+\f2major_number.minor_number\fP
+.br
+\f2major_number.minor_number.release_number\fP.
+.P
+The version string is of the following form:
+.P
+\f2version number<space>vendor-specific information\fP
+.P
+Vendor-specific information is optional.
+Its and contents depend on the implementation.
+.P
+The standard GLU contains a basic set of features and capabilities.
+If a company or group of companies wish to support other features,
+these may be included as extensions to the GLU.
+If \f2name\fP is
+\%\f3GLU_EXTENSIONS\fP, then \%\f3gluGetString\fP
+returns a space-separated list of names of supported GLU extensions.
+(Extension names never contain spaces.)
+.P
+All strings are null-terminated.
+.SH NOTES
+\%\f3gluGetString\fP only returns information about GLU extensions. Call
+\f3glGetString\fP to get a list of GL extensions.
+.P
+\%\f3gluGetString\fP is an initialization routine. Calling it after
+a \f3glNewList\fP results in undefined behavior.
+.SH ERRORS
+NULL is returned if \f2name\fP is not
+\%\f3GLU_VERSION\fP or \%\f3GLU_EXTENSIONS\fP.
+.P
+.SH SEE ALSO
+\f3glGetString(3G)\fP
+