GLAPI/glGetString: Difference between revisions
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
const GLubyte* '''glGetString'''(GLenum | const GLubyte* '''glGetString'''(GLenum {{param|name}}); | ||
== Function Definition == | == Function Definition == | ||
const GLubyte* '''glGetStringi'''(GLenum | const GLubyte* '''glGetStringi'''(GLenum {{param|name}}, GLuint {{param|index}}); | ||
; name | ; name | ||
| Line 21: | Line 21: | ||
== Description == | == Description == | ||
'''glGetString''' returns a pointer to a static string describing some aspect of the current GL connection. | '''glGetString''' returns a pointer to a static string describing some aspect of the current GL connection. {{param|name}} can be one of the following: | ||
; {{code|GL_VENDOR}} | ; {{code|GL_VENDOR}} | ||
| Line 35: | Line 35: | ||
: | : | ||
Returns a version or release number for the shading language. | Returns a version or release number for the shading language. | ||
'''glGetStringi''' returns a pointer to a static string indexed by | '''glGetStringi''' returns a pointer to a static string indexed by {{param|index}}. {{param|name}} can be one of the following: | ||
; {{code|GL_EXTENSIONS}} | ; {{code|GL_EXTENSIONS}} | ||
: | : | ||
For '''glGetStringi''' only, returns the extension string supported by the implementation at | For '''glGetStringi''' only, returns the extension string supported by the implementation at {{param|index}}. | ||
Strings {{code|GL_VENDOR}} and {{code|GL_RENDERER}} together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms. | Strings {{code|GL_VENDOR}} and {{code|GL_RENDERER}} together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms. | ||
| Line 58: | Line 58: | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|name}} is not an accepted value. | ||
{{code|GL_INVALID_VALUE}} is generated by '''glGetStringi''' if | {{code|GL_INVALID_VALUE}} is generated by '''glGetStringi''' if {{param|index}} is outside the valid range for indexed state {{param|name}}. | ||
== Copyright == | == Copyright == | ||
Revision as of 01:21, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.0 | |
glGetString: return a string describing the current GL connection
Function Definition
const GLubyte* glGetString(GLenum name);
Function Definition
const GLubyte* glGetStringi(GLenum name, GLuint index);
- name
- Specifies a symbolic constant, one of GL_VENDOR, GL_RENDERER, GL_VERSION, or GL_SHADING_LANGUAGE_VERSION. Additionally, glGetStringi accepts the GL_EXTENSIONS token.
- index
- For glGetStringi, specifies the index of the string to return.
Description
glGetString returns a pointer to a static string describing some aspect of the current GL connection. name can be one of the following:
- GL_VENDOR
Returns the company responsible for this GL implementation. This name does not change from release to release.
- GL_RENDERER
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.
- GL_VERSION
Returns a version or release number.
- GL_SHADING_LANGUAGE_VERSION
Returns a version or release number for the shading language. glGetStringi returns a pointer to a static string indexed by index. name can be one of the following:
- GL_EXTENSIONS
For glGetStringi only, returns the extension string supported by the implementation at index. Strings GL_VENDOR and GL_RENDERER together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms.
The GL_VERSION and GL_SHADING_LANGUAGE_VERSION strings begin with a version number. The version number uses one of these forms:
major_number.minor_number'major_number.minor_number.release_number
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.
All strings are null-terminated.
Notes
If an error is generated, glGetString returns 0.
The client and server may support different versions. glGetString always returns a compatible version number. The release number always describes the server.
Errors
GL_INVALID_ENUM is generated if name is not an accepted value.
GL_INVALID_VALUE is generated by glGetStringi if index is outside the valid range for indexed state name.
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.