Class: DilationShader

@geenee/bodyrenderers-common.DilationShader

Image dilation shader

Specialization of ShaderProgram performing dilation operation on image.

Hierarchy

• ShaderProgram

  ↳ DilationShader

Constructors

constructor

• new DilationShader(gl, size, radius?)

Constructor

Parameters

Name	Type	Default value	Description
gl	WebGL2RenderingContext	undefined	WebGL context where program is instantiated
size	Size	undefined	Size of processed (input & output) image
radius	number	1	Dilation operation radius

Overrides

ShaderProgram.constructor

Properties

fragShader

• Protected fragShader: null | WebGLShader

Fragment shader

Inherited from

ShaderProgram.fragShader

---

frameBuffer

• Protected frameBuffer: null | WebGLFramebuffer

Frame buffer (output)

Inherited from

ShaderProgram.frameBuffer

---

gl

• Protected gl: WebGL2RenderingContext

WebGL context where program is instantiated

Inherited from

ShaderProgram.gl

---

inputs

• Protected inputs: string[]

Shader texture inputs (names of sampler uniforms)

Inherited from

ShaderProgram.inputs

---

outputTexture

• Protected Optional outputTexture: ImageTexture

Output image texture

Inherited from

ShaderProgram.outputTexture

---

shaderProgram

• Protected shaderProgram: null | WebGLProgram

Shader program

Inherited from

ShaderProgram.shaderProgram

---

size

• Protected size: Size

Size of processed (input & output) image

Inherited from

ShaderProgram.size

---

uniforms

• Protected uniforms: Object

Shader uniforms as name-type map object

Index signature

▪ [key: string]: UniformType

Inherited from

ShaderProgram.uniforms

---

uniformsLoc

• Protected uniformsLoc: Object

Unifrom locations

Index signature

▪ [key: string]: WebGLUniformLocation | null

Inherited from

ShaderProgram.uniformsLoc

---

vertAttrs

• Protected vertAttrs: null | WebGLVertexArrayObject

Vertex attributes

Inherited from

ShaderProgram.vertAttrs

---

vertBuffer

• Protected vertBuffer: null | WebGLBuffer

Vertex buffer

Inherited from

ShaderProgram.vertBuffer

---

vertShader

• Protected vertShader: null | WebGLShader

Vertex shader

Inherited from

ShaderProgram.vertShader

Methods

compile

▸ Protected compile(fragSrc, vertSrc): void

Compile shader program

Allocates and sets up all resources required for shader program, compiles and links shaders.

Parameters

Name	Type	Description
fragSrc	string	Fragment shader source (copy shader by default)
vertSrc	string	Vertex shader source (copy shader by default)

Returns

void

Inherited from

ShaderProgram.compile

---

dispose

▸ dispose(): void

Dispose program object

Releases resources and instances allocated by program. Program object cannot be used after calling dispose().

Returns

void

Inherited from

ShaderProgram.dispose

---

output

▸ output(): null | WebGLTexture

Output image texture

Returns

null | WebGLTexture

Image texture

Inherited from

ShaderProgram.output

---

prepare

▸ Protected prepare(gl, inputs, uniforms?): void

Prepare execution of the shader

Set input textures and provided uniform values, bind program and setup vertex attribute arrays.

Parameters

Name	Type	Description
gl	WebGL2RenderingContext	Context of shader program
inputs	(null | WebGLTexture)[]	Input image textures
uniforms?	Object	Values of shader uniforms

Returns

void

Inherited from

ShaderProgram.prepare

---

process

▸ process(inputs, uniforms?): null | WebGLTexture

Process input image

Applies shader program to input image, output is written to image texture using framebuffer.

Parameters

Name	Type	Description
inputs	(null | WebGLTexture)[]	Input image textures
uniforms?	Object	Values of shader uniforms

Returns

null | WebGLTexture

Output image texture

Inherited from

ShaderProgram.process

---

program

▸ program(): null | WebGLProgram

Shader program instance

Returns

null | WebGLProgram

Instance of shader program

Inherited from

ShaderProgram.program

---

render

▸ render(inputs, uniforms?): void

Process input image and render the result

Applies shader program to input image, output is renderer to canvas providing WebGL context.

Parameters

Name	Type	Description
inputs	(null | WebGLTexture)[]	Input image textures
uniforms?	Object	Values of shader uniforms

Returns

void

Inherited from

ShaderProgram.render

---

resize

▸ resize(size): void

Resize

Resizes output image texture and updates uniforms.

Parameters

Name	Type	Description
size	Size	Main/output shader size

Returns

void

Inherited from

ShaderProgram.resize

---

restore

▸ Protected restore(gl, state): void

Restore context state

Restores state of WebGL context to recorded checkpoint. This allows to safely share context with other engines.

Parameters

Name	Type	Description
gl	WebGL2RenderingContext	Context to restore state
state	Object	Previously recorded state
state.activeTexture	number	-
state.arrayBuffer	null | WebGLBuffer	-
state.colorMask	boolean[]	-
state.cullFace	boolean	-
state.framebuffer	null | WebGLFramebuffer	-
state.program	null | WebGLProgram	-
state.scissor	Int32Array	-
state.textures	(null | WebGLTexture)[]	-
state.vertexArray	null | WebGLVertexArrayObject	-
state.viewport	Int32Array	-

Returns

void

Inherited from

ShaderProgram.restore

---

save

▸ Protected save(gl): Object

Save context state

Saves state of WebGL including program in use, bound array buffers, framebuffer, and textures. Returned state can be restored later to safely share context with other frameworks or renderers.

Parameters

Name	Type	Description
gl	WebGL2RenderingContext	Context which state will be recorded

Returns

Object

Current state of WebGL context

Name	Type
activeTexture	number
arrayBuffer	null | WebGLBuffer
colorMask	boolean[]
cullFace	boolean
framebuffer	null | WebGLFramebuffer
program	null | WebGLProgram
scissor	Int32Array
textures	(null | WebGLTexture)[]
vertexArray	null | WebGLVertexArrayObject
viewport	Int32Array

Inherited from

ShaderProgram.save