docs: update README with quick documentation
This commit is contained in:
@@ -2,7 +2,35 @@
|
||||
|
||||
# GLSL Glyphs Generator
|
||||
|
||||
> Generate GLSL ready 8x8 glyph maps and usable functions
|
||||
> Generate GLSL ready 8x8 glyph maps and usable functions.
|
||||
|
||||
Reads each 8x8 glyph into 4x4 squares then converts them into (0-65535) integers.
|
||||
|
||||
```txt
|
||||
██████ 0x151E, 0x8A87, 0xE19D, 0x789B,
|
||||
█ █
|
||||
█ █ █ █ ███ ███ █ ██ ██ █
|
||||
█ █ -> █ █ █ █ █ █
|
||||
█ ████ █ █ █ █ █ █ █
|
||||
█ ██ █ █ █ ███ ███
|
||||
█ █
|
||||
██████
|
||||
```
|
||||
|
||||
Writes it into GLSL ready files to use it easily in shaders
|
||||
|
||||
```glsl
|
||||
const int cp437_glyphs[] = int[1024](
|
||||
0x0000, 0x0000, 0x0000, 0x0000, // 0x00, EMPTY
|
||||
0x151E, 0x8A87, 0xE19D, 0x789B, // 0x01, SMILEY
|
||||
// ...
|
||||
);
|
||||
|
||||
bool cp437(vec2 pos, int code)
|
||||
{
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -88,4 +116,5 @@ release-% release major/minor/patch
|
||||
* [x] Generate a separate sentences file
|
||||
* [ ] Custom height glyph map
|
||||
* [ ] Custom width glyph map
|
||||
* [ ] More compact data using GLSL ints
|
||||
* [ ] separated sets/patterns
|
||||
|
||||
Reference in New Issue
Block a user