GLAPI/glCompileShader: Difference between revisions
m fixed sort key |
m Bot: Adding better formatting. |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glCompileShader'''(GLuint | void '''glCompileShader'''(GLuint {{param|shader}}); | ||
; shader | ; shader | ||
| Line 15: | Line 15: | ||
== Description == | == Description == | ||
'''glCompileShader''' compiles the source code strings that have been stored in the shader object specified by | '''glCompileShader''' compiles the source code strings that have been stored in the shader object specified by {{param|shader}}. | ||
The compilation status will be stored as part of the shader object's state. This value will be set to {{ | The compilation status will be stored as part of the shader object's state. This value will be set to {{enum|GL_TRUE}} if the shader was compiled without errors and is ready for use, and {{enum|GL_FALSE}} otherwise. It can be queried by calling {{apifunc|glGetShader}} with arguments {{param|shader}} and {{enum|GL_COMPILE_STATUS}}. | ||
Compilation of a shader can fail for a number of reasons as specified by the OpenGL Shading Language Specification. Whether or not the compilation was successful, information about the compilation can be obtained from the shader object's information log by calling | Compilation of a shader can fail for a number of reasons as specified by the OpenGL Shading Language Specification. Whether or not the compilation was successful, information about the compilation can be obtained from the shader object's information log by calling {{apifunc|glGetShaderInfoLog}}. | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|shader}} is not a value generated by OpenGL. | ||
{{ | {{enum|GL_INVALID_OPERATION}} is generated if {{param|shader}} is not a shader object. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGetShaderInfoLog}} with argument {{param|shader}} | |||
{{apifunc|glGetShader}} with arguments {{param|shader}} and {{enum|GL_COMPILE_STATUS}} | |||
{{apifunc|glIsShader}} | |||
== See Also == | == See Also == | ||
{{apifunc|glAttachShader}}, {{apifunc|glCreateShader}}, {{apifunc|glCreateShaderProgram}}, {{apifunc|glLinkProgram}}, {{apifunc|glReleaseShaderCompiler}}, {{apifunc|glShaderSource}}, {{apifunc|glShaderBinary}} | |||
== Copyright == | == Copyright == | ||
| Line 43: | Line 43: | ||
Copyright © 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/ http://opencontent.org/openpub/]. | Copyright © 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/ http://opencontent.org/openpub/]. | ||
[[Category:API Reference | [[Category:Core API Reference|CompileShader]] | ||
[[Category:Core API Ref Shader Program Creation|CompileShader]] | |||
[[Category:Shader Object API State Functions|CompileShader]] | |||
Latest revision as of 09:51, 15 August 2013
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 2.0 | |
glCompileShader: Compiles a shader object
Function Definition
void glCompileShader(GLuint shader);
- shader
- Specifies the shader object to be compiled.
Description
glCompileShader compiles the source code strings that have been stored in the shader object specified by shader.
The compilation status will be stored as part of the shader object's state. This value will be set to GL_TRUE if the shader was compiled without errors and is ready for use, and GL_FALSE otherwise. It can be queried by calling glGetShader with arguments shader and GL_COMPILE_STATUS.
Compilation of a shader can fail for a number of reasons as specified by the OpenGL Shading Language Specification. Whether or not the compilation was successful, information about the compilation can be obtained from the shader object's information log by calling glGetShaderInfoLog.
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.
Associated Gets
glGetShaderInfoLog with argument shader
glGetShader with arguments shader and GL_COMPILE_STATUS
See Also
glAttachShader, glCreateShader, glCreateShaderProgram, glLinkProgram, glReleaseShaderCompiler, glShaderSource, glShaderBinary
Copyright
Copyright © 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/.