OpenGL Shading Language (GLSL) Quick Reference Guide
Describes GLSL version 1.10, as included in OpenGL v2.0, and specified by "The OpenGL Shading Language", version 1.10.59. Section and page numbers refer to that version of the spec.
BUILT-IN FUNCTIONS
Key: vec = vec2 | vec3 | vec4 mat = mat2 | mat3 | mat4 ivec = ivec2 | ivec3 | ivec4 bvec = bvec2 | bvec3 | bvec4 genType = float | vec2 | vec3 | vec4
Matrix Functions (8.5 p55) mat matrixCompMult( mat, mat ) Vector Relational Functions (8.6 p55) bool all( bvec ) bool any( bvec ) bvec equal( vec, vec ) bvec equal( ivec, ivec ) bvec equal( bvec, bvec ) bvec greaterThan( vec, vec ) bvec greaterThan( ivec, ivec ) bvec greaterThanEqual( vec, vec ) bvec greaterThanEqual( ivec, ivec ) bvec lessThan( vec, vec ) bvec lessThan( ivec, ivec ) bvec lessThanEqual( vec, vec ) bvec lessThanEqual( ivec, ivec ) bvec not( bvec ) bvec notEqual( vec, vec ) bvec notEqual( ivec, ivec ) bvec notEqual( bvec, bvec ) Texture Lookup Functions (8.7 p56) Optional bias term is Fragment ONLY vec4 texture1D( sampler1D, float [,float bias] ) vec4 texture1DProj( sampler1D, vec2 [,float bias] ) vec4 texture1DProj( sampler1D, vec4 [,float bias] ) vec4 texture2D( sampler2D, vec2 [,float bias] ) vec4 texture2DProj( sampler2D, vec3 [,float bias] ) vec4 texture2DProj( sampler2D, vec4 [,float bias] ) vec4 texture3D( sampler3D, vec3 [,float bias] ) vec4 texture3DProj( sampler3D, vec4 [,float bias] ) vec4 textureCube( samplerCube, vec3 [,float bias] ) vec4 vec4 vec4 vec4 shadow1D( sampler1DShadow, vec3 [,float bias] ) shadow2D( sampler2DShadow, vec3 [,float bias] ) shadow1DProj( sampler1DShadow, vec4 [,float bias] ) shadow2DProj( sampler2DShadow, vec4 [,float bias] )
DATA TYPES (4.1 p16)
float, vec2, vec3, vec4 int, ivec2, ivec3, ivec4 bool, bvec2, bvec3, bvec4 mat2, mat3, mat4 void sampler1D, sampler2D, sampler3D samplerCube sampler1DShadow, sampler2DShadow
Angle and Trigonometry Functions (8.1 p51) genType sin( genType ) genType cos( genType ) genType tan( genType ) genType genType genType genType asin( genType ) acos( genType ) atan( genType, genType ) atan( genType )
genType radians( genType ) genType degrees( genType ) Exponential Functions (8.2 p52) genType pow( genType, genType ) genType exp( genType ) genType log( genType ) genType exp2( genType ) genType log2( genType ) genType sqrt( genType ) genType inversesqrt( genType ) Common Functions (8.3 p52) genType abs( genType ) genType ceil( genType ) genType clamp( genType, genType, genType ) genType clamp( genType, float, float ) genType floor( genType ) genType fract( genType ) genType max( genType, genType ) genType max( genType, float ) genType min( genType, genType ) genType min( genType, float ) genType mix( genType, genType, genType ) genType mix( genType, genType, float ) genType mod( genType, genType ) genType mod( genType, float ) genType sign( genType ) genType smoothstep( genType, genType, genType ) genType smoothstep( float, float, genType ) genType step( genType, genType ) genType step( float, genType ) Geometric Functions (8.4 p54) vec4 ftransform() Vertex ONLY vec3 cross( vec3, vec3 ) float distance( genType, genType ) float dot( genType, genType ) genType faceforward( genType V, genType I, genType N ) float length( genType ) genType normalize( genType ) genType reflect( genType I, genType N ) genType refract( genType I, genType N, float eta ) Fragment Processing Functions (8.8 p58) Fragment ONLY genType dFdx( genType ) genType dFdy( genType ) genType fwidth( genType )
DATA TYPE QUALIFIERS (4.3 p22)
global variable declarations: uniform input to Vertex and Fragment shader from OpenGL or application (READ-ONLY) attribute input per-vertex to Vertex shader from OpenGL or application (READ-ONLY) varying output from Vertex shader (READ/WRITE), interpolated, then input to Fragment shader (READ-ONLY) const compile-time constant (READ-ONLY) function parameters: in value initialized on entry, not copied on return (default) out copied out on return, but not initialized inout value initialized on entry, and copied out on return const constant function input
VECTOR COMPONENTS (5.5 p 30)
component names may not be mixed across sets x, y, z, w r, g, b, a s, t, p, q
Texture Lookup Functions with LOD (8.7 p56) Vertex ONLY; ensure GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS > 0 vec4 texture1DLod( sampler1D, float, float lod ) vec4 texture1DProjLod( sampler1D, vec2, float lod ) vec4 texture1DProjLod( sampler1D, vec4, float lod ) vec4 vec4 vec4 vec4 texture2DLod( sampler2D, vec2, float lod ) texture2DProjLod( sampler2D, vec3, float lod ) texture2DProjLod( sampler2D, vec4, float lod ) texture3DProjLod( sampler3D, vec4, float lod )
PREPROCESSOR (3.3 p9)
# #define #undef #if #ifdef #ifndef #else #elif #endif #error #pragma #line __LINE__ __FILE__ __VERSION__
vec4 textureCubeLod( samplerCube, vec3, float lod ) vec4 vec4 vec4 vec4 shadow1DLod( sampler1DShadow, vec3, float lod ) shadow2DLod( sampler2DShadow, vec3, float lod ) shadow1DProjLod( sampler1DShadow, vec4, float lod ) shadow2DProjLod( sampler2DShadow, vec4, float lod )
GLSL version declaration and extensions protocol: #version default is "#version 110" (3.3 p11) #extension {name | all} : {require | enable | warn | disable} default is "#extension all : disable" (3.3 p11)
Noise Functions (8.9 p60) float noise1( genType ) vec2 noise2( genType ) vec3 noise3( genType ) vec4 noise4( genType )
VERTEX SHADER VARIABLES
Special Output Variables (7.1 p42) access=RW vec4 gl_Position; shader must write float gl_PointSize; enable GL_VERTEX_PROGRAM_POINT_SIZE vec4 gl_ClipVertex; Attribute Inputs (7.3 p44) access=RO attribute vec4 gl_Vertex; attribute vec3 gl_Normal; attribute vec4 gl_Color; attribute vec4 gl_SecondaryColor; attribute vec4 gl_MultiTexCoord0; attribute vec4 gl_MultiTexCoord1; attribute vec4 gl_MultiTexCoord2; attribute vec4 gl_MultiTexCoord3; attribute vec4 gl_MultiTexCoord4; attribute vec4 gl_MultiTexCoord5; attribute vec4 gl_MultiTexCoord6; attribute vec4 gl_MultiTexCoord7; attribute float gl_FogCoord; Varying Outputs (7.6 p48) access=RW varying vec4 gl_FrontColor; varying vec4 gl_BackColor; enable GL_VERTEX_PROGRAM_TWO_SIDE varying vec4 gl_FrontSecondaryColor; varying vec4 gl_BackSecondaryColor; varying vec4 gl_TexCoord[ ]; MAX=gl_MaxTextureCoords varying float gl_FogFragCoord;
BUILT-IN UNIFORMs (7.5 p45) access=RO
uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 uniform mat4 gl_ModelViewMatrix; gl_ModelViewProjectionMatrix; gl_ProjectionMatrix; gl_TextureMatrix[gl_MaxTextureCoords]; gl_ModelViewMatrixInverse; gl_ModelViewProjectionMatrixInverse; gl_ProjectionMatrixInverse; gl_TextureMatrixInverse[gl_MaxTextureCoords]; gl_ModelViewMatrixTranspose; gl_ModelViewProjectionMatrixTranspose; gl_ProjectionMatrixTranspose; gl_TextureMatrixTranspose[gl_MaxTextureCoords]; gl_ModelViewMatrixInverseTranspose; gl_ModelViewProjectionMatrixInverseTranspose; gl_ProjectionMatrixInverseTranspose; gl_TextureMatrixInverseTranspose[gl_MaxTextureCoords]; struct gl_LightModelParameters { vec4 ambient; }; uniform gl_LightModelParameters gl_LightModel; struct gl_LightModelProducts { vec4 sceneColor; }; uniform gl_LightModelProducts gl_FrontLightModelProduct; uniform gl_LightModelProducts gl_BackLightModelProduct; struct gl_LightProducts { vec4 ambient; vec4 diffuse; vec4 specular; }; uniform gl_LightProducts gl_FrontLightProduct[gl_MaxLights]; uniform gl_LightProducts gl_BackLightProduct[gl_MaxLights]; struct gl_MaterialParameters { vec4 emission; vec4 ambient; vec4 diffuse; vec4 specular; float shininess; }; uniform gl_MaterialParameters gl_FrontMaterial; uniform gl_MaterialParameters gl_BackMaterial; struct gl_PointParameters { float size; float sizeMin; float sizeMax; float fadeThresholdSize; float distanceConstantAttenuation; float distanceLinearAttenuation; float distanceQuadraticAttenuation; }; uniform gl_PointParameters gl_Point; uniform vec4 gl_TextureEnvColor[gl_MaxTextureUnits]; (1) uniform vec4 gl_ClipPlane[gl_MaxClipPlanes]; uniform vec4 uniform vec4 uniform vec4 uniform vec4 uniform vec4 uniform vec4 uniform vec4 uniform vec4 gl_EyePlaneS[gl_MaxTextureCoords]; gl_EyePlaneT[gl_MaxTextureCoords]; gl_EyePlaneR[gl_MaxTextureCoords]; gl_EyePlaneQ[gl_MaxTextureCoords]; gl_ObjectPlaneS[gl_MaxTextureCoords]; gl_ObjectPlaneT[gl_MaxTextureCoords]; gl_ObjectPlaneR[gl_MaxTextureCoords]; gl_ObjectPlaneQ[gl_MaxTextureCoords];
uniform mat3 gl_NormalMatrix; uniform float gl_NormalScale; struct gl_DepthRangeParameters { float near; float far; float diff; }; uniform gl_DepthRangeParameters gl_DepthRange; struct gl_FogParameters { vec4 color; float density; float start; float end; float scale; }; uniform gl_FogParameters gl_Fog; struct gl_LightSourceParameters { vec4 ambient; vec4 diffuse; vec4 specular; vec4 position; vec4 halfVector; vec3 spotDirection; float spotExponent; float spotCutoff; float spotCosCutoff; float constantAttenuation; float linearAttenuation; float quadraticAttenuation; }; uniform gl_LightSourceParameters gl_LightSource[gl_MaxLights];
FRAGMENT SHADER VARIABLES
Special Output Variables (7.2 p43) access=RW vec4 gl_FragColor; vec4 gl_FragData[gl_MaxDrawBuffers]; float gl_FragDepth; DEFAULT=glFragCoord.z Varying Inputs (7.6 p48) access=RO varying vec4 gl_Color; varying vec4 gl_SecondaryColor; varying vec4 gl_TexCoord[ ]; MAX=gl_MaxTextureCoords varying float gl_FogFragCoord; Special Input Variables (7.2 p43) access=RO vec4 gl_FragCoord; pixel coordinates bool gl_FrontFacing;
BUILT-IN CONSTANTS (7.4 p44)
const int gl_MaxVertexUniformComponents; const int gl_MaxFragmentUniformComponents; const int gl_MaxVertexAttribs; const int gl_MaxVaryingFloats; const int gl_MaxDrawBuffers; const int gl_MaxTextureCoords; const int gl_MaxTextureUnits; const int gl_MaxTextureImageUnits; const int gl_MaxVertexTextureImageUnits; const int gl_MaxCombinedTextureImageUnits; const int gl_MaxLights; const int gl_MaxClipPlanes;
OpenSceneGraph Preset Uniforms
as of OSG 1.0 int osg_FrameNumber; float osg_FrameTime; float osg_DeltaFrameTime; mat4 osg_ViewMatrix; mat4 osg_ViewMatrixInverse;
Fine print / disclaimer Copyright 2005 Mike Weiblen http://mew.cx/ Please send feedback/corrections/comments to [email protected] OpenGL is a registered trademark of Silicon Graphics Inc. Except as noted below, if discrepancies between this guide and the GLSL specification, believe the spec! Revised 2005-11-26 Notes 1. Corrects a typo in the OpenGL 2.0 specification.
OpenGL Shading Language (GLSL) Quick Reference Guide
Describes the GLSL version 1.2 Sbastien Barbier January 2009.
GEOMETRY SHADER VARIABLES
Constant buit-in int gl_VerticesIn number of vertices belonging to the primitive
DATA TYPES
unsigned int, uvec2, uvec3, uvec4 sampler1DArray, sampler2DArray sampler1DArrayShadow, sampler2DArrayShadow, samplerCubeShadow isampler1D, isampler2D, isampler3D, isamplerCube, isampler2DRect isampler1DArray, isampler2DArray usampler1D, usampler2D, usampler3D, usamplerCube, usampler2DRect usampler1DArray, usampler2DArray samplerBuffer, isamplerBuffer, usamplerBuffer
Special Output Variables vec4 gl_Position; shader must write float gl_PointSize; vec4 gl_ClipVertex; int gl_PrimitiveID; int gl_Layer; Varying Outputs varying out vec4 gl_FrontColor; varying out vec4 gl_BackColor; varying out vec4 gl_FrontSecondaryColor; varying out vec4 gl_BackSecondaryColor; varying out vec4 gl_TexCoord[]; varying out vec4 gl_FogFragCoord; Varying Inputs varying in vec4 gl_FrontColorIn[gl_VerticesIn]; varying in vec4 gl_BackColorIn[gl_VerticesIn]; varying in vec4 gl_FrontSecondaryColorIn[gl_VerticesIn]; varying in vec4 gl_BackSecondaryColorIn[gl_VerticesIn]; varying in vec4 gl_TexCoordIn[gl_VerticesIn][]; varying in float gl_FogFragCoordIn[gl_VerticesIn]; varying in vec4 gl_PositionIn[gl_VerticesIn]; varying in float gl_PointSizeIn[gl_VerticesIn]; varying in vec4 gl_ClipVertexIn[gl_VerticesIn]; Functions void EmitVertex(); void EndPrimitive();
DATA TYPE QUALIFIERS
flat varying noperspective varying centroid varying
VERTEX/FRAGMENT SHADER VARIABLES
Attribute inputs access = RO Vertex int gl_VertexID int gl_InstanceID Fragment int gl_PrimitiveID
BUILT-IN FUNCTIONS
% : modulo &, |, ^, ~, << , >> : bit-wise operations For texture access: vec4 texture1D(sampler1D sampler, float coord [, float bias]) ivec4 texture1D(isampler1D sampler, float coord [, float bias]) uvec4 texture1D(usampler1D sampler, float coord [, float bias]) More ? cf. EXT_gpu_shader4, g80specs.pdf p117-124
