Skip to main content

TextPipeline

Struct TextPipeline 

Source
pub struct TextPipeline { /* private fields */ }
Expand description

End-to-end text shaping + rasterization pipeline for OxiUI.

Wraps oxitext::Pipeline and maps errors to TextError / UiError.

Implementations§

Source§

impl TextPipeline

Source

pub fn from_bytes(font_bytes: &[u8]) -> Result<Self, TextError>

Create a new pipeline from raw font bytes (TTF or OTF).

§Errors

Returns TextError::Pipeline if the font bytes are invalid or unparseable.

Source

pub fn from_system_font(family: &str) -> Result<Self, TextError>

Create a pipeline using a named system font family.

§Errors

Returns TextError::Pipeline if no matching system font is found.

Source

pub fn set_fallback_fonts(&mut self, fonts: Vec<Vec<u8>>)

Configure a font fallback chain.

When a glyph is .notdef in the primary font the pipeline walks this list to find a substitute.

Source

pub fn shape( &mut self, text: &str, style: &TextStyle, ) -> Result<ShapedText, TextError>

Shape and lay out text under style, returning per-line glyph positions without rasterizing.

§Errors

Propagates shaping/layout errors.

Source

pub fn measure( &mut self, text: &str, style: &TextStyle, ) -> Result<(f32, f32), TextError>

Measure total bounding box without rasterizing.

Returns (width, height) in pixels.

§Errors

Propagates shaping/layout errors.

Source

pub fn glyph_positions( &mut self, text: &str, style: &TextStyle, ) -> Result<Vec<GlyphPosition>, TextError>

Return per-glyph positions for hit-testing.

§Errors

Propagates shaping/layout errors.

Source

pub fn render( &mut self, text: &str, style: &TextStyle, ) -> Result<RenderResult, UiError>

Shape and rasterize text with the given style.

Returns a RenderResult containing per-glyph bitmaps.

§Errors

Propagates pipeline errors as UiError::Render.

Auto Trait Implementations§

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.