Class Shader

Describes a shader programm, which can be used for drawing.

Hierarchy

Shader

Index

Constructors

constructor

Properties

Accessors

webGlProgram

Methods

Constructors

constructor

new Shader(gl: WebGLRenderingContext, options: ShaderOptions): Shader

- Defined in shader.ts:46
Creates a new Shader

Parameters
- gl: WebGLRenderingContext
  
  Rendering context
- options: ShaderOptions
  
  Options to initialize the shader with. See ShaderOptions.
Returns Shader

Properties

Private attributeLocations

attributeLocations: object

Type declaration

[name: string]: number

Private attributes

attributes: WebGLActiveInfo[] = []

Protected gl

gl: WebGLRenderingContext

Rendering context

Private handle

handle: WebGLProgram

Private uniforms

uniforms: object

Type declaration

[name: string]: UniformInfo

Static Private _current

_current: WebGLTexture

Accessors

webGlProgram

get webGlProgram(): WebGLProgram

- Defined in shader.ts:91
Handle to the native WebGL program.

Returns WebGLProgram

Methods

Private collectAttributeInformation

collectAttributeInformation(): void

- Defined in shader.ts:250
Returns void

Private collectUniformInformation

collectUniformInformation(): void

- Defined in shader.ts:237
Returns void

delete

delete(): void

- Defined in shader.ts:229
Delete the underlying WebGLProgramm

Returns void

getAttributeLocation

getAttributeLocation(name: string): number

- Defined in shader.ts:111
Returns the attribute index for a attribute variable name in the shader. Calling this method has no performance caveat.

Parameters
- name: string
Returns number

Private getParameter

getParameter(param: number): any

- Defined in shader.ts:233
Parameters
- param: number
Returns any

getUniformLocation

getUniformLocation(name: string): WebGLUniformLocation

- Defined in shader.ts:105
Returns the WebGLUniformLocation for a uniform variable name in the shader. Calling this method has no performance caveat.

Parameters
- name: string
Returns WebGLUniformLocation

setFloat

setFloat(loc: WebGLUniformLocation, value: number): void

- Defined in shader.ts:167
Send a float to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- value: number
  
  value to send
Returns void

setMat2

setMat2(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:199
Send a 2x2 Matrix to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Array representing the matrix
Returns void

setMat3

setMat3(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:207
Send a 3x3 Matrix to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Array representing the matrix
Returns void

setMat4

setMat4(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:215
Send a 4x4 Matrix to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Array representing the matrix
Returns void

setTextureUnit

setTextureUnit(loc: WebGLUniformLocation, unit: number): void

- Defined in shader.ts:223
Bind a texture unit to a Sampler2D variable,

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- unit: number
  
  Index of Texture unit (zero-based)
Returns void

setUniform

setUniform(name: string, value: UniformValue): void

- Defined in shader.ts:129
Set a single uniform by name.

Parameters
- name: string
  
  Name of the uniform variable in the shader
- value: UniformValue
  
  Value to set
Returns void

setUniforms

setUniforms(uniforms: UniformCollection): void

- Defined in shader.ts:117
Set multiple uniforms from a UniformCollection

Parameters
- uniforms: UniformCollection
  
  Key is the uniform name, value the uniform value to set.
Returns void

setVec2

setVec2(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:175
Send a Vector2 to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Vector as an array
Returns void

setVec3

setVec3(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:183
Send a Vector3 to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Vector as an array
Returns void

setVec4

setVec4(loc: WebGLUniformLocation, arr: Float32Array | number[]): void

- Defined in shader.ts:191
Send a Vector4 to the shader.

Parameters
- loc: WebGLUniformLocation
  
  WebGLUniformLocation of the variable.
- arr: Float32Array | number[]
  
  Vector as an array
Returns void

use

use(): void

- Defined in shader.ts:96
Use this shader if it is not currently in use.

Returns void

Static fromFiles

fromFiles(gl: WebGLRenderingContext, vertexUrl: string, fragmentUrl: string, options?: Partial<ShaderOptions>): Promise<Shader>

- Defined in shader.ts:31
Loads shader sources from files via the fetch API and initializes the shader with them.

Parameters
- gl: WebGLRenderingContext
  
  Rendering context.
- vertexUrl: string
  
  Url to the vertex shader file.
- fragmentUrl: string
  
  Url to the fragment shader file.
- Optional options: Partial<ShaderOptions>
  
  Additional shader options.
Returns Promise<Shader>

Generated using TypeDoc