ed/VEFontCache-Odin
1
0
Fork 0
mirror of https://github.com/Ed94/VEFontCache-Odin.git synced 2025-08-05 14:42:42 -07:00
Code Issues Packages Projects Releases Wiki Activity

Proofing docs more

Browse Source
This commit is contained in:
Edward R. Gonzalez
2025-01-27 17:33:57 -05:00
parent f145281b6a
commit d6da8ee84e
4 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Readme.md
View File

@@ -62,7 +62,7 @@ There a total of six procedures, 3 for shapes, 3 for text:
* `draw_text_view_space`
* `draw_text`
The normalized space procedures are the `baseline` interface draw procedures. They expec the position, and scale provided to operate with an unsigned normalized space where the bottom left is 0.0, 0.0 and the top right is 1.0, 1.0.
The normalized space procedures are the `baseline` interface draw procedures. They expect the position, and scale provided to operate with an unsigned normalized space where the bottom left is 0.0, 0.0 and the top right is 1.0, 1.0.
The view space will normalize the position and scale for the user based on the provided view and zoom. The coordinate system is still unsigned just scaled to the view's size.
@@ -105,9 +105,13 @@ Provides a Vec2 the width and height occupied by the provided text string. The y
A wrapper for `parser_get_font_vertical_metrics`. Will provide the ascent, descent, and line_gap for a font entry.
Stuff used by the draw list generation interface or just getters and setters.
## Miscellaneous
Stuff used by the draw list generation interface or just getters and setters.
### get_font_entry
Provides the backend Entry for for the given `Font_ID` (passed immutably). If the user desires a mutable reference, just resolve it manually.
### get_cursor_pos
@@ -136,6 +140,11 @@ Does nothing when zoom is 1.0
Uses `resolve_draw_px_size` to constrain which font size is used for the zoom.
### snap_normalized_position_to_view
Will snap the given position to the nearest pixel via ceil of the given view.
Does nothing if view is 1 or 0
### set_alpha_scalar
This is an artifact feature of the current shader, it *may* be removed in the future... Increasing the alpha of the colour draw with above 1.0 increases the edge contrast of the glyph shape.