Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/buffer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -749,16 +749,27 @@ impl Buffer {
{
for run in self.layout_runs() {
for glyph in run.glyphs.iter() {
let (cache_key, x_int, y_int) = (glyph.cache_key, glyph.x_int, glyph.y_int);
let physical_glyph = glyph.physical((0., 0.), 1.0);

let glyph_color = match glyph.color_opt {
Some(some) => some,
None => color,
};

cache.with_pixels(font_system, cache_key, glyph_color, |x, y, color| {
f(x_int + x, run.line_y as i32 + y_int + y, 1, 1, color);
});
cache.with_pixels(
font_system,
physical_glyph.cache_key,
glyph_color,
|x, y, color| {
f(
physical_glyph.x + x,
run.line_y as i32 + physical_glyph.y + y,
1,
1,
color,
);
},
);
}
}
}
Expand Down
20 changes: 15 additions & 5 deletions src/edit/editor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -696,7 +696,6 @@ impl Edit for Editor {
) where
F: FnMut(i32, i32, u32, u32, Color),
{
let font_size = self.buffer.metrics().font_size;
let line_height = self.buffer.metrics().line_height;

for run in self.buffer.layout_runs() {
Expand Down Expand Up @@ -852,16 +851,27 @@ impl Edit for Editor {
}

for glyph in run.glyphs.iter() {
let (cache_key, x_int, y_int) = (glyph.cache_key, glyph.x_int, glyph.y_int);
let physical_glyph = glyph.physical((0., 0.), 1.0);

let glyph_color = match glyph.color_opt {
Some(some) => some,
None => color,
};

cache.with_pixels(font_system, cache_key, glyph_color, |x, y, color| {
f(x_int + x, line_y as i32 + y_int + y, 1, 1, color);
});
cache.with_pixels(
font_system,
physical_glyph.cache_key,
glyph_color,
|x, y, color| {
f(
physical_glyph.x + x,
line_y as i32 + physical_glyph.y + y,
1,
1,
color,
);
},
);
}
}
}
Expand Down
54 changes: 41 additions & 13 deletions src/layout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,72 @@ pub struct LayoutGlyph {
pub start: usize,
/// End index of cluster in original line
pub end: usize,
/// Font size of the glyph
pub font_size: f32,
/// Font id of the glyph
pub font_id: fontdb::ID,
/// Font id of the glyph
pub glyph_id: u16,
/// X offset of hitbox
pub x: f32,
/// width of hitbox
/// Y offset of hitbox
pub y: f32,
/// Width of hitbox
pub w: f32,
/// Unicode BiDi embedding level, character is left-to-right if `level` is divisible by 2
pub level: unicode_bidi::Level,
/// Cache key, see [CacheKey]
pub cache_key: CacheKey,
/// X offset in line
///
/// If you are dealing with physical coordinates, you will want to use [`Self::x_int`]
/// together with [`CacheKey::x_bin`] instead. This will ensure the best alignment of the
/// rasterized glyphs with the pixel grid.
/// If you are dealing with physical coordinates, use [`Self::physical`] to obtain a
/// [`PhysicalGlyph`] for rendering.
///
/// This offset is useful when you are dealing with logical units and you do not care or
/// cannot guarantee pixel grid alignment. For instance, when you want to use the glyphs
/// for vectorial text, apply linear transformations to the layout, etc.
pub x_offset: f32,
/// Y offset in line
///
/// If you are dealing with physical coordinates, you will want to use [`Self::y_int`]
/// together with [`CacheKey::y_bin`] instead. This will ensure the best alignment of the
/// rasterized glyphs with the pixel grid.
/// If you are dealing with physical coordinates, use [`Self::physical`] to obtain a
/// [`PhysicalGlyph`] for rendering.
///
/// This offset is useful when you are dealing with logical units and you do not care or
/// cannot guarantee pixel grid alignment. For instance, when you want to use the glyphs
/// for vectorial text, apply linear transformations to the layout, etc.
pub y_offset: f32,
/// Integer component of X offset in line
pub x_int: i32,
/// Integer component of Y offset in line
pub y_int: i32,
/// Optional color override
pub color_opt: Option<Color>,
/// Metadata from `Attrs`
pub metadata: usize,
}

pub struct PhysicalGlyph {
/// Cache key, see [CacheKey]
pub cache_key: CacheKey,
/// Integer component of X offset in line
pub x: i32,
/// Integer component of Y offset in line
pub y: i32,
}

impl LayoutGlyph {
pub fn physical(&self, offset: (f32, f32), scale: f32) -> PhysicalGlyph {

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really like the name. Ideally, it should be a verb; but I can't quite come up with anything. I'll keep thinking about it.

let x_offset = self.font_size * self.x_offset;
let y_offset = self.font_size * self.y_offset;

let (cache_key, x, y) = CacheKey::new(
self.font_id,
self.glyph_id,
self.font_size * scale,
(
(self.x + x_offset) * scale + offset.0,
((self.y - y_offset) * scale + offset.1).trunc(), // Hinting in Y axis

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe hinting could be an argument flag to this method and could be passed and stored in the CacheKey. This way we could tie it all together with the swash::swash_image function in a type safe way.

@hecrj hecrj Jun 20, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a Discord discussion, the author of swash shared:

My general recommendation would be to never apply fractional offsets in the y direction. We do so in the x direction because scaled advance widths are almost never integral and we’re generally rasterizing to a fixed grid so if the fractional component of the advance is not taken into account, you end up with very noticeable inconsistent spacing between glyphs and the error accumulates quickly over a line.
For most body text, the line height is consistent so rounding is fine (and imho, preferable).

So I guess we can just keep hinting hardcoded like this.

),
);

PhysicalGlyph { cache_key, x, y }
}
}

/// A line of laid out glyphs
pub struct LayoutLine {
/// Width of the line
Expand Down
22 changes: 7 additions & 15 deletions src/shape.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use unicode_script::{Script, UnicodeScript};
use unicode_segmentation::UnicodeSegmentation;

use crate::fallback::FontFallbackIter;
use crate::{Align, AttrsList, CacheKey, Color, Font, FontSystem, LayoutGlyph, LayoutLine, Wrap};
use crate::{Align, AttrsList, Color, Font, FontSystem, LayoutGlyph, LayoutLine, Wrap};

/// The shaping strategy of some text.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
Expand Down Expand Up @@ -332,26 +332,18 @@ impl ShapeGlyph {
w: f32,
level: unicode_bidi::Level,
) -> LayoutGlyph {
let x_offset = font_size * self.x_offset;
let y_offset = font_size * self.y_offset;

let (cache_key, x_int, y_int) = CacheKey::new(
self.font_id,
self.glyph_id,
font_size,
(x + x_offset, y - y_offset),
);
LayoutGlyph {
start: self.start,
end: self.end,
font_size,
font_id: self.font_id,
glyph_id: self.glyph_id,
x,
y,
w,
level,
cache_key,
x_offset,
y_offset,
x_int,
y_int,
x_offset: self.x_offset,
y_offset: self.y_offset,
color_opt: self.color_opt,
metadata: self.metadata,
}
Expand Down