43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
# Set Pixel
|
|
|
|
The set pixel function. #set pixel.
|
|
|
|
Set the on/off state of pixel in an [Image](/reference/images/image).
|
|
|
|
### JavaScript
|
|
|
|
```
|
|
export function setPixel(_this: micro_bit.Image, x: number, y: number, value: boolean)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
* x - [Number](/reference/types/number); the *x coordinate* or horizontal position of a pixel in an [image](/reference/images/image)
|
|
* x - [Number](/reference/types/number); the *y coordinate* or vertical position of a pixel in an [image](/reference/images/image)
|
|
* value -[Boolean](/reference/types/boolean); the on/off state of a pixel; `true` for on, `false` for off
|
|
|
|
### x, y coordinates?
|
|
|
|
To figure out the ``x``, ``y`` coordinates, see [LED screen](/device/screen).
|
|
|
|
### Example
|
|
|
|
The following example creates an image and stores it in the `img` variable. The `set pixel` function sets the centre pixel off, before `img` is shown using `show image`.
|
|
|
|
```
|
|
let img = images.createImage(`
|
|
. . # . .
|
|
. # . # .
|
|
. . # . .
|
|
. # . # .
|
|
. . # . .
|
|
`)
|
|
img.setPixel(2, 2, false)
|
|
img.showImage(0)
|
|
```
|
|
|
|
### See also
|
|
|
|
[pixel](/reference/images/pixel), [show image](/reference/images/show-image), [image](/reference/images/image), [create image](/reference/images/create-image), [scroll image](/reference/images/scroll-image)
|
|
|