ShaderProgram | @kiswa/kilo

Thin wrapper around WebGLProgram, and WebGLShader to simplify usage.

Hierarchy

ShaderProgram

Index

Constructors

constructor

Accessors

program

Methods

Constructors

constructor

new ShaderProgram(gl: WebGLRenderingContext, scripts: Scripts, name?: string): ShaderProgram

- Defined in renderer/webgl/shader-program.ts:25
Initialize ShaderProgram object.

Parameters
- gl: WebGLRenderingContext
  
  WebGLRenderingContext to use for the shaders and program.
- scripts: Scripts
  
  Sources for both vertex and fragment shaders to be used.
- Default value name: string = "default"
  
  The name of the program (useful in debugging).
Returns ShaderProgram

Accessors

program

get program(): WebGLProgram

- Defined in renderer/webgl/shader-program.ts:23
Gets the compiled WebGLProgram.

Returns WebGLProgram

Methods

getAttribLocation

getAttribLocation(name: string): number

- Defined in renderer/webgl/shader-program.ts:50
Gets the attribute location for the provided name.

throws

Error if no attribute with the provided name.

Parameters
- name: string
  
  Name of the attribute to locate.
Returns number

getUniformLocation

getUniformLocation(name: string): WebGLUniformLocation

- Defined in renderer/webgl/shader-program.ts:65
Gets the uniform location for the provided name.

throws

Error if no uniform with the provided name.

Parameters
- name: string
  
  Name of the uniform to locate.
Returns WebGLUniformLocation

Protected load

load(vertexSource: string, fragmentSource: string): void

- Defined in renderer/webgl/shader-program.ts:79
Loads the provided sources into a compiled program.

Parameters
- vertexSource: string
  
  Source for the vertex shader.
- fragmentSource: string
  
  Source for the fragment shader.
Returns void