Skip to content

Commit 86985a9

Browse files
author
HarshKhandeparkar
committed
docs: new tool docs
1 parent 40ef812 commit 86985a9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ See [example](https://harshkhandeparkar.github.io/gpujs-real-renderer).
225225
- `brushColor` (*array*): The color of the brush in the corm `[red, green, blue]` where each of
226226
`red`, `green` and `blue` are between 0 and 1.
227227
- `eraserSize` (*number*): Size of the eraser.
228-
- `mode` ('paint' | 'erase'): The current mode of the board. This mode can be set in the options or using the `changeMode` method.
228+
- `tool` ('brush' | 'erase'): The current tool used on the board. This tool can be set in the options or using the `changeTool` method.
229229
230230
##### Options
231231
Since this is a child class of `RealRenderer`, all the options of `RealRender` are applicable here as well.
@@ -241,7 +241,7 @@ Apart from those, the following are additional options that can be passed on to
241241
242242
- `maxUndos`(*Number*) (Default: `15`): Determines the maximum possible undos. (Use a smaller number on devices with less RAM)
243243
244-
- `mode` (*'paint' | 'draw'*) (Default: `'paint'`): Determines whether the board paints or erases on mouse drag.
244+
- `tool` (*'brush' | 'draw'*) (Default: `'brush'`): Determines which tool to use.
245245
246246
##### Methods
247247
Since this is a child class of `RealRenderer`, all the methods of `RealRender` are available here as well.
@@ -252,7 +252,7 @@ Apart from these methods, the following new methods are also available and are c
252252
- `changeBrushColor(newColor)`: Change the brush color.
253253
- `changeBrushSize(newSize)`: Change the brush size.
254254
- `changeEraserSize(newSize)`: Change the eraser size.
255-
- `changeMode(newMode)`: Change the mode.
255+
- `changeTool(newTool)`: Change the tool.
256256
- `undo(numUndos = 1)`: Undoes the specified number of brush strokes. (Defualt: undoes one stroke)
257257
- `redo(numUndos = 1)`: Redoes the specified number of brush strokes. (Defualt: redoes one stroke)
258258
- `clear()`: Clears the board.

0 commit comments

Comments
 (0)