Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

glvalidateprogram(3g) [osx man page]

GLVALIDATEPROGRAM(3G)						    OpenGL 3.3						     GLVALIDATEPROGRAM(3G)

NAME

       glValidateProgram - Validates a program object

C SPECIFICATION

       void glValidateProgram(GLuint program);

PARAMETERS

       program
	   Specifies the handle of the program object to be validated.

DESCRIPTION

       glValidateProgram checks to see whether the executables contained in program can execute given the current OpenGL state. The information
       generated by the validation process will be stored in program's information log. The validation information may consist of an empty string,
       or it may be a string containing information about how the current program object interacts with the rest of current OpenGL state. This
       provides a way for OpenGL implementers to convey more information about why the current program is inefficient, suboptimal, failing to
       execute, and so on.

       The status of the validation operation will be stored as part of the program object's state. This value will be set to GL_TRUE if the
       validation succeeded, and GL_FALSE otherwise. It can be queried by calling glGetProgram() with arguments program and GL_VALIDATE_STATUS. If
       validation is successful, program is guaranteed to execute given the current state. Otherwise, program is guaranteed to not execute.

       This function is typically useful only during application development. The informational string stored in the information log is completely
       implementation dependent; therefore, an application should not expect different OpenGL implementations to produce identical information
       strings.

NOTES

       This function mimics the validation operation that OpenGL implementations must perform when rendering commands are issued while
       programmable shaders are part of current state. The error GL_INVALID_OPERATION will be generated by any command that triggers the rendering
       of geometry if:

       o   any two active samplers in the current program object are of different types, but refer to the same texture image unit,

       o   the number of active samplers in the program exceeds the maximum number of texture image units allowed.

       It may be difficult or cause a performance degradation for applications to catch these errors when rendering commands are issued.
       Therefore, applications are advised to make calls to glValidateProgram to detect these issues during application development.

ERRORS

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

       GL_INVALID_OPERATION is generated if program is not a program object.

ASSOCIATED GETS

       glGetProgram() with arguments program and GL_VALIDATE_STATUS

       glGetProgramInfoLog() with argument program

       glIsProgram()

SEE ALSO

       glLinkProgram(), glUseProgram()

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						     GLVALIDATEPROGRAM(3G)

Check Out this Related Man Page

GLGETPROGRAMINFOLOG(3G) 					  [FIXME: manual]					   GLGETPROGRAMINFOLOG(3G)

NAME

       glGetProgramInfoLog - Returns the information log for a program object

C SPECIFICATION

       void glGetProgramInfoLog(GLuint program, GLsizei maxLength, GLsizei *length, GLchar *infoLog);

PARAMETERS

       program
	   Specifies the program 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

       glGetProgramInfoLog returns the information log for the specified program object. The information log for a program object is modified when
       the program object is linked or validated. The string that is returned will be null terminated.

       glGetProgramInfoLog 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 glGetProgram() with the value GL_INFO_LOG_LENGTH.

       The information log for a program object is either an empty string, or a string containing information about the last link operation, or a
       string containing information about the last validation operation. It may contain diagnostic messages, warning messages, and other
       information. When a program object is created, its information log will be a string of length 0.

NOTES

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

ERRORS

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

       GL_INVALID_OPERATION is generated if program is not a program object.

       GL_INVALID_VALUE is generated if maxLength is less than 0.

ASSOCIATED GETS

       glGetProgram() with argument GL_INFO_LOG_LENGTH

       glIsProgram()

SEE ALSO

       glCompileShader(), glGetShaderInfoLog(), 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/.

[FIXME: source] 						    05/30/2012						   GLGETPROGRAMINFOLOG(3G)
Man Page