GLSL : common mistakes
The following article discusses common mistakes made in the OpenGL Shading Language, GLSL.
- 1 Uniforms
- 2 Miscellaneous
How to use glUniform
If you look at all the glUniform*v functions, there is a parameter called count.
What's wrong with this code? Would it cause a crash?
//Vertex Shader uniform vec4 LightPosition;
//In your C++ code float light; //Fill in `light` with data. glUniform4fv(MyShader, 4, light);
The problem is that for count, you set it to 4 while it should be 1 because you are sending 1 vec4 to the shader. The count is the number of that type (4f, which corresponds to vec4) that you are setting.
//Vertex Shader uniform vec2 Exponents;
//In your C++ code float Exponents; glUniform2fv(MyShader, 5, Exponents);
This is correct. The length of the array is 5, which is what we tell glUniform2fv.
glUniform doesn't work
You probably did not bind the correct shader first. Call glUseProgram(myprogram) first.
glGetUniformLocation and glGetActiveUniform
Although not strictly a mistake, some wonder why glGetUniformLocation returns -1. If there is a uniform that you are not using, the driver will optimize your uniform out. Drivers are really good at optimizing code. If you are using your uniform, but none of the values computed from that uniform contribute to any output from the shader (directly or indirectly), the uniform will usually be optimized out.
Typically this is not a problem, since if you pass -1 instead of a valid uniform location to the glUniform calls, they will quietly do nothing anyway. But you will also get -1 if you misspell the variable name to glGetUniformLocation, so keep this in mind.
When should you call glUseProgram?
glUseProgram needs to be called before you setup a uniform (unless you have GL 4.1 or ARB_separate_shader_objects, and can use glProgramUniform). There are several versions of the glUniform function depending if your variable is a single float, vec2, vec3, vec4, a matrix, etc. Notice that the glUniform functions do not take the program ID (your shader) as a parameter.
Uniform Names across shader stages
It is legal to have the same uniform defined in different shader stage.
When you call glGetUniformLocation, it will return one location. When you update the uniform with a call to glUniform, the driver takes care of sending the value for each stage (vertex shader, geometry shader, fragment shader).
This is because a GLSL program contains all of the shader stages at once. Programs do not consider uniforms in a vertex shader to be different from uniforms in a fragment shader.
Enable Or Not To Enable
With fixed pipeline, you needed to call
glEnable(GL_TEXTURE_2D) to enable 2D texturing. You needed to call
glEnable(GL_LIGHTING). Since shaders override these functionalities, you don't need to glEnable/glDisable. If you don't want texturing, you either need to write another shader that doesn't do texturing or you can attach a all white or all black texture, depending on your needs. You can also write one shader that does lighting and one that doesn't.
Things that are not overriden by shaders, like the alpha test, depth test, stencil test... calling glEnable/glDisable will have an effect.
Binding A Texture
NVIDIA and Types
nVidia drivers are more relaxed. For example:
float myvalue = 0;
The above is not legal according to the GLSL specification 1.10, due to the inability to automatically convert from integers (numbers without decimals) to floats (numbers with decimals). Use 0.0 instead. With GLSL 1.20 and above, it is legal because it will be converted to a float.
float myvalue1 = 0.5f; float myvalue2 = 0.5F;
The above is not legal according to the GLSL specification 1.10. With GLSL 1.20, it becomes legal.
float texel = texture2D(tex, texcoord);
The above is wrong since
texture2D returns a
vec4. Do one of these instead:
float texel = texture2D(tex, texcoord).r; float texel = texture2D(tex, texcoord).x;
Functions inputs and outputs
Functions should look like this
vec4 myfunction(inout float value1, in vec3 value2, in vec4 value3)
vec4 myfunction(float value1, vec3 value2, vec4 value3)
In the vertex shader
gl_TexCoord = gl_MultiTexCoord0;
and in the fragment shader
vec4 texel = texture2D(tex, gl_TexCoord.xy);
zw isn't being used in the fs.
Keep in mind that for GLSL 1.30, you should define your own vertex attribute.
This means that instead of gl_MultiTexCoord0, define AttrMultiTexCoord0.
Also, do not use gl_TexCoord. Define your own varying and call it VaryingTexCoord0.
Sampling and Rendering to the Same Texture
Normally, you should not sample a texture and render to that same texture at the same time. This would give you undefined behavior. It might work on some GPUs and with some driver version but not others.
The extension GL_NV_texture_barrier can be used to avoid this in certain ways. Specifically, you can use the barrier to ping-pong between two regions of the same texture without having to switch textures or buffers or anything. You still don't get to read and write to the same location in a texture at the same time unless there is only a single read and write of each texel, and the read is in the fragment shader invocation that writes the same texel.