glgetshaderinfolog(3g) [osx man page]

GLGETSHADERINFOLOG(3G)						    OpenGL 3.3						    GLGETSHADERINFOLOG(3G)

NAME

       glGetShaderInfoLog - Returns the information log for a shader object

C SPECIFICATION

       void glGetShaderInfoLog(GLuint shader, GLsizei maxLength, GLsizei *length, GLchar *infoLog);

PARAMETERS

       shader
	   Specifies the shader object whose information log is to be queried.

       maxLength
	   Specifies the size of the character buffer for storing the returned information log.

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

       infoLog
	   Specifies an array of characters that is used to return the information log.

DESCRIPTION

       glGetShaderInfoLog returns the information log for the specified shader object. The information log for a shader object is modified when
       the shader is compiled. The string that is returned will be null terminated.

       glGetShaderInfoLog returns in infoLog as much of the information log as it can, up to a maximum of maxLength 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 information log can
       be obtained by calling glGetShader() with the value GL_INFO_LOG_LENGTH.

       The information log for a shader object is a string that may contain diagnostic messages, warning messages, and other information about the
       last compile operation. When a shader object is created, its information log will be a string of length 0.

NOTES

       The information log for a shader object is the OpenGL implementer's primary mechanism for conveying information about the compilation
       process. Therefore, the information log can be helpful to application developers during the development process, even when compilation is
       successful. Application developers should not expect different OpenGL implementations to produce identical information logs.

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 maxLength is less than 0.

ASSOCIATED GETS

       glGetShader() with argument GL_INFO_LOG_LENGTH

       glIsShader()

SEE ALSO

       glCompileShader(), glGetProgramInfoLog(), glLinkProgram(), glValidateProgram()

COPYRIGHT

       Copyright (C) 2003-2005 3Dlabs Inc. Ltd. This material may be distributed subject to the terms and conditions set forth in the Open
       Publication License, v 1.0, 8 June 1999.  http://opencontent.org/openpub/.

OpenGL 3.3							    03/08/2011						    GLGETSHADERINFOLOG(3G)

Check Out this Related Man Page

GLGETSHADER(3G) 						    OpenGL 3.3							   GLGETSHADER(3G)

NAME

       glGetShaderiv - Returns a parameter from a shader object

C SPECIFICATION

       void glGetShaderiv(GLuint shader, GLenum pname, GLint *params);

PARAMETERS

       shader
	   Specifies the shader object to be queried.

       pname
	   Specifies the object parameter. Accepted symbolic names are GL_SHADER_TYPE, GL_DELETE_STATUS, GL_COMPILE_STATUS, GL_INFO_LOG_LENGTH,
	   GL_SHADER_SOURCE_LENGTH.

       params
	   Returns the requested object parameter.

DESCRIPTION

       glGetShader returns in params the value of a parameter for a specific shader object. The following parameters are defined:

       GL_SHADER_TYPE

	   params returns GL_VERTEX_SHADER if shader is a vertex shader object, GL_GEOMETRY_SHADER if shader is a geometry shader object, and
	   GL_FRAGMENT_SHADER if shader is a fragment shader object.

       GL_DELETE_STATUS

	   params returns GL_TRUE if shader is currently flagged for deletion, and GL_FALSE otherwise.

       GL_COMPILE_STATUS

	   params returns GL_TRUE if the last compile operation on shader was successful, and GL_FALSE otherwise.

       GL_INFO_LOG_LENGTH

	   params returns the number of characters in the information log for shader including the null termination character (i.e., the size of
	   the character buffer required to store the information log). If shader has no information log, a value of 0 is returned.

       GL_SHADER_SOURCE_LENGTH

	   params returns the length of the concatenation of the source strings that make up the shader source for the shader, including the null
	   termination character. (i.e., the size of the character buffer required to store the shader source). If no source code exists, 0 is
	   returned.

NOTES

       If an error is generated, no change is made to the contents of params.

ERRORS

       GL_INVALID_VALUE is generated if shader is not a value generated by OpenGL.

       GL_INVALID_OPERATION is generated if shader does not refer to a shader object.

       GL_INVALID_ENUM is generated if pname is not an accepted value.

ASSOCIATED GETS

       glGetShaderInfoLog() with argument shader

       glGetShaderSource() with argument shader

       glIsShader()

SEE ALSO

       glCompileShader(), glCreateShader(), glDeleteShader(), glGetProgram(), glShaderSource()

COPYRIGHT

       Copyright (C) 2003-2005 3Dlabs Inc. Ltd. This material may be distributed subject to the terms and conditions set forth in the Open
       Publication License, v 1.0, 8 June 1999.  http://opencontent.org/openpub/.

OpenGL 3.3							    03/08/2011							   GLGETSHADER(3G)

Linux and UNIX Man Pages

glgetshaderinfolog(3g) [osx man page]

Check Out this Related Man Page