Class Shader

Hierarchy

Shader

Index

Constructors

Properties

attributes fragmentSource program uniforms vertexSource

Accessors

Methods

compile getAttributes getUniforms isCurrentlyBound setTexture setUniform setUniformBoolean setUniformFloat setUniformFloatArray setUniformFloatVector setUniformInt setUniformIntArray setUniformMatrix use

Constructors

constructor

new Shader(options?: ShaderOptions): Shader
Create a shader program in excalibur
Parameters
- Optional options: ShaderOptions
  
  specify shader vertex and fragment source
Returns Shader
- Defined in Graphics/Context/shader.ts:95

Properties

attributes

attributes: {
[variableName: string]: VertexAttributeDefinition;
} = {}

Type declaration

[variableName: string]: VertexAttributeDefinition

`Readonly` fragmentSource

fragmentSource: string

program

program: WebGLProgram

uniforms

uniforms: {
[variableName: string]: UniformDefinition;
} = {}

Type declaration

[variableName: string]: UniformDefinition

`Readonly` vertexSource

vertexSource: string

Accessors

compiled

get compiled(): boolean
Returns boolean
- Defined in Graphics/Context/shader.ts:87

Methods

compile

compile(): WebGLProgram
Compile the current shader against a webgl context

Returns WebGLProgram
- Defined in Graphics/Context/shader.ts:117

getAttributes

getAttributes(): VertexAttributeDefinition[]
Returns VertexAttributeDefinition[]
- Defined in Graphics/Context/shader.ts:152

getUniforms

getUniforms(): UniformDefinition[]
Returns UniformDefinition[]
- Defined in Graphics/Context/shader.ts:136

isCurrentlyBound

isCurrentlyBound(): boolean
Returns boolean
- Defined in Graphics/Context/shader.ts:110

setTexture

setTexture(slotNumber: number, texture: WebGLTexture): void
Set a texture in a gpu texture slot
Parameters
- slotNumber: number
- texture: WebGLTexture
Returns void
- Defined in Graphics/Context/shader.ts:175

setUniform

setUniform<TUniformType>(uniformType: TUniformType, name: string, ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>): void
Set any available uniform type in webgl

For example setUniform('uniformMatrix2fv', 'u_my2x2_mat`, ...);
Type Parameters
- TUniformType extends UniformTypeNames
Parameters
- uniformType: TUniformType
- name: string
- Rest ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>
Returns void
- Defined in Graphics/Context/shader.ts:270

setUniformBoolean

setUniformBoolean(name: string, value: boolean): void
Set a boolean uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: boolean
Returns void
- Defined in Graphics/Context/shader.ts:213

setUniformFloat

setUniformFloat(name: string, value: number): void
Set a float uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: number
Returns void
- Defined in Graphics/Context/shader.ts:225

setUniformFloatArray

setUniformFloatArray(name: string, value: number[]): void
Set a float array uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: number[]
Returns void
- Defined in Graphics/Context/shader.ts:237

setUniformFloatVector

setUniformFloatVector(name: string, value: Vector): void
Set a Vector uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: Vector
Returns void
- Defined in Graphics/Context/shader.ts:249

setUniformInt

setUniformInt(name: string, value: number): void
Set an integer uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: number
Returns void
- Defined in Graphics/Context/shader.ts:189

setUniformIntArray

setUniformIntArray(name: string, value: number[]): void
Set an integer array uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: number[]
Returns void
- Defined in Graphics/Context/shader.ts:201

setUniformMatrix

setUniformMatrix(name: string, value: Matrix): void
Set an Matrix uniform for the current shader

Important Must call ex.Shader.use() before setting a uniform!
Parameters
- name: string
- value: Matrix
Returns void
- Defined in Graphics/Context/shader.ts:261

use

use(): void
Binds the shader program

Returns void
- Defined in Graphics/Context/shader.ts:104