Gl.GetShaderSource (gb.opengl.glsl)

Returns the source code string from a shader object.

Parameters

shader

Specifies the shader object to be queried.

bufSize

Specifies the size of the character buffer for storing the returned source code string.

length

Returns the length of the string returned in source (excluding the null terminator).

source

Specifies an array of characters that is used to return the source code string.

Description

Gl.GetShaderSource returns the concatenation of the source code strings from the shader object specified by shader. The source code strings for a shader object are the result of a previous call to Gl.ShaderSource. The string returned by the function will be null terminated.

Gl.GetShaderSource returns in source as much of the source code string as it can, up to a maximum of bufSize characters. The number of characters actually returned, excluding the null termination character, is specified by length. If the length of the returned string is not required, a value of NULL can be passed in the length argument. The size of the buffer required to store the returned source code string can be obtained by calling Gl.GetShader with the value Gl.SHADER_SOURCE_LENGTH.

Errors

Gl.INVALID_VALUE is generated if shader is not a value generated by OpenGL.

Gl.INVALID_OPERATION is generated if shader is not a shader object.

Gl.INVALID_VALUE is generated if bufSize is less than 0.

Associated Gets

Gl.GetShader with argument Gl.SHADER_SOURCE_LENGTH

Gl.IsShader

See also

See original documentation on OpenGL website