pxt-calliope/docs/reference/images/set-pixel.md

Set Pixel

The set pixel function. #set pixel.

Set the on/off state of pixel in an Image.

JavaScript

export function setPixel(_this: micro_bit.Image, x: number, y: number, value: boolean)

Parameters

• x - Number; the x coordinate or horizontal position of a pixel in an image
• x - Number; the y coordinate or vertical position of a pixel in an image
• value -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.

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, show image, image, create image, scroll image