Document that Clear resets the Dot to Orig
Remove note on how to reset Dot to the Orig
This commit is contained in:
parent
ad738cddf8
commit
8d8d5cc9db
|
@ -61,10 +61,7 @@ func RangeTable(table *unicode.RangeTable) []rune {
|
||||||
// Text exports two important fields: Orig and Dot. Dot is the position where the next character
|
// Text exports two important fields: Orig and Dot. Dot is the position where the next character
|
||||||
// will be written. Dot is automatically moved when writing to a Text object, but you can also
|
// will be written. Dot is automatically moved when writing to a Text object, but you can also
|
||||||
// manipulate it manually. Orig specifies the text origin, usually the top-left dot position. Dot is
|
// manipulate it manually. Orig specifies the text origin, usually the top-left dot position. Dot is
|
||||||
// always aligned to Orig when writing newlines.
|
// always aligned to Orig when writing newlines. The Clear method resets the Dot to Orig.
|
||||||
//
|
|
||||||
// To reset the Dot to the Orig, just assign it:
|
|
||||||
// txt.Dot = txt.Orig
|
|
||||||
type Text struct {
|
type Text struct {
|
||||||
// Orig specifies the text origin, usually the top-left dot position. Dot is always aligned
|
// Orig specifies the text origin, usually the top-left dot position. Dot is always aligned
|
||||||
// to Orig when writing newlines.
|
// to Orig when writing newlines.
|
||||||
|
@ -184,7 +181,7 @@ func (txt *Text) BoundsOf(s string) pixel.Rect {
|
||||||
return bounds
|
return bounds
|
||||||
}
|
}
|
||||||
|
|
||||||
// Clear removes all written text from the Text.
|
// Clear removes all written text from the Text. The Dot field is reset to Orig.
|
||||||
func (txt *Text) Clear() {
|
func (txt *Text) Clear() {
|
||||||
txt.prevR = -1
|
txt.prevR = -1
|
||||||
txt.bounds = pixel.Rect{}
|
txt.bounds = pixel.Rect{}
|
||||||
|
|
Loading…
Reference in New Issue