Struct gdnative::BitmapFont

pub struct BitmapFont { /* fields omitted */ }

core class BitmapFont 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

BitmapFont inherits methods from:

• Font
• Resource
• Reference
• Object

Methods

impl BitmapFont

pub fn new() -> BitmapFont

pub fn new_ref(&self) -> BitmapFont

Creates a new reference to the same reference-counted object.

pub fn _get_chars(&self) -> Int32Array

pub fn _get_kernings(&self) -> Int32Array

pub fn _get_textures(&self) -> VariantArray

pub fn _set_chars(&mut self, arg0: Int32Array)

pub fn _set_kernings(&mut self, arg0: Int32Array)

pub fn _set_textures(&mut self, arg0: VariantArray)

pub fn add_char(
    &mut self,
    character: i64,
    texture: i64,
    rect: Rect<f32, UnknownUnit>,
    align: Vector2D<f32, UnknownUnit>,
    advance: f64
)

pub fn add_kerning_pair(&mut self, char_a: i64, char_b: i64, kerning: i64)

pub fn add_texture(&mut self, texture: Option<Texture>)

pub fn clear(&mut self)

pub fn create_from_fnt(&mut self, path: GodotString) -> Result<(), GodotError>

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

pub fn get_fallback(&self) -> Option<BitmapFont>

pub fn get_kerning_pair(&self, char_a: i64, char_b: i64) -> i64

pub fn get_texture(&self, idx: i64) -> Option<Texture>

pub fn get_texture_count(&self) -> i64

pub fn set_ascent(&mut self, px: f64)

pub fn set_distance_field_hint(&mut self, enable: bool)

pub fn set_fallback(&mut self, fallback: Option<BitmapFont>)

pub fn set_height(&mut self, px: f64)

pub fn to_font(&self) -> Font

Up-cast.

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = Font>

pub fn new_ref(&self) -> Font

Creates a new reference to the same reference-counted object.

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

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

pub fn get_ascent(&self) -> f64

pub fn get_descent(&self) -> f64

pub fn get_height(&self) -> f64

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

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

pub fn has_outline(&self) -> bool

pub fn is_distance_field_hint(&self) -> bool

pub fn update_changes(&mut self)

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for BitmapFont

fn clone(&self) -> BitmapFont

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitmapFont

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

Formats the value using the given formatter.

impl Deref for BitmapFont

type Target = Font

The resulting type after dereferencing.

fn deref(&self) -> &Font

Dereferences the value.

impl DerefMut for BitmapFont

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

Mutably dereferences the value.

impl Drop for BitmapFont

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for BitmapFont

fn from_variant(variant: &Variant) -> Result<BitmapFont, FromVariantError>

impl GodotObject for BitmapFont

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> BitmapFont

unsafe fn from_return_position_sys(obj: *mut c_void) -> BitmapFont

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for BitmapFont

fn construct() -> BitmapFont

impl ToVariant for BitmapFont

fn to_variant(&self) -> Variant