API reference
@searsuite/sear-render-context
Platform-neutral drawing contracts with Web Canvas, SVG, WebGL, and headless adapters.
20 exportsderived from source
- classCoordinateTransformersource ↗
-
class CoordinateTransformerSingle authority for host-view, world, and raster coordinate conversion.
constructorconstructor CoordinateTransformer(scrollManager: ScrollManager, renderContext: RenderContext, hitRenderContext: RenderContext): CoordinateTransformerCreates a CoordinateTransformer instance.
scrollManager: ScrollManagerrenderContext: RenderContexthitRenderContext: RenderContext
propertysymbolstatic readonly symbol: symbolDI token for resolving the host-neutral coordinate transformer.
methodgetVisibleWorldRect getVisibleWorldRect(): PositionRect<unknown>Returns the visible world rect.
methodviewToRaster viewToRaster(point: CoordinatePoint): CoordinatePointConverts a host-view point into raster coordinates for pixel reads.
point: CoordinatePoint
methodviewToWorld viewToWorld(point: CoordinatePoint, scroll?: Pick<ScrollManagerState, "x" | "y">): CoordinatePointConverts a host-view point into world coordinates.
point: CoordinatePointscroll: Pick<ScrollManagerState, "x" | "y">
methodworldToView worldToView(point: CoordinatePoint, scroll?: Pick<ScrollManagerState, "x" | "y">): CoordinatePointConverts a world point into host-view coordinates.
point: CoordinatePointscroll: Pick<ScrollManagerState, "x" | "y">
- classHeadlessHitRenderContextsource ↗
-
class HeadlessHitRenderContext extends HeadlessRenderContextHit-test layer marker for a headless render pipeline.
constructorconstructor HeadlessHitRenderContext(): HeadlessHitRenderContextpropertysymbolstatic readonly symbol: symbolDI token for resolving HeadlessHitRenderContext.
Inherited members 59
Inherited from HeadlessRenderContext.
- isDrawn
- hitSymbol
- offScreenSymbol
- addClickEventListener
- addEventListener
- addMouseDownEventListener
- addMouseMoveEventListener
- addMouseUpEventListener
- addResizeListener
- beginFrame
- beginNodeSemantics
- beginPath
- clearRect
- clip
- cloneNode
- closePath
- createHitNode
- drawImage
- endNodeSemantics
- fill
- fillText
- getAttribute
- getImageData
- getLineWidth
- getMaxLineWidth
- getRasterScale
- getRenderTarget
- getRoot
- getViewScale
- initialize
- lineTo
- measureText
- moveTo
- putImageData
- rect
- removeClickEventListener
- removeMouseDownEventListener
- removeMouseMoveEventListener
- removeMouseUpEventListener
- removeResizeListener
- requiresExplicitNodeClear
- requiresFrameRebuild
- resetHitFrame
- resetTransform
- resize
- restore
- save
- setAttribute
- setFillStyle
- setFont
- setLineDash
- setLineWidth
- setStrokeStyle
- setTransform
- setViewScale
- stroke
- strokeRect
- supportsDirtyRedraw
- translate
- classHeadlessOffScreenRenderContextsource ↗
-
class HeadlessOffScreenRenderContext extends HeadlessRenderContextOff-screen layer marker for a headless render pipeline.
constructorconstructor HeadlessOffScreenRenderContext(): HeadlessOffScreenRenderContextpropertysymbolstatic readonly symbol: symbolDI token for resolving HeadlessOffScreenRenderContext.
Inherited members 59
Inherited from HeadlessRenderContext.
- isDrawn
- hitSymbol
- offScreenSymbol
- addClickEventListener
- addEventListener
- addMouseDownEventListener
- addMouseMoveEventListener
- addMouseUpEventListener
- addResizeListener
- beginFrame
- beginNodeSemantics
- beginPath
- clearRect
- clip
- cloneNode
- closePath
- createHitNode
- drawImage
- endNodeSemantics
- fill
- fillText
- getAttribute
- getImageData
- getLineWidth
- getMaxLineWidth
- getRasterScale
- getRenderTarget
- getRoot
- getViewScale
- initialize
- lineTo
- measureText
- moveTo
- putImageData
- rect
- removeClickEventListener
- removeMouseDownEventListener
- removeMouseMoveEventListener
- removeMouseUpEventListener
- removeResizeListener
- requiresExplicitNodeClear
- requiresFrameRebuild
- resetHitFrame
- resetTransform
- resize
- restore
- save
- setAttribute
- setFillStyle
- setFont
- setLineDash
- setLineWidth
- setStrokeStyle
- setTransform
- setViewScale
- stroke
- strokeRect
- supportsDirtyRedraw
- translate
- classHeadlessRenderContextsource ↗
-
class HeadlessRenderContext extends RenderContextRender context that preserves engine state while producing no raster output.
constructorconstructor HeadlessRenderContext(): HeadlessRenderContextpropertysymbolstatic readonly symbol: symbolDI token for resolving the headless render context.
methodaddClickEventListener addClickEventListener(_callback: (event: EventWithOffset): void): voidAttaches a click listener.
_callback: (event: EventWithOffset): void
methodaddEventListener addEventListener(_type: string, _callback: (event: EventWithOffset): void): (): voidAttaches a normalized event listener and returns an idempotent disposer.
_type: string_callback: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(_callback: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
_callback: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(_callback: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
_callback: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(_callback: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
_callback: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(_callback: (): void): voidAttaches a resize listener for host target size changes.
_callback: (): void
methodbeginPath beginPath(): voidBegins a new path.
methodclearRect clearRect(_x: number, _y: number, _width: number, _height: number): voidClears a rectangle from the target.
_x: number_y: number_width: number_height: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): RenderContextCreates a same-kind render context for an auxiliary render layer.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): RenderContextCreates a same-kind render context configured for hit testing.
methoddrawImage drawImage(_image: unknown, _x: number, _y: number): voiddrawImage(_image: unknown, _x: number, _y: number, _width: number, _height: number): voiddrawImage(_image: unknown, _x: number, _y: number, _width: number, _height: number, _sx: number, _sy: number, _sWidth: number, _sHeight: number): voidDraws an image at its natural size.
_image: unknown_x: number_y: number_width: number_height: number_sx: number_sy: number_sWidth: number_sHeight: number
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(_text: string, _x: number, _y: number, _maxWidth?: number): voidDraws text at the given position.
_text: string_x: number_y: number_maxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(_x: number, _y: number, width: number, height: number): RenderImageDataReads raster pixels from the target.
_x: number_y: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberRaster units represented by one host-view unit for this context.
methodgetRenderTarget getRenderTarget(): unknownReturns the native backing target owned by this render context.
methodgetRoot getRoot(): unknownReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the current logical view scale.
methodinitialize initialize(scale?: number): voidInitializes target sizing and adapter-specific state.
scale: number
methodlineTo lineTo(_x: number, _y: number): voidAdds a line from the current path cursor.
_x: number_y: number
methodmeasureText measureText(text: string): { height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(_x: number, _y: number): voidMoves the active path cursor.
_x: number_y: number
methodputImageData putImageData(_imageData: RenderImageData, _x: number, _y: number): voidWrites raster pixels to the target.
_imageData: RenderImageData_x: number_y: number
methodrect rect(_x: number, _y: number, _width: number, _height: number): voidAdds a rectangle to the active path.
_x: number_y: number_width: number_height: number
methodremoveClickEventListener removeClickEventListener(_callback: (event: EventWithOffset): void): voidRemoves a click listener.
_callback: (event: EventWithOffset): void
methodremoveMouseDownEventListener removeMouseDownEventListener(_callback: (event: EventWithOffset): void): voidRemoves a pointer-press listener.
_callback: (event: EventWithOffset): void
methodremoveMouseMoveEventListener removeMouseMoveEventListener(_callback: (event: EventWithOffset): void): voidRemoves a pointer-move listener.
_callback: (event: EventWithOffset): void
methodremoveMouseUpEventListener removeMouseUpEventListener(_callback: (event: EventWithOffset): void): voidRemoves a pointer-release listener.
_callback: (event: EventWithOffset): void
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(_width: number, _height: number, scale?: number): voidResizes the backing render target to the host view's logical size and raster scale.
_width: number_height: numberscale: number
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(_fillStyle: RenderPaint): voidSets the current fill style.
_fillStyle: RenderPaint
methodsetFont setFont(_font: string): voidSets the active platform-neutral font descriptor.
_font: string
methodsetLineDash setLineDash(_segments: number[]): voidSets the current line dash pattern.
_segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(_strokeStyle: RenderPaint): voidSets the current stroke style.
_strokeStyle: RenderPaint
methodsetTransform setTransform(_a: number, _b: number, _c: number, _d: number, _e: number, _f: number): voidReplaces the current transform matrix.
_a: number_b: number_c: number_d: number_e: number_f: number
methodsetViewScale setViewScale(scale: number): voidLogical view scale (distinct from device pixel ratio).
scale: number
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(_x: number, _y: number, _width: number, _height: number): voidStrokes a rectangle without requiring a separate path.
_x: number_y: number_width: number_height: number
methodtranslate translate(_x: number, _y: number): voidTranslates the current drawing transform.
_x: number_y: number
Inherited members 10
Inherited from RenderContext.
- classRenderContextsource ↗
-
class RenderContextPlatform-neutral immediate-mode drawing contract used by render strategies.
Concrete render targets implement this shape so scene nodes and strategies can draw without depending on host-specific APIs.
constructorconstructor RenderContext(): RenderContextpropertyisDrawn isDrawn: booleanWhether the target has received at least one draw operation.
propertyhitSymbolstatic readonly hitSymbol: symbolDI token for the hit-test render layer.
propertyoffScreenSymbolstatic readonly offScreenSymbol: symbolDI token for the scroll-optimization render layer.
propertysymbolstatic readonly symbol: symbolDI token for the primary visible render layer.
methodaddClickEventListener addClickEventListener(callBack: (event: EventWithOffset): void): voidAttaches a click listener.
callBack: (event: EventWithOffset): void
methodaddEventListener addEventListener(type: string, callBack: (event: EventWithOffset): void): (): voidAttaches a normalized event listener and returns an idempotent disposer.
type: stringcallBack: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
callBack: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
callBack: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
callBack: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(callBack: (): void): voidAttaches a resize listener for host target size changes.
callBack: (): void
methodbeginFrame beginFrame(): voidStarts a new render frame when the target rebuilds its visual state.
methodbeginNodeSemantics beginNodeSemantics(_semantics: RenderNodeSemantics): voidMarks subsequent drawing operations as belonging to one semantic scene node.
_semantics: RenderNodeSemantics
methodbeginPath beginPath(): voidBegins a new path.
methodclearRect clearRect(x: number, y: number, width: number, height: number): voidClears a rectangle from the target.
x: numbery: numberwidth: numberheight: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): RenderContextCreates a same-kind render context for an auxiliary render layer.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): RenderContextCreates a same-kind render context configured for hit testing.
methoddrawImage drawImage(image: unknown, x: number, y: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number, sx: number, sy: number, sWidth: number, sHeight: number): voidDraws an image at its natural size.
image: unknownx: numbery: numberwidth: numberheight: numbersx: numbersy: numbersWidth: numbersHeight: number
methodendNodeSemantics endNodeSemantics(): voidEnds the semantic scene-node boundary started by beginNodeSemantics.
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(text: string, x: number, y: number, maxWidth?: number): voidDraws text at the given position.
text: stringx: numbery: numbermaxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(x: number, y: number, width: number, height: number): RenderImageDataReads raster pixels from the target.
x: numbery: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberRaster units represented by one host-view unit for this context.
methodgetRenderTarget getRenderTarget(): unknownReturns the native backing target owned by this render context.
methodgetRoot getRoot(): unknownReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the current logical view scale.
methodinitialize initialize(scale?: number): voidInitializes target sizing and adapter-specific state.
scale: number
methodlineTo lineTo(x: number, y: number): voidAdds a line from the current path cursor.
x: numbery: number
methodmeasureText measureText(text: string): { fontAscent?: number; fontDescent?: number; fontLineGap?: number; height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(x: number, y: number): voidMoves the active path cursor.
x: numbery: number
methodputImageData putImageData(imageData: RenderImageData, x: number, y: number): voidWrites raster pixels to the target.
imageData: RenderImageDatax: numbery: number
methodrect rect(x: number, y: number, width: number, height: number): voidAdds a rectangle to the active path.
x: numbery: numberwidth: numberheight: number
methodremoveClickEventListener removeClickEventListener(callBack: (event: EventWithOffset): void): voidRemoves a click listener.
callBack: (event: EventWithOffset): void
methodremoveMouseDownEventListener removeMouseDownEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-press listener.
callBack: (event: EventWithOffset): void
methodremoveMouseMoveEventListener removeMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-move listener.
callBack: (event: EventWithOffset): void
methodremoveMouseUpEventListener removeMouseUpEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-release listener.
callBack: (event: EventWithOffset): void
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodrequiresExplicitNodeClear requiresExplicitNodeClear(): booleanWhether an existing node must erase its prior output before it is redrawn.
methodrequiresFrameRebuild requiresFrameRebuild(): booleanWhether the target must rebuild a complete visual frame instead of reusing a pixel cache.
methodresetHitFrame resetHitFrame(width: number, height: number): voidResets the complete hit-test frame using the target's native lifecycle.
width: numberheight: number
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(width: number, height: number, scale?: number): voidResizes the backing render target to the host view's logical size and raster scale.
width: numberheight: numberscale: number
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(fillStyle: RenderPaint): voidSets the current fill style.
fillStyle: RenderPaint
methodsetFont setFont(font: string): voidSets the active platform-neutral font descriptor.
font: string
methodsetLineDash setLineDash(segments: number[]): voidSets the current line dash pattern.
segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(strokeStyle: RenderPaint): voidSets the current stroke style.
strokeStyle: RenderPaint
methodsetTransform setTransform(a: number, b: number, c: number, d: number, e: number, f: number): voidReplaces the current transform matrix.
a: numberb: numberc: numberd: numbere: numberf: number
methodsetViewScale setViewScale(scale: number): voidLogical view scale (distinct from device pixel ratio).
scale: number
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(x: number, y: number, width: number, height: number): voidStrokes a rectangle without requiring a separate path.
x: numbery: numberwidth: numberheight: number
methodsupportsDirtyRedraw supportsDirtyRedraw(): booleanWhether the target can apply a redraw to only its accumulated dirty regions.
methodtranslate translate(x: number, y: number): voidTranslates the current drawing transform.
x: numbery: number
- classWebCanvasRenderContextsource ↗
-
class WebCanvasRenderContext extends RenderContextBrowser Canvas2D implementation of the platform-neutral RenderContext.
The context keeps device-pixel-ratio and logical view scale separate so render strategies can work in shared world/view coordinates while the canvas writes to the correct raster backing store.
constructorconstructor WebCanvasRenderContext(renderTarget: unknown, readbackOptimized?: boolean, platform?: Platform): WebCanvasRenderContextConstructs a Canvas render context from a host canvas.
renderTarget: unknownHTMLCanvasElement supplied by the host adapter.
readbackOptimized: booleanplatform: Platform
propertysymbolstatic readonly symbol: symbolDI token for resolving the visible canvas render context.
methodaddClickEventListener addClickEventListener(callBack: (event: EventWithOffset): void): voidAttaches a click listener.
callBack: (event: EventWithOffset): void
methodaddEventListener addEventListener(type: string, callBack: (event: EventWithOffset): void): (): voidRegisters a host pointer event listener on the canvas root.
type: stringcallBack: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
callBack: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
callBack: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
callBack: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(callBack: (): void): voidAttaches a resize listener for host target size changes.
callBack: (): void
methodbeginPath beginPath(): voidBegins a new path.
methodclearRect clearRect(x: number, y: number, width: number, height: number): voidClears a rectangle from the target.
x: numbery: numberwidth: numberheight: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): WebCanvasRenderContextClones the backing canvas dimensions into a detached WebCanvasRenderContext.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): WebCanvasRenderContextCreates a detached render context used by hit rendering.
methoddrawImage drawImage(image: unknown, x: number, y: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number, sx: number, sy: number, sWidth: number, sHeight: number): voidDraws an image at its natural size.
image: unknownx: numbery: numberwidth: numberheight: numbersx: numbersy: numbersWidth: numbersHeight: number
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(text: string, x: number, y: number, maxWidth?: number): voidDraws text at the given position.
text: stringx: numbery: numbermaxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(x: number, y: number, width: number, height: number): { data: [number, number, number, number][]; height: number; width: number }Reads raster pixels from the target.
x: numbery: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberReturns the host-view to raster scale, excluding logical sheet zoom.
methodgetRenderTarget getRenderTarget(): HTMLCanvasElementReturns the native backing target owned by this render context.
methodgetRoot getRoot(): HTMLCanvasElementReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the logical view scale.
methodinitialize initialize(scale: number): voidInitializes canvas sizing and marks the canvas with the shared render-context token.
scale: numberDevice pixel ratio used for backing-store dimensions.
methodlineTo lineTo(x: number, y: number): voidAdds a line from the current path cursor.
x: numbery: number
methodmeasureText measureText(text: string): { fontAscent?: number; fontDescent?: number; height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(x: number, y: number): voidMoves the active path cursor.
x: numbery: number
methodputImageData putImageData(imageData: RenderImageData, x: number, y: number): voidWrites raw pixel data to the backing context.
imageData: RenderImageDataCompact image data shape used by RenderContext.
x: numberRaster x-coordinate.
y: numberRaster y-coordinate.
methodrect rect(x: number, y: number, width: number, height: number): voidAdds a rectangle to the active path.
x: numbery: numberwidth: numberheight: number
methodremoveClickEventListener removeClickEventListener(callBack: (event: EventWithOffset): void): voidRemoves a click listener.
callBack: (event: EventWithOffset): void
methodremoveMouseDownEventListener removeMouseDownEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-press listener.
callBack: (event: EventWithOffset): void
methodremoveMouseMoveEventListener removeMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-move listener.
callBack: (event: EventWithOffset): void
methodremoveMouseUpEventListener removeMouseUpEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-release listener.
callBack: (event: EventWithOffset): void
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(width: number, height: number, scale?: number): voidResizes the canvas backing store for a logical host viewport.
width: numberHost-view width.
height: numberHost-view height.
scale: numberRaster scale to apply to the backing store.
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(fillStyle: RenderPaint): voidSets the current fill style.
fillStyle: RenderPaint
methodsetFont setFont(font: string): voidSets the active platform-neutral font descriptor.
font: string
methodsetLineDash setLineDash(segments: number[]): voidSets the current line dash pattern.
segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(strokeStyle: RenderPaint): voidSets the current stroke style.
strokeStyle: RenderPaint
methodsetTransform setTransform(a: number, b: number, c: number, d: number, e: number, f: number): voidApplies a transform in shared view coordinates.
Translation and scale are multiplied by raster and view scale so callers do not need to reason about canvas backing-store pixels.
a: numberb: numberc: numberd: numbere: numberf: number
methodsetViewScale setViewScale(scale: number): voidUpdates the logical view scale used by sheet zoom.
scale: numberNew view scale.
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(x: number, y: number, width: number, height: number): voidStrokes a rectangle without requiring a separate path.
x: numbery: numberwidth: numberheight: number
methodtranslate translate(x: number, y: number): voidTranslates the current drawing transform.
x: numbery: number
Inherited members 10
Inherited from RenderContext.
- classWebHitCanvasRenderContextsource ↗
-
class WebHitCanvasRenderContext extends WebCanvasRenderContextCanvas render context specialization for the hit-test layer.
constructorconstructor WebHitCanvasRenderContext(renderTarget: unknown, readbackOptimized?: boolean, platform?: Platform): WebHitCanvasRenderContextConstructs a Canvas render context from a host canvas.
renderTarget: unknownHTMLCanvasElement supplied by the host adapter.
readbackOptimized: booleanplatform: Platform
propertysymbolstatic readonly symbol: symbolDI token for resolving the hit canvas context.
Inherited members 59
Inherited from WebCanvasRenderContext.
- isDrawn
- hitSymbol
- offScreenSymbol
- addClickEventListener
- addEventListener
- addMouseDownEventListener
- addMouseMoveEventListener
- addMouseUpEventListener
- addResizeListener
- beginFrame
- beginNodeSemantics
- beginPath
- clearRect
- clip
- cloneNode
- closePath
- createHitNode
- drawImage
- endNodeSemantics
- fill
- fillText
- getAttribute
- getImageData
- getLineWidth
- getMaxLineWidth
- getRasterScale
- getRenderTarget
- getRoot
- getViewScale
- initialize
- lineTo
- measureText
- moveTo
- putImageData
- rect
- removeClickEventListener
- removeMouseDownEventListener
- removeMouseMoveEventListener
- removeMouseUpEventListener
- removeResizeListener
- requiresExplicitNodeClear
- requiresFrameRebuild
- resetHitFrame
- resetTransform
- resize
- restore
- save
- setAttribute
- setFillStyle
- setFont
- setLineDash
- setLineWidth
- setStrokeStyle
- setTransform
- setViewScale
- stroke
- strokeRect
- supportsDirtyRedraw
- translate
- classWebOffScreenCanvasRenderContextsource ↗
-
class WebOffScreenCanvasRenderContext extends WebCanvasRenderContextCanvas render context specialization for scroll optimization buffers.
constructorconstructor WebOffScreenCanvasRenderContext(renderTarget: unknown, readbackOptimized?: boolean, platform?: Platform): WebOffScreenCanvasRenderContextConstructs a Canvas render context from a host canvas.
renderTarget: unknownHTMLCanvasElement supplied by the host adapter.
readbackOptimized: booleanplatform: Platform
propertysymbolstatic readonly symbol: symbolDI token for resolving the off-screen canvas context.
Inherited members 59
Inherited from WebCanvasRenderContext.
- isDrawn
- hitSymbol
- offScreenSymbol
- addClickEventListener
- addEventListener
- addMouseDownEventListener
- addMouseMoveEventListener
- addMouseUpEventListener
- addResizeListener
- beginFrame
- beginNodeSemantics
- beginPath
- clearRect
- clip
- cloneNode
- closePath
- createHitNode
- drawImage
- endNodeSemantics
- fill
- fillText
- getAttribute
- getImageData
- getLineWidth
- getMaxLineWidth
- getRasterScale
- getRenderTarget
- getRoot
- getViewScale
- initialize
- lineTo
- measureText
- moveTo
- putImageData
- rect
- removeClickEventListener
- removeMouseDownEventListener
- removeMouseMoveEventListener
- removeMouseUpEventListener
- removeResizeListener
- requiresExplicitNodeClear
- requiresFrameRebuild
- resetHitFrame
- resetTransform
- resize
- restore
- save
- setAttribute
- setFillStyle
- setFont
- setLineDash
- setLineWidth
- setStrokeStyle
- setTransform
- setViewScale
- stroke
- strokeRect
- supportsDirtyRedraw
- translate
- classWebRenderContextsource ↗
-
class WebRenderContext extends RenderContextExperimental Web-backed render context used for element-based rendering experiments.
constructorconstructor WebRenderContext(container: HTMLDivElement, platform?: Platform): WebRenderContextCreates a Web render context attached to the provided container.
container: HTMLDivElementplatform: Platform
propertycache cache: Set<HTMLElement>Virtual path cache collected before a fill or stroke commits DOM elements.
propertyroot root: HTMLDivElementRoot DOM element that receives generated render elements.
propertysymbolstatic readonly symbol: symbolDI token for resolving the Web render context.
methodaddClickEventListener addClickEventListener(callBack: (event: EventWithOffset): void): voidAttaches a click listener.
callBack: (event: EventWithOffset): void
methodaddEventListener addEventListener(type: string, callBack: (event: EventWithOffset): void): (): voidAttaches a normalized event listener and returns an idempotent disposer.
type: stringcallBack: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
callBack: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
callBack: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
callBack: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(): voidAttaches a resize listener for host target size changes.
methodbeginPath beginPath(): voidClear timing 1、Virtual Path Again 2、beginPath 3、clearRect
methodclearRect clearRect(x: number, y: number, width: number, height: number): voidClears a rectangle from the target.
x: numbery: numberwidth: numberheight: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): RenderContextCreates a same-kind render context for an auxiliary render layer.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): RenderContextCreates a same-kind render context configured for hit testing.
methoddrawImage drawImage(image: unknown, x: number, y: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number, sx: number, sy: number, sWidth: number, sHeight: number): voidDraws an image at its natural size.
image: unknownx: numbery: numberwidth: numberheight: numbersx: numbersy: numbersWidth: numbersHeight: number
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(text: string, x: number, y: number, maxWidth?: number): voidDraws text at the given position.
text: stringx: numbery: numbermaxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(x: number, y: number, width: number, height: number): { data: [number, number, number, number][]; height: number; width: number }Reads raster pixels from the target.
x: numbery: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberRaster units represented by one host-view unit for this context.
methodgetRenderTarget getRenderTarget(): unknownReturns the native backing target owned by this render context.
methodgetRoot getRoot(): HTMLDivElementReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the current logical view scale.
methodinitialize initialize(): voidInitializes target sizing and adapter-specific state.
methodlineTo lineTo(x: number, y: number): voidAdds a line from the current path cursor.
x: numbery: number
methodmeasureText measureText(text: string): { height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(x: number, y: number): voidMoves the active path cursor.
x: numbery: number
methodputImageData putImageData(imageData: RenderImageData, x: number, y: number): voidWrites raster pixels to the target.
imageData: RenderImageDatax: numbery: number
methodrect rect(x: number, y: number, width: number, height: number): voidAdds a rectangle to the active path.
x: numbery: numberwidth: numberheight: number
methodremoveClickEventListener removeClickEventListener(callBack: (event: EventWithOffset): void): voidRemoves a click listener.
callBack: (event: EventWithOffset): void
methodremoveMouseDownEventListener removeMouseDownEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-press listener.
callBack: (event: EventWithOffset): void
methodremoveMouseMoveEventListener removeMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-move listener.
callBack: (event: EventWithOffset): void
methodremoveMouseUpEventListener removeMouseUpEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-release listener.
callBack: (event: EventWithOffset): void
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(): voidResizes the backing render target to the host view's logical size and raster scale.
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(fillStyle: RenderPaint): voidSets the current fill style.
fillStyle: RenderPaint
methodsetFont setFont(font: string): voidSets the active platform-neutral font descriptor.
font: string
methodsetLineDash setLineDash(segments: number[]): voidSets the current line dash pattern.
segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(strokeStyle: string): voidSets the current stroke style.
strokeStyle: string
methodsetTransform setTransform(a: number, b: number, c: number, d: number, e: number, f: number): voidReplaces the current transform matrix.
a: numberb: numberc: numberd: numbere: numberf: number
methodsetViewScale setViewScale(_scale: number): voidLogical view scale (distinct from device pixel ratio).
_scale: number
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(x: number, y: number, width: number, height: number): voidStrokes a rectangle without requiring a separate path.
x: numbery: numberwidth: numberheight: number
methodtranslate translate(x: number, y: number): voidTranslates the current drawing transform.
x: numbery: number
Inherited members 10
Inherited from RenderContext.
- classWebSvgRenderContextsource ↗
-
class WebSvgRenderContext extends RenderContextProduction SVG implementation of the platform-neutral RenderContext.
SVG is retained-mode while Canvas is immediate-mode. The context therefore preserves paint order in SVG groups and applies later clearRect operations as masks to earlier groups. A detached Canvas mirror supplies the raster-only APIs (text metrics and hit-image reads) required by the shared engine.
constructorconstructor WebSvgRenderContext(root: unknown, platform?: Platform): WebSvgRenderContextCreates an SVG render context with a detached raster mirror for Canvas-only APIs.
root: unknownSVG element that receives retained draw output.
platform: PlatformOptional platform diagnostics adapter.
propertysymbolstatic readonly symbol: symbolDI token for resolving the SVG render context.
methodaddClickEventListener addClickEventListener(callBack: (event: EventWithOffset): void): voidAttaches a click listener.
callBack: (event: EventWithOffset): void
methodaddEventListener addEventListener(type: string, callBack: (event: EventWithOffset): void): (): voidAttaches a normalized event listener and returns an idempotent disposer.
type: stringcallBack: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
callBack: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
callBack: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(callBack: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
callBack: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(callBack: (): void): voidAttaches a resize listener for host target size changes.
callBack: (): void
methodbeginFrame beginFrame(): voidReplaces retained SVG output before a full shared-engine render pass.
methodbeginNodeSemantics beginNodeSemantics(semantics: RenderNodeSemantics): voidMarks subsequent drawing operations as belonging to one semantic scene node.
semantics: RenderNodeSemantics
methodbeginPath beginPath(): voidBegins a new path.
methodclearRect clearRect(x: number, y: number, width: number, height: number): voidClears a rectangle from the target.
x: numbery: numberwidth: numberheight: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): WebSvgRenderContextCreates a same-kind render context for an auxiliary render layer.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): WebSvgRenderContextCreates a same-kind render context configured for hit testing.
methoddrawImage drawImage(image: unknown, x: number, y: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number, sx: number, sy: number, sWidth: number, sHeight: number): voidDraws an image at its natural size.
image: unknownx: numbery: numberwidth: numberheight: numbersx: numbersy: numbersWidth: numbersHeight: number
methodendNodeSemantics endNodeSemantics(): voidEnds the semantic scene-node boundary started by beginNodeSemantics.
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(text: string, x: number, y: number, maxWidth?: number): voidDraws text at the given position.
text: stringx: numbery: numbermaxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(x: number, y: number, width: number, height: number): { data: [number, number, number, number][]; height: number; width: number }Reads raster pixels from the target.
x: numbery: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberRaster units represented by one host-view unit for this context.
methodgetRenderTarget getRenderTarget(): SVGSVGElementReturns the native backing target owned by this render context.
methodgetRoot getRoot(): SVGSVGElementReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the current logical view scale.
methodinitialize initialize(scale?: number): voidInitializes target sizing and adapter-specific state.
scale: number
methodlineTo lineTo(x: number, y: number): voidAdds a line from the current path cursor.
x: numbery: number
methodmeasureText measureText(text: string): { fontAscent?: number; fontDescent?: number; height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(x: number, y: number): voidMoves the active path cursor.
x: numbery: number
methodputImageData putImageData(imageData: RenderImageData, x: number, y: number): voidWrites raster pixels to the target.
imageData: RenderImageDatax: numbery: number
methodrect rect(x: number, y: number, width: number, height: number): voidAdds a rectangle to the active path.
x: numbery: numberwidth: numberheight: number
methodremoveClickEventListener removeClickEventListener(callBack: (event: EventWithOffset): void): voidRemoves a click listener.
callBack: (event: EventWithOffset): void
methodremoveMouseDownEventListener removeMouseDownEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-press listener.
callBack: (event: EventWithOffset): void
methodremoveMouseMoveEventListener removeMouseMoveEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-move listener.
callBack: (event: EventWithOffset): void
methodremoveMouseUpEventListener removeMouseUpEventListener(callBack: (event: EventWithOffset): void): voidRemoves a pointer-release listener.
callBack: (event: EventWithOffset): void
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodrequiresExplicitNodeClear requiresExplicitNodeClear(): booleanWhether an existing node must erase its prior output before it is redrawn.
methodrequiresFrameRebuild requiresFrameRebuild(): booleanWhether the target must rebuild a complete visual frame instead of reusing a pixel cache.
methodresetHitFrame resetHitFrame(_width: number, _height: number): voidResets the complete hit-test frame using the target's native lifecycle.
_width: number_height: number
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(width: number, height: number, scale?: number): voidResizes the backing render target to the host view's logical size and raster scale.
width: numberheight: numberscale: number
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(fillStyle: RenderPaint): voidSets the current fill style.
fillStyle: RenderPaint
methodsetFont setFont(font: string): voidSets the active platform-neutral font descriptor.
font: string
methodsetLineDash setLineDash(segments: number[]): voidSets the current line dash pattern.
segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(strokeStyle: RenderPaint): voidSets the current stroke style.
strokeStyle: RenderPaint
methodsetTransform setTransform(a: number, b: number, c: number, d: number, e: number, f: number): voidReplaces the current transform matrix.
a: numberb: numberc: numberd: numbere: numberf: number
methodsetViewScale setViewScale(scale: number): voidLogical view scale (distinct from device pixel ratio).
scale: number
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(x: number, y: number, width: number, height: number): voidStrokes a rectangle without requiring a separate path.
x: numbery: numberwidth: numberheight: number
methodsupportsDirtyRedraw supportsDirtyRedraw(): booleanWhether the target can apply a redraw to only its accumulated dirty regions.
methodtranslate translate(x: number, y: number): voidTranslates the current drawing transform.
x: numbery: number
- classWebWebGLRenderContextsource ↗
-
class WebWebGLRenderContext extends RenderContextNative WebGL implementation of the platform-neutral RenderContext.
Geometry, images, and glyph quads are submitted directly to GPU buffers. Canvas2D is used only to measure text and rasterize glyphs into texture atlases; it never receives scene or complete-frame drawing.
Exampleconst context = new WebWebGLRenderContext(canvas, platform); context.initialize(window.devicePixelRatio);constructorconstructor WebWebGLRenderContext(renderTarget: unknown, platform?: Platform): WebWebGLRenderContextrenderTarget: unknownplatform: Platform
propertysymbolstatic readonly symbol: symbolDI token for the primary visible render layer.
methodaddClickEventListener addClickEventListener(callback: (event: EventWithOffset): void): voidAttaches a click listener.
callback: (event: EventWithOffset): void
methodaddEventListener addEventListener(type: string, callback: (event: EventWithOffset): void): (): voidAttaches a normalized event listener and returns an idempotent disposer.
type: stringcallback: (event: EventWithOffset): void
methodaddMouseDownEventListener addMouseDownEventListener(callback: (event: EventWithOffset): void): voidAttaches a pointer-press listener.
callback: (event: EventWithOffset): void
methodaddMouseMoveEventListener addMouseMoveEventListener(callback: (event: EventWithOffset): void): voidAttaches a pointer-move listener.
callback: (event: EventWithOffset): void
methodaddMouseUpEventListener addMouseUpEventListener(callback: (event: EventWithOffset): void): voidAttaches a pointer-release listener.
callback: (event: EventWithOffset): void
methodaddResizeListener addResizeListener(callback: (): void): voidAttaches a resize listener for host target size changes.
callback: (): void
methodbeginFrame beginFrame(): voidStarts a new render frame when the target rebuilds its visual state.
methodbeginPath beginPath(): voidBegins a new path.
methodclearRect clearRect(x: number, y: number, width: number, height: number): voidClears a rectangle from the target.
x: numbery: numberwidth: numberheight: number
methodclip clip(): voidClips future drawing to the active path.
methodcloneNode cloneNode(): WebWebGLRenderContextCreates a same-kind render context for an auxiliary render layer.
methodclosePath closePath(): voidCloses the active path.
methodcreateHitNode createHitNode(): WebCanvasRenderContextCreates a same-kind render context configured for hit testing.
methoddrawImage drawImage(image: unknown, x: number, y: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number): voiddrawImage(image: unknown, x: number, y: number, width: number, height: number, sx: number, sy: number, sWidth: number, sHeight: number): voidDraws an image at its natural size.
image: unknownx: numbery: numberwidth: numberheight: numbersx: numbersy: numbersWidth: numbersHeight: number
methodfill fill(): voidFills the active path with the current fill style.
methodfillText fillText(text: string, x: number, y: number, maxWidth?: number): voidDraws text at the given position.
text: stringx: numbery: numbermaxWidth: number
methodgetAttribute getAttribute(name: string): stringReads a host-visible attribute from the backing target.
name: string
methodgetImageData getImageData(x: number, y: number, width: number, height: number): RenderImageDataReads raster pixels from the target.
x: numbery: numberwidth: numberheight: number
methodgetLineWidth getLineWidth(): numberReturns the current stroke line width.
methodgetMaxLineWidth getMaxLineWidth(): numberReturns the largest stroke width tracked for erase padding.
methodgetRasterScale getRasterScale(): numberRaster units represented by one host-view unit for this context.
methodgetRenderTarget getRenderTarget(): HTMLCanvasElementReturns the native backing target owned by this render context.
methodgetRoot getRoot(): HTMLCanvasElementReturns the event root associated with this render context.
methodgetViewScale getViewScale(): numberReturns the current logical view scale.
methodinitialize initialize(scale?: number): voidInitializes target sizing and adapter-specific state.
scale: number
methodlineTo lineTo(x: number, y: number): voidAdds a line from the current path cursor.
x: numbery: number
methodmeasureText measureText(text: string): { fontAscent?: number; fontDescent?: number; fontLineGap?: number; height: number; width: number }Measures text using the active font and returns normalized metrics.
text: string
methodmoveTo moveTo(x: number, y: number): voidMoves the active path cursor.
x: numbery: number
methodputImageData putImageData(imageData: RenderImageData, x: number, y: number): voidWrites raster pixels to the target.
imageData: RenderImageDatax: numbery: number
methodrect rect(x: number, y: number, width: number, height: number): voidAdds a rectangle to the active path.
x: numbery: numberwidth: numberheight: number
methodremoveClickEventListener removeClickEventListener(): voidRemoves a click listener.
methodremoveMouseDownEventListener removeMouseDownEventListener(): voidRemoves a pointer-press listener.
methodremoveMouseMoveEventListener removeMouseMoveEventListener(): voidRemoves a pointer-move listener.
methodremoveMouseUpEventListener removeMouseUpEventListener(): voidRemoves a pointer-release listener.
methodremoveResizeListener removeResizeListener(): voidRemoves the active resize listener, if any.
methodrequiresExplicitNodeClear requiresExplicitNodeClear(): booleanWhether an existing node must erase its prior output before it is redrawn.
methodrequiresFrameRebuild requiresFrameRebuild(): booleanWhether the target must rebuild a complete visual frame instead of reusing a pixel cache.
methodresetTransform resetTransform(): voidResets the current transform to the identity transform.
methodresize resize(width: number, height: number, scale?: number): voidResizes the backing render target to the host view's logical size and raster scale.
width: numberheight: numberscale: number
methodrestore restore(): voidRestores the most recently saved drawing state.
methodsave save(): voidSaves the current drawing state.
methodsetAttribute setAttribute(name: string, value: string): voidSets a host-visible attribute on the backing target.
name: stringvalue: string
methodsetFillStyle setFillStyle(fillStyle: RenderPaint): voidSets the current fill style.
fillStyle: RenderPaint
methodsetFont setFont(font: string): voidSets the active platform-neutral font descriptor.
font: string
methodsetLineDash setLineDash(segments: number[]): voidSets the current line dash pattern.
segments: number[]
methodsetLineWidth setLineWidth(width: number): voidSets the current stroke line width.
width: number
methodsetStrokeStyle setStrokeStyle(strokeStyle: RenderPaint): voidSets the current stroke style.
strokeStyle: RenderPaint
methodsetTransform setTransform(a: number, b: number, c: number, d: number, e: number, f: number): voidReplaces the current transform matrix.
a: numberb: numberc: numberd: numbere: numberf: number
methodsetViewScale setViewScale(scale: number): voidLogical view scale (distinct from device pixel ratio).
scale: number
methodstroke stroke(): voidStrokes the active path with the current stroke style.
methodstrokeRect strokeRect(x: number, y: number, width: number, height: number): voidStrokes a rectangle without requiring a separate path.
x: numbery: numberwidth: numberheight: number
methodsupportsDirtyRedraw supportsDirtyRedraw(): booleanWhether the target can apply a redraw to only its accumulated dirty regions.
methodtranslate translate(x: number, y: number): voidTranslates the current drawing transform.
x: numbery: number
Inherited members 6
Inherited from RenderContext.
- interfaceCoordinatePointsource ↗
-
interface CoordinatePointPublic contract for viewport/world/raster coordinate points.
- interfaceEventWithOffsetsource ↗
-
interface EventWithOffset extends RenderPointerEventHost pointer event carrying offsets in view coordinates.
Host adapters translate their native pointer event into the same offset contract and optionally provide a normalized click count.
propertyclickCount readonly clickCount?: numberConsecutive click count normalized by host adapters when available.
Inherited members 13
Inherited from RenderPointerEvent.
- interfaceRenderImageDatasource ↗
-
interface RenderImageData - interfaceRenderNodeSemanticssource ↗
-
interface RenderNodeSemanticsSemantic ownership metadata attached to drawing for retained targets and diagnostics.
- interfaceRenderPointerEventsource ↗
-
interface RenderPointerEventPointer event shape shared by renderers without requiring host-native event types.
propertyaltKey readonly altKey?: booleanpropertybutton readonly button?: numberNormalized button index: zero is the primary pointer button.
propertyclickCount readonly clickCount?: numberpropertyclientX readonly clientX?: numberpropertyclientY readonly clientY?: numberpropertyctrlKey readonly ctrlKey?: booleanpropertydetail readonly detail?: numberpropertymetaKey readonly metaKey?: booleanpropertyoffsetX readonly offsetX: numberpropertyoffsetY readonly offsetY: numberpropertyshiftKey readonly shiftKey?: booleanpropertytarget readonly target?: unknownmethodpreventDefault preventDefault(): voidmethodstopPropagation stopPropagation(): void - typeRenderGradientsource ↗
-
type RenderGradient = objectOpaque paint handles supplied by a concrete renderer.
- typeRenderImageSourcesource ↗
-
type RenderImageSource = unknown - typeRenderPaintsource ↗
-
type RenderPaint = string | RenderGradient | RenderPattern - typeRenderPatternsource ↗
-
type RenderPattern = objectOpaque pattern handles supplied by a concrete renderer.
No public exports match that search.