Shader

Represents a GPU shader program for custom rendering effects.

Shaders are programs that run on the GPU to transform vertices and calculate pixel colors. Ceramic uses shaders for all rendering, from basic sprite drawing to complex visual effects.

Key features:

• Support for vertex and fragment shaders
• Uniform variables for passing data to shaders
• Multiple texture slot support
• Custom vertex attributes
• Automatic shader compilation and linking

Common uses:

• Visual effects (blur, glow, distortion)
• Color manipulation (hue shift, contrast)
• Custom rendering techniques
• Post-processing filters
• Special material effects

Ceramic provides several built-in shaders:

• 'shader:textured' - Standard textured rendering (default)
• 'shader:pixelArt' - High-quality pixel art scaling
• Various effect shaders depending on plugins

// Load and apply a custom shader
var shader = assets.shader('myEffect').clone();
shader.setFloat('intensity', 0.5);
shader.setVec2('resolution', screen.width, screen.height);
myVisual.shader = shader;

// Animate shader uniforms
app.onUpdate(this, delta -> {
    shader.setFloat('time', Timer.now);
    shader.setColor('tint', Color.fromHSB(
        (Timer.now * 60) % 360, 1, 1
    ));
});

Instance Members #

The backend-specific shader implementation. Used internally by the rendering system.

The shader asset this shader was loaded from. Null if created programmatically.

All vertex attributes used by this shader (except texture slot attribute) Includes standard attributes (position, texCoord, color) plus any custom attributes.

Base standard vertex attributes (position, texCoord, color), without any custom attribute.

Custom vertex attributes beyond the standard ones. Used for passing additional per-vertex data to shaders.

Vertex attribute used to store texture slot (if the shader is a multi-texture shader).

Total size of custom float attributes in the vertex buffer. Calculated from customAttributes array.

Creates a copy of this shader with independent uniform values.

Useful when you need multiple instances of the same shader with different parameters.

Sets an integer uniform variable.

Sets a float uniform variable.

Sets a vec2 uniform variable.

Sets a vec3 uniform variable.

Sets a vec4 uniform variable.

Sets a float array uniform variable. Useful for passing multiple values or matrices.

Sets a texture uniform variable.

Textures are bound to numbered slots (0, 1, 2, etc.). Slot 0 is typically used for the main texture.

Sets a mat2 uniform variable (column-major order).

Sets a mat3 uniform variable (column-major order).

Sets a mat4 uniform variable (column-major order).

Creates a new shader instance.

Standard vertex attributes are automatically included:

• vertexPosition (vec3): Vertex position in model space
• vertexTCoord (vec2): Texture coordinates
• vertexColor (vec4): Vertex color with alpha

Private Members #

Resolve the texture slot for the given name

Metadata #