Updated bffnt.md to fix kerning documentation.#17
Updated bffnt.md to fix kerning documentation.#17KartMakerBrosU wants to merge 1 commit intokinnay:masterfrom
Conversation
The previous documentation of the BFFNT's Kerning section was incorrect. Updated it to explain it correctly.
|
Interesting, do you know why this is called FirstWord and SecondWord? |
|
Kerning pairs are based off of how to offset the SecondWord character based on which FirstWord character came before it. The labeling of FirstWord and SecondWord is a result of another tool which properly parsed the section labeling them that way for a similar format to BFFNT. If this is an issue I can change it to make it easier to understand. |
| | 0x0 | 4 | Identifier ("KRNG") | | ||
| | 0x4 | 4 | Section size | | ||
| | 0x8 | | Kerning Data | | ||
| | 0x8 | 2 | Number of Kerning FirstWord Entries | |
There was a problem hiding this comment.
Can we come up with a better name for FirstWord and SecondWord?
| | Offset | Size | Description | | ||
| | --- | --- | --- | | ||
| | 0x0 | 2 | Character code | | ||
| | 0x1 | 2 | Character offset | |
There was a problem hiding this comment.
Shouldn't the character offset be at offset 0x2, since the size of the character code is 2 bytes?
| | 0x8 | 2 | Horizontal Offset for Glyph 2 | | ||
| | 0x2 | 2 | Character code | | ||
| | 0x4 | 2 | Offset to its SecondWord entries | | ||
| | ... | ... | ... | |
| | 0x6 | 2 | Character Code 2 | | ||
| | 0x8 | 2 | Horizontal Offset for Glyph 2 | | ||
| | 0x2 | 2 | Character code | | ||
| | 0x4 | 2 | Offset to its SecondWord entries | |
There was a problem hiding this comment.
Since 'entries' is plural, how many SecondWord entries does each FirstWord entry refer to?
|
I think it would be good to clarify this. I've left a few comments, do you want to work on them? |
The previous documentation of the BFFNT's Kerning section was incorrect. I corrected it to document the FirstWord and SecondWord pairs correctly.