Struct gdnative::api::DynamicFont

pub struct DynamicFont { /* fields omitted */ }

core class DynamicFont inherits Font (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

DynamicFont inherits methods from:

• Font
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl DynamicFont

Constants

pub const SPACING_BOTTOM: i64

pub const SPACING_CHAR: i64

pub const SPACING_SPACE: i64

pub const SPACING_TOP: i64

impl DynamicFont

pub fn new() -> Ref<DynamicFont, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_fallback(&self, data: impl AsArg<DynamicFontData>)

Adds a fallback font.

pub fn get_available_chars(&self) -> GodotString

Returns a string containing all the characters available in the main and all the fallback fonts.
				If a given character is included in more than one font, it appears only once in the returned string.

pub fn get_fallback(&self, idx: i64) -> Option<Ref<DynamicFontData, Shared>>

Returns the fallback font at index [code]idx[/code].

pub fn get_fallback_count(&self) -> i64

Returns the number of fallback fonts.

pub fn font_data(&self) -> Option<Ref<DynamicFontData, Shared>>

The font data.

pub fn outline_color(&self) -> Color

The font outline's color.
			[b]Note:[/b] It's recommended to leave this at the default value so that you can adjust it in individual controls. For example, if the outline is made black here, it won't be possible to change its color using a Label's font outline modulate theme item.

pub fn outline_size(&self) -> i64

The font outline's thickness in pixels (not relative to the font size).

pub fn size(&self) -> i64

The font size in pixels.

pub fn spacing(&self, _type: i64) -> i64

Extra spacing at the top in pixels.

pub fn use_filter(&self) -> bool

If [code]true[/code], filtering is used. This makes the font blurry instead of pixelated when scaling it if font oversampling is disabled or ineffective. It's recommended to enable this when using the font in a control whose size changes over time, unless a pixel art aesthetic is desired.

pub fn use_mipmaps(&self) -> bool

If [code]true[/code], mipmapping is used. This improves the font's appearance when downscaling it if font oversampling is disabled or ineffective.

pub fn remove_fallback(&self, idx: i64)

Removes the fallback font at index [code]idx[/code].

pub fn set_fallback(&self, idx: i64, data: impl AsArg<DynamicFontData>)

Sets the fallback font at index [code]idx[/code].

pub fn set_font_data(&self, data: impl AsArg<DynamicFontData>)

The font data.

pub fn set_outline_color(&self, color: Color)

The font outline's color.
			[b]Note:[/b] It's recommended to leave this at the default value so that you can adjust it in individual controls. For example, if the outline is made black here, it won't be possible to change its color using a Label's font outline modulate theme item.

pub fn set_outline_size(&self, size: i64)

The font outline's thickness in pixels (not relative to the font size).

pub fn set_size(&self, data: i64)

The font size in pixels.

pub fn set_spacing(&self, _type: i64, value: i64)

Extra spacing at the top in pixels.

pub fn set_use_filter(&self, enable: bool)

If [code]true[/code], filtering is used. This makes the font blurry instead of pixelated when scaling it if font oversampling is disabled or ineffective. It's recommended to enable this when using the font in a control whose size changes over time, unless a pixel art aesthetic is desired.

pub fn set_use_mipmaps(&self, enable: bool)

If [code]true[/code], mipmapping is used. This improves the font's appearance when downscaling it if font oversampling is disabled or ineffective.

Methods from Deref<Target = Font>

pub fn draw(
    &self,
    canvas_item: Rid,
    position: Vector2D<f32, UnknownUnit>,
    string: impl Into<GodotString>,
    modulate: Color,
    clip_w: i64,
    outline_modulate: Color
)

Draw [code]string[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis.
				See also [method CanvasItem.draw_string].

Default Arguments

• modulate - Color( 1, 1, 1, 1 )
• clip_w - -1
• outline_modulate - Color( 1, 1, 1, 1 )

pub fn draw_char(
    &self,
    canvas_item: Rid,
    position: Vector2D<f32, UnknownUnit>,
    char: i64,
    next: i64,
    modulate: Color,
    outline: bool
) -> f64

Draw character [code]char[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally kerning if [code]next[/code] is passed. clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.

Default Arguments

• next - -1
• modulate - Color( 1, 1, 1, 1 )
• outline - false

pub fn get_ascent(&self) -> f64

Returns the font ascent (number of pixels above the baseline).

pub fn get_char_size(&self, char: i64, next: i64) -> Vector2D<f32, UnknownUnit>

Returns the size of a character, optionally taking kerning into account if the next character is provided.

Default Arguments

• next - 0

pub fn get_descent(&self) -> f64

Returns the font descent (number of pixels below the baseline).

pub fn get_height(&self) -> f64

Returns the total font height (ascent plus descent) in pixels.

pub fn get_string_size(
    &self,
    string: impl Into<GodotString>
) -> Vector2D<f32, UnknownUnit>

Returns the size of a string, taking kerning and advance into account.

pub fn get_wordwrap_string_size(
    &self,
    string: impl Into<GodotString>,
    width: f64
) -> Vector2D<f32, UnknownUnit>

Returns the size that the string would have with word wrapping enabled with a fixed [code]width[/code].

pub fn has_outline(&self) -> bool

Returns [code]true[/code] if the font has an outline.

pub fn is_distance_field_hint(&self) -> bool

pub fn update_changes(&self)

After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.

Trait Implementations

impl Debug for DynamicFont

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

Formats the value using the given formatter.

impl Deref for DynamicFont

type Target = Font

The resulting type after dereferencing.

fn deref(&self) -> &Font

Dereferences the value.

impl DerefMut for DynamicFont

fn deref_mut(&mut self) -> &mut Font

Mutably dereferences the value.

impl GodotObject for DynamicFont

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for DynamicFont

fn construct() -> Ref<DynamicFont, Unique>

impl SubClass<Font> for DynamicFont

impl SubClass<Object> for DynamicFont

impl SubClass<Reference> for DynamicFont

impl SubClass<Resource> for DynamicFont