getstring.3gl 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. '\" e
  2. '\"! eqn | mmdoc
  3. '\"macro stdmacro
  4. .ds Vn Version 1.2
  5. .ds Dt 6 March 1997
  6. .ds Re Release 1.2.0
  7. .ds Dp May 02 11:53
  8. .ds Dm 37 getstring
  9. .ds Xs 20129 4 getstring.gl
  10. .TH GLUGETSTRING 3G
  11. .SH NAME
  12. .B "gluGetString
  13. \- return a string describing the GLU version or GLU extensions
  14. .SH C SPECIFICATION
  15. const GLubyte * \f3gluGetString\fP(
  16. GLenum \fIname\fP )
  17. .nf
  18. .fi
  19. .SH PARAMETERS
  20. .TP \w'\f2name\fP\ \ 'u
  21. \f2name\fP
  22. Specifies a symbolic constant, one of
  23. \%\f3GLU_VERSION\fP, or \%\f3GLU_EXTENSIONS\fP.
  24. .SH DESCRIPTION
  25. \%\f3gluGetString\fP returns a pointer to a static string describing the
  26. GLU version or the GLU extensions that are supported.
  27. .P
  28. The version number is one of the following
  29. forms:
  30. .P
  31. \f2major_number.minor_number\fP
  32. .br
  33. \f2major_number.minor_number.release_number\fP.
  34. .P
  35. The version string is of the following form:
  36. .P
  37. \f2version number<space>vendor-specific information\fP
  38. .P
  39. Vendor-specific information is optional.
  40. Its and contents depend on the implementation.
  41. .P
  42. The standard GLU contains a basic set of features and capabilities.
  43. If a company or group of companies wish to support other features,
  44. these may be included as extensions to the GLU.
  45. If \f2name\fP is
  46. \%\f3GLU_EXTENSIONS\fP, then \%\f3gluGetString\fP
  47. returns a space-separated list of names of supported GLU extensions.
  48. (Extension names never contain spaces.)
  49. .P
  50. All strings are null-terminated.
  51. .SH NOTES
  52. \%\f3gluGetString\fP only returns information about GLU extensions. Call
  53. \f3glGetString\fP to get a list of GL extensions.
  54. .P
  55. \%\f3gluGetString\fP is an initialization routine. Calling it after
  56. a \f3glNewList\fP results in undefined behavior.
  57. .SH ERRORS
  58. NULL is returned if \f2name\fP is not
  59. \%\f3GLU_VERSION\fP or \%\f3GLU_EXTENSIONS\fP.
  60. .P
  61. .SH SEE ALSO
  62. \f3glGetString(3G)\fP