Skip to main content

TextSettings

Struct TextSettings 

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

Immutable size, shaping policy, and budgets of one registered font.

Logical size is pixels per em, not a promise that every glyph has that height. Labels using a registration share this size and direction. Register another font configuration when a second size is needed. Display DPI is selected by the desktop runner; it never changes logical text metrics.

Engine budget types here are configuration values, not renderer resources. Font bytes must come from a trusted application asset. Dependency parsing and shaping are not an untrusted-font sandbox or an OS OOM guarantee.

Implementations§

Source§

impl TextSettings

Source

pub fn new(logical_em_size: f32) -> Result<Self, TextError>

Creates a positive normal logical em size with the remaining defaults.

Non-finite, non-positive, or subnormal sizes return an error. Creation is headless and does not rasterize or allocate an atlas.

Source

pub const fn with_direction(self, direction: TextDirection) -> Self

Selects a single-run shaping direction; this is not bidi paragraph layout.

Source

pub const fn with_font_budget(self, budget: FontBudget) -> Self

Replaces per-font source-capacity and declared-glyph limits. Application-wide source limits still apply independently.

Source

pub const fn with_layout_budget(self, budget: TextLayoutBudget) -> Self

Replaces per-label input/output and per-glyph rasterization work limits. Zero limits are valid. A label exceeding a limit is rejected atomically.

Source

pub const fn with_atlas_budget(self, budget: TextAtlasBudget) -> Self

Replaces fixed desktop atlas and per-run capacities.

This stores an already validated configuration without allocating GPU resources. Device dimensions and raster fit are checked on desktop use.

Source

pub const fn logical_em_size(self) -> f32

Returns the fixed logical-pixel em size shared by this registration.

Source

pub const fn direction(self) -> TextDirection

Returns the requested direction for one horizontal shaping run.

Source

pub const fn font_budget(self) -> FontBudget

Returns limits applied when taking ownership of font source bytes.

Source

pub const fn layout_budget(self) -> TextLayoutBudget

Returns limits applied to each changed label and rasterized glyph.

Source

pub const fn atlas_budget(self) -> TextAtlasBudget

Returns the fixed physical atlas dimensions and per-run capacities.

Source

pub fn with_atlas_limits( self, limits: TextAtlasLimits, ) -> Result<Self, TextError>

Sets GPU-independent atlas/run configuration. Validation failure preserves self. Available with both headless-text and text; desktop conversion is checked.

Source

pub const fn atlas_limits(self) -> TextAtlasLimits

Returns the GPU-independent atlas/run configuration used by CPU label validation.

Source

pub fn style(self, scale: f32) -> Result<TextStyle, TextError>

Creates Engine’s style for an explicit physical-pixels-per-logical scale.

A headless caller can use 1.0; desktop presentation uses actual DPI. Invalid or unrepresentable physical size returns a typed font error. This creates a value only and performs no GPU operation.

Trait Implementations§

Source§

impl Clone for TextSettings

Source§

fn clone(&self) -> Self

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 Copy for TextSettings

Source§

impl Debug for TextSettings

Source§

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

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

impl Default for TextSettings

Source§

fn default() -> Self

Uses 24 logical pixels per em, automatic direction, an 8 MiB font cap, 4096 UTF-8 bytes and 1024 shaped glyphs per label, and Engine’s fixed 1024 by 1024 RGBA atlas. Raster work is capped per glyph at one million coverage pixels and 16384 outline commands.

Source§

impl PartialEq for TextSettings

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TextSettings

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> ConditionalSend for T
where T: Send,

Source§

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

Source§

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

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

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

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

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

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

Source§

type Template = T

The Template for this type.
Source§

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

Source§

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

Creates Self using default().

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoResult<T> for T

Source§

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

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Output = T

The type of value produced by this Template.
Source§

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

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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> Upcast<T> for T

Source§

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

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> WorldEvent for T
where T: Copy + Send + Sync + 'static,