Browse Source

document hxd.res.Font (see #461)

ncannasse 6 years ago
parent
commit
3fa4ffdc51
1 changed files with 5 additions and 0 deletions
  1. 5 0
      hxd/res/Font.hx

+ 5 - 0
hxd/res/Font.hx

@@ -1,5 +1,10 @@
 package hxd.res;
 
+/**
+	Allows to build a font bitmap to be used by h2d.Text. Only some platforms support such runtime Font building
+	and the result in terms of font quality, antialiasing, etc might vary depending on the platform.
+	It is recommended to use offline BitmapFont instead, read https://heaps.io/documentation/text.html
+**/
 class Font extends Resource {
 
 	public function build( size : Int, ?options ) : h2d.Font {