52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# Pixel
|
|
|
|
The pixel function.
|
|
|
|
Get the state of a pixel in an [Image](/reference/image/image).
|
|
|
|
### KindScript
|
|
|
|
```
|
|
export function pixel(_this: micro_bit.Image, x: number, y: number) : boolean
|
|
```
|
|
|
|
### Parameters
|
|
|
|
* x - [Number](/reference/types/number); the *x coordinate* or horizontal position of a pixel in an [image](/reference/image/image)
|
|
* y - [Number](/reference/types/number); the *y coordinate* or vertical position of a pixel in an [image](/reference/image/image)
|
|
|
|
### x, y coordinates?
|
|
|
|
To figure out the ``x``, ``y`` coordinates, see [LED screen](/device/screen).
|
|
|
|
### Returns
|
|
|
|
* [Boolean](/reference/types/boolean) - `true` for on and `false` for off
|
|
|
|
### Example
|
|
|
|
This example gets the state of pixel `0, 0` in the `img` variable:
|
|
|
|
### ~hide
|
|
|
|
```
|
|
let img = images.createImage(`
|
|
. . # . . . . . . .
|
|
. # . # . . . # . .
|
|
. . # . . . . . . .
|
|
. # . # . . . # . .
|
|
. . # . . . . . . .
|
|
`)
|
|
```
|
|
|
|
### ~
|
|
|
|
```
|
|
let state = img.pixel(0, 0)
|
|
```
|
|
|
|
### See also
|
|
|
|
[set pixel](/reference/images/set-pixel), [show image](/reference/images/show-image), [image](/reference/image/image), [create image](/reference/images/create-image), [scroll image](/reference/images/scroll-image)
|
|
|