1
1
Fork 0
mirror of https://github.com/QB64-Phoenix-Edition/QB64pe.git synced 2024-07-26 06:15:52 +00:00
QB64-PE/internal/help/_glGetString.txt
SMcNeill 6e01fc8dce Altered string compare routines (<,<=,>,>=) so they don't give false results with CHR$(0).
Added new _STRCMP and _STRICMP commands for quick string comparisons.
Cleaned up QB64 to finish removing the QUI (quick user insert) code and folders.
Altered UCASE and LCASE routines to be faster in some situations for us.
2014-09-22 08:19:03 -04:00

72 lines
3.2 KiB
Plaintext

'''_glGetString:''' return a string describing the current GL connection
{{PageSyntax}}
FUNCTION _glGetString&amp;&amp; (BYVAL name AS _UNSIGNED LONG)
const GLubyte* '''_glGetString'''(GLenum {{Parameter|name}});
const GLubyte* '''_glGetStringi'''(GLenum {{Parameter|name}}, GLuint {{Parameter|index}});
; name
: Specifies a symbolic constant, one of {{KW|_GL_VENDOR}}, {{KW|_GL_RENDERER}}, {{KW|_GL_VERSION}}, or {{KW|_GL_SHADING_LANGUAGE_VERSION}}. Additionally, '''_glGetStringi''' accepts the {{KW|_GL_EXTENSIONS}} token.
; index
: For '''_glGetStringi''', specifies the index of the string to return.
{{PageDescription}}
'''_glGetString''' returns a pointer to a static string describing some aspect of the current GL connection. {{Parameter|name}} can be one of the following:
; {{KW|_GL_VENDOR}}
:
Returns the company responsible for this GL implementation. This name does not change from release to release.
; {{KW|_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.
; {{KW|_GL_VERSION}}
:
Returns a version or release number.
; {{KW|_GL_SHADING_LANGUAGE_VERSION}}
:
Returns a version or release number for the shading language.
Strings {{KW|_GL_VENDOR}} and {{KW|_GL_RENDERER}} together uniquely specify a platform. They do not change from release to release and should be used by platform-recognition algorithms.
'''_glGetStringi''' returns a pointer to a static string indexed by {{Parameter|index}}. {{Parameter|name}} can be one of the following:
; {{KW|_GL_EXTENSIONS}}
: For '''_glGetStringi''' only, returns the extension string supported by the implementation at {{Parameter|index}}. The index {{Parameter|index}} is on the range [0 to {{KW|_glGet|Integerv(GL_NUM_EXTENSIONS)}} - 1].
; {{KW|_GL_SHADING_LANGUAGE_VERSION}}
: Returns one of the versions of [[GLSL]] supported by this implementation. {{Parameter|index}} is on the range [0 to {{KW|_glGet|Integerv(GL_NUM_SHADING_LANGUAGE_VERSIONS)}} - 1].
The {{KW|_GL_VERSION}} and {{KW|_GL_SHADING_LANGUAGE_VERSION}} strings begin with a version number. The version number uses one of these forms:
''major_number.minor_number''
or
''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.
{{PageNotes}}
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.
{{PageErrors}}
{{KW|_GL_INVALID_ENUM}} is generated if {{Parameter|name}} is not an accepted value.
{{KW|_GL_INVALID_VALUE}} is generated by '''_glGetStringi''' if {{Parameter|index}} is outside the valid range for indexed state {{Parameter|name}}.
{{PageCopyright}}
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/ http://oss.sgi.com/projects/FreeB/].