Skip to content

Commit 77a455f

Browse files
committed
docs/library/framebuf: Document new text sizing.
Document new optional size parameter for the text method.
1 parent 2556e79 commit 77a455f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/library/framebuf.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,15 @@ The following methods draw shapes onto the FrameBuffer.
8787
Drawing text
8888
------------
8989

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

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

97100

98101
Other methods

0 commit comments

Comments
 (0)