1681-engine / pixel / PixelGrid

Class: PixelGrid

Defined in: src/pixel/pixel.ts:94

Extended by

• PixelWindow

Constructors

Constructor

new PixelGrid(w, h): PixelGrid;

Defined in: src/pixel/pixel.ts:97

Parameters

Parameter	Type
w	number
h	number

Returns

PixelGrid

Properties

data

readonly data: Uint32Array;

Defined in: src/pixel/pixel.ts:95

---

h

readonly h: number;

Defined in: src/pixel/pixel.ts:99

---

w

readonly w: number;

Defined in: src/pixel/pixel.ts:98

Methods

alphaAt()

alphaAt(x, y): number;

Defined in: src/pixel/pixel.ts:119

Parameters

Parameter	Type
x	number
y	number

Returns

number

---

blend()

blend(
   x, 
   y, 
   c
): void;

Defined in: src/pixel/pixel.ts:295

Alpha-blends a color onto an existing pixel.

Parameters

Parameter	Type
x	number
y	number
c	number

Returns

void

---

blit()

blit(
   src, 
   dx, 
   dy, 
   flipX?
): void;

Defined in: src/pixel/pixel.ts:285

Parameters

Parameter	Type	Default value
src	PixelGrid	undefined
dx	number	undefined
dy	number	undefined
flipX	boolean	false

Returns

void

---

circle()

circle(
   cx, 
   cy, 
   r, 
   c
): void;

Defined in: src/pixel/pixel.ts:146

Parameters

Parameter	Type
cx	number
cy	number
r	number
c	number

Returns

void

---

clone()

clone(): PixelGrid;

Defined in: src/pixel/pixel.ts:343

Returns

PixelGrid

---

ellipse()

ellipse(
   cx, 
   cy, 
   rx, 
   ry, 
   c
): void;

Defined in: src/pixel/pixel.ts:136

Filled ellipse; a pixel is inside when its center lies inside the ellipse.

Parameters

Parameter	Type
cx	number
cy	number
rx	number
ry	number
c	number

Returns

void

---

equals()

equals(other): boolean;

Defined in: src/pixel/pixel.ts:327

Same size and same pixels.

Parameters

Parameter	Type
other	PixelGrid

Returns

boolean

---

get()

get(x, y): number;

Defined in: src/pixel/pixel.ts:114

Parameters

Parameter	Type
x	number
y	number

Returns

number

---

hline()

hline(
   x0, 
   x1, 
   y, 
   c
): void;

Defined in: src/pixel/pixel.ts:127

Parameters

Parameter	Type
x0	number
x1	number
y	number
c	number

Returns

void

---

inBounds()

inBounds(x, y): boolean;

Defined in: src/pixel/pixel.ts:104

Parameters

Parameter	Type
x	number
y	number

Returns

boolean

---

key()

key(): number;

Defined in: src/pixel/pixel.ts:334

Cheap hash of the pixels, for grouping identical frames before comparing them.

Returns

number

---

line()

line(
   x0, 
   y0, 
   x1, 
   y1, 
   c, 
   thickness?
): void;

Defined in: src/pixel/pixel.ts:158

Parameters

Parameter	Type	Default value
x0	number	undefined
y0	number	undefined
x1	number	undefined
y1	number	undefined
c	number	undefined
thickness	number	1

Returns

void

---

outline()

outline(
   c, 
   diagonal?, 
   width?
): void;

Defined in: src/pixel/pixel.ts:211

Adds width pixels of outline around all opaque pixels, one ring at a time — the same result as calling it width times, but each ring only visits the neighbours of the ring before it instead of the whole grid again. (A pixel next to ring k is always filled by ring k+1, so nothing further back can still be waiting.)

Parameters

Parameter	Type	Default value
c	number	undefined
diagonal	boolean	false
width	number	1

Returns

void

---

poly()

poly(points, c): void;

Defined in: src/pixel/pixel.ts:185

Filled polygon (even-odd scanline on pixel centers).

Parameters

Parameter	Type
points	[number, number][]
c	number

Returns

void

---

px()

px(
   x, 
   y, 
   c
): void;

Defined in: src/pixel/pixel.ts:108

Parameters

Parameter	Type
x	number
y	number
c	number

Returns

void

---

recolor()

recolor(from, to): void;

Defined in: src/pixel/pixel.ts:271

Replaces every pixel whose color matches from.

Parameters

Parameter	Type
from	number
to	number

Returns

void

---

rect()

rect(
   x, 
   y, 
   w, 
   h, 
   c
): void;

Defined in: src/pixel/pixel.ts:123

Parameters

Parameter	Type
x	number
y	number
w	number
h	number
c	number

Returns

void

---

ring()

ring(
   cx, 
   cy, 
   r, 
   thickness, 
   c
): void;

Defined in: src/pixel/pixel.ts:150

Parameters

Parameter	Type
cx	number
cy	number
r	number
thickness	number
c	number

Returns

void

---

tint()

tint(f, pred): void;

Defined in: src/pixel/pixel.ts:276

Multiplies brightness of opaque pixels matching pred.

Parameters

Parameter	Type
f	number
pred	(x, y) => boolean

Returns

void

---

toCanvas()

toCanvas(): HTMLCanvasElement;

Defined in: src/pixel/pixel.ts:349

Returns

HTMLCanvasElement

---

upscaled()

upscaled(factor): PixelGrid;

Defined in: src/pixel/pixel.ts:314

The same picture on a grid factor times as fine, each pixel becoming a square block.

Parameters

Parameter	Type
factor	number

Returns

PixelGrid

---

vline()

vline(
   x, 
   y0, 
   y1, 
   c
): void;

Defined in: src/pixel/pixel.ts:131

Parameters

Parameter	Type
x	number
y0	number
y1	number
c	number

Returns

void

---

from()

static from(canvas): PixelGrid;

Defined in: src/pixel/pixel.ts:306

Reads a canvas back into a grid (a PNG layer of the paper doll joining the painted ones).

Parameters

Parameter	Type
canvas	HTMLCanvasElement

Returns

PixelGrid