Clarify when to use x_offset and y_offset in LayoutGlyph
This commit is contained in:
parent
01f6c1fd89
commit
be6dea75a8
1 changed files with 18 additions and 2 deletions
|
|
@ -20,9 +20,25 @@ pub struct LayoutGlyph {
|
|||
pub rtl: bool,
|
||||
/// Cache key, see [CacheKey]
|
||||
pub cache_key: CacheKey,
|
||||
// X offset in line
|
||||
/// X offset in line
|
||||
///
|
||||
/// Unless you are not 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.
|
||||
///
|
||||
/// 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
|
||||
/// Y offset in line
|
||||
///
|
||||
/// Unless you are not 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.
|
||||
///
|
||||
/// 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,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue