Skip to content

Commit 7bcd5fd

Browse files
committed
docs/library/framebuf: Document new text sizing.
Document new optional size parameter for the text method.
1 parent 7147935 commit 7bcd5fd

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
@@ -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)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy