GLGETSTRING

Index

NAME

- return a string describing the current GL connection

C SPECIFICATION

const GLubyte* f3glGetStringfP( GLenum fInamefP )

PARAMETERS

f2namefP: Specifies a symbolic constant, one of %f3GL_VENDORfP, %f3GL_RENDERERfP, %f3GL_VERSIONfP, or %f3GL_EXTENSIONSfP.

DESCRIPTION

%f3glGetStringfP returns a pointer to a static string describing some aspect of the current GL connection. f2namefP can be one of the following:

%f3GL_VENDORfP: Returns the company responsible for this GL implementation. This name does not change from release to release.
%f3GL_RENDERERfP: 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.
%f3GL_VERSIONfP: Returns a version or release number.
%f3GL_EXTENSIONSfP: Returns a space-separated list of supported extensions to GL. Because the GL does not include queries for the performance characteristics of an implementation, some applications are written to recognize known platforms and modify their GL usage based on known performance characteristics of these platforms. Strings %f3GL_VENDORfP and %f3GL_RENDERERfP together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms. Some applications want to make use of features that are not part of the standard GL. These features may be implemented as extensions to the standard GL. The %f3GL_EXTENSIONSfP string is a space-separated list of supported GL extensions. (Extension names never contain a space character.) The %f3GL_VERSIONfP string begins with a version number. The version number uses one of these forms: f2major_number.minor_numberfP
f2major_number.minor_number.release_numberfP Vendor-specific information may follow the version number. Its 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, %f3glGetStringfP returns 0. The client and server may support different versions or extensions. %f3glGetStringfP always returns a compatible version number or list of extensions. The release number always describes the server.

ERRORS

%f3GL_INVALID_ENUMfP is generated if f2namefP is not an accepted value. %f3GL_INVALID_OPERATIONfP is generated if %f3glGetStringfP is executed between the execution of %f3glBeginfP and the corresponding execution of %f3glEndfP.