Struct Font

#[repr(C)]
pub struct Font { /* private fields */ }

Expand description

Godot class Font.

Inherits Resource.

Related symbols:

font: sidecar module with related enum/flag types
IFont: virtual methods

§Not instantiable

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

Implementations§

§

impl Font

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

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

pub fn find_variation<'a>(&self, variation_coordinates: &'a 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: 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: GString) -> ExGetStringSize<'a>

pub fn get_multiline_string_size(&self, text: 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: GString, ) -> ExGetMultilineStringSize<'a>

pub fn draw_string(&self, canvas_item: Rid, pos: Vector2, text: 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: GString, ) -> ExDrawString<'a>

pub fn draw_multiline_string( &self, canvas_item: Rid, pos: Vector2, text: 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: GString, ) -> ExDrawMultilineString<'a>

pub fn draw_string_outline(&self, canvas_item: Rid, pos: Vector2, text: 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: GString, ) -> ExDrawStringOutline<'a>

pub fn draw_multiline_string_outline( &self, canvas_item: Rid, pos: Vector2, text: 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: GString, ) -> ExDrawMultilineStringOutline<'a>

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

pub fn draw_char( &self, canvas_item: Rid, pos: Vector2, char: i64, 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: i64, font_size: i32, ) -> ExDrawChar<'a>

pub fn draw_char_outline( &self, canvas_item: Rid, pos: Vector2, char: i64, 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: i64, font_size: i32, ) -> ExDrawCharOutline<'a>

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

pub fn get_supported_chars(&self) -> GString

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

pub fn is_script_supported(&self, script: 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: GString)

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

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: 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 set_scene_unique_id(&mut self, id: 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>

Methods from Deref<Target = RefCounted>§

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>§

pub fn get_class(&self) -> GString

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

pub fn set(&mut self, property: StringName, value: &Variant)

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

pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)

pub fn get_indexed(&self, property_path: 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: StringName) -> bool

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

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: &Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: 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: StringName) -> ExGetMeta<'a>

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

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

pub fn add_user_signal(&mut self, signal: 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: GString, ) -> ExAddUserSignal<'a>

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

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: 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: 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: 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: 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: 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: 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: StringName, value: &Variant)

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

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

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

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

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

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

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

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

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

pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> 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: 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: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: 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: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>

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.