Skip to content

Commit 125fd25

Browse files
author
HarshKhandeparkar
committed
docs: improve docs for tools
1 parent 352d240 commit 125fd25

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,14 @@ See [example](https://harshkhandeparkar.github.io/gpujs-real-renderer).
226226
##### Properties (Read-Only)
227227
- `brushSize` (*number*): The radius of the drawing brush. The size is measured in the board's
228228
arbitrary coordinate system.
229-
- `brushColor` (*array*): The color of the brush in the corm `[red, green, blue]` where each of
229+
- `brushColor` (*array*): The color of the brush in the form `[red, green, blue]` where each of
230230
`red`, `green` and `blue` are between 0 and 1.
231231
- `eraserSize` (*number*): Size of the eraser.
232232
- `tool` ('brush' | 'rainbow_brush' | 'eraser' | 'line'): The current tool used on the board. This tool can be set in the options or using the `changeTool` method.
233+
- `brush`: Normal brush which uses the `brushColor` property as the color.
234+
- `rainbow_brush`: Brush with continuously changing color.
235+
- `eraser`: Erases.
236+
- `line`: Draws a line with `brushColor` property as the color.
233237
234238
##### Options
235239
Since this is a child class of `RealRenderer`, all the options of `RealRender` are applicable here as well.

0 commit comments

Comments
 (0)