pxt-calliope/docs/reference/game/clear.md

40 lines
752 B
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# Clear
2016-04-02 01:22:47 +02:00
The clear function for images.
2016-03-26 00:47:20 +01:00
2016-04-16 00:02:26 +02:00
Turn off all the pixels in an [Image](/reference/images/image).
2016-03-26 00:47:20 +01:00
## JavaScript
2016-03-26 00:47:20 +01:00
```sig
2016-03-26 00:47:20 +01:00
export function clear(img: micro_bit.Image)
```
## Parameters
2016-03-26 00:47:20 +01:00
* none
## Example
2016-03-26 00:47:20 +01:00
The following example turns off the pixels of `img` when the A input button is pressed:
```blocks
2016-03-26 00:47:20 +01:00
let img = images.createImage(`
. . . . .
. # # # .
. # # # .
. # # # .
. . . . .
`)
img.showImage(0)
2020-03-19 16:26:40 +01:00
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {
2016-03-26 00:47:20 +01:00
img.clear()
img.showImage(0)
})
```
## See also
2016-03-26 00:47:20 +01:00
2016-04-16 00:02:26 +02:00
[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)
2016-03-26 00:47:20 +01:00