pxt-calliope/docs/reference/images/show-image.md
Juri Wolf 5f7a8e5301
Updates for V4 (#197)
* update yotta defaults for 16kb devices

* refactor deprecated blocks

* updates for button events

* update button events

* update refference

* update docs

* update docs

* update button event blocks

* update docs

* update block id
2022-08-10 09:36:19 -07:00

1.7 KiB

Show Image

Show an image (picture) on the LED screen. After the @boardname@ shows an image, it will pause for 400 milliseconds (1000 milliseconds is one second).

let item: Image = null;
item.showImage(0);

Parameters

  • an image (picture). It is usually a square with five LEDs on a side, but it might be wider.
  • a number that says how many LEDs from the left of the picture the @boardname@ should start. 0 means start at the first frame of the picture, 5 means start at the second frame, 10 means start at the third, and so on.

Example: Flip-flopping arrow

This program makes a big image with a frame of an arrow pointing up, and a frame of an arrow pointing down. If you press button A, the program will use show image to show the arrow pointing up. (It starts 0 LEDs from the left in the big image.) If you press button B, the program will use show image to show the arrow pointing down, which starts 5 LEDs from the left.

let arrows = images.createBigImage(`
    . . # . .   . . # . .
    . # # # .   . . # . .
    # . # . #   # . # . #
    . . # . .   . # # # .
    . . # . .   . . # . .
    `);
input.onButtonEvent(Button.A, input.buttonEventClick(), () => {
    arrows.showImage(0);
});
input.onButtonEvent(Button.B, input.buttonEventClick(), () => {
    arrows.showImage(5);
});

See also

image, create image, create big image, scroll image, show animation