Struct DrawText

pub struct DrawText {
    pub pos: [f32; 2],
    pub color: Color,
    pub decoration: TextDecoration,
    pub layout: Arc<PreparedTextLayout>,
}

Prepared shaped text positioned by its first baseline.

The shared layout keeps source text, glyphs, and line metrics alive. Color is the uniform paint color; styled layouts may additionally carry per-glyph colors. All positions and metrics are logical pixels.

Examples

use std::sync::Arc;
use ailloli_ui_core::{Color, FontId, TextDecoration, TextStyle};
use ailloli_ui_runtime::scene::DrawText;
use ailloli_ui_text::{TextLayoutParams, TextSystem};
let mut system = TextSystem::new();
let layout = system.layout_cached(TextLayoutParams::new(
    "hello", TextStyle::new(FontId::Ui, 14, Color::WHITE),
));
let draw = DrawText { pos: [5.0, 20.0], color: Color::WHITE,
    decoration: TextDecoration::None, layout };
assert_eq!(draw.layout.text(), "hello");

Fields

pos: [f32; 2]

[x, first_baseline_y] in window-space logical pixels.

color: Color

Uniform linear-RGBA paint color.

decoration: TextDecoration

Requested paint-only text decoration.

layout: Arc<PreparedTextLayout>

Shared, renderer-ready shaped layout.

Implementations

impl DrawText

Provides the operations defined for DrawText.

pub fn decoration_rects(&self, dpr: f32) -> Vec<Rect>

Returns logical-pixel underline rectangles for non-empty visual lines.

Decorations other than underline return an empty vector. dpr is clamped to at least 0.01 using floating-point max; NaN therefore also becomes 0.01, while positive infinity can yield non-finite snapped coordinates. Each underline is at least one physical pixel thick, uses the line width, and is vertically snapped to the effective DPR.

Examples

use ailloli_ui_core::{Color, FontId, TextDecoration, TextStyle};
use ailloli_ui_runtime::scene::DrawText;
use ailloli_ui_text::{TextLayoutParams, TextSystem};
let mut system = TextSystem::new();
let layout = system.layout_cached(TextLayoutParams::new(
    "underlined", TextStyle::new(FontId::Ui, 14, Color::WHITE),
));
let draw = DrawText { pos: [0.0, layout.lines[0].baseline_y], color: Color::WHITE,
    decoration: TextDecoration::Underline, layout };
assert_eq!(draw.decoration_rects(2.0).len(), 1);
assert!(draw.decoration_rects(2.0)[0].h >= 0.5);

Trait Implementations

impl Clone for DrawText

fn clone(&self) -> DrawText

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DrawText

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.