TextConfig

Struct TextConfig 

Source
pub struct TextConfig {
    pub color: Color,
    pub font_id: u16,
    pub font_size: u16,
    pub letter_spacing: u16,
    pub line_height: u16,
    pub wrap_mode: TextElementConfigWrapMode,
    pub alignment: TextAlignment,
}
Expand description

Configuration settings for rendering text elements.

Fields§

§color: Color

The color of the text.

§font_id: u16

Clay does not manage fonts. It is up to the user to assign a unique ID to each font and provide it via the font_id field.

§font_size: u16

The font size of the text.

§letter_spacing: u16

The spacing between letters.

§line_height: u16

The height of each line of text.

§wrap_mode: TextElementConfigWrapMode

Defines the text wrapping behavior.

§alignment: TextAlignment

The alignment of the text.

Implementations§

Source§

impl TextConfig

Source

pub fn new() -> Self

Creates a new TextConfig instance with default values.

Source

pub fn color(&mut self, color: Color) -> &mut Self

Sets the text color.

Source

pub fn font_id(&mut self, id: u16) -> &mut Self

Sets the font ID. The user is responsible for assigning unique font IDs.

Source

pub fn font_size(&mut self, size: u16) -> &mut Self

Sets the font size.

Source

pub fn letter_spacing(&mut self, spacing: u16) -> &mut Self

Sets the letter spacing.

Source

pub fn line_height(&mut self, height: u16) -> &mut Self

Sets the line height.

Source

pub fn wrap_mode(&mut self, mode: TextElementConfigWrapMode) -> &mut Self

Sets the text wrapping mode.

Source

pub fn alignment(&mut self, alignment: TextAlignment) -> &mut Self

Sets the text alignment.

Source

pub fn end(&self) -> TextElementConfig

Finalizes the text configuration and stores it in memory.

Trait Implementations§

Source§

impl Clone for TextConfig

Source§

fn clone(&self) -> TextConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextConfig

Source§

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

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

impl Default for TextConfig

Source§

fn default() -> Self

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

impl From<Clay_TextElementConfig> for TextConfig

Source§

fn from(value: Clay_TextElementConfig) -> Self

Converts to this type from the input type.
Source§

impl From<TextConfig> for Clay_TextElementConfig

Source§

fn from(value: TextConfig) -> Self

Converts to this type from the input type.
Source§

impl Copy for TextConfig

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.

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