Struct DrawGlyphs
pub struct DrawGlyphs<'a> { /* private fields */ }Expand description
Builder for encoding a glyph run.
Created using Scene::draw_glyphs.
Implementations§
§impl<'a> DrawGlyphs<'a>
impl<'a> DrawGlyphs<'a>
pub fn new(scene: &'a mut Scene, font: &FontData) -> DrawGlyphs<'a>
pub fn new(scene: &'a mut Scene, font: &FontData) -> DrawGlyphs<'a>
Creates a new builder for encoding a glyph run for the specified encoding with the given font.
pub fn transform(self, transform: Affine) -> DrawGlyphs<'a>
pub fn transform(self, transform: Affine) -> DrawGlyphs<'a>
Sets the global transform. This is applied to all glyphs after the offset translation.
The default value is the identity matrix.
pub fn glyph_transform(self, transform: Option<Affine>) -> DrawGlyphs<'a>
pub fn glyph_transform(self, transform: Option<Affine>) -> DrawGlyphs<'a>
Sets the per-glyph transform. This is applied to all glyphs prior to offset translation. This is common used for applying a shear to simulate an oblique font.
The default value is None.
pub fn brush_transform(self, transform: Option<Affine>) -> DrawGlyphs<'a>
pub fn brush_transform(self, transform: Option<Affine>) -> DrawGlyphs<'a>
Sets the transform applied to the brush contents.
This is applied after the global run transform and is encoded as the glyph run’s paint transform. It affects transformed brushes such as gradients and images; solid colors ignore it.
The default value is None.
pub fn font_size(self, size: f32) -> DrawGlyphs<'a>
pub fn font_size(self, size: f32) -> DrawGlyphs<'a>
Sets the font size in pixels per em units.
The default value is 16.0.
pub fn font_embolden(self, embolden: FontEmbolden) -> DrawGlyphs<'a>
pub fn font_embolden(self, embolden: FontEmbolden) -> DrawGlyphs<'a>
Sets synthetic embolden settings.
pub fn hint(self, hint: bool) -> DrawGlyphs<'a>
pub fn hint(self, hint: bool) -> DrawGlyphs<'a>
Sets whether to enable hinting.
The default value is false.
pub fn normalized_coords(self, coords: &[i16]) -> DrawGlyphs<'a>
pub fn normalized_coords(self, coords: &[i16]) -> DrawGlyphs<'a>
Sets the normalized design space coordinates for a variable font instance.
pub fn brush(
self,
brush: impl Into<Brush<ImageBrush<&'a ImageData>, &'a Gradient>>,
) -> DrawGlyphs<'a>
pub fn brush( self, brush: impl Into<Brush<ImageBrush<&'a ImageData>, &'a Gradient>>, ) -> DrawGlyphs<'a>
Sets the brush.
The default value is solid black.
pub fn brush_alpha(self, alpha: f32) -> DrawGlyphs<'a>
pub fn brush_alpha(self, alpha: f32) -> DrawGlyphs<'a>
Sets an additional alpha multiplier for the brush.
The default value is 1.0.
pub fn draw(
self,
style: impl Into<StyleRef<'a>>,
glyphs: impl Iterator<Item = Glyph>,
)
pub fn draw( self, style: impl Into<StyleRef<'a>>, glyphs: impl Iterator<Item = Glyph>, )
Encodes a fill or stroke for the given sequence of glyphs and consumes the builder.
The style parameter accepts either Fill or Stroke types.
This supports emoji fonts in COLR and bitmap formats.
style is ignored for these fonts.
For these glyphs, the given brush is used as the “foreground color”, and should
be Solid for maximum compatibility.
Auto Trait Implementations§
impl<'a> Freeze for DrawGlyphs<'a>
impl<'a> !RefUnwindSafe for DrawGlyphs<'a>
impl<'a> Send for DrawGlyphs<'a>
impl<'a> Sync for DrawGlyphs<'a>
impl<'a> Unpin for DrawGlyphs<'a>
impl<'a> UnsafeUnpin for DrawGlyphs<'a>
impl<'a> !UnwindSafe for DrawGlyphs<'a>
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
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more