Class Shader`Abstract`

Base class for the shaders of the Mesh component.

Extend it and name the class with DefineShader. Every method gets the material options of the mesh as options.

See

Index

Constructors

Properties

Methods

fragment shaderKey? uniforms? updateUniforms? vertex

Constructors

constructor

new Shader(): Shader

Returns Shader

Properties

`Static`shaderName

shaderName: string

The name the configuration uses for the shader. DefineShader sets it, so a game usually does not assign it.

Methods

`Abstract`fragment

fragment(options: unknown): string
Runs when the renderer creates the shader. Returns the fragment shader code.
Parameters
- options: unknown
Returns string

`Optional`shaderKey

shaderKey?(name: string, options: unknown): string
Runs every frame. When the returned string changes, the renderer creates the shader again. Optional.
Parameters
- name: string
- options: unknown
Returns string

`Optional`uniforms

uniforms?(options: unknown): ShaderUniformDefinitions
Runs when the renderer creates the shader. Returns your own uniforms, with a start value and a type. Optional.
Parameters
- options: unknown
Returns ShaderUniformDefinitions

`Optional`updateUniforms

updateUniforms?(uniforms: ShaderUniforms, options: unknown): void
Runs every frame. Write the new uniform values into uniforms. Optional.
Parameters
- uniforms: ShaderUniforms
- options: unknown
Returns void

`Abstract`vertex

vertex(options: unknown): string
Runs when the renderer creates the shader. Returns the vertex shader code.
Parameters
- options: unknown
Returns string