Documentation / @ripl/3d / Context3D

Class: Context3D

Defined in: 3d/src/context.ts:90

Base 3D rendering context providing view/projection matrices, camera, lighting, and projection. Subclassed by CanvasContext3D and WebGPUContext3D.

Extends

• DOMContext<HTMLCanvasElement, Context3DMeta>

Extended by

• CanvasContext3D

Constructors

Constructor

new Context3D(type, target, element, options?): Context3D

Defined in: 3d/src/context.ts:107

Parameters

Parameter	Type
type	string
target	string | HTMLElement
element	HTMLCanvasElement
options?	Context3DOptions

Returns

Context3D

Overrides

DOMContext<HTMLCanvasElement, Context3DMeta>.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
buffer	public	boolean	false	DOMContext.buffer	core/src/context/context.ts:102
currentState	protected	BaseState	undefined	DOMContext.currentState	core/src/context/context.ts:112
element	readonly	HTMLCanvasElement	undefined	DOMContext.element	core/src/context/context.ts:99
faceBuffer	public	ProjectedFace3D[]	[]	-	3d/src/context.ts:97
far	protected	number	undefined	-	3d/src/context.ts:101
fov	protected	number	undefined	-	3d/src/context.ts:99
height	public	number	undefined	DOMContext.height	core/src/context/context.ts:104
lightDirection	public	Vector3	undefined	-	3d/src/context.ts:95
lightMode	public	LightMode	undefined	-	3d/src/context.ts:96
meta	readonly	Context3DMeta	undefined	DOMContext.meta	core/src/context/context.ts:100
near	protected	number	undefined	-	3d/src/context.ts:100
parent?	public	EventBus<ContextEventMap>	undefined	DOMContext.parent	core/src/core/event-bus.ts:79
projectionMatrix	public	Matrix4	undefined	-	3d/src/context.ts:93
renderDepth	protected	number	0	DOMContext.renderDepth	core/src/context/context.ts:113
renderedElements	public	RenderElement[]	undefined	DOMContext.renderedElements	core/src/context/context.ts:109
renderElement?	public	RenderElement	undefined	DOMContext.renderElement	core/src/context/context.ts:108
root	readonly	HTMLElement	undefined	DOMContext.root	dom/src/context.ts:44
scaleDPR	public	Scale<number, number>	undefined	DOMContext.scaleDPR	core/src/context/context.ts:107
scaleX	public	Scale<number, number>	undefined	DOMContext.scaleX	core/src/context/context.ts:105
scaleY	public	Scale<number, number>	undefined	DOMContext.scaleY	core/src/context/context.ts:106
states	protected	BaseState[]	undefined	DOMContext.states	core/src/context/context.ts:111
type	readonly	string	undefined	DOMContext.type	core/src/context/context.ts:98
viewMatrix	public	Matrix4	undefined	-	3d/src/context.ts:92
viewProjectionMatrix	public	Matrix4	undefined	-	3d/src/context.ts:94
width	public	number	undefined	DOMContext.width	core/src/context/context.ts:103
defaultKey	readonly	typeof defaultKey	undefined	DOMContext.defaultKey	core/src/core/disposer.ts:10

Accessors

currentRenderElement

Get Signature

get currentRenderElement(): RenderElement | undefined

Defined in: core/src/context/context.ts:115

Returns

RenderElement | undefined

Set Signature

set currentRenderElement(element): void

Defined in: core/src/context/context.ts:119

Parameters

Parameter	Type
element	RenderElement | undefined

Returns

void

Inherited from

DOMContext.currentRenderElement

---

direction

Get Signature

get direction(): Direction

Defined in: core/src/context/context.ts:143

Returns

Direction

Set Signature

set direction(value): void

Defined in: core/src/context/context.ts:147

Parameters

Parameter	Type
value	Direction

Returns

void

Inherited from

DOMContext.direction

---

fill

Get Signature

get fill(): string

Defined in: core/src/context/context.ts:127

Returns

string

Set Signature

set fill(value): void

Defined in: core/src/context/context.ts:131

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

DOMContext.fill

---

filter

Get Signature

get filter(): string

Defined in: core/src/context/context.ts:135

Returns

string

Set Signature

set filter(value): void

Defined in: core/src/context/context.ts:139

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

DOMContext.filter

---

font

Get Signature

get font(): string

Defined in: core/src/context/context.ts:151

Returns

string

Set Signature

set font(value): void

Defined in: core/src/context/context.ts:155

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

DOMContext.font

---

fontKerning

Get Signature

get fontKerning(): FontKerning

Defined in: core/src/context/context.ts:159

Returns

FontKerning

Set Signature

set fontKerning(value): void

Defined in: core/src/context/context.ts:163

Parameters

Parameter	Type
value	FontKerning

Returns

void

Inherited from

DOMContext.fontKerning

---

globalCompositeOperation

Get Signature

get globalCompositeOperation(): unknown

Defined in: core/src/context/context.ts:175

Returns

unknown

Set Signature

set globalCompositeOperation(value): void

Defined in: core/src/context/context.ts:179

Parameters

Parameter	Type
value	unknown

Returns

void

Inherited from

DOMContext.globalCompositeOperation

---

lineCap

Get Signature

get lineCap(): LineCap

Defined in: core/src/context/context.ts:183

Returns

LineCap

Set Signature

set lineCap(value): void

Defined in: core/src/context/context.ts:187

Parameters

Parameter	Type
value	LineCap

Returns

void

Inherited from

DOMContext.lineCap

---

lineDash

Get Signature

get lineDash(): number[]

Defined in: core/src/context/context.ts:191

Returns

number[]

Set Signature

set lineDash(value): void

Defined in: core/src/context/context.ts:195

Parameters

Parameter	Type
value	number[]

Returns

void

Inherited from

DOMContext.lineDash

---

lineDashOffset

Get Signature

get lineDashOffset(): number

Defined in: core/src/context/context.ts:199

Returns

number

Set Signature

set lineDashOffset(value): void

Defined in: core/src/context/context.ts:203

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.lineDashOffset

---

lineJoin

Get Signature

get lineJoin(): LineJoin

Defined in: core/src/context/context.ts:207

Returns

LineJoin

Set Signature

set lineJoin(value): void

Defined in: core/src/context/context.ts:211

Parameters

Parameter	Type
value	LineJoin

Returns

void

Inherited from

DOMContext.lineJoin

---

lineWidth

Get Signature

get lineWidth(): number

Defined in: core/src/context/context.ts:215

Returns

number

Set Signature

set lineWidth(value): void

Defined in: core/src/context/context.ts:219

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.lineWidth

---

miterLimit

Get Signature

get miterLimit(): number

Defined in: core/src/context/context.ts:223

Returns

number

Set Signature

set miterLimit(value): void

Defined in: core/src/context/context.ts:227

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.miterLimit

---

opacity

Get Signature

get opacity(): number

Defined in: core/src/context/context.ts:167

Returns

number

Set Signature

set opacity(value): void

Defined in: core/src/context/context.ts:171

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.opacity

---

renderStrategy

Get Signature

get renderStrategy(): RenderStrategy

Defined in: 3d/src/context.ts:103

Returns

RenderStrategy

---

rotation

Get Signature

get rotation(): Rotation

Defined in: core/src/context/context.ts:327

Returns

Rotation

Set Signature

set rotation(value): void

Defined in: core/src/context/context.ts:331

Parameters

Parameter	Type
value	Rotation

Returns

void

Inherited from

DOMContext.rotation

---

shadowBlur

Get Signature

get shadowBlur(): number

Defined in: core/src/context/context.ts:231

Returns

number

Set Signature

set shadowBlur(value): void

Defined in: core/src/context/context.ts:235

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.shadowBlur

---

shadowColor

Get Signature

get shadowColor(): string

Defined in: core/src/context/context.ts:239

Returns

string

Set Signature

set shadowColor(value): void

Defined in: core/src/context/context.ts:243

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

DOMContext.shadowColor

---

shadowOffsetX

Get Signature

get shadowOffsetX(): number

Defined in: core/src/context/context.ts:247

Returns

number

Set Signature

set shadowOffsetX(value): void

Defined in: core/src/context/context.ts:251

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.shadowOffsetX

---

shadowOffsetY

Get Signature

get shadowOffsetY(): number

Defined in: core/src/context/context.ts:255

Returns

number

Set Signature

set shadowOffsetY(value): void

Defined in: core/src/context/context.ts:259

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.shadowOffsetY

---

stroke

Get Signature

get stroke(): string

Defined in: core/src/context/context.ts:263

Returns

string

Set Signature

set stroke(value): void

Defined in: core/src/context/context.ts:267

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

DOMContext.stroke

---

textAlign

Get Signature

get textAlign(): TextAlignment

Defined in: core/src/context/context.ts:271

Returns

TextAlignment

Set Signature

set textAlign(value): void

Defined in: core/src/context/context.ts:275

Parameters

Parameter	Type
value	TextAlignment

Returns

void

Inherited from

DOMContext.textAlign

---

textBaseline

Get Signature

get textBaseline(): TextBaseline

Defined in: core/src/context/context.ts:279

Returns

TextBaseline

Set Signature

set textBaseline(value): void

Defined in: core/src/context/context.ts:283

Parameters

Parameter	Type
value	TextBaseline

Returns

void

Inherited from

DOMContext.textBaseline

---

transformOriginX

Get Signature

get transformOriginX(): TransformOrigin

Defined in: core/src/context/context.ts:335

Returns

TransformOrigin

Set Signature

set transformOriginX(value): void

Defined in: core/src/context/context.ts:339

Parameters

Parameter	Type
value	TransformOrigin

Returns

void

Inherited from

DOMContext.transformOriginX

---

transformOriginY

Get Signature

get transformOriginY(): TransformOrigin

Defined in: core/src/context/context.ts:343

Returns

TransformOrigin

Set Signature

set transformOriginY(value): void

Defined in: core/src/context/context.ts:347

Parameters

Parameter	Type
value	TransformOrigin

Returns

void

Inherited from

DOMContext.transformOriginY

---

transformScaleX

Get Signature

get transformScaleX(): number

Defined in: core/src/context/context.ts:311

Returns

number

Set Signature

set transformScaleX(value): void

Defined in: core/src/context/context.ts:315

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.transformScaleX

---

transformScaleY

Get Signature

get transformScaleY(): number

Defined in: core/src/context/context.ts:319

Returns

number

Set Signature

set transformScaleY(value): void

Defined in: core/src/context/context.ts:323

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.transformScaleY

---

translateX

Get Signature

get translateX(): number

Defined in: core/src/context/context.ts:295

Returns

number

Set Signature

set translateX(value): void

Defined in: core/src/context/context.ts:299

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.translateX

---

translateY

Get Signature

get translateY(): number

Defined in: core/src/context/context.ts:303

Returns

number

Set Signature

set translateY(value): void

Defined in: core/src/context/context.ts:307

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.translateY

---

zIndex

Get Signature

get zIndex(): number

Defined in: core/src/context/context.ts:287

Returns

number

Set Signature

set zIndex(value): void

Defined in: core/src/context/context.ts:291

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

DOMContext.zIndex

Methods

applyClip()

applyClip(path, fillRule?): void

Defined in: core/src/context/context.ts:500

Clips subsequent drawing operations to the given path.

Parameters

Parameter	Type
path	ContextPath
fillRule?	FillRule

Returns

void

Inherited from

DOMContext.applyClip

---

applyFill()

applyFill(path, fillRule?): void

Defined in: core/src/context/context.ts:505

Fills the given path or text element using the current fill style.

Parameters

Parameter	Type
path	ContextElement
fillRule?	FillRule

Returns

void

Inherited from

DOMContext.applyFill

---

applyStroke()

applyStroke(path): void

Defined in: core/src/context/context.ts:510

Strokes the given path or text element using the current stroke style.

Parameters

Parameter	Type
path	ContextElement

Returns

void

Inherited from

DOMContext.applyStroke

---

batch()

batch<TResult>(body): TResult

Defined in: core/src/context/context.ts:441

Clears the rendering surface and brackets the callback in markRenderStart/markRenderEnd, returning the callback's result.

Type Parameters

Type Parameter	Default type
TResult	void

Parameters

Parameter	Type
body	() => TResult

Returns

TResult

Inherited from

DOMContext.batch

---

clear()

clear(): void

Defined in: core/src/context/context.ts:408

Clears the entire rendering surface.

Returns

void

Inherited from

DOMContext.clear

---

createPath()

createPath(id?): ContextPath

Defined in: core/src/context/context.ts:485

Creates a new path element, optionally reusing an id for SVG diffing efficiency.

Parameters

Parameter	Type
id?	string

Returns

ContextPath

Inherited from

DOMContext.createPath

---

createText()

createText(options): ContextText

Defined in: core/src/context/context.ts:490

Creates a new text element from the given options.

Parameters

Parameter	Type
options	TextOptions

Returns

ContextText

Inherited from

DOMContext.createText

---

destroy()

destroy(): void

Defined in: dom/src/context.ts:303

Destroys the context, removing the DOM element and disposing all resources.

Returns

void

Inherited from

DOMContext.destroy

---

disableInteraction()

disableInteraction(): void

Defined in: dom/src/context.ts:291

Disables DOM interaction events and clears the active element set.

Returns

void

Inherited from

DOMContext.disableInteraction

---

dispose()

protected dispose(key?): void

Defined in: core/src/core/disposer.ts:24

Disposes all resources under the given key, or all resources if no key is provided.

Parameters

Parameter	Type
key?	PropertyKey

Returns

void

Inherited from

DOMContext.dispose

---

drawImage()

drawImage(image, x, y, width?, height?): void

Defined in: core/src/context/context.ts:495

Draws an image onto the rendering surface at the given position and optional size.

Parameters

Parameter	Type
image	CanvasImageSource
x	number
y	number
width?	number
height?	number

Returns

void

Inherited from

DOMContext.drawImage

---

emit()

Call Signature

emit<TEvent>(event): TEvent

Defined in: core/src/core/event-bus.ts:127

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter	Default type
TEvent extends Event<undefined>	Event<undefined>

Parameters

Parameter	Type
event	TEvent

Returns

TEvent

Inherited from

DOMContext.emit

Call Signature

emit<TEvent>(type, data): Event<ContextEventMap[TEvent]>

Defined in: core/src/core/event-bus.ts:128

Emits an event, invoking all matching handlers and bubbling to the parent if applicable.

Type Parameters

Type Parameter
TEvent extends keyof ContextEventMap

Parameters

Parameter	Type
type	TEvent
data	ContextEventMap[TEvent]

Returns

Event<ContextEventMap[TEvent]>

Inherited from

DOMContext.emit

---

enableInteraction()

enableInteraction(): void

Defined in: dom/src/context.ts:263

Enables DOM interaction events (mouse enter, leave, move, click, drag) with element hit testing.

Returns

void

Inherited from

DOMContext.enableInteraction

---

getDefaultState()

protected getDefaultState(): BaseState

Defined in: core/src/context/context.ts:381

Returns

BaseState

Inherited from

DOMContext.getDefaultState

---

getLightDirectionForRender()

getLightDirectionForRender(): Vector3

Defined in: 3d/src/context.ts:185

Returns the effective light direction for the current render, accounting for the light mode.

Returns

Vector3

---

has()

has(type): boolean

Defined in: core/src/core/event-bus.ts:84

Returns whether there are any listeners registered for the given event type.

Parameters

Parameter	Type
type	keyof ContextEventMap

Returns

boolean

Inherited from

DOMContext.has

---

hitTest()

protected hitTest(events, x, y): RenderElement[]

Defined in: core/src/context/context.ts:529

Tests which rendered elements intersect the given point for the given event types, returning them sorted by zIndex (highest first).

Parameters

Parameter	Type
events	string[]
x	number
y	number

Returns

RenderElement[]

Inherited from

DOMContext.hitTest

---

init()

protected init(): void

Defined in: dom/src/context.ts:80

Returns

void

Inherited from

DOMContext.init

---

invalidateTrackedElements()

invalidateTrackedElements(event?): void

Defined in: core/src/context/context.ts:418

Clears the cached list of tracked elements for interaction, forcing a rebuild on the next hit test.

Parameters

Parameter	Type
event?	string

Returns

void

Inherited from

DOMContext.invalidateTrackedElements

---

isPointInPath()

isPointInPath(path, x, y, fillRule?): boolean

Defined in: core/src/context/context.ts:515

Tests whether a point is inside the filled region of a path.

Parameters

Parameter	Type
path	ContextPath
x	number
y	number
fillRule?	FillRule

Returns

boolean

Inherited from

DOMContext.isPointInPath

---

isPointInStroke()

isPointInStroke(path, x, y): boolean

Defined in: core/src/context/context.ts:520

Tests whether a point is on the stroked outline of a path.

Parameters

Parameter	Type
path	ContextPath
x	number
y	number

Returns

boolean

Inherited from

DOMContext.isPointInStroke

---

layer()

layer<TResult>(body): TResult

Defined in: core/src/context/context.ts:397

Executes a callback within a save/restore pair, returning the callback's result.

Type Parameters

Type Parameter	Default type
TResult	void

Parameters

Parameter	Type
body	() => TResult

Returns

TResult

Inherited from

DOMContext.layer

---

markRenderEnd()

markRenderEnd(): void

Defined in: core/src/context/context.ts:436

Signals the end of a render pass.

Returns

void

Inherited from

DOMContext.markRenderEnd

---

markRenderStart()

markRenderStart(): void

Defined in: core/src/context/context.ts:427

Signals the start of a render pass; resets the rendered-elements list at depth 0.

Returns

void

Inherited from

DOMContext.markRenderStart

---

measureText()

measureText(text, font?): TextMetrics

Defined in: core/src/context/context.ts:480

Measures text dimensions using the context's current font or an optional override.

Parameters

Parameter	Type
text	string
font?	string

Returns

TextMetrics

Inherited from

DOMContext.measureText

---

off()

off<TEvent>(type, handler): void

Defined in: core/src/core/event-bus.ts:102

Removes a previously registered handler for the given event type.

Type Parameters

Type Parameter
TEvent extends keyof ContextEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<ContextEventMap[TEvent]>

Returns

void

Inherited from

DOMContext.off

---

on()

on<TEvent>(type, handler, options?): Disposable

Defined in: core/src/core/event-bus.ts:89

Subscribes a handler to the given event type and returns a disposable for cleanup.

Type Parameters

Type Parameter
TEvent extends keyof ContextEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<ContextEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

DOMContext.on

---

once()

once<TEvent>(type, handler, options?): Disposable

Defined in: core/src/core/event-bus.ts:117

Subscribes a handler that is automatically removed after it fires once.

Type Parameters

Type Parameter
TEvent extends keyof ContextEventMap

Parameters

Parameter	Type
type	TEvent
handler	EventHandler<ContextEventMap[TEvent]>
options?	EventSubscriptionOptions

Returns

Disposable

Inherited from

DOMContext.once

---

project()

project(point): ProjectedPoint

Defined in: 3d/src/context.ts:194

Projects a 3D world-space point to 2D screen coordinates.

Parameters

Parameter	Type
point	Vector3

Returns

ProjectedPoint

---

rescale()

protected rescale(width, height): void

Defined in: core/src/context/context.ts:371

Parameters

Parameter	Type
width	number
height	number

Returns

void

Inherited from

DOMContext.rescale

---

reset()

reset(): void

Defined in: core/src/context/context.ts:413

Resets the context to its initial state.

Returns

void

Inherited from

DOMContext.reset

---

restore()

restore(): void

Defined in: core/src/context/context.ts:392

Restores the most recently saved state from the stack.

Returns

void

Inherited from

DOMContext.restore

---

retain()

protected retain(value, key?): void

Defined in: core/src/core/disposer.ts:13

Registers a disposable resource under an optional key for later cleanup.

Parameters

Parameter	Type	Default value
value	Disposable	undefined
key	PropertyKey	Disposer.defaultKey

Returns

void

Inherited from

DOMContext.retain

---

rotate()

rotate(angle): void

Defined in: core/src/context/context.ts:455

Applies a rotation transformation.

Parameters

Parameter	Type
angle	number

Returns

void

Inherited from

DOMContext.rotate

---

save()

save(): void

Defined in: core/src/context/context.ts:386

Pushes the current state onto the stack and resets to defaults.

Returns

void

Inherited from

DOMContext.save

---

scale()

scale(x, y): void

Defined in: core/src/context/context.ts:460

Applies a scale transformation.

Parameters

Parameter	Type
x	number
y	number

Returns

void

Inherited from

DOMContext.scale

---

setCamera()

setCamera(eye, target, up): void

Defined in: 3d/src/context.ts:158

Sets the view matrix from an eye position, look-at target, and up direction.

Parameters

Parameter	Type
eye	Vector3
target	Vector3
up	Vector3

Returns

void

---

setOrthographic()

setOrthographic(left, right, bottom, top, near, far): void

Defined in: 3d/src/context.ts:172

Sets an orthographic projection with explicit frustum bounds.

Parameters

Parameter	Type
left	number
right	number
bottom	number
top	number
near	number
far	number

Returns

void

---

setPerspective()

setPerspective(fov, near, far): void

Defined in: 3d/src/context.ts:164

Updates the perspective projection with the given field of view, near, and far planes.

Parameters

Parameter	Type
fov	number
near	number
far	number

Returns

void

---

setTransform()

setTransform(a, b, c, d, e, f): void

Defined in: core/src/context/context.ts:470

Parameters

Parameter	Type
a	number
b	number
c	number
d	number
e	number
f	number

Returns

void

Inherited from

DOMContext.setTransform

---

submitMesh()

submitMesh(submission): void

Defined in: 3d/src/context.ts:206

Submits a mesh for rendering this frame. Noop in the base class; overridden by GPU-backed contexts.

Parameters

Parameter	Type
submission	MeshSubmission

Returns

void

---

transform()

transform(a, b, c, d, e, f): void

Defined in: core/src/context/context.ts:475

Parameters

Parameter	Type
a	number
b	number
c	number
d	number
e	number
f	number

Returns

void

Inherited from

DOMContext.transform

---

translate()

translate(x, y): void

Defined in: core/src/context/context.ts:465

Applies a translation transformation.

Parameters

Parameter	Type
x	number
y	number

Returns

void

Inherited from

DOMContext.translate

---

updateProjectionMatrix()

protected updateProjectionMatrix(): void

Defined in: 3d/src/context.ts:145

Returns

void

---

updateViewProjectionMatrix()

protected updateViewProjectionMatrix(): void

Defined in: 3d/src/context.ts:141

Returns

void