korge-core/korlibs.image.font/Font

Font

interface Font : Resourceable<Font> , Extra

Inheritors

Properties

abstract var extra: ExtraType

val Font.lazyBitmap: BitmapFont

Gets a BitmapFont from the font, that is going to be computed lazily as glyphs are required.

abstract val name: String

Functions

fun <T> Font.drawText(ctx: Context2d?, size: Double, text: T, paint: Paint?, pos: Point = Point.ZERO, fill: Boolean = true, renderer: TextRenderer<T> = DefaultStringTextRenderer as TextRenderer<T>, align: TextAlignment = TextAlignment.BASELINE_LEFT, outMetrics: TextMetricsResult? = null, fillStyle: Paint? = null, stroke: Stroke? = null, textRangeStart: Int = 0, textRangeEnd: Int = Int.MAX_VALUE, placed: TextRendererActions.(codePoint: Int, Point, size: Double, metrics: GlyphMetrics, fmetrics: FontMetrics, transform: Matrix) -> Unit? = null): TextMetricsResult?

open suspend override fun get(): Font

abstract fun getFontMetrics(size: Double, metrics: FontMetrics = FontMetrics()): FontMetrics

getGlyphMetrics

abstract fun getGlyphMetrics(size: Double, codePoint: Int, metrics: GlyphMetrics = GlyphMetrics(), reader: WStringReader? = null): GlyphMetrics

abstract fun getKerning(size: Double, leftCodePoint: Int, rightCodePoint: Int): Double

open override fun getOrNull(): Font

fun <T> Font.getTextBounds(size: Double, text: T, out: TextMetrics = TextMetrics(), renderer: TextRenderer<T> = DefaultStringTextRenderer as TextRenderer<T>, align: TextAlignment = TextAlignment.TOP_LEFT): TextMetrics

getTextBoundsWithGlyphs

fun <T> Font.getTextBoundsWithGlyphs(size: Double, text: T, renderer: TextRenderer<T> = DefaultStringTextRenderer as TextRenderer<T>, align: TextAlignment = TextAlignment.BASELINE_LEFT): TextMetricsResult

registerTemporarily

inline suspend fun <T> Font.registerTemporarily(name: String = this.name, block: () -> T): T

inline fun <T> Font.registerTemporarily(registry: DefaultFontRegistry, name: String = this.name, block: () -> T): T

abstract fun renderGlyph(ctx: Context2d, size: Double, codePoint: Int, pos: Point, fill: Boolean?, metrics: GlyphMetrics, reader: WStringReader? = null, beforeDraw: () -> Unit? = null): Boolean

renderGlyphToBitmap

fun Font.renderGlyphToBitmap(size: Double, codePoint: Int, paint: Paint = DefaultPaint, fill: Boolean = true, effect: BitmapEffect? = null, border: Int = 1, nativeRendering: Boolean = true, reader: WStringReader? = null): TextToBitmapResult

renderTextToBitmap

fun <T> Font.renderTextToBitmap(size: Double, text: T, paint: Paint = DefaultPaint, background: Paint = NonePaint, fill: Boolean = true, border: Int = 0, renderer: TextRenderer<T> = DefaultStringTextRenderer as TextRenderer<T>, returnGlyphs: Boolean = true, nativeRendering: Boolean = true, drawBorder: Boolean = false): TextToBitmapResult

inline fun Font.toBitmapFont(fontSize: Number, chars: CharacterSet = CharacterSet.LATIN_ALL, fontName: String = this.name, paint: Paint = Colors.WHITE, mipmaps: Boolean = true, effect: BitmapEffect? = null): BitmapFont