Difference between revisions of "GLAPI/glCreateShader"

From OpenGL Wiki
Jump to navigation Jump to search
(4.0 API.)
 
m (Bot: Adding better formatting.)
 
(9 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   GLuint '''glCreateShader'''(GLenum ''shaderType'');
+
   GLuint '''glCreateShader'''(GLenum {{param|shaderType}});
  
 
; shaderType
 
; shaderType
: Specifies the type of shader to be created. Must be one of {{code|GL_VERTEX_SHADER}}, {{code|GL_TESS_CONTROL_SHADER}}, {{code|GL_TESS_EVALUATION_SHADER}}, {{code|GL_GEOMETRY_SHADER}}, or {{code|GL_FRAGMENT_SHADER}}.
+
: Specifies the type of shader to be created. Must be one of {{enum|GL_VERTEX_SHADER}}, {{enum|GL_TESS_CONTROL_SHADER}}, {{enum|GL_TESS_EVALUATION_SHADER}}, {{enum|GL_GEOMETRY_SHADER}}, {{enum|GL_FRAGMENT_SHADER}}, or {{enum|GL_COMPUTE_SHADER}}.
  
 
== Description ==
 
== Description ==
  
'''glCreateShader''' creates an empty shader object and returns a non-zero value by which it can be referenced. A shader object is used to maintain the source code strings that define a shader. ''shaderType'' indicates the type of shader to be created. Five types of shader are supported. A shader of type {{code|GL_VERTEX_SHADER}} is a shader that is intended to run on the programmable vertex processor. A shader of type {{code|GL_TESS_CONTROL_SHADER}} is a shader that is intended to run on the programmable tessellation processor in the control stage. A shader of type {{code|GL_TESS_EVALUATION_SHADER}} is a shader that is intended to run on the programmable tessellation processor in the evaluation stage. A shader of type {{code|GL_GEOMETRY_SHADER}} is a shader that is intended to run on the programmable geometry processor. A shader of type {{code|GL_FRAGMENT_SHADER}} is a shader that is intended to run on the programmable fragment processor.
+
'''glCreateShader''' creates an empty shader object and returns a non-zero value by which it can be referenced. A shader object is used to maintain the source code strings that define a shader. {{param|shaderType}} indicates the type of shader to be created. The following types are supported:
  
When created, a shader object's {{code|GL_SHADER_TYPE}} parameter is set to either {{code|GL_VERTEX_SHADER}}, {{code|GL_TESS_CONTROL_SHADER}}, {{code|GL_TESS_EVALUATION_SHADER}}, {{code|GL_GEOMETRY_SHADER}} or {{code|GL_FRAGMENT_SHADER}}, depending on the value of ''shaderType''.
+
* [[Vertex Shader|{{enum|GL_VERTEX_SHADER}}]]
 +
* [[Tessellation Control Shader|{{enum|GL_TESS_CONTROL_SHADER}}]]
 +
* [[Tessellation Evaluation Shader|{{enum|GL_TESS_EVALUATION_SHADER}}]]
 +
* [[Geometry Shader|{{enum|GL_GEOMETRY_SHADER}}]]
 +
* [[Fragment Shader|{{enum|GL_FRAGMENT_SHADER}}]]
 +
* [[Compute Shader|{{enum|GL_COMPUTE_SHADER}}]]
 +
 
 +
When created, a shader object's {{enum|GL_SHADER_TYPE}} parameter is set to the {{param|shaderType}}.
  
 
== Notes ==
 
== Notes ==
Line 24: Line 31:
  
 
Applications are responsible for providing the synchronization across API calls when objects are accessed from different execution threads.
 
Applications are responsible for providing the synchronization across API calls when objects are accessed from different execution threads.
 +
 +
{{enum|GL_COMPUTE_SHADER}} is available only if the GL version is 4.3 or higher.
  
 
== Errors ==
 
== Errors ==
Line 29: Line 38:
 
This function returns 0 if an error occurs creating the shader object.
 
This function returns 0 if an error occurs creating the shader object.
  
{{code|GL_INVALID_ENUM}} is generated if ''shaderType'' is not an accepted value.
+
{{enum|GL_INVALID_ENUM}} is generated if {{param|shaderType}} is not an accepted value.
  
 
== Associated Gets ==
 
== Associated Gets ==
  
[[GLAPI/glGetShader|glGetShader]] with a valid shader object and the parameter to be queried
+
{{apifunc|glGetShader}} with a valid shader object and the parameter to be queried
  
[[GLAPI/glGetShaderInfoLog|glGetShaderInfoLog]] with a valid shader object
+
{{apifunc|glGetShaderInfoLog}} with a valid shader object
  
[[GLAPI/glGetShaderSource|glGetShaderSource]] with a valid shader object
+
{{apifunc|glGetShaderSource}} with a valid shader object
  
[[GLAPI/glIsShader|glIsShader]]
+
{{apifunc|glIsShader}}
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glAttachShader|glAttachShader]], [[GLAPI/glCompileShader|glCompileShader]], [[GLAPI/glDeleteShader|glDeleteShader]], [[GLAPI/glDetachShader|glDetachShader]], [[GLAPI/glShaderSource|glShaderSource]]
+
{{apifunc|glAttachShader}}, {{apifunc|glCompileShader}}, {{apifunc|glDeleteShader}}, {{apifunc|glDetachShader}}, {{apifunc|glIsShader}}, {{apifunc|glShaderSource}}
  
 
== Copyright ==
 
== Copyright ==
Line 49: Line 58:
 
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 4]]
+
[[Category:Core API Reference|CreateShader]]
 +
[[Category:Core API Ref Shader Program Creation|CreateShader]]

Latest revision as of 04:06, 30 July 2013

glCreateShader
Core in version 4.6
Core since version 2.0

glCreateShader: Creates a shader object

Function Definition

 GLuint glCreateShader(GLenum shaderType​);
shaderType
Specifies the type of shader to be created. Must be one of GL_VERTEX_SHADER, GL_TESS_CONTROL_SHADER, GL_TESS_EVALUATION_SHADER, GL_GEOMETRY_SHADER, GL_FRAGMENT_SHADER, or GL_COMPUTE_SHADER.

Description

glCreateShader creates an empty shader object and returns a non-zero value by which it can be referenced. A shader object is used to maintain the source code strings that define a shader. shaderType​ indicates the type of shader to be created. The following types are supported:

When created, a shader object's GL_SHADER_TYPE parameter is set to the shaderType​.

Notes

Like buffer and texture objects, the name space for shader objects may be shared across a set of contexts, as long as the server sides of the contexts share the same address space. If the name space is shared across contexts, any attached objects and the data associated with those attached objects are shared as well.

Applications are responsible for providing the synchronization across API calls when objects are accessed from different execution threads.

GL_COMPUTE_SHADER is available only if the GL version is 4.3 or higher.

Errors

This function returns 0 if an error occurs creating the shader object.

GL_INVALID_ENUM is generated if shaderType​ is not an accepted value.

Associated Gets

glGetShader with a valid shader object and the parameter to be queried

glGetShaderInfoLog with a valid shader object

glGetShaderSource with a valid shader object

glIsShader

See Also

glAttachShader, glCompileShader, glDeleteShader, glDetachShader, glIsShader, glShaderSource

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/.