Skip to main content

DrawGlyphs

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>

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>

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>

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>

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>

Sets the font size in pixels per em units.

The default value is 16.0.

pub fn font_embolden(self, embolden: FontEmbolden) -> DrawGlyphs<'a>

Sets synthetic embolden settings.

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>

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>

Sets the brush.

The default value is solid black.

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>, )

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert 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>

Convert 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)

Convert &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)

Convert &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
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,