GLAPI/glCreateShaderProgram: Difference between revisions
< GLAPI
4.0 API. |
m Bot: Adding better formatting. |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
== Function Definition == | == Function Definition == | ||
GLuint '''glCreateShaderProgramv'''(GLenum | GLuint '''glCreateShaderProgramv'''(GLenum {{param|type}}, GLsizei {{param|count}}, const char **{{param|strings}}); | ||
; type | ; type | ||
: Specifies the type of shader to create. | : Specifies the type of shader to create. | ||
; count | ; count | ||
: Specifies the number of source code strings in the array | : Specifies the number of source code strings in the array {{param|strings}}. | ||
; strings | ; strings | ||
: Specifies the address of an array of pointers to source code strings from which to create the program object. | : Specifies the address of an array of pointers to source code strings from which to create the program object. | ||
| Line 20: | Line 20: | ||
== Description == | == Description == | ||
'''glCreateShaderProgram''' creates a program object containing compiled and linked shaders for a single stage specified by | '''glCreateShaderProgram''' creates a program object containing compiled and linked shaders for a single stage specified by {{param|type}}. {{param|strings}} refers to an array of {{param|count}} strings from which to create the shader executables. | ||
'''glCreateShaderProgram''' is equivalent (assuming no errors are generated) to: | '''glCreateShaderProgram''' is equivalent (assuming no errors are generated) to: | ||
| Line 47: | Line 47: | ||
return 0; | return 0; | ||
} | } | ||
</source>The program object created by '''glCreateShaderProgram''' has its {{ | </source>The program object created by '''glCreateShaderProgram''' has its {{enum|GL_PROGRAM_SEPARABLE}} status set to {{enum|GL_TRUE}}. | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if if {{param|type}} is not an accepted shader type. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|count}} is negative. | ||
Other errors are generated if the supplied shader code fails to compile and link, as described for the commands in the pseudocode sequence above, but all such errors are generated without any side effects of executing those commands. | |||
== See Also == | == See Also == | ||
{{apifunc|glCreateShader}}, {{apifunc|glCreateProgram}}, {{apifunc|glCompileShader}}, {{apifunc|glShaderSource}}, {{apifunc|glLinkProgram}} | |||
== Copyright == | == Copyright == | ||
Copyright © 2010 Khronos Group. 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 © 2010-2012 Khronos Group. 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|CreateShaderProgram]] | ||
[[Category:Core API Ref Shader Program Creation|CreateShaderProgram]] | |||
Latest revision as of 01:42, 25 July 2013
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 4.1 | |
| Core ARB extension | ARB_separate_shader_objects | |
glCreateShaderProgramv: create a stand-alone program from an array of null-terminated source code strings
Function Definition
GLuint glCreateShaderProgramv(GLenum type, GLsizei count, const char **strings);
- type
- Specifies the type of shader to create.
- count
- Specifies the number of source code strings in the array strings.
- strings
- Specifies the address of an array of pointers to source code strings from which to create the program object.
Description
glCreateShaderProgram creates a program object containing compiled and linked shaders for a single stage specified by type. strings refers to an array of count strings from which to create the shader executables.
glCreateShaderProgram is equivalent (assuming no errors are generated) to:
const GLuint shader = glCreateShader(type);
if (shader) {
glShaderSource(shader, count, strings, NULL);
glCompileShader(shader);
const GLuint program = glCreateProgram();
if (program) {
GLint compiled = GL_FALSE;
glGetShaderiv(shader, GL_COMPILE_STATUS, &compiled);
glProgramParameteri(program, GL_PROGRAM_SEPARABLE, GL_TRUE);
if (compiled) {
glAttachShader(program, shader);
glLinkProgram(program);
glDetachShader(program, shader);
}
/* append-shader-info-log-to-program-info-log */
}
glDeleteShader(shader);
return program;
} else {
return 0;
}
The program object created by glCreateShaderProgram has its GL_PROGRAM_SEPARABLE status set to GL_TRUE.
Errors
GL_INVALID_ENUM is generated if if type is not an accepted shader type.
GL_INVALID_VALUE is generated if count is negative.
Other errors are generated if the supplied shader code fails to compile and link, as described for the commands in the pseudocode sequence above, but all such errors are generated without any side effects of executing those commands.
See Also
glCreateShader, glCreateProgram, glCompileShader, glShaderSource, glLinkProgram
Copyright
Copyright © 2010-2012 Khronos Group. 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/.