README
Tr
FontEngine
Tr
TextBatchBuilder
T
FontLoadHooks
T
SimpleFontEngine
- ::newSimpleFontEngine::new
T
SimpleTextBatchBuilder
- ::newSimpleTextBatchBuilder::new
T
TextRenderer
- ::clearTextRenderer::clear
- ::flush_dirty_pagesTextRenderer::flush_dirty_pages
- ::get_atlasTextRenderer::get_atlas
- ::get_pageTextRenderer::get_page
- ::get_page_idTextRenderer::get_page_id
- ::get_page_idsTextRenderer::get_page_ids
- ::glyph_countTextRenderer::glyph_count
- ::load_atlas_cacheTextRenderer::load_atlas_cache
- ::measureTextRenderer::measure
- ::newTextRenderer::new
- ::new_with_optionsTextRenderer::new_with_options
- ::page_countTextRenderer::page_count
- ::render_textTextRenderer::render_text
V
font_data_to_bytes
V
load_font
V
load_font_engine_from_bytes
V
load_text_renderer
V
new_font_load_hooks
V
parse_font_bytes
V
reset_font_load_hooks
V
set_font_load_hooks

text

Text rendering helpers (glyph cache, batch builder, font engine) on top of mizchi/gfx and mizchi/font, extracted from kagura

moon add mizchi/text@0.2.0

Download zip

Author

mizchi

Version

0.2.0

License

Apache-2.0

Repository

github.com/mizchi/text-mbt

Last updated

2 months ago

Downloads

Dependencies

mizchi/gfx0.1.0
mizchi/font0.7.0

README

#
FontEngine

source

pub trait FontEngine {
  fn measure(Self, run : @mizchi/font.TextRun
TextRun) -> @mizchi/font.TextMetrics
TextMetrics
  fn shape(Self, run : @mizchi/font.TextRun
TextRun) -> Array[@mizchi/font.GlyphQuad
GlyphQuad] raise
}

#
TextBatchBuilder

source

pub trait TextBatchBuilder {
  fn build_draw_commands(Self, target : @mizchi/gfx.ImageHandle
ImageHandle, glyphs : Array[@mizchi/font.GlyphQuad
GlyphQuad], shader : @mizchi/gfx.ShaderHandle
ShaderHandle) -> Array[@mizchi/gfx.DrawTrianglesCommand
DrawTrianglesCommand] raise
}

#
FontLoadHooks

source

pub struct FontLoadHooks {
  load_font_data : (String) -> Array[Int]?
}

#
SimpleFontEngine

source

pub struct SimpleFontEngine {
  font : @mizchi/font.TTFont
TTFont
}

impl FontEngine for SimpleFontEngine

fn measure(self : SimpleFontEngine, run : @mizchi/font.TextRun
TextRun) -> @mizchi/font.TextMetrics
TextMetrics

source

fn shape(self : SimpleFontEngine, run : @mizchi/font.TextRun
TextRun) -> Array[@mizchi/font.GlyphQuad
GlyphQuad] raise

source

#
SimpleFontEngine::new

source

fn SimpleFontEngine::new(font : @mizchi/font.TTFont
TTFont) -> SimpleFontEngine

#
SimpleTextBatchBuilder

source

pub struct SimpleTextBatchBuilder {
  cache : @mizchi/font.GlyphCache
GlyphCache
  pipeline_id : Int
}

impl TextBatchBuilder for SimpleTextBatchBuilder

fn build_draw_commands(self : SimpleTextBatchBuilder, target : @mizchi/gfx.ImageHandle
ImageHandle, glyphs : Array[@mizchi/font.GlyphQuad
GlyphQuad], shader : @mizchi/gfx.ShaderHandle
ShaderHandle) -> Array[@mizchi/gfx.DrawTrianglesCommand
DrawTrianglesCommand] raise

source

#
SimpleTextBatchBuilder::new

source

fn SimpleTextBatchBuilder::new(cache : @mizchi/font.GlyphCache
GlyphCache, pipeline_id : Int) -> SimpleTextBatchBuilder

#
TextRenderer

source

pub struct TextRenderer {
  inner : @mizchi/font.TextRenderer
TextRenderer
}

GPU-aware text renderer wrapping @font.TextRenderer. Adds render_text() which produces @gfx.DrawTrianglesCommand.

#
TextRenderer::clear

source

fn TextRenderer::clear(self : TextRenderer) -> Unit

#
TextRenderer::flush_dirty_pages

source

fn TextRenderer::flush_dirty_pages(self : TextRenderer) -> Array[@mizchi/font.AtlasPageInfo
AtlasPageInfo]

#
TextRenderer::get_atlas

source

fn TextRenderer::get_atlas(self : TextRenderer) -> @mizchi/font.GlyphAtlas
GlyphAtlas

#
TextRenderer::get_page

source

fn TextRenderer::get_page(self : TextRenderer, index : Int) -> @mizchi/font.GlyphAtlas
GlyphAtlas

#
TextRenderer::get_page_id

source

fn TextRenderer::get_page_id(self : TextRenderer) -> Int

#
TextRenderer::get_page_ids

source

fn TextRenderer::get_page_ids(self : TextRenderer) -> Array[Int]

#
TextRenderer::glyph_count

source

fn TextRenderer::glyph_count(self : TextRenderer) -> Int

#
TextRenderer::load_atlas_cache

source

fn TextRenderer::load_atlas_cache(self : TextRenderer, data : Array[Int]) -> Bool

Replace the first page of a TextRenderer with deserialized data. Accepts a single page's serialized data (Array[Int]).

#
TextRenderer::measure

source

fn TextRenderer::measure(self : TextRenderer, text : String, size_px : Double) -> @mizchi/font.TextMetrics
TextMetrics

Measure text dimensions without rasterizing.

#
TextRenderer::new

source

fn TextRenderer::new(font : @mizchi/font.TTFont
TTFont, atlas_size : Int, base_page_id : Int, pipeline_id : Int) -> TextRenderer

#
TextRenderer::new_with_options

source

fn TextRenderer::new_with_options(font : @mizchi/font.TTFont
TTFont, atlas_size : Int, base_page_id : Int, pipeline_id : Int, max_pages : Int) -> TextRenderer

#
TextRenderer::page_count

source

fn TextRenderer::page_count(self : TextRenderer) -> Int

#
TextRenderer::render_text

source

fn TextRenderer::render_text(self : TextRenderer, text : String, size_px : Double, x : Double, y : Double, dst : @mizchi/gfx.ImageHandle
ImageHandle, shader : @mizchi/gfx.ShaderHandle
ShaderHandle, blend : @mizchi/gfx.BlendMode
BlendMode, uniform_dwords : Array[Int]) -> Array[@mizchi/gfx.DrawTrianglesCommand
DrawTrianglesCommand]

Render text at the given position, returning draw commands ready for the graphics pipeline. Also rasterizes any new glyphs into the atlas.

#
font_data_to_bytes

source

fn font_data_to_bytes(data : Array[Int]) -> Bytes

#
load_font

source

fn load_font(name : String) -> @mizchi/font.TTFont
TTFont?

#
load_font_engine_from_bytes

source

fn load_font_engine_from_bytes(data : Bytes) -> SimpleFontEngine?

Load font engine from raw bytes.

#
load_text_renderer

source

fn load_text_renderer(name : String, atlas_size : Int, page_id : Int, pipeline_id : Int) -> TextRenderer?

#
new_font_load_hooks

source

fn new_font_load_hooks(load_font_data : (String) -> Array[Int]?) -> FontLoadHooks

#
parse_font_bytes

source

fn parse_font_bytes(data : Bytes) -> @mizchi/font.TTFont
TTFont?

Parse font from raw bytes (auto-detects TTF/OTF/WOFF1/WOFF2).

#
reset_font_load_hooks

source

fn reset_font_load_hooks() -> Unit

#
set_font_load_hooks

source

fn set_font_load_hooks(hooks : FontLoadHooks) -> Unit

Source Files

Site source Report issue Packages Build queue Skills Statistics

text

#FontEngine

#TextBatchBuilder

#FontLoadHooks

#SimpleFontEngine

#SimpleFontEngine::new

#SimpleTextBatchBuilder

#SimpleTextBatchBuilder::new

#TextRenderer

#TextRenderer::clear

#TextRenderer::flush_dirty_pages

#TextRenderer::get_atlas

#TextRenderer::get_page

#TextRenderer::get_page_id

#TextRenderer::get_page_ids

#TextRenderer::glyph_count

#TextRenderer::load_atlas_cache

#TextRenderer::measure

#TextRenderer::new

#TextRenderer::new_with_options

#TextRenderer::page_count

#TextRenderer::render_text

#font_data_to_bytes

#load_font

#load_font_engine_from_bytes

#load_text_renderer

#new_font_load_hooks

#parse_font_bytes

#reset_font_load_hooks

#set_font_load_hooks

Source Files

#
FontEngine

#
TextBatchBuilder

#
FontLoadHooks

#
SimpleFontEngine

#
SimpleFontEngine::new

#
SimpleTextBatchBuilder

#
SimpleTextBatchBuilder::new

#
TextRenderer

#
TextRenderer::clear

#
TextRenderer::flush_dirty_pages

#
TextRenderer::get_atlas

#
TextRenderer::get_page

#
TextRenderer::get_page_id

#
TextRenderer::get_page_ids

#
TextRenderer::glyph_count

#
TextRenderer::load_atlas_cache

#
TextRenderer::measure

#
TextRenderer::new

#
TextRenderer::new_with_options

#
TextRenderer::page_count

#
TextRenderer::render_text

#
font_data_to_bytes

#
load_font

#
load_font_engine_from_bytes

#
load_text_renderer

#
new_font_load_hooks

#
parse_font_bytes

#
reset_font_load_hooks

#
set_font_load_hooks