c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate docs from the other repo

Browse Source
This commit is contained in:
Michal Moskal
2016-03-25 16:47:20 -07:00
parent 38d2cf06d2
commit a08eb53f92
895 changed files with 36888 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/reference/images/set-pixel.md Normal file
View File

@ -0,0 +1,42 @@
# Set Pixel
The set pixel function. #set pixel #image #docs
Set the on/off state of pixel in an [Image](/microbit/reference/image/image).
### KindScript
```
export function setPixel(_this: micro_bit.Image, x: number, y: number, value: boolean)
```
### Parameters
* x - [Number](/microbit/reference/types/number); the *x coordinate* or horizontal position of a pixel in an [image](/microbit/reference/image/image)
* x - [Number](/microbit/reference/types/number); the *y coordinate* or vertical position of a pixel in an [image](/microbit/reference/image/image)
* value -[Boolean](/microbit/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](/microbit/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](/microbit/reference/images/pixel), [show image](/microbit/reference/images/show-image), [image](/microbit/reference/image/image), [create image](/microbit/reference/images/create-image), [scroll image](/microbit/reference/images/scroll-image)