diff options
Diffstat (limited to 'font_lib/API.md')
-rw-r--r-- | font_lib/API.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/font_lib/API.md b/font_lib/API.md new file mode 100644 index 0000000..7ec499b --- /dev/null +++ b/font_lib/API.md @@ -0,0 +1,47 @@ +# Font Lib API +This document describes Font Lib API. Font Lib creates textures for font display on entities. + +## Provided methods +### get\_line\_width +**font\_lib.get\_line\_width(text)** + +Computes line width for a given font height and text +**text**: Text to be rendered + +**Returns**: rendered text width + +### make\_line\_texture +**font\_lib.make\_line\_texture(text, texturew, x, y)** + +Builds texture part for a text line + +**text**: Text to be rendered + +**texturew**: Width of the texture (extra text is not rendered) + +**x**: Starting x position in texture + +**y**: Vertical position of the line in texture + +**Returns**: Texture string + +### make\_multiline\_texture +**font\_lib.make\_multiline\_texture(text, texturew, textureh, maxlines, valign, color)** + +Builds texture for a multiline colored text + +**text**: Text to be rendered + +**texturew**: Width of the texture (extra text will be truncated) + +**textureh**: Height of the texture + +**maxlines**: Maximum number of lines + +**valign**: Vertical text align ("top" or "center") + +**color**: Color of the text + +**Returns**: Texture string + + |