Class Renderer<T>`Abstract`

Abstract rendering type. Used by PixelManipulator to enable rendering to various targets.

Type Parameters

T

Hierarchy

Renderer

Index

Constructors

Properties

_height _width defaultRenderAs renderInfo

Methods

get_height get_width modifyElement renderPixel reset set_height set_width update

Constructors

constructor

new Renderer<T>(): Renderer<T>
Type Parameters
- T
Returns Renderer<T>

Properties

`Private` _height

_height: number = 1

`Private` _width

_width: number = 1

`Abstract` defaultRenderAs

defaultRenderAs: T

The renderAs value for the default element

renderInfo

renderInfo: T[] = []

Ordered by ID, the renderAs info for each element.

Methods

get_height

get_height(): number
Returns
the height of the canvas

Returns number
- Defined in renderers.ts:111

get_width

get_width(): number
Returns
the width of the canvas

Returns number
- Defined in renderers.ts:100

modifyElement

modifyElement(id: number, newRenderAs: T): T
Intentionally overridable, called when an element is modified.

Returns
The value passed upstream to be stored as the actual renderAs info, allowing for sanitation in this function, or one overriding it.
Parameters
- id: number
  
  The id of the element to modify.
- newRenderAs: T
  
  The new renderAs info.
Returns T
- Defined in renderers.ts:84

`Abstract` renderPixel

renderPixel(location: Location, id: number): void
Renders a pixel on a given location on the next call to update
Parameters
- location: Location
  
  Where to render the pixel.
- id: number
  
  the pixel to render.
Returns void
- Defined in renderers.ts:69

`Abstract` reset

reset(): void
Reset the render target.

Returns void
- Defined in renderers.ts:71

set_height

set_height(value: number): void
Parameters
- value: number
  
  The new height of the canvas
Returns void
- Defined in renderers.ts:106

set_width

set_width(value: number): void
Parameters
- value: number
  
  The new width of the canvas
Returns void
- Defined in renderers.ts:95

`Abstract` update

update(): void
Update the render target. Draws all changes queued up by renderPixel.

Returns void
- Defined in renderers.ts:73

Generated using TypeDoc