StrokePath
A RenderNode which renders a stroke path consisting of several line segments,
potentially closed at the end.
Constructor
new StrokePath(manager)
Parameters
| name | type | optional | description |
|---|---|---|---|
| manager | Phaser.Renderer.WebGL.RenderNodes.RenderNodeManager | No | The manager that owns this RenderNode. |
Scope: static
Extends
Source: src/renderer/webgl/renderNodes/StrokePath.js#L10
Since: 4.0.0
Inherited Members
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Members
drawLineNode
drawLineNode: Phaser.Renderer.WebGL.RenderNodes.DrawLine
Description:
The RenderNode that generates a line segment.
Source: src/renderer/webgl/renderNodes/StrokePath.js#L29
Since: 4.0.0
Inherited Methods
From Phaser.Renderer.WebGL.RenderNodes.RenderNode:
Public Methods
run
<instance> run(drawingContext, submitterNode, path, lineWidth, open, currentMatrix, tintTL, tintTR, tintBL, tintBR, detail, lighting)
Description:
Render a stroke path consisting of several line segments.
Parameters:
| name | type | optional | description |
|---|---|---|---|
| drawingContext | Phaser.Renderer.WebGL.DrawingContext | No | The context currently in use. |
| submitterNode | Phaser.Renderer.WebGL.RenderNodes.BatchHandlerTriFlat | No | The Submitter node to use. |
| path | Array.<Phaser.Types.GameObjects.Graphics.WidePoint> | No | The points that define the line segments. |
| lineWidth | number | No | The width of the stroke. |
| open | boolean | No | Whether the stroke is open or closed. |
| currentMatrix | Phaser.GameObjects.Components.TransformMatrix | No | The current transform matrix. |
| tintTL | number | No | The top-left tint color. |
| tintTR | number | No | The top-right tint color. |
| tintBL | number | No | The bottom-left tint color. |
| tintBR | number | No | The bottom-right tint color. |
| detail | number | No | The level of detail to use when rendering the stroke. Points which are only this far apart in screen space are combined. It is ignored if the entire path is equal to or shorter than this distance. |
| lighting | boolean | No | Whether to apply lighting effects to the stroke. |
Overrides: Phaser.Renderer.WebGL.RenderNodes.RenderNode#run
Source: src/renderer/webgl/renderNodes/StrokePath.js#L39
Since: 4.0.0