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

Update scroll-image.md (#701)

Browse Source 
Just change the documentation here, cause the underlying API doesn't work correctly yet 2cff906f01/source/drivers/MicroBitDisplay.cpp (L931)
So negative values are not working for now.
This commit is contained in:
Jan Karger 2018-03-08 21:57:28 +01:00 committed by Peli de Halleux
parent c9963f7a56
commit 4a8d9ee9cd
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference/images/scroll-image.md
View File

@ -11,14 +11,11 @@ item.scrollImage(5, 200);
## Parameters ## Parameters
* a [number](/types/number) that means * a [number](/types/number) that means
how many LEDs to scroll at a time, from right to left or how many LEDs to scroll at a time from right to left.
left to right. If you use a positive number like `2`, the image You must use a positive number like `2`.
will scroll from the right side of the screen to the left. If you use `5`, the image will scroll one **frame** at a time.
If you use a negative number like `-2`, the image will scroll (A frame is a part of the image. It is a square with five LEDs
in the other direction. If you use `5` or `-5`, the image on a side). This is useful for **animation**.
will scroll one **frame** at a time. (A frame is a part of the
image. It is a square with five LEDs on a side). This is
useful for **animation**.
* a [number](/types/number) that means * a [number](/types/number) that means
how many milliseconds to wait before scrolling the amount that how many milliseconds to wait before scrolling the amount that