Skip to main content

Interface: Render2DPaintContext

Defined in: render/render-context.ts:112

The context returned after a shape is declared. It extends Render2DContext so further shapes can be chained — multiple shapes drawn before a paint call accumulate and are painted together:

draw.ellipse(...).rect(...).fill(...) // both shapes share one fill

cut() uses the most-recently drawn shape as a cutter: it unions the shapes before it and subtracts that last shape, so only it punches a hole. Shapes drawn after cut() are added back, and the whole result paints as one surface — a single gradient maps across all of it:

draw.rect(...).ellipse(...).cut().rect(...).fill(gradient) // rect ∪ (previous) − ellipse, then ∪ the trailing rect

Extends

Methods

applyMask()

applyMask(): Render2DPaintContext

Defined in: render/render-context.ts:132

Switch a mask scope from mask-collection phase to content phase. Call after drawing the mask shape(s) following RenderContext.mask():

draw.mask({ mode: 'alpha' }) .ellipse({...}).fill(maskFill) .applyMask() .rect({...}).fill(this.fill).stroke(this.stroke) .endMask();

Returns

Render2DPaintContext


cut()

cut(): Render2DPaintContext

Defined in: render/render-context.ts:121

Use the last-drawn shape as a cutter: union the shapes before it and subtract that last shape, leaving the result as the current shape so subsequent shapes and paint calls treat everything as a single surface.

Returns

Render2DPaintContext


ellipse()

abstract ellipse(state): Render2DPaintContext

Defined in: render/render-context.ts:80

Declare an ellipse (circle when width === height).

Parameters

state

Partial<EllipseState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.ellipse


endMask()

endMask(): void

Defined in: render/render-context.ts:134

Close the mask scope opened by RenderContext.mask().

Returns

void


fill()

fill(fills): Render2DPaintContext

Defined in: render/render-context.ts:113

Parameters

fills

FillProp | FillProp[]

Returns

Render2DPaintContext


image()

abstract image(state): Render2DPaintContext

Defined in: render/render-context.ts:90

Declare a raster image.

Parameters

state

Partial<ImageState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.image


line()

abstract line(state): Render2DPaintContext

Defined in: render/render-context.ts:88

Declare a straight line segment.

Parameters

state

Partial<LineState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.line


path()

abstract path(state): Render2DPaintContext

Defined in: render/render-context.ts:86

Declare a vector path, either from a PathState or a PathBuilder.

Parameters

state

Partial<PathState> | PathBuilder

Returns

Render2DPaintContext

Inherited from

Render2DContext.path


polygon()

abstract polygon(state): Render2DPaintContext

Defined in: render/render-context.ts:92

Declare a regular polygon (triangle, pentagon, …).

Parameters

state

Partial<PolygonState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.polygon


polygram()

abstract polygram(state): Render2DPaintContext

Defined in: render/render-context.ts:94

Declare a star / polygram.

Parameters

state

Partial<PolygramState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.polygram


rect()

abstract rect(state): Render2DPaintContext

Defined in: render/render-context.ts:78

Declare an axis-aligned rectangle.

Parameters

state

Partial<RectState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.rect


richText()

abstract richText(state): Render2DPaintContext

Defined in: render/render-context.ts:84

Declare a multi-span rich-text block.

Parameters

state

Partial<RichTextState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.richText


shadow()

shadow(shadows): Render2DPaintContext

Defined in: render/render-context.ts:115

Parameters

shadows

ShadowProp | ShadowProp[]

Returns

Render2DPaintContext


stroke()

stroke(strokes): Render2DPaintContext

Defined in: render/render-context.ts:114

Parameters

strokes

StrokeProp | StrokeProp[]

Returns

Render2DPaintContext


text()

abstract text(state): Render2DPaintContext

Defined in: render/render-context.ts:82

Declare a single-style text run.

Parameters

state

Partial<TextState>

Returns

Render2DPaintContext

Inherited from

Render2DContext.text