mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-12-26 11:48:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

text: Improve documentations

Browse Source 
Updates #1271
This commit is contained in:
Hajime Hoshi 2020-07-30 00:02:32 +09:00
parent ac16564e95
commit 35d1c8ae7a
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
text/text.go
View File

@ -200,9 +200,18 @@ var textM sync.Mutex
// //
// face is the font for text rendering. // face is the font for text rendering.
// (x, y) represents a 'dot' (period) position. // (x, y) represents a 'dot' (period) position.
// This means that if the given text consisted of a single character ".",
// it would be positioned at the given position (x, y).
// Be careful that this doesn't represent left-upper corner position. // Be careful that this doesn't represent left-upper corner position.
//
// clr is the color for text rendering. // clr is the color for text rendering.
// //
// If you want to adjust the position of the text, these functions are useful:
//
// * golang.org/x/image/font.Face.Metrics: the metrics of the face.
// * text.MeasureString: the size of the given text.
// * golang.org/x/image/font.BoundString: the bound rectangle of the given text.
//
// The '\n' newline character puts the following text on the next line. // The '\n' newline character puts the following text on the next line.
// Line height is based on Metrics().Height of the font. // Line height is based on Metrics().Height of the font.
// //
@ -246,7 +255,8 @@ func Draw(dst *ebiten.Image, text string, face font.Face, x, y int, clr color.Co
// MeasureString returns the measured size of a given string using a given font. // MeasureString returns the measured size of a given string using a given font.
// This method will return the exact size in pixels that a string drawn by Draw will be. // This method will return the exact size in pixels that a string drawn by Draw will be.
// text can include multiple lines. //
// This is very similar to golang.org/x/image/font's MeasureString, but this MeasureString considers multiple lines.
// //
// text is the string that's being measured. // text is the string that's being measured.
// face is the font for text rendering. // face is the font for text rendering.