Struct dx::engine::d2::display::Font

source · [−]

pub struct Font {
    pub name: String,
    pub size: f32,
    pub line_height: f32,
    /* private fields */
}

Expand description

A bitmap font, created in any tool that exports the BMFont format, such as the original BMFont editor, Hiero, or Glyph Designer.

Fields

name: String

The name that was used to load this font.

size: f32

The size of this font, in pixels.

line_height: f32

The vertical distance between each line of text in this font, in pixels.

Implementations

source

impl Font

source

pub fn new(pack: Rc<impl AssetPack + 'static>, name: String) -> Self

Parses a font using files in an asset pack. @param name The path to the font within the asset pack, excluding the .fnt suffix.

source

pub fn dispose_files(&mut self) -> &Self

Disposes the source .fnt File used to create this Font. This can free up some memory, if you don’t intend to recreate this Font later from the same AssetPack.

@returns This instance, for chaining.

source

pub fn split_lines(&self, text: String, max_width: f32) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Splits text into multiple lines that fit into a given width when displayed using this font.

source

pub fn glyphs(&self, text: String) -> Vec<Glyph>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the list of Glyphs that make up a string. Characters without glyphs in this font will be missing from the list.

source

pub fn layout_text(
    &self,
    text: String,
    align: TextAlign,
    wrap_width: f32,
    letter_spacing: f32,
    line_spacing: f32
) -> TextLayout

source

pub fn glyph(&self, ch: char) -> Option<&Glyph>

Get the Glyph for a given character code.

source

pub fn check_reload(&mut self) -> usize

Trait Implementations

source

impl Clone for Font

source

fn clone(&self) -> Font

Returns a copy 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 Font

source

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

Formats the value using the given formatter. Read more

source

impl Default for Font

source

fn default() -> Font

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

source

impl PartialEq for Font

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=.

Auto Trait Implementations

impl !RefUnwindSafe for Font

impl !Send for Font

impl !Sync for Font

impl Unpin for Font

impl !UnwindSafe for Font

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<Target, From> Getter<From> for Target where
From: AsRef<Target>,

source

fn get(from: &From) -> &Target

Typed getter

source

impl<'a, T, C, M> Inspect<'a, C, &'a C, M> for T

source

fn inspect(ctx: &'a mut C) -> &'a C

Inspect the context.

source

impl<'a, T, C, M> Inspect<'a, C, &'a mut C, M> for T

source

fn inspect(ctx: &'a mut C) -> &'a mut C

Inspect the context.

source

impl<'a, T, C, M> Inspect<'a, C, (), M> for T

source

fn inspect(&'a mut C)

Inspect the context.

source

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

const: unstable · 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<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,

source

fn into_color(self) -> To

Convert into color

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,

Sets value as a parameter of self.

source

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> Upcast<T> for T

source

Struct dx::engine::d2::display::Font

Fields

Implementations

impl Font

pub fn new(pack: Rc<impl AssetPack + 'static>, name: String) -> Self

pub fn dispose_files(&mut self) -> &Self

pub fn split_lines(&self, text: String, max_width: f32) -> Vec<String>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn glyphs(&self, text: String) -> Vec<Glyph>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn layout_text( &self, text: String, align: TextAlign, wrap_width: f32, letter_spacing: f32, line_spacing: f32) -> TextLayout

pub fn glyph(&self, ch: char) -> Option<&Glyph>

pub fn check_reload(&mut self) -> usize

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

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

impl Debug for Font

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

impl Default for Font

fn default() -> Font

impl PartialEq<Font> for Font

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

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

Auto Trait Implementations

impl !RefUnwindSafe for Font

impl !Send for Font

impl !Sync for Font

impl Unpin for Font

impl !UnwindSafe for Font

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

impl<Target, From> Getter<From> for Target where From: AsRef<Target>,

fn get(from: &From) -> &Target

impl<'a, T, C, M> Inspect<'a, C, &'a C, M> for T

fn inspect(ctx: &'a mut C) -> &'a C

impl<'a, T, C, M> Inspect<'a, C, &'a mut C, M> for T

fn inspect(ctx: &'a mut C) -> &'a mut C

impl<'a, T, C, M> Inspect<'a, C, (), M> for T

fn inspect(&'a mut C)

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

fn into(self) -> U

impl<Fr, To> IntoColor<To> for Fr where To: FromColor<Fr>,

fn into_color(self) -> To

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Upcast<T> for T

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn split_lines(&self, text: String, max_width: f32) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn glyphs(&self, text: String) -> Vec<Glyph>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn layout_text(
&self,
text: String,
align: TextAlign,
wrap_width: f32,
letter_spacing: f32,
line_spacing: f32
) -> TextLayout

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Target, From> Getter<From> for Target where
From: AsRef<Target>,

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

impl<Fr, To> IntoColor<To> for Fr where
To: FromColor<Fr>,

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,