korge-core/korlibs.image.text

Package-level declarations

Types

class BoundBuilderTextRendererActions : TextRendererActions

class CurveTextRenderer<T>(original: TextRenderer<T>, val path: VectorPath, val curve: Curve) : TransformedTextRenderer<T>

HorizontalAlign

inline class HorizontalAlign(val ratio: Double) : EnumLike<HorizontalAlign>

ITextRendererActions

interface ITextRendererActions

RichTextData

data class RichTextData(val lines: List<RichTextData.Line>, val defaultStyle: RichTextData.Style = lines.firstOrNull()?.defaultStyle ?: Style.DEFAULT) : List<RichTextData.Line> , Extra

RichTextDataPlacements

data class RichTextDataPlacements(val placements: FastArrayList<RichTextDataPlacements.Placement> = fastArrayListOf()) : List<RichTextDataPlacements.Placement>

Text2TextRendererActions

class Text2TextRendererActions : TextRendererActions

TextAlignment

data class TextAlignment(val horizontal: HorizontalAlign, val vertical: VerticalAlign) : EnumLike<TextAlignment>

TextRenderer

interface TextRenderer<T>

TextRendererActions

abstract class TextRendererActions : ITextRendererActions

TransformedTextRenderer

open class TransformedTextRenderer<T>(val original: TextRenderer<T>, val transformation: (ITextRendererActions) -> ITextRendererActions) : TextRenderer<T>

VerticalAlign

inline class VerticalAlign(val ratio: Double) : EnumLike<VerticalAlign>

Properties

DefaultStringTextRenderer

val DefaultStringTextRenderer: TextRenderer<String>

DefaultWStringTextRenderer

val DefaultWStringTextRenderer: TextRenderer<WString>

Functions

aroundPath

fun ITextRendererActions.aroundPath(curve: Curve): ITextRendererActions

fun <T> TextRenderer<T>.aroundPath(curve: Curve): CurveTextRenderer<T>

fun <T> TextRenderer<T>.aroundPath(path: VectorPath): CurveTextRenderer<T>

inline fun <T> TextRenderer<T>.aroundPath(out: VectorPath = VectorPath(), block: VectorPath.() -> Unit): CurveTextRenderer<T>

bounds

fun RichTextDataPlacements.bounds(): Rectangle

fun RichTextData.bounds(maxHeight: Int = Int.MAX_VALUE): Rectangle

CreateStringTextRenderer

fun CreateStringTextRenderer(getVersion: () -> Int = { 0 }, handler: ITextRendererActions.(reader: WStringReader, c: Int, g: GlyphMetrics, advance: Double) -> Unit): TextRenderer<String>

CreateWStringTextRenderer

fun CreateWStringTextRenderer(getVersion: () -> Int = { 0 }, handler: ITextRendererActions.(reader: WStringReader, c: Int, g: GlyphMetrics, advance: Double) -> Unit): TextRenderer<WString>

DefaultTextRenderer

inline fun <T> DefaultTextRenderer(): TextRenderer<out Any>

drawRichText

fun Context2d.drawRichText(text: RichTextData, bounds: Rectangle = Rectangle(0, 0, width, height), wordWrap: Boolean = true, includePartialLines: Boolean = false, ellipsis: String? = null, fill: Paint? = null, stroke: Stroke? = null, align: TextAlignment = TextAlignment.TOP_LEFT, includeFirstLineAlways: Boolean = true, textRangeStart: Int = 0, textRangeEnd: Int = Int.MAX_VALUE): Int

fromHTML

fun RichTextData.Companion.fromHTML(html: String, style: RichTextData.Style = RichTextData.Style.DEFAULT): RichTextData

invoke

operator fun <T> TextRenderer<T>.invoke(actions: ITextRendererActions, text: T, size: Double, defaultFont: Font)

measure

fun <T> TextRenderer<T>.measure(text: T, size: Double, defaultFont: Font): BoundBuilderTextRendererActions

place

fun RichTextData.place(bounds: Rectangle, wordWrap: Boolean = true, includePartialLines: Boolean = false, ellipsis: String? = null, fill: Paint? = null, stroke: Stroke? = null, align: TextAlignment = TextAlignment.TOP_LEFT, includeFirstLineAlways: Boolean = true, out: RichTextDataPlacements = RichTextDataPlacements()): RichTextDataPlacements

text

fun <T> VectorBuilder.text(text: T, font: VectorFont, textSize: Double = 16.0, pos: Point = Point.ZERO, align: TextAlignment = TextAlignment.BASELINE_LEFT, renderer: TextRenderer<T> = DefaultStringTextRenderer as TextRenderer<T>)

toHTML

fun RichTextData.toHTML(): String

transformed

fun <T> TextRenderer<T>.transformed(transformation: (ITextRendererActions) -> ITextRendererActions): TransformedTextRenderer<T>

withSpacing

fun <T> TextRenderer<T>.withSpacing(spacing: Float): TransformedTextRenderer<T>