pxt-calliope/docs/reference/game/clear.md
2020-03-19 16:26:40 +01:00

40 lines
752 B
Markdown

# Clear
The clear function for images.
Turn off all the pixels in an [Image](/reference/images/image).
## JavaScript
```sig
export function clear(img: micro_bit.Image)
```
## Parameters
* none
## Example
The following example turns off the pixels of `img` when the A input button is pressed:
```blocks
let img = images.createImage(`
. . . . .
. # # # .
. # # # .
. # # # .
. . . . .
`)
img.showImage(0)
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {
img.clear()
img.showImage(0)
})
```
## See also
[Image](/reference/images/image), [show animation](/reference/basic/show-animation), [show image](/reference/images/show-image), [scroll image](/reference/images/scroll-image), [create image](/reference/images/create-image)