Struct gdnative_bindings_lily::BitmapFont [−][src]
pub struct BitmapFont { /* fields omitted */ }
Expand description
core class BitmapFont
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
BitmapFont 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
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Adds a character to the font, where character
is the Unicode value, texture
is the texture index, rect
is the region in the texture (in pixels!), align
is the (optional) alignment for the character and advance
is the (optional) advance.
Default Arguments
align
-Vector2( 0, 0 )
advance
--1
Adds a kerning pair to the BitmapFont as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
Adds a texture to the BitmapFont.
Creates a BitmapFont from the *.fnt
file at path
.
Returns a kerning pair as a difference.
Returns the font atlas texture at index idx
.
Returns the number of textures in the BitmapFont atlas.
Ascent (number of pixels above the baseline).
If true
, distance field hint is enabled.
The fallback font.
Total font height (ascent plus descent) in pixels.
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 BitmapFont
impl !Send for BitmapFont
impl !Sync for BitmapFont
impl Unpin for BitmapFont
impl UnwindSafe for BitmapFont