Inserted example images to MicroPython doc
Inserted in-line images explaining MicroPython functions to the documentation
This commit is contained in:
parent
e38cd40348
commit
5a61a09ef3
|
@ -148,6 +148,8 @@ Draws a rectangle filled with the current pen colour to the buffer. The `x` and
|
|||
picodisplay.rectangle(x, y, w, h)
|
||||
```
|
||||
|
||||
![Rectangle function explanation image](/micropython/modules/pico_display/images/rectangle.png)
|
||||
|
||||
### circle
|
||||
|
||||
Draws a circle filled with the current pen colour to the buffer. The `x` and `y` parameters specify the centre of the circle, `r` specifies the radius in pixels.
|
||||
|
@ -156,6 +158,8 @@ Draws a circle filled with the current pen colour to the buffer. The `x` and `y
|
|||
picodisplay.rectangle(x, y, w, h)
|
||||
```
|
||||
|
||||
![Circle function explanation image](/micropython/modules/pico_display/images/circle.png)
|
||||
|
||||
### character
|
||||
|
||||
Draws a single character to the display buffer in the current pen colour. The `c` parameter should be the ASCII numerical representation of the character to be printed, `x` and `y` describe the top-left corner of the character's drawing field. The `character` function can also be given an optional 4th parameter, `scale`, describing the scale of the character to be drawn. Default value is 2.
|
||||
|
@ -175,6 +179,8 @@ picodisplay.text(string, x, y, wrap)
|
|||
picodisplay.text(string, x, y, wrap, scale)
|
||||
```
|
||||
|
||||
![Text scale explanation image](/micropython/modules/pico_display/images/text_scale.png)
|
||||
|
||||
### set_clip
|
||||
|
||||
This function defines a rectangular area outside which no drawing actions will take effect. If a drawing action crosses the boundary of the clip then only the pixels inside the clip will be drawn. Note that `clip` does not remove pixels which have already been drawn, it only prevents new pixels being drawn outside the described area. A more visual description of the function of clips can be found below. Only one clip can be active at a time, and defining a new clip replaces any previous clips. The `x` and `y` parameters describe the upper-left corner of the clip area, `w` and `h` describe the width and height in pixels.
|
||||
|
@ -183,6 +189,8 @@ This function defines a rectangular area outside which no drawing actions will t
|
|||
picodisplay.set_clip(x, y, w, h)
|
||||
```
|
||||
|
||||
![Clip function explanation image](/micropython/modules/pico_display/images/clip.png)
|
||||
|
||||
### remove_clip
|
||||
|
||||
This function removes any currently implemented clip.
|
||||
|
|
Loading…
Reference in New Issue