Struct LayoutOptions 

pub struct LayoutOptions {
    pub alignment: TextAlignment,
    pub flow_direction: FlowDirection,
    pub truncation: Option<TruncationMode>,
    pub tab_stops: TabStops,
    pub paragraph_spacing: f32,
    pub hanging_punctuation: bool,
    pub decoration: Option<TextDecoration>,
    pub inline_objects: Vec<InlineObject>,
}

Comprehensive layout options for a single layout pass.

Construct via LayoutOptions::builder() for a fluent API, or create directly and use Default for the standard left-aligned horizontal flow.

Fields

alignment: TextAlignment

Horizontal text alignment within the line box.

flow_direction: FlowDirection

Text flow direction (horizontal or vertical).

truncation: Option<TruncationMode>

Truncation configuration; None disables truncation.

tab_stops: TabStops

Tab stop configuration.

paragraph_spacing: f32

Extra vertical space (in pixels) inserted between paragraphs when using crate::engine::LayoutEngine::layout_paragraphs.

hanging_punctuation: bool

When true, CJK fullwidth punctuation at the start or end of a line is allowed to overhang (“hang”) into the margin by half its advance width.

This is the CSS hanging-punctuation: allow-end behaviour from CSS Text Module Level 3 §3. Affects crate::engine::LayoutEngine::layout_with_options.

decoration: Option<TextDecoration>

Optional text decoration to apply to all rendered runs.

When set, crate::engine::LayoutEngine::layout_with_options computes oxitext_core::DecorationRects for every line and stores them in crate::engine::LayoutResult::decorations.

inline_objects: Vec<InlineObject>

Inline objects to be positioned during layout.

Each oxitext_core::InlineObject is appended after the shaped glyphs on the last line, advancing the cursor by object.advance for each.

Implementations

impl LayoutOptions

pub fn builder() -> LayoutOptionsBuilder

Returns a new LayoutOptionsBuilder initialised with the defaults.

Trait Implementations

impl Clone for LayoutOptions

fn clone(&self) -> LayoutOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutOptions

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

Formats the value using the given formatter.

impl Default for LayoutOptions

fn default() -> Self

Returns the “default value” for a type.