Struct Font 

pub struct Font { /* private fields */ }

Godot class Font.

Inherits Resource.

Related symbols:

• font: sidecar module with related enum/flag types

See also Godot docs for Font.

Not instantiable

This class cannot be constructed. Obtain Gd<Font> instances via Godot APIs.

Final class

This class is final, meaning you cannot inherit from it, and it comes without I* interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.

Implementations

impl Font

pub fn set_fallbacks(&mut self, fallbacks: &Array<Gd<Font>>)

pub fn get_fallbacks(&self) -> Array<Gd<Font>>

pub fn find_variation(&self, variation_coordinates: &Dictionary) -> Rid

To set the default parameters, use Self::find_variation_ex and its builder methods. See the book for detailed usage instructions.

pub fn find_variation_ex<'a>( &'a self, variation_coordinates: &'a Dictionary, ) -> ExFindVariation<'a>

pub fn get_rids(&self) -> Array<Rid>

pub fn get_height(&self) -> f32

To set the default parameters, use Self::get_height_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_height_ex<'a>(&'a self) -> ExGetHeight<'a>

pub fn get_ascent(&self) -> f32

To set the default parameters, use Self::get_ascent_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_ascent_ex<'a>(&'a self) -> ExGetAscent<'a>

pub fn get_descent(&self) -> f32

To set the default parameters, use Self::get_descent_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_descent_ex<'a>(&'a self) -> ExGetDescent<'a>

pub fn get_underline_position(&self) -> f32

To set the default parameters, use Self::get_underline_position_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_underline_position_ex<'a>(&'a self) -> ExGetUnderlinePosition<'a>

pub fn get_underline_thickness(&self) -> f32

To set the default parameters, use Self::get_underline_thickness_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_underline_thickness_ex<'a>(&'a self) -> ExGetUnderlineThickness<'a>

pub fn get_font_name(&self) -> GString

pub fn get_font_style_name(&self) -> GString

pub fn get_ot_name_strings(&self) -> Dictionary

pub fn get_font_style(&self) -> FontStyle

pub fn get_font_weight(&self) -> i32

pub fn get_font_stretch(&self) -> i32

pub fn get_spacing(&self, spacing: SpacingType) -> i32

pub fn get_opentype_features(&self) -> Dictionary

pub fn set_cache_capacity(&mut self, single_line: i32, multi_line: i32)

pub fn get_string_size(&self, text: impl AsArg<GString>) -> Vector2

To set the default parameters, use Self::get_string_size_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_string_size_ex<'a>( &'a self, text: impl AsArg<GString> + 'a, ) -> ExGetStringSize<'a>

pub fn get_multiline_string_size(&self, text: impl AsArg<GString>) -> Vector2

To set the default parameters, use Self::get_multiline_string_size_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_multiline_string_size_ex<'a>( &'a self, text: impl AsArg<GString> + 'a, ) -> ExGetMultilineStringSize<'a>

pub fn draw_string( &self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString>, )

To set the default parameters, use Self::draw_string_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_string_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString> + 'a, ) -> ExDrawString<'a>

pub fn draw_multiline_string( &self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString>, )

To set the default parameters, use Self::draw_multiline_string_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_multiline_string_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString> + 'a, ) -> ExDrawMultilineString<'a>

pub fn draw_string_outline( &self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString>, )

To set the default parameters, use Self::draw_string_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_string_outline_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString> + 'a, ) -> ExDrawStringOutline<'a>

pub fn draw_multiline_string_outline( &self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString>, )

To set the default parameters, use Self::draw_multiline_string_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_multiline_string_outline_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, text: impl AsArg<GString> + 'a, ) -> ExDrawMultilineStringOutline<'a>

pub fn get_char_size(&self, char: u32, font_size: i32) -> Vector2

pub fn draw_char( &self, canvas_item: Rid, pos: Vector2, char: u32, font_size: i32, ) -> f32

To set the default parameters, use Self::draw_char_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_char_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, char: u32, font_size: i32, ) -> ExDrawChar<'a>

pub fn draw_char_outline( &self, canvas_item: Rid, pos: Vector2, char: u32, font_size: i32, ) -> f32

To set the default parameters, use Self::draw_char_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_char_outline_ex<'a>( &'a self, canvas_item: Rid, pos: Vector2, char: u32, font_size: i32, ) -> ExDrawCharOutline<'a>

pub fn has_char(&self, char: u32) -> bool

pub fn get_supported_chars(&self) -> GString

pub fn is_language_supported(&self, language: impl AsArg<GString>) -> bool

pub fn is_script_supported(&self, script: impl AsArg<GString>) -> bool

pub fn get_supported_feature_list(&self) -> Dictionary

pub fn get_supported_variation_list(&self) -> Dictionary

pub fn get_face_count(&self) -> i64

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_path_cache(&mut self, path: impl AsArg<GString>)

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

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

pub fn is_local_to_scene(&self) -> bool

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

pub fn setup_local_to_scene(&mut self)

pub fn reset_state(&mut self)

pub fn set_id_for_path( &mut self, path: impl AsArg<GString>, id: impl AsArg<GString>, )

pub fn get_id_for_path(&self, path: impl AsArg<GString>) -> GString

pub fn is_built_in(&self) -> bool

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

pub fn duplicate_deep(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_deep_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_deep_ex<'a>(&'a self) -> ExDuplicateDeep<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_script(&self) -> Option<Gd<Script>>

pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool

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

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

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

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn get_translation_domain(&self) -> StringName

pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for Font

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

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) -> &<Font as Deref>::Target

Dereferences the value.

impl DerefMut for Font

fn deref_mut(&mut self) -> &mut <Font as Deref>::Target

Mutably dereferences the value.

impl GodotClass for Font

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Resource

The immediate superclass of T. This is always a Godot engine class.

fn class_id() -> ClassId

Globally unique class ID, linked to the name under which the class is registered in Godot.

fn class_name() -> ClassId

👎Deprecated: Renamed to class_id()

fn inherits<Base>() -> bool

where Base: GodotClass,

Returns whether Self inherits from Base.

impl Inherits<Font> for FontFile

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Font> for FontVariation

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Font> for SystemFont

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Object> for Font

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<RefCounted> for Font

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl Inherits<Resource> for Font

const IS_SAME_CLASS: bool = false

True iff Self == Base.

impl WithSignals for Font

type SignalCollection<'c, C: WithSignals> = SignalsOfResource<'c, C>

The associated struct listing all signals of this class.