Gambas Documentation - /comp/gb.opengl/gl/getstring

/comp/gb.opengl/gl/getstring

# Gl.GetString (gb.opengl)

Static Function GetString ( Name As Integer ) As String

Return a string describing the current GL connection.

### Parameters

name

  Specifies a symbolic constant, one of Gl.VENDOR, Gl.RENDERER, Gl.VERSION, or Gl.SHADING_LANGUAGE_VERSION. Additionally, Gl.GetStringi accepts the Gl.EXTENSIONS token.

index

  For Gl.GetStringi, specifies the index of the string to return.

### Description

Gl.GetString 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.

Gl.GetStringi returns a pointer to a static string indexed by index. name can be one of the following:

Gl.EXTENSIONS

  For Gl.GetStringi 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, Gl.GetString returns 0.

The client and server may support different versions. Gl.GetString 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 Gl.GetStringi if index is outside the valid range for indexed state name.

See original documentation on OpenGL website