Struct gdnative::Font

pub struct Font { /* fields omitted */ }

core class Font inherits Resource (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

Font inherits methods from:

• Resource
• Reference
• Object

Methods

impl 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.

Methods from Deref<Target = Resource>

pub fn new_ref(&self) -> Resource

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

pub fn _setup_local_to_scene(&mut self)

pub fn duplicate(&self, subresources: bool) -> Option<Resource>

pub fn get_local_scene(&self) -> Option<Node>

pub fn get_name(&self) -> GodotString

pub fn get_path(&self) -> GodotString

pub fn get_rid(&self) -> Rid

pub fn is_local_to_scene(&self) -> bool

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

pub fn set_name(&mut self, name: GodotString)

pub fn set_path(&mut self, path: GodotString)

pub fn setup_local_to_scene(&mut self)

pub fn take_over_path(&mut self, path: GodotString)

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

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 Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

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

Formats the value using the given formatter.

impl Deref for Font

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Font

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

Mutably dereferences the value.

impl Drop for Font

fn drop(&mut self)

Executes the destructor for this type.

impl FromVariant for Font

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

impl GodotObject for Font

fn class_name() -> &'static str

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

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

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

impl ToVariant for Font

fn to_variant(&self) -> Variant