Difference between revisions of "GLAPI/glProgramBinary"
m (Renaming category: 'GL 4 API Shader Program Creation' to 'Core API Ref Shader Program Creation'.) |
m (Bot: Adding better formatting.) |
||
| Line 9: | Line 9: | ||
== Function Definition == | == Function Definition == | ||
| − | void '''glProgramBinary'''(GLuint | + | void '''glProgramBinary'''(GLuint {{param|program}}, GLenum {{param|binaryFormat}}, const void *{{param|binary}}, GLsizei {{param|length}}); |
; program | ; program | ||
| Line 16: | Line 16: | ||
: Specifies the format of the binary data in binary. | : Specifies the format of the binary data in binary. | ||
; binary | ; binary | ||
| − | : Specifies the address an array containing the binary to be loaded into | + | : Specifies the address an array containing the binary to be loaded into {{param|program}}. |
; length | ; length | ||
| − | : Specifies the number of bytes contained in | + | : Specifies the number of bytes contained in {{param|binary}}. |
== Description == | == Description == | ||
| − | '''glProgramBinary''' loads a program object with a program binary previously returned from | + | '''glProgramBinary''' loads a program object with a program binary previously returned from {{apifunc|glGetProgramBinary}}. {{param|binaryFormat}} and {{param|binary}} must be those returned by a previous call to {{apifunc|glGetProgramBinary}}, and {{param|length}} must be the length returned by {{apifunc|glGetProgramBinary}}, or by {{apifunc|glGetProgram}} when called with {{param|pname}} set to {{code|GL_PROGRAM_BINARY_LENGTH}}. If these conditions are not met, loading the program binary will fail and {{param|program}}'s {{code|GL_LINK_STATUS}} will be set to {{code|GL_FALSE}}. |
| − | A program object's program binary is replaced by calls to | + | A program object's program binary is replaced by calls to {{apifunc|glLinkProgram}} or '''glProgramBinary'''. When linking success or failure is concerned, '''glProgramBinary''' can be considered to perform an implicit linking operation. {{apifunc|glLinkProgram}} and '''glProgramBinary''' both set the program object's {{code|GL_LINK_STATUS}} to {{code|GL_TRUE}} or {{code|GL_FALSE}}. |
A successful call to '''glProgramBinary''' will reset all uniform variables to their initial values. The initial value is either the value of the variable's initializer as specified in the original shader source, or zero if no initializer was present. Additionally, all vertex shader input and fragment shader output assignments that were in effect when the program was linked before saving are restored with '''glProgramBinary''' is called. | A successful call to '''glProgramBinary''' will reset all uniform variables to their initial values. The initial value is either the value of the variable's initializer as specified in the original shader source, or zero if no initializer was present. Additionally, all vertex shader input and fragment shader output assignments that were in effect when the program was linked before saving are restored with '''glProgramBinary''' is called. | ||
| Line 30: | Line 30: | ||
== Errors == | == Errors == | ||
| − | {{code|GL_INVALID_OPERATION}} is generated if | + | {{code|GL_INVALID_OPERATION}} is generated if {{param|program}} is not the name of an existing program object. |
| − | {{code|GL_INVALID_ENUM}} is generated if | + | {{code|GL_INVALID_ENUM}} is generated if {{param|binaryFormat}} is not a value recognized by the implementation. |
== Notes == | == Notes == | ||
| Line 40: | Line 40: | ||
== Associated Gets == | == Associated Gets == | ||
| − | + | {{apifunc|glGetProgram}} with argument {{code|GL_PROGRAM_BINARY_LENGTH}} | |
| − | + | {{apifunc|glGet}} with argument {{code|GL_NUM_PROGRAM_BINARY_FORMATS}} | |
| − | + | {{apifunc|glGet}} with argument {{code|GL_PROGRAM_BINARY_FORMATS}} | |
== See Also == | == See Also == | ||
| − | + | {{apifunc|glGetProgram}}, {{apifunc|glGetProgramBinary}} | |
== Copyright == | == Copyright == | ||
Revision as of 01:24, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 4.1 | |
| Core ARB extension | ARB_get_program_binary | |
glProgramBinary: load a program object with a program binary
Contents
Function Definition
void glProgramBinary(GLuint program, GLenum binaryFormat, const void *binary, GLsizei length);
- program
- Specifies the name of a program object into which to load a program binary.
- binaryFormat
- Specifies the format of the binary data in binary.
- binary
- Specifies the address an array containing the binary to be loaded into program.
- length
- Specifies the number of bytes contained in binary.
Description
glProgramBinary loads a program object with a program binary previously returned from glGetProgramBinary. binaryFormat and binary must be those returned by a previous call to glGetProgramBinary, and length must be the length returned by glGetProgramBinary, or by glGetProgram when called with pname set to GL_PROGRAM_BINARY_LENGTH. If these conditions are not met, loading the program binary will fail and program's GL_LINK_STATUS will be set to GL_FALSE.
A program object's program binary is replaced by calls to glLinkProgram or glProgramBinary. When linking success or failure is concerned, glProgramBinary can be considered to perform an implicit linking operation. glLinkProgram and glProgramBinary both set the program object's GL_LINK_STATUS to GL_TRUE or GL_FALSE.
A successful call to glProgramBinary will reset all uniform variables to their initial values. The initial value is either the value of the variable's initializer as specified in the original shader source, or zero if no initializer was present. Additionally, all vertex shader input and fragment shader output assignments that were in effect when the program was linked before saving are restored with glProgramBinary is called.
Errors
GL_INVALID_OPERATION is generated if program is not the name of an existing program object.
GL_INVALID_ENUM is generated if binaryFormat is not a value recognized by the implementation.
Notes
A program binary may fail to load if the implementation determines that there has been a change in hardware or software configuration from when the program binary was produced such as having been compiled with an incompatible or outdated version of the compiler.
Associated Gets
glGetProgram with argument GL_PROGRAM_BINARY_LENGTH
glGet with argument GL_NUM_PROGRAM_BINARY_FORMATS
glGet with argument GL_PROGRAM_BINARY_FORMATS
See Also
glGetProgram, glGetProgramBinary
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/.