Skip to content

Commit 4572a10

Browse files
committed
Update API documentation for clear() method
1 parent 04aa61b commit 4572a10

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/api.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -202,17 +202,19 @@ YourScreen.endDraw();
202202

203203
#### Description
204204

205-
Clear the screen contents, uses the background colour set in background().
205+
Clear the screen contents or a specific pixel, uses the background colour set in background().
206206

207207
#### Syntax
208208

209209
```
210210
YourScreen.clear()
211+
YourScreen.clear(x, y)
211212
```
212213

213214
#### Parameters
214215

215-
None
216+
- x: x position of the pixel to clear
217+
- y: y position of the pixel to clear
216218

217219
#### Returns
218220

0 commit comments

Comments
 (0)