Skip to main content

ShapeOptions

Struct ShapeOptions 

Source
pub struct ShapeOptions {
    pub width: Option<f32>,
    pub wrap: WrapMode,
    pub max_lines: Option<u32>,
    pub family: Option<Arc<str>>,
    pub weight: u16,
    pub line_height: Option<f32>,
}
Expand description

Extension shape parameters. Backends that don’t override [TextShaper::shape_wrapped] fall through to the no-wrap path so old callers keep working.

Fields§

§width: Option<f32>

Available width for wrapping, in logical pixels. None = unbounded.

§wrap: WrapMode

Wrap policy.

§max_lines: Option<u32>

Hard cap on line count after shaping (callers cull). None = unbounded.

§family: Option<Arc<str>>

CSS font-family fallback chain as authored (comma-separated, possibly quoted names, generic keywords allowed). None = the platform sans-serif. The backend resolves the first family present in its font database.

§weight: u16

CSS font-weight (1-1000; 400 = normal, 700 = bold).

§line_height: Option<f32>

Resolved CSS line-height, in the same unit space as the size_px argument passed alongside these options to TextShaper::shape (a caller that scales size_px by DPR must scale this the same way). None => the backend’s own line-height: normal fallback (DEFAULT_LINE_HEIGHT_MULTIPLIER). Callers with a TextStyle-ish source resolve one via lumen_core::components::resolve_line_height before constructing these options; this field never re-derives the multiplier itself.

Implementations§

Source§

impl ShapeOptions

Source

pub fn resolved_line_height(&self, size_px: f32) -> f32

Line height in the same unit space as size_px: the authored CSS line-height when the caller resolved one, else size_px times DEFAULT_LINE_HEIGHT_MULTIPLIER. Shaping, measuring, and painting all route through this so one paragraph cannot end up with three different line heights.

Trait Implementations§

Source§

impl Clone for ShapeOptions

Source§

fn clone(&self) -> ShapeOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ShapeOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ShapeOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromTemplate for T
where T: Clone + Default + Unpin,

§

type Template = T

The [Template] for this type.
§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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.

§

impl<T> IntoResult<T> for T

§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
§

impl<T> Template for T
where T: Clone + Default + Unpin,

§

type Output = T

The type of value produced by this [Template].
§

fn build_template( &self, _context: &mut TemplateContext<'_, '_>, ) -> Result<<T as Template>::Output, BevyError>

Uses this template and the given entity context to produce a [Template::Output].
§

fn clone_template(&self) -> T

Clones this template. See Clone.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
§

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