flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-11-03 04:18:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve documentation around SpriteFontTextFormatter (#2661)

Browse Source 
Add a class-level doc comment to `SpriteFontTextFormatter`, analogous to
`TextPainterTextFormatter`.
Also, super-specify the return type of the `format` method to facilitate
understanding (again, this makes it more aligned with its twin
`TextPainterTextFormatter`).
This commit is contained in:
Luan Nico
2023-08-20 06:26:21 -07:00
committed by GitHub
parent 37271f5c52
commit 8401c569bf
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/flame/lib/src/text/formatters/sprite_font_text_formatter.dart
View File

@ -4,9 +4,10 @@ import 'dart:ui' hide LineMetrics;
import 'package:flame/src/text/common/line_metrics.dart'; import 'package:flame/src/text/common/line_metrics.dart';
import 'package:flame/src/text/common/sprite_font.dart'; import 'package:flame/src/text/common/sprite_font.dart';
import 'package:flame/src/text/elements/sprite_font_text_element.dart'; import 'package:flame/src/text/elements/sprite_font_text_element.dart';
import 'package:flame/src/text/elements/text_element.dart';
import 'package:flame/src/text/formatters/text_formatter.dart'; import 'package:flame/src/text/formatters/text_formatter.dart';
/// [SpriteFontTextFormatter] will render text using a [SpriteFont] font,
/// creating a [SpriteFontTextElement].
class SpriteFontTextFormatter extends TextFormatter { class SpriteFontTextFormatter extends TextFormatter {
SpriteFontTextFormatter.fromFont( SpriteFontTextFormatter.fromFont(
this.font, { this.font, {
@ -25,7 +26,7 @@ class SpriteFontTextFormatter extends TextFormatter {
final Paint paint; final Paint paint;
@override @override
TextElement format(String text) { SpriteFontTextElement format(String text) {
var rects = Float32List(text.length * 4); var rects = Float32List(text.length * 4);
var transforms = Float32List(text.length * 4); var transforms = Float32List(text.length * 4);
var j = 0; var j = 0;