Struct raqote::draw_target::fk::Font
source · pub struct Font {
freetype_face: *mut FT_FaceRec,
font_data: Arc<Vec<u8>>,
}
Expand description
A cross-platform loader that uses the FreeType library to load and rasterize fonts.
On macOS and Windows, the Cargo feature loader-freetype-default
can be used to opt into this
loader by default.
Fields§
§freetype_face: *mut FT_FaceRec
§font_data: Arc<Vec<u8>>
Implementations§
source§impl Font
impl Font
sourcepub fn from_bytes(
font_data: Arc<Vec<u8>>,
font_index: u32,
) -> Result<Font, FontLoadingError>
pub fn from_bytes( font_data: Arc<Vec<u8>>, font_index: u32, ) -> Result<Font, FontLoadingError>
Loads a font from raw font data (the contents of a .ttf
/.otf
/etc. file).
If the data represents a collection (.ttc
/.otc
/etc.), font_index
specifies the index
of the font to load from it. If the data represents a single font, pass 0 for font_index
.
sourcepub fn from_file(
file: &mut File,
font_index: u32,
) -> Result<Font, FontLoadingError>
pub fn from_file( file: &mut File, font_index: u32, ) -> Result<Font, FontLoadingError>
Loads a font from a .ttf
/.otf
/etc. file.
If the file is a collection (.ttc
/.otc
/etc.), font_index
specifies the index of the
font to load from it. If the file represents a single font, pass 0 for font_index
.
sourcepub fn from_path<P>(path: P, font_index: u32) -> Result<Font, FontLoadingError>
pub fn from_path<P>(path: P, font_index: u32) -> Result<Font, FontLoadingError>
Loads a font from the path to a .ttf
/.otf
/etc. file.
If the file is a collection (.ttc
/.otc
/etc.), font_index
specifies the index of the
font to load from it. If the file represents a single font, pass 0 for font_index
.
sourcepub unsafe fn from_native_font(freetype_face: *mut FT_FaceRec) -> Font
pub unsafe fn from_native_font(freetype_face: *mut FT_FaceRec) -> Font
Creates a font from a native API handle.
sourcepub fn from_handle(handle: &Handle) -> Result<Font, FontLoadingError>
pub fn from_handle(handle: &Handle) -> Result<Font, FontLoadingError>
Loads the font pointed to by a handle.
sourcepub fn analyze_bytes(
font_data: Arc<Vec<u8>>,
) -> Result<FileType, FontLoadingError>
pub fn analyze_bytes( font_data: Arc<Vec<u8>>, ) -> Result<FileType, FontLoadingError>
Determines whether a blob of raw font data represents a supported font, and, if so, what type of font it is.
sourcepub fn analyze_file(file: &mut File) -> Result<FileType, FontLoadingError>
pub fn analyze_file(file: &mut File) -> Result<FileType, FontLoadingError>
Determines whether a file represents a supported font, and, if so, what type of font it is.
sourcepub fn analyze_path<P>(path: P) -> Result<FileType, FontLoadingError>
pub fn analyze_path<P>(path: P) -> Result<FileType, FontLoadingError>
Determines whether a path points to a supported font, and, if so, what type of font it is.
sourcepub fn native_font(&self) -> *mut FT_FaceRec
pub fn native_font(&self) -> *mut FT_FaceRec
Returns the wrapped native font handle.
This function increments the reference count of the FreeType face before returning it.
Therefore, it is the caller’s responsibility to free it with FT_Done_Face
.
sourcepub fn postscript_name(&self) -> Option<String>
pub fn postscript_name(&self) -> Option<String>
Returns the PostScript name of the font. This should be globally unique.
sourcepub fn full_name(&self) -> String
pub fn full_name(&self) -> String
Returns the full name of the font (also known as “display name” on macOS).
sourcepub fn family_name(&self) -> String
pub fn family_name(&self) -> String
Returns the name of the font family.
sourcepub fn is_monospace(&self) -> bool
pub fn is_monospace(&self) -> bool
Returns true if and only if the font is monospace (fixed-width).
sourcepub fn properties(&self) -> Properties
pub fn properties(&self) -> Properties
Returns the values of various font properties, corresponding to those defined in CSS.
sourcepub fn glyph_for_char(&self, character: char) -> Option<u32>
pub fn glyph_for_char(&self, character: char) -> Option<u32>
Returns the usual glyph ID for a Unicode character.
Be careful with this function; typographically correct character-to-glyph mapping must be done using a shaper such as HarfBuzz. This function is only useful for best-effort simple use cases like “what does character X look like on its own”.
sourcepub fn glyph_by_name(&self, name: &str) -> Option<u32>
pub fn glyph_by_name(&self, name: &str) -> Option<u32>
Returns the glyph ID for the specified glyph name.
sourcepub fn glyph_count(&self) -> u32
pub fn glyph_count(&self) -> u32
Returns the number of glyphs in the font.
Glyph IDs range from 0 inclusive to this value exclusive.
sourcepub fn outline<S>(
&self,
glyph_id: u32,
hinting: HintingOptions,
sink: &mut S,
) -> Result<(), GlyphLoadingError>where
S: OutlineSink,
pub fn outline<S>(
&self,
glyph_id: u32,
hinting: HintingOptions,
sink: &mut S,
) -> Result<(), GlyphLoadingError>where
S: OutlineSink,
Sends the vector path for a glyph to a path builder.
If hinting_mode
is not None, this function performs grid-fitting as requested before
sending the hinding outlines to the builder.
TODO(pcwalton): What should we do for bitmap glyphs?
sourcepub fn typographic_bounds(
&self,
glyph_id: u32,
) -> Result<RectF, GlyphLoadingError>
pub fn typographic_bounds( &self, glyph_id: u32, ) -> Result<RectF, GlyphLoadingError>
Returns the boundaries of a glyph in font units.
sourcepub fn advance(&self, glyph_id: u32) -> Result<Vector2F, GlyphLoadingError>
pub fn advance(&self, glyph_id: u32) -> Result<Vector2F, GlyphLoadingError>
Returns the distance from the origin of the glyph with the given ID to the next, in font units.
sourcepub fn origin(&self, _: u32) -> Result<Vector2F, GlyphLoadingError>
pub fn origin(&self, _: u32) -> Result<Vector2F, GlyphLoadingError>
Returns the amount that the given glyph should be displaced from the origin.
FIXME(pcwalton): This always returns zero on FreeType.
sourcepub fn supports_hinting_options(
&self,
hinting_options: HintingOptions,
for_rasterization: bool,
) -> bool
pub fn supports_hinting_options( &self, hinting_options: HintingOptions, for_rasterization: bool, ) -> bool
Returns true if and only if the font loader can perform hinting in the requested way.
Some APIs support only rasterizing glyphs with hinting, not retrieving hinted outlines. If
for_rasterization
is false, this function returns true if and only if the loader supports
retrieval of hinted outlines. If for_rasterization
is true, this function returns true
if and only if the loader supports rasterizing hinted glyphs.
sourcepub fn raster_bounds(
&self,
glyph_id: u32,
point_size: f32,
transform: Transform2F,
hinting_options: HintingOptions,
rasterization_options: RasterizationOptions,
) -> Result<RectI, GlyphLoadingError>
pub fn raster_bounds( &self, glyph_id: u32, point_size: f32, transform: Transform2F, hinting_options: HintingOptions, rasterization_options: RasterizationOptions, ) -> Result<RectI, GlyphLoadingError>
Returns the pixel boundaries that the glyph will take up when rendered using this loader’s rasterizer at the given size and origin.
sourcepub fn rasterize_glyph(
&self,
canvas: &mut Canvas,
glyph_id: u32,
point_size: f32,
transform: Transform2F,
hinting_options: HintingOptions,
rasterization_options: RasterizationOptions,
) -> Result<(), GlyphLoadingError>
pub fn rasterize_glyph( &self, canvas: &mut Canvas, glyph_id: u32, point_size: f32, transform: Transform2F, hinting_options: HintingOptions, rasterization_options: RasterizationOptions, ) -> Result<(), GlyphLoadingError>
Rasterizes a glyph to a canvas with the given size and origin.
Format conversion will be performed if the canvas format does not match the rasterization options. For example, if bilevel (black and white) rendering is requested to an RGBA surface, this function will automatically convert the 1-bit raster image to the 32-bit format of the canvas. Note that this may result in a performance penalty, depending on the loader.
If hinting_options
is not None, the requested grid fitting is performed.
sourcepub fn handle(&self) -> Option<Handle>
pub fn handle(&self) -> Option<Handle>
Returns a handle to this font, if possible.
This is useful if you want to open the font with a different loader.
sourcepub fn copy_font_data(&self) -> Option<Arc<Vec<u8>>>
pub fn copy_font_data(&self) -> Option<Arc<Vec<u8>>>
Attempts to return the raw font data (contents of the font file).
If this font is a member of a collection, this function returns the data for the entire collection.
sourcepub fn load_font_table(&self, table_tag: u32) -> Option<Box<[u8]>>
pub fn load_font_table(&self, table_tag: u32) -> Option<Box<[u8]>>
Returns the raw contents of the OpenType table with the given tag.
Tags are four-character codes. A list of tags can be found in the OpenType specification.
Trait Implementations§
source§impl Loader for Font
impl Loader for Font
source§type NativeFont = *mut FT_FaceRec
type NativeFont = *mut FT_FaceRec
source§fn from_bytes(
font_data: Arc<Vec<u8>>,
font_index: u32,
) -> Result<Font, FontLoadingError>
fn from_bytes( font_data: Arc<Vec<u8>>, font_index: u32, ) -> Result<Font, FontLoadingError>
source§fn analyze_bytes(font_data: Arc<Vec<u8>>) -> Result<FileType, FontLoadingError>
fn analyze_bytes(font_data: Arc<Vec<u8>>) -> Result<FileType, FontLoadingError>
source§fn analyze_file(file: &mut File) -> Result<FileType, FontLoadingError>
fn analyze_file(file: &mut File) -> Result<FileType, FontLoadingError>
source§fn native_font(&self) -> <Font as Loader>::NativeFont
fn native_font(&self) -> <Font as Loader>::NativeFont
source§unsafe fn from_native_font(native_font: <Font as Loader>::NativeFont) -> Font
unsafe fn from_native_font(native_font: <Font as Loader>::NativeFont) -> Font
source§fn postscript_name(&self) -> Option<String>
fn postscript_name(&self) -> Option<String>
source§fn full_name(&self) -> String
fn full_name(&self) -> String
source§fn family_name(&self) -> String
fn family_name(&self) -> String
source§fn is_monospace(&self) -> bool
fn is_monospace(&self) -> bool
source§fn properties(&self) -> Properties
fn properties(&self) -> Properties
source§fn glyph_for_char(&self, character: char) -> Option<u32>
fn glyph_for_char(&self, character: char) -> Option<u32>
source§fn glyph_by_name(&self, name: &str) -> Option<u32>
fn glyph_by_name(&self, name: &str) -> Option<u32>
source§fn glyph_count(&self) -> u32
fn glyph_count(&self) -> u32
source§fn outline<S>(
&self,
glyph_id: u32,
hinting_mode: HintingOptions,
sink: &mut S,
) -> Result<(), GlyphLoadingError>where
S: OutlineSink,
fn outline<S>(
&self,
glyph_id: u32,
hinting_mode: HintingOptions,
sink: &mut S,
) -> Result<(), GlyphLoadingError>where
S: OutlineSink,
source§fn typographic_bounds(&self, glyph_id: u32) -> Result<RectF, GlyphLoadingError>
fn typographic_bounds(&self, glyph_id: u32) -> Result<RectF, GlyphLoadingError>
source§fn advance(&self, glyph_id: u32) -> Result<Vector2F, GlyphLoadingError>
fn advance(&self, glyph_id: u32) -> Result<Vector2F, GlyphLoadingError>
source§fn origin(&self, origin: u32) -> Result<Vector2F, GlyphLoadingError>
fn origin(&self, origin: u32) -> Result<Vector2F, GlyphLoadingError>
source§fn copy_font_data(&self) -> Option<Arc<Vec<u8>>>
fn copy_font_data(&self) -> Option<Arc<Vec<u8>>>
source§fn supports_hinting_options(
&self,
hinting_options: HintingOptions,
for_rasterization: bool,
) -> bool
fn supports_hinting_options( &self, hinting_options: HintingOptions, for_rasterization: bool, ) -> bool
source§fn rasterize_glyph(
&self,
canvas: &mut Canvas,
glyph_id: u32,
point_size: f32,
transform: Transform2F,
hinting_options: HintingOptions,
rasterization_options: RasterizationOptions,
) -> Result<(), GlyphLoadingError>
fn rasterize_glyph( &self, canvas: &mut Canvas, glyph_id: u32, point_size: f32, transform: Transform2F, hinting_options: HintingOptions, rasterization_options: RasterizationOptions, ) -> Result<(), GlyphLoadingError>
source§fn get_fallbacks(&self, text: &str, locale: &str) -> FallbackResult<Font>
fn get_fallbacks(&self, text: &str, locale: &str) -> FallbackResult<Font>
source§fn load_font_table(&self, table_tag: u32) -> Option<Box<[u8]>>
fn load_font_table(&self, table_tag: u32) -> Option<Box<[u8]>>
source§fn from_handle(handle: &Handle) -> Result<Self, FontLoadingError>
fn from_handle(handle: &Handle) -> Result<Self, FontLoadingError>
source§fn analyze_path<P>(path: P) -> Result<FileType, FontLoadingError>
fn analyze_path<P>(path: P) -> Result<FileType, FontLoadingError>
source§fn raster_bounds(
&self,
glyph_id: u32,
point_size: f32,
transform: Transform2F,
_: HintingOptions,
_: RasterizationOptions,
) -> Result<RectI, GlyphLoadingError>
fn raster_bounds( &self, glyph_id: u32, point_size: f32, transform: Transform2F, _: HintingOptions, _: RasterizationOptions, ) -> Result<RectI, GlyphLoadingError>
point_size
and transform
. The origin of the coordinate space is
at the top left.Auto Trait Implementations§
impl Freeze for Font
impl RefUnwindSafe for Font
impl !Send for Font
impl !Sync for Font
impl Unpin for Font
impl UnwindSafe for Font
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)