glGetString — return a string describing the current GL connection
const GLubyte* glGetString( | GLenum name); |
const GLubyte* glGetStringi( | GLenum name, |
GLuint index); |
name Specifies a symbolic constant, one of GL_EXTENSIONS, GL_RENDERER, GL_SHADING_LANGUAGE_VERSION, GL_VENDOR, or GL_VERSION. glGetStringi accepts only the GL_EXTENSIONS token.
index For glGetStringi, specifies the index of the string to return.
glGetString returns a pointer to a static string describing some aspect of the current GL connection. name can be one of the following:
GL_EXTENSIONS Returns the extension string supported by the implementation.
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 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 string is laid out as follows:
OpenGL ES N.M vendor-specific information
The GL_SHADING_LANGUAGE_VERSION string is laid out as follows:
OpenGL ES GLSL ES N.M vendor-specific information
The version number is either of the form major_number.minor_number or major_number.minor_number.release_number, where the numbers all have one or more digits. The minor number for SHADING_LANGUAGE_VERSION is always two digits, matching the OpenGL ES Shading Language Specification 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.
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.
There is no defined relationship between the order in which extension names appear in the non-indexed string and the order in which they appear in the indexed query.
There is no defined relationship between any particular extension name and the index values; an extension name may correspond to a different index in different GL contexts and/or implementations.
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.
| OpenGL ES API Version | ||||
|---|---|---|---|---|
| Function Name | 2.0 | 3.0 | 3.1 | 3.2 |
GetString | ✔ | ✔ | ✔ | ✔ |
GetStringi | - | ✔ | ✔ | ✔ |
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2015 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see https://khronos.org/registry/OpenGL-Refpages/LICENSES/LicenseRef-FreeB.txt.