8000 docs/library/framebuf: Document new text sizing. · micropython/micropython@9b56b04 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 9b56b04

Browse files
committed
docs/library/framebuf: Document new text sizing.
Document new optional size parameter for the text method.
1 parent 4105133 commit 9b56b04

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/library/framebuf.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,15 @@ The following methods draw shapes onto the FrameBuffer.
112112
Drawing text
113113
------------
114114

115-
.. method:: FrameBuffer.text(s, x, y[, c])
115+
.. method:: FrameBuffer.text(s, x, y[, c[, size]])
116116

117117
Write text to the FrameBuffer using the the coordinates as the upper-left
118118
corner of the text. The color of the text can be defined by the optional
119-
argument but is otherwise a default value of 1. All characters have
119+
``c`` argument but is otherwise a default value of 1. Characters have base
120120
dimensions of 8x8 pixels and there is currently no way to change the font.
121+
The optional ``size`` argument (which defaults to ``8``) allows a font size
122+
to be specified. The standard 8x8 font will be crudely scaled, so integer
123+
multiples of 8 (e.g., ``16``) will work best.
121124

122125

123126
Other methods

0 commit comments

Comments
 (0)
0