Struct gdnative_bindings_lily::DynamicFont [−][src]
pub struct DynamicFont { /* fields omitted */ }
Expand description
core class DynamicFont
inherits Font
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
DynamicFont inherits methods from:
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
Constants
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Adds a fallback font.
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.
Returns the fallback font at index idx
.
Returns the number of fallback fonts.
The font outline’s color. Note: 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.
The font outline’s thickness in pixels (not relative to the font size).
If true
, 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.
If true
, mipmapping is used. This improves the font’s appearance when downscaling it if font oversampling is disabled or ineffective.
Removes the fallback font at index idx
.
Sets the fallback font at index idx
.
The font data.
The font outline’s color. Note: 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.
The font outline’s thickness in pixels (not relative to the font size).
Extra spacing at the top in pixels.
If true
, 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.
If true
, mipmapping is used. This improves the font’s appearance when downscaling it if font oversampling is disabled or ineffective.
Methods from Deref<Target = Font>
Draw string
into a canvas item using the font at a given position, with modulate
color, and optionally clipping the width. position
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 )
Draw character char
into a canvas item using the font at a given position, with modulate
color, and optionally kerning if next
is passed. clipping the width. position
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
Returns the font ascent (number of pixels above the baseline).
Returns the size of a character, optionally taking kerning into account if the next character is provided.
Default Arguments
next
-0
Returns the font descent (number of pixels below the baseline).
Returns the total font height (ascent plus descent) in pixels.
Returns the size of a string, taking kerning and advance into account.
Returns the size that the string would have with word wrapping enabled with a fixed width
.
Returns true
if the font has an outline.
After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it.
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for DynamicFont
impl !Send for DynamicFont
impl !Sync for DynamicFont
impl Unpin for DynamicFont
impl UnwindSafe for DynamicFont