Class Shader

Hierarchy

Shader

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:105

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:97

Methods

compile

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

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

getAttributes

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

getUniforms

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

isCurrentlyBound

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

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:186

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:388

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:248

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:272

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:296

setUniformFloatColor

setUniformFloatColor(name: string, value: Color): void
Set a Color uniform for the current shader

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

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:319

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:200

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:224

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:367

trySetUniform

trySetUniform<TUniformType>(uniformType: TUniformType, name: string, ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>): boolean
Set any available uniform type in webgl. Will try to set the uniform, will return false if the uniform didn't exist, true if it was set.

WILL NOT THROW on error

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

trySetUniformBoolean

trySetUniformBoolean(name: string, value: boolean): boolean
Set a boolean uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformFloat

trySetUniformFloat(name: string, value: number): boolean
Set a float uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformFloatArray

trySetUniformFloatArray(name: string, value: number[]): boolean
Set a float array uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformFloatColor

trySetUniformFloatColor(name: string, value: Color): boolean
Set a Color uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformFloatVector

trySetUniformFloatVector(name: string, value: Vector): boolean
Set a Vector uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformInt

trySetUniformInt(name: string, value: number): boolean
Set an integer uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformIntArray

trySetUniformIntArray(name: string, value: number[]): boolean
Set an integer array uniform for the current shader, WILL NOT THROW on error.

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

trySetUniformMatrix

trySetUniformMatrix(name: string, value: Matrix): boolean
Set an Matrix uniform for the current shader, WILL NOT THROW on error.

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

use

use(): void
Binds the shader program

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

Class Shader

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: ShaderOptions

Returns Shader

Properties

attributes

Type declaration

[variableName: string]: VertexAttributeDefinition

Readonly fragmentSource

program

uniforms

Type declaration

[variableName: string]: UniformDefinition

Readonly vertexSource

Accessors

compiled

Returns boolean

Methods

compile

Returns WebGLProgram

getAttributes

Returns VertexAttributeDefinition[]

getUniforms

Returns UniformDefinition[]

isCurrentlyBound

Returns boolean

setTexture

Parameters

slotNumber: number

texture: WebGLTexture

Returns void

setUniform

Type Parameters

TUniformType extends UniformTypeNames

Parameters

uniformType: TUniformType

name: string

Rest ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>

Returns void

setUniformBoolean

Parameters

name: string

value: boolean

Returns void

setUniformFloat

Parameters

name: string

value: number

Returns void

setUniformFloatArray

Parameters

name: string

value: number[]

Returns void

setUniformFloatColor

Parameters

name: string

value: Color

Returns void

setUniformFloatVector

Parameters

name: string

value: Vector

Returns void

setUniformInt

Parameters

name: string

value: number

Returns void

setUniformIntArray

Parameters

name: string

`Optional` options: ShaderOptions

`Readonly` fragmentSource

`Readonly` vertexSource

`Rest` ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>

`Rest` ...value: RemoveFirstFromTuple<Parameters<WebGLRenderingContext[TUniformType]>>