Shader Basics

Overview of Shaders

Panda3D supports two shading languages: GLSL and Cg. This section assumes that you have a working knowledge of a shader language. If not, it would be wise to read about GLSL or Cg before trying to understand how they fit into Panda3D.

Though Panda3D has used only Cg in the past, it is recommended that you create new shaders in GLSL unless you want to target DirectX as well, since the NVIDIA Cg toolkit is no longer being maintained.

There are various types of shaders, each capable of describing a different stage in the rendering process. In the most simple case, a model simply has a vertex shader, which describes how each vertex is processed, and a fragment shader (also called a pixel shader in DirectX parlance), describing how the color of each visible pixel on the model is determined. A shader pipeline can be composed of one or more of the following types of shaders:

Vertex shader

The first stage of the pipeline. It is run for each vertex on the model geometry, and is responsible for preparing the vertex data, usually by transforming the original vertex position to on-screen X, Y coordinates.

Tessellation control (hull) shader

Optional. When tessellation is used, this specifies how to subdivide the tessellation patch. GLSL only.

Tessellation evaluation (domain) shader

Optional. When tessellation is used, this determines the position of the tessellated vertices. GLSL only.

Geometry shader

Optional. This is run for each input primitive (usually a triangle), and determines how the geometry is formed from the input vertices. It may also create additional geometry.

Fragment (pixel) shaders

This is the last stage of the pipeline before the pixel is blended into the framebuffer, and usually the most useful one. It determines the color of each pixel of the rendered geometry, and therefore performs tasks such as lighting and texturing.

There is also another advanced type of shader called a Compute shader, which stands on its own and does not fit into the pipeline above.

You will usually only find a vertex and fragment shader, since geometry and tessellation shaders are relatively new features that are useful only in more specific cases.

GLSL Shaders

GLSL shaders are always separated up into separate files for vertex, fragment and geometry shaders, with the main entry point being called main(). All GLSL shaders begin with a #version line indicating the version of the GLSL standard that the shader is written in, which maps to a corresponding version of OpenGL. For example, version 120 will require OpenGL 2.1, version 150 requires OpenGL 3.2, and version 330 requires OpenGL 3.3.

In the future, Panda3D will automatically convert the shader to the appropriate version of GLSL supported by the graphics card. In the meantime, it is recommended to write your shaders in GLSL 150 or later, unless you need to support very old graphics hardware, in which case it may be necessary to target GLSL 120.

Example Shader

This example applies the first texture of the model using the first texture coordinate set, but switches the red and blue channels around.

This is the vertex shader, named myshader.vert:

#version 150

// Uniform inputs
uniform mat4 p3d_ModelViewProjectionMatrix;

// Vertex inputs
in vec4 p3d_Vertex;
in vec2 p3d_MultiTexCoord0;

// Output to fragment shader
out vec2 texcoord;

void main() {
  gl_Position = p3d_ModelViewProjectionMatrix * p3d_Vertex;
  texcoord = p3d_MultiTexCoord0;
}

This is the fragment shader, named myshader.frag:

#version 150

uniform sampler2D p3d_Texture0;

// Input from vertex shader
in vec2 texcoord;

// Output to the screen
out vec4 p3d_FragColor;

void main() {
  vec4 color = texture(p3d_Texture0, texcoord);
  p3d_FragColor = color.bgra;
}

Loading a GLSL Shader

To load the above shader and apply it to a model, we can use the following code:

shader = Shader.load(Shader.SL_GLSL,
                     vertex="myshader.vert",
                     fragment="myshader.frag")
model.setShader(shader)

To add a geometry shader, simply add the filename of the geometry shader as additional parameter, following the fragment shader.

Cg Shaders

Caution

Support for Cg shaders will be deprecated in an upcoming version of Panda3D.

A Cg shader must contain procedures named vshader() and fshader(); the vertex shader and fragment shader respectively. If a geometry shader is used, then it must also contain a procedure named gshader().

Single-File Cg Shaders

To write a Cg shader in a single file, you must create a shader program that looks much like the one shown below. This example preserves position but switches the red and green channels of everything it is applied to:

//Cg

void vshader(float4 vtx_position : POSITION,
             float4 vtx_color: COLOR,
             out float4 l_position : POSITION,
             out float4 l_color0 : COLOR0,
             uniform float4x4 mat_modelproj)
{
  l_position = mul(mat_modelproj, vtx_position);
  l_color0 = vtx_color;
}

void fshader(float4 l_color0 : COLOR0,
             out float4 o_color : COLOR)
{
  o_color = l_color0.grba;
}

Multi-File Cg Shaders

Cg shaders can be divided into several files as well; one for the vertex shader, another for the fragment shader, and a third for the geometry shader. The procedure names are still required to be vshader(), fshader() and gshader() in their respective shader files.

Loading a Cg Shader

Loading a single-file Cg shader is done with the Shader.load() procedure. The first parameter is the path to the shader file, and the second is the shader language, which in this case is Shader.SL_Cg. The following is an example of using this procedure:

from panda3d.core import Shader

shader = Shader.load("myshader.sha", Shader.SL_Cg)
model.setShader(shader)

Loading a multi-file Cg shader requires a different set of parameters for the load() function; the first being the shader language, and the second, third and fourth being paths to the vertex, fragment and geometry shaders respectively. Here is an example:

shader = Shader.load(Shader.SL_Cg,
                     vertex="myvertexshader.sha",
                     fragment="myfragmentshader.sha",
                     geometry="mygeometryshader.sha")
model.setShader(shader)

Applying the Shader

Shaders can be applied to any part of the scene graph. The call to NodePath.setShader() causes the model to be rendered with the shader passed to it as a parameter. Shaders propagate down the scene graph, like any other render attribute; the node and everything beneath it will use the shader.

As with other state changes, it is possible to pass a second priority parameter to indicate that the shader specified at that node should override shaders specified on a higher or lower node that have a lower priority value.

Fetching Data from the Panda3D Runtime

Each shader program contains a parameter list. Panda3D scans the parameter list and interprets each parameter name as a request to extract data from the panda runtime. For example, if the shader contains a parameter declaration p3d_Vertex (or for Cg, float3 vtx_position : POSITION), Panda3D will interpret that as a request for the vertex position, and it will satisfy the request. Panda3D will only allow parameter declarations that it recognizes and understands.

Panda3D will generate an error if the parameter qualifiers do not match what Panda3D is expecting. For example, if you declare the parameter float3 vtx_position, then Panda3D will be happy. If, on the other hand, you were to declare uniform sampler2D vtx_position, then Panda3D would generate two separate errors: Panda3D knows that vtx_position is supposed to be a float-vector, not a texture, and that it is supposed to be varying, not uniform.

Again, all parameter names must be recognized. There is a list of GLSL shader inputs as well as a list of Cg shader inputs that shows all the valid parameter names and the data that Panda3D will supply.

Supplying Data to the Shader Manually

Most of the data that the shader could want can be fetched from Panda3D at runtime by using the appropriate parameter names. However, it is sometimes necessary to supply some user-provided data to the shader. For this, you need NodePath.setShaderInput(). Here is an example:

myModel.setShaderInput("tint", (1.0, 0.5, 0.5, 1.0))

The method NodePath.setShaderInput() stores data that can be accessed by the shader. It is possible to store data of type Texture, NodePath, and any vector object.

The data that you store using setShaderInput() isn’t necessarily used by the shader. Instead, the values are stored in the node, but unless the shader explicitly asks for them, they will sit unused. So the example above simply stores the vector, but it is up to the shader whether or not it is interested in a data item labeled “tint”.

To fetch data that was supplied using setShaderInput(), the shader must use the appropriate parameter name. See the list of GLSL shader inputs or the list of Cg shader inputs, many of which refer to the data that was stored using setShaderInput().

Shader inputs propagate down the scene graph, and accumulate as they go. For example, if you store setShaderInput("x", 1) on a node, and setShaderInput("y", 2) on its child, then the child will contain both values. If you store setShaderInput("z", 1) on a node, and setShaderInput("z", 2) on its child, then the latter will override the former.

This method also accepts a third parameter, priority, which defaults to zero. If you store setShaderInput("w", 1, priority=1000) on a node, and setShaderInput("w", 2, priority=500) on the child, then the child will contain a “w” value of 1, because the priority 1000 overrides the priority 500.

To set multiple shader inputs at once, it is most efficient to use a single call to setShaderInputs():

myModel.setShaderInputs(
    tint=(1.0, 0.5, 0.5, 1.0),
    tex=myTexture,
)

Shader Render Attributes

The functions NodePath.setShader() and setShaderInput() are used to apply a shader to a node in the scene graph. Internally, these functions manipulate a render attribute of class ShaderAttrib on the node.

In rare occasions, it is necessary to manipulate ShaderAttrib objects explicitly. As an example, the code below shows how to create a ShaderAttrib and apply it to a camera:

attrib = ShaderAttrib.make()
attrib = attrib.setShader(Shader.load("myshader.sha"))
attrib = attrib.setShaderInput("tint", (1.0, 0.5, 0.5, 1.0))
base.cam.node().setInitialState(attrib)

Be careful: attribs are immutable objects. So when you apply a function like setShader() or setShaderInput() to a ShaderAttrib, you aren’t modifying the attrib. Instead, these functions work by returning a new attrib (which contains the modified data).

Deferred Shader Compilation

When you create a Cg shader object, it compiles the shader, checking for syntax errors. But it does not check whether or not your video card is powerful enough to handle the shader. This only happens later on, when you try to render something with the shader. In the case of GLSL shaders, all of this will only happen when the shader is first used to render something.

In the unusual event that your computer contains multiple video cards, the shader may be compiled more than once. It is possible that the compilation could succeed for one video card, and fail for the other.