migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-09-02 23:00:04 -04:00
Code Activity

Clean up docstrings: GlyphAllocation.id, shaper y_offset, segment_into_runs

Browse Source 
- Update GlyphAllocation.id docstring to reflect its actual usage
  (overflow character kerning via legacy kern table)
- Replace planning artifact comment on shaper y_offset caching
- Document script-mixing limitation in segment_into_runs
This commit is contained in:
gcailly
2026-03-26 15:03:03 +01:00
parent 96b370e0aa
commit c5cb18f769
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
crates/epaint/src/text/font.rs
View File

@@ -126,10 +126,10 @@ impl SubpixelBin {
#[derive(Clone, Copy, Debug, PartialEq, Default)] #[derive(Clone, Copy, Debug, PartialEq, Default)]
pub struct GlyphAllocation { pub struct GlyphAllocation {
/// Used for pair-kerning. /// The glyph ID in the font face that produced this allocation.
/// ///
/// Doesn't need to be unique. /// Used for legacy `kern` table lookup when positioning the overflow
/// Use [`skrifa::GlyphId::NOTDEF`] if you just want to have an id, and don't care. /// character (e.g. `…`) during text truncation.
pub(crate) id: skrifa::GlyphId, pub(crate) id: skrifa::GlyphId,
/// Unit: screen pixels. /// Unit: screen pixels.
@@ -669,7 +669,8 @@ impl FontFace {
// Cache the allocation WITHOUT the shaper y_offset (which varies per call) // Cache the allocation WITHOUT the shaper y_offset (which varies per call)
self.glyph_alloc_cache.insert(cache_key, allocation); self.glyph_alloc_cache.insert(cache_key, allocation);
// Apply shaper y_offset after caching (Option A from plan) // Apply shaper y_offset after caching — the offset varies per call site
// so we cache the base allocation without it.
allocation.uv_rect.offset.y += shaper_y_offset_points; allocation.uv_rect.offset.y += shaper_y_offset_points;
(allocation, h_pos_round) (allocation, h_pos_round)
@@ -801,6 +802,11 @@ impl Font<'_> {
/// falls back to a different font than its base character, it stays /// falls back to a different font than its base character, it stays
/// with the base character's font (the shaper will handle it). /// with the base character's font (the shaper will handle it).
/// ///
/// NOTE: Segmentation is by font face, not by Unicode script. A run may
/// mix scripts (e.g. Latin + Cyrillic) when they share the same font.
/// This is acceptable for scripts with similar shaping rules, but would
/// need script-aware splitting once RTL/bidi support is added.
///
/// Results are appended to `out` (which is cleared first) to allow /// Results are appended to `out` (which is cleared first) to allow
/// the caller to reuse the allocation across calls. /// the caller to reuse the allocation across calls.
pub(crate) fn segment_into_runs(&mut self, text: &str, out: &mut Vec<TextRun>) { pub(crate) fn segment_into_runs(&mut self, text: &str, out: &mut Vec<TextRun>) {