diff options
author | Adrian Johnson <ajohnson@redneon.com> | 2008-08-10 14:24:48 +0930 |
---|---|---|
committer | Adrian Johnson <ajohnson@redneon.com> | 2008-08-10 14:24:48 +0930 |
commit | bc4635f07729d6a73054971f0e7ec04433f414da (patch) | |
tree | c2c43d8433a958ac511e06fa0a16293e343836d2 /src/cairo-scaled-font-subsets-private.h | |
parent | 4c8317941815971f1d060243e1f6153df06866ca (diff) |
Update _cairo_scaled_font_subsets_map_glyph() docs
Diffstat (limited to 'src/cairo-scaled-font-subsets-private.h')
-rw-r--r-- | src/cairo-scaled-font-subsets-private.h | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/cairo-scaled-font-subsets-private.h b/src/cairo-scaled-font-subsets-private.h index 1de3f863..bc1b9550 100644 --- a/src/cairo-scaled-font-subsets-private.h +++ b/src/cairo-scaled-font-subsets-private.h @@ -127,12 +127,10 @@ _cairo_scaled_font_subsets_destroy (cairo_scaled_font_subsets_t *font_subsets); * @font_subsets: a #cairo_scaled_font_subsets_t * @scaled_font: the font of the glyph to be mapped * @scaled_font_glyph_index: the index of the glyph to be mapped + * @utf8: a string of text encoded in UTF-8 + * @utf8_len: length of @utf8 in bytes * @subset_glyph_ret: return structure containing subset font and glyph id * - * @font_id_ret: return value giving the font ID of the mapped glyph - * @subset_id_ret: return value giving the subset ID of the mapped glyph within the @font_id_ret - * @subset_glyph_index_ret: return value giving the index of the mapped glyph within the @subset_id_ret subset - * * Map a glyph from a #cairo_scaled_font to a new index within a * subset of that font. The mapping performed is from the tuple: * @@ -170,6 +168,14 @@ _cairo_scaled_font_subsets_destroy (cairo_scaled_font_subsets_t *font_subsets); * used by #cairo_scaled_font_subset_t as provided by * _cairo_scaled_font_subsets_foreach. * + * @utf8 and @utf8_len specify a string of unicode characters that the + * glyph @scaled_font_glyph_index maps to. If @utf8_is_mapped in + * @subset_glyph_ret is TRUE, the font subsetting will (where index to + * unicode mapping is supported) ensure that @scaled_font_glyph_index + * maps to @utf8. If @utf8_is_mapped is FALSE, + * @scaled_font_glyph_index has already been mapped to a different + * unicode string. + * * The returned values in the #cairo_scaled_font_subsets_glyph_t struct are: * * @font_id: The font ID of the mapped glyph |