Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
TextServerExtension
繼承: TextServer < RefCounted < Object
被繼承: TextServerAdvanced, TextServerDummy, TextServerFallback
自訂 TextServer 實作(外掛程式)的基底類別。
說明
外部的 TextServer 實作應該繼承這個類。
方法
void |
_cleanup() virtual |
_create_font() virtual required |
|
_create_font_linked_variation(font_rid: RID) virtual |
|
_create_shaped_text(direction: Direction, orientation: Orientation) virtual required |
|
void |
_draw_hex_code_box(canvas: RID, size: int, pos: Vector2, index: int, color: Color) virtual const |
void |
_font_clear_glyphs(font_rid: RID, size: Vector2i) virtual required |
void |
_font_clear_kerning_map(font_rid: RID, size: int) virtual |
void |
_font_clear_size_cache(font_rid: RID) virtual required |
void |
_font_clear_system_fallback_cache() virtual |
void |
_font_clear_textures(font_rid: RID, size: Vector2i) virtual required |
void |
_font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const |
void |
_font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const |
_font_get_antialiasing(font_rid: RID) virtual const |
|
_font_get_ascent(font_rid: RID, size: int) virtual required const |
|
_font_get_baseline_offset(font_rid: RID) virtual const |
|
_font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) virtual required const |
|
_font_get_descent(font_rid: RID, size: int) virtual required const |
|
_font_get_disable_embedded_bitmaps(font_rid: RID) virtual const |
|
_font_get_embolden(font_rid: RID) virtual const |
|
_font_get_face_count(font_rid: RID) virtual const |
|
_font_get_face_index(font_rid: RID) virtual const |
|
_font_get_fixed_size(font_rid: RID) virtual required const |
|
_font_get_fixed_size_scale_mode(font_rid: RID) virtual required const |
|
_font_get_generate_mipmaps(font_rid: RID) virtual const |
|
_font_get_global_oversampling() virtual const |
|
_font_get_glyph_advance(font_rid: RID, size: int, glyph: int) virtual required const |
|
_font_get_glyph_contours(font_rid: RID, size: int, index: int) virtual const |
|
_font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) virtual required const |
|
_font_get_glyph_list(font_rid: RID, size: Vector2i) virtual required const |
|
_font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) virtual required const |
|
_font_get_hinting(font_rid: RID) virtual const |
|
_font_get_keep_rounding_remainders(font_rid: RID) virtual const |
|
_font_get_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual const |
|
_font_get_kerning_list(font_rid: RID, size: int) virtual const |
|
_font_get_language_support_override(font_rid: RID, language: String) virtual |
|
_font_get_language_support_overrides(font_rid: RID) virtual |
|
_font_get_msdf_pixel_range(font_rid: RID) virtual const |
|
_font_get_msdf_size(font_rid: RID) virtual const |
|
_font_get_name(font_rid: RID) virtual const |
|
_font_get_opentype_feature_overrides(font_rid: RID) virtual const |
|
_font_get_ot_name_strings(font_rid: RID) virtual const |
|
_font_get_oversampling(font_rid: RID) virtual const |
|
_font_get_palette_colors(font_rid: RID, index: int) virtual const |
|
_font_get_palette_count(font_rid: RID) virtual const |
|
_font_get_palette_custom_colors(font_rid: RID) virtual const |
|
_font_get_palette_name(font_rid: RID, index: int) virtual const |
|
_font_get_scale(font_rid: RID, size: int) virtual required const |
|
_font_get_script_support_override(font_rid: RID, script: String) virtual |
|
_font_get_script_support_overrides(font_rid: RID) virtual |
|
_font_get_size_cache_info(font_rid: RID) virtual const |
|
_font_get_size_cache_list(font_rid: RID) virtual required const |
|
_font_get_spacing(font_rid: RID, spacing: SpacingType) virtual const |
|
_font_get_stretch(font_rid: RID) virtual const |
|
BitField[FontStyle] |
_font_get_style(font_rid: RID) virtual const |
_font_get_style_name(font_rid: RID) virtual const |
|
_font_get_subpixel_positioning(font_rid: RID) virtual const |
|
_font_get_supported_chars(font_rid: RID) virtual required const |
|
_font_get_supported_glyphs(font_rid: RID) virtual required const |
|
_font_get_texture_count(font_rid: RID, size: Vector2i) virtual required const |
|
_font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) virtual required const |
|
_font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) virtual const |
|
_font_get_transform(font_rid: RID) virtual const |
|
_font_get_underline_position(font_rid: RID, size: int) virtual required const |
|
_font_get_underline_thickness(font_rid: RID, size: int) virtual required const |
|
_font_get_used_palette(font_rid: RID) virtual const |
|
_font_get_variation_coordinates(font_rid: RID) virtual const |
|
_font_get_weight(font_rid: RID) virtual const |
|
_font_has_char(font_rid: RID, char: int) virtual required const |
|
_font_is_allow_system_fallback(font_rid: RID) virtual const |
|
_font_is_force_autohinter(font_rid: RID) virtual const |
|
_font_is_language_supported(font_rid: RID, language: String) virtual const |
|
_font_is_modulate_color_glyphs(font_rid: RID) virtual const |
|
_font_is_multichannel_signed_distance_field(font_rid: RID) virtual const |
|
_font_is_script_supported(font_rid: RID, script: String) virtual const |
|
void |
_font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) virtual required |
void |
_font_remove_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual |
void |
_font_remove_language_support_override(font_rid: RID, language: String) virtual |
void |
_font_remove_script_support_override(font_rid: RID, script: String) virtual |
void |
_font_remove_size_cache(font_rid: RID, size: Vector2i) virtual required |
void |
_font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) virtual required |
void |
_font_render_glyph(font_rid: RID, size: Vector2i, index: int) virtual |
void |
_font_render_range(font_rid: RID, size: Vector2i, start: int, end: int) virtual |
void |
_font_set_allow_system_fallback(font_rid: RID, allow_system_fallback: bool) virtual |
void |
_font_set_antialiasing(font_rid: RID, antialiasing: FontAntialiasing) virtual |
void |
_font_set_ascent(font_rid: RID, size: int, ascent: float) virtual required |
void |
_font_set_baseline_offset(font_rid: RID, baseline_offset: float) virtual |
void |
_font_set_data(font_rid: RID, data: PackedByteArray) virtual |
void |
_font_set_data_ptr(font_rid: RID, data_ptr: |
void |
_font_set_descent(font_rid: RID, size: int, descent: float) virtual required |
void |
_font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) virtual |
void |
_font_set_embolden(font_rid: RID, strength: float) virtual |
void |
_font_set_face_index(font_rid: RID, face_index: int) virtual |
void |
_font_set_fixed_size(font_rid: RID, fixed_size: int) virtual required |
void |
_font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) virtual required |
void |
_font_set_force_autohinter(font_rid: RID, force_autohinter: bool) virtual |
void |
_font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool) virtual |
void |
_font_set_global_oversampling(oversampling: float) virtual |
void |
_font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) virtual required |
void |
_font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) virtual required |
void |
_font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) virtual required |
void |
_font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) virtual required |
void |
_font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) virtual required |
void |
_font_set_hinting(font_rid: RID, hinting: Hinting) virtual |
void |
_font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool) virtual |
void |
_font_set_kerning(font_rid: RID, size: int, glyph_pair: Vector2i, kerning: Vector2) virtual |
void |
_font_set_language_support_override(font_rid: RID, language: String, supported: bool) virtual |
void |
_font_set_modulate_color_glyphs(font_rid: RID, modulate: bool) virtual |
void |
_font_set_msdf_pixel_range(font_rid: RID, msdf_pixel_range: int) virtual |
void |
_font_set_msdf_size(font_rid: RID, msdf_size: int) virtual |
void |
_font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool) virtual |
void |
_font_set_name(font_rid: RID, name: String) virtual |
void |
_font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary) virtual |
void |
_font_set_oversampling(font_rid: RID, oversampling: float) virtual |
void |
_font_set_palette_custom_colors(font_rid: RID, colors: PackedColorArray) virtual |
void |
_font_set_scale(font_rid: RID, size: int, scale: float) virtual required |
void |
_font_set_script_support_override(font_rid: RID, script: String, supported: bool) virtual |
void |
_font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) virtual |
void |
_font_set_stretch(font_rid: RID, stretch: int) virtual |
void |
_font_set_style(font_rid: RID, style: BitField[FontStyle]) virtual |
void |
_font_set_style_name(font_rid: RID, name_style: String) virtual |
void |
_font_set_subpixel_positioning(font_rid: RID, subpixel_positioning: SubpixelPositioning) virtual |
void |
_font_set_texture_image(font_rid: RID, size: Vector2i, texture_index: int, image: Image) virtual required |
void |
_font_set_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int, offset: PackedInt32Array) virtual |
void |
_font_set_transform(font_rid: RID, transform: Transform2D) virtual |
void |
_font_set_underline_position(font_rid: RID, size: int, underline_position: float) virtual required |
void |
_font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) virtual required |
void |
_font_set_used_palette(font_rid: RID, index: int) virtual |
void |
_font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) virtual |
void |
_font_set_weight(font_rid: RID, weight: int) virtual |
_font_supported_feature_list(font_rid: RID) virtual const |
|
_font_supported_variation_list(font_rid: RID) virtual const |
|
_font_validate(font_rid: RID) virtual const |
|
_format_number(number: String, language: String) virtual const |
|
void |
|
_get_features() virtual required const |
|
_get_hex_code_box_size(size: int, index: int) virtual const |
|
_get_name() virtual required const |
|
_get_short_name() virtual const |
|
_get_support_data() virtual const |
|
_get_support_data_filename() virtual const |
|
_get_support_data_info() virtual const |
|
_has_feature(feature: Feature) virtual required const |
|
_is_confusable(string: String, dict: PackedStringArray) virtual const |
|
_is_locale_right_to_left(locale: String) virtual const |
|
_is_locale_using_support_data(locale: String) virtual const |
|
_is_valid_identifier(string: String) virtual const |
|
_is_valid_letter(unicode: int) virtual const |
|
_load_support_data(filename: String) virtual |
|
_name_to_tag(name: String) virtual const |
|
_parse_number(number: String, language: String) virtual const |
|
_parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) virtual const |
|
_percent_sign(language: String) virtual const |
|
void |
_reference_oversampling_level(oversampling: float) virtual |
_save_support_data(filename: String) virtual const |
|
_shaped_get_run_count(shaped: RID) virtual const |
|
_shaped_get_run_direction(shaped: RID, index: int) virtual const |
|
_shaped_get_run_font_rid(shaped: RID, index: int) virtual const |
|
_shaped_get_run_font_size(shaped: RID, index: int) virtual const |
|
_shaped_get_run_glyph_range(shaped: RID, index: int) virtual const |
|
_shaped_get_run_language(shaped: RID, index: int) virtual const |
|
_shaped_get_run_object(shaped: RID, index: int) virtual const |
|
_shaped_get_run_range(shaped: RID, index: int) virtual const |
|
_shaped_get_run_text(shaped: RID, index: int) virtual const |
|
_shaped_get_span_count(shaped: RID) virtual required const |
|
_shaped_get_span_embedded_object(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_meta(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_object(shaped: RID, index: int) virtual required const |
|
_shaped_get_span_text(shaped: RID, index: int) virtual required const |
|
_shaped_get_text(shaped: RID) virtual required const |
|
void |
_shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary) virtual required |
_shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, length: int, baseline: float) virtual required |
|
_shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary, language: String, meta: Variant) virtual required |
|
void |
_shaped_text_clear(shaped: RID) virtual required |
_shaped_text_closest_character_pos(shaped: RID, pos: int) virtual const |
|
void |
_shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, color: Color, oversampling: float) virtual const |
void |
_shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, outline_size: int, color: Color, oversampling: float) virtual const |
_shaped_text_duplicate(shaped: RID) virtual required |
|
_shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag]) virtual |
|
_shaped_text_get_ascent(shaped: RID) virtual required const |
|
void |
_shaped_text_get_carets(shaped: RID, position: int, r_caret: |
_shaped_text_get_character_breaks(shaped: RID) virtual const |
|
_shaped_text_get_custom_ellipsis(shaped: RID) virtual const |
|
_shaped_text_get_custom_punctuation(shaped: RID) virtual const |
|
_shaped_text_get_descent(shaped: RID) virtual required const |
|
_shaped_text_get_direction(shaped: RID) virtual const |
|
_shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) virtual const |
|
_shaped_text_get_ellipsis_glyph_count(shaped: RID) virtual required const |
|
|
_shaped_text_get_ellipsis_glyphs(shaped: RID) virtual required const |
_shaped_text_get_ellipsis_pos(shaped: RID) virtual required const |
|
_shaped_text_get_glyph_count(shaped: RID) virtual required const |
|
|
_shaped_text_get_glyphs(shaped: RID) virtual required const |
_shaped_text_get_grapheme_bounds(shaped: RID, pos: int) virtual const |
|
_shaped_text_get_inferred_direction(shaped: RID) virtual const |
|
_shaped_text_get_line_breaks(shaped: RID, width: float, start: int, break_flags: BitField[LineBreakFlag]) virtual const |
|
_shaped_text_get_line_breaks_adv(shaped: RID, width: PackedFloat32Array, start: int, once: bool, break_flags: BitField[LineBreakFlag]) virtual const |
|
_shaped_text_get_object_glyph(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_object_range(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_object_rect(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_get_objects(shaped: RID) virtual required const |
|
_shaped_text_get_orientation(shaped: RID) virtual const |
|
_shaped_text_get_parent(shaped: RID) virtual required const |
|
_shaped_text_get_preserve_control(shaped: RID) virtual const |
|
_shaped_text_get_preserve_invalid(shaped: RID) virtual const |
|
_shaped_text_get_range(shaped: RID) virtual required const |
|
_shaped_text_get_selection(shaped: RID, start: int, end: int) virtual const |
|
_shaped_text_get_size(shaped: RID) virtual required const |
|
_shaped_text_get_spacing(shaped: RID, spacing: SpacingType) virtual const |
|
_shaped_text_get_trim_pos(shaped: RID) virtual required const |
|
_shaped_text_get_underline_position(shaped: RID) virtual required const |
|
_shaped_text_get_underline_thickness(shaped: RID) virtual required const |
|
_shaped_text_get_width(shaped: RID) virtual required const |
|
_shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag], skip_grapheme_flags: BitField[GraphemeFlag]) virtual const |
|
_shaped_text_has_object(shaped: RID, key: Variant) virtual required const |
|
_shaped_text_hit_test_grapheme(shaped: RID, coord: float) virtual const |
|
_shaped_text_hit_test_position(shaped: RID, coord: float) virtual const |
|
_shaped_text_is_ready(shaped: RID) virtual required const |
|
_shaped_text_next_character_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_next_grapheme_pos(shaped: RID, pos: int) virtual const |
|
void |
_shaped_text_overrun_trim_to_width(shaped: RID, width: float, trim_flags: BitField[TextOverrunFlag]) virtual |
_shaped_text_prev_character_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_prev_grapheme_pos(shaped: RID, pos: int) virtual const |
|
_shaped_text_resize_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, baseline: float) virtual required |
|
void |
_shaped_text_set_bidi_override(shaped: RID, override: Array) virtual |
void |
_shaped_text_set_custom_ellipsis(shaped: RID, char: int) virtual |
void |
_shaped_text_set_custom_punctuation(shaped: RID, punct: String) virtual |
void |
_shaped_text_set_direction(shaped: RID, direction: Direction) virtual |
void |
_shaped_text_set_orientation(shaped: RID, orientation: Orientation) virtual |
void |
_shaped_text_set_preserve_control(shaped: RID, enabled: bool) virtual |
void |
_shaped_text_set_preserve_invalid(shaped: RID, enabled: bool) virtual |
void |
_shaped_text_set_spacing(shaped: RID, spacing: SpacingType, value: int) virtual |
_shaped_text_shape(shaped: RID) virtual required |
|
|
_shaped_text_sort_logical(shaped: RID) virtual required |
_shaped_text_substr(shaped: RID, start: int, length: int) virtual required const |
|
_shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) virtual |
|
_shaped_text_update_breaks(shaped: RID) virtual |
|
_shaped_text_update_justification_ops(shaped: RID) virtual |
|
_spoof_check(string: String) virtual const |
|
_string_get_character_breaks(string: String, language: String) virtual const |
|
_string_get_word_breaks(string: String, language: String, chars_per_line: int) virtual const |
|
_string_to_lower(string: String, language: String) virtual const |
|
_string_to_title(string: String, language: String) virtual const |
|
_string_to_upper(string: String, language: String) virtual const |
|
_strip_diacritics(string: String) virtual const |
|
_tag_to_name(tag: int) virtual const |
|
void |
_unreference_oversampling_level(oversampling: float) virtual |
方法說明
void _cleanup() virtual 🔗
注銷文字伺服器前會呼叫該方法。
RID _create_font() virtual required 🔗
新建空的字型快取條目資源。
RID _create_font_linked_variation(font_rid: RID) virtual 🔗
可選,如果字型支援額外間距或基線偏移,則實作該方法。
建立一個新的已有字型變體,該字型重複使用相同的字形快取和字型資料。
RID _create_shaped_text(direction: Direction, orientation: Orientation) virtual required 🔗
使用給定的方向 direction 和朝向 orientation 新建用於複雜排版的緩衝。
void _draw_hex_code_box(canvas: RID, size: int, pos: Vector2, index: int, color: Color) virtual const 🔗
繪製顯示字元十六進位程式碼的方框。
void _font_clear_glyphs(font_rid: RID, size: Vector2i) virtual required 🔗
從快取條目中移除所有渲染字形資訊。
void _font_clear_kerning_map(font_rid: RID, size: int) virtual 🔗
移除所有字距調整覆蓋。
void _font_clear_size_cache(font_rid: RID) virtual required 🔗
從快取條目中移除所有的字形大小。
void _font_clear_system_fallback_cache() virtual 🔗
釋放所有自動載入的系統字型。
void _font_clear_textures(font_rid: RID, size: Vector2i) virtual required 🔗
從快取條目中移除所有紋理。
void _font_draw_glyph(font_rid: RID, canvas: RID, size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const 🔗
使用字型 font_rid 和大小 size 在畫布項中的指定位置繪製單個字形。如果 oversampling 大於零,則會將其作為字型過取樣係數,否則使用視埠的過取樣設定。
void _font_draw_glyph_outline(font_rid: RID, canvas: RID, size: int, outline_size: int, pos: Vector2, index: int, color: Color, oversampling: float) virtual required const 🔗
使用字型 font_rid 與字型大小 size,在畫布項目的指定位置繪製外框大小為 outline_size 的單一字形外框。若 oversampling 大於零,則將它用作字型過取樣係數;否則使用視埠的過取樣設定。
FontAntialiasing _font_get_antialiasing(font_rid: RID) virtual const 🔗
返回字形的反鋸齒模式。
float _font_get_ascent(font_rid: RID, size: int) virtual required const 🔗
返回字形的上升幅度(超出基線的圖元數)。
float _font_get_baseline_offset(font_rid: RID) virtual const 🔗
回傳額外的基線偏移(作為字型高度的一部分)。
int _font_get_char_from_glyph_index(font_rid: RID, size: int, glyph_index: int) virtual required const 🔗
回傳與 glyph_index 關聯的字元程式碼,如果 glyph_index 無效則回傳 0。
float _font_get_descent(font_rid: RID, size: int) virtual required const 🔗
返回字形的減少量(低於基線的圖元數)。
bool _font_get_disable_embedded_bitmaps(font_rid: RID) virtual const 🔗
回傳字型是否僅用了內嵌點陣圖載入。
float _font_get_embolden(font_rid: RID) virtual const 🔗
返回字形的加粗力度。
int _font_get_face_count(font_rid: RID) virtual const 🔗
返回 TrueType / OpenType 集合中的字形數。
int _font_get_face_index(font_rid: RID) virtual const 🔗
返回 TrueType / OpenType 集合中的活動字形索引。
int _font_get_fixed_size(font_rid: RID) virtual required const 🔗
返回點陣字型的固定大小。
FixedSizeScaleMode _font_get_fixed_size_scale_mode(font_rid: RID) virtual required const 🔗
回傳點陣圖字型的縮放模式。
bool _font_get_generate_mipmaps(font_rid: RID) virtual const 🔗
如果啟用了字形紋理 mipmap 生成,則返回 true。
float _font_get_global_oversampling() virtual const 🔗
返回字形過取樣係數,由 TextServer 中的所有字形共用。
Vector2 _font_get_glyph_advance(font_rid: RID, size: int, glyph: int) virtual required const 🔗
回傳字形的推進量(下一個字形的偏移量)。
Dictionary _font_get_glyph_contours(font_rid: RID, size: int, index: int) virtual const 🔗
回傳字形的輪廓。
int _font_get_glyph_index(font_rid: RID, size: int, char: int, variation_selector: int) virtual required const 🔗
返回 char 的字形索引,可以用 variation_selector 修改。
PackedInt32Array _font_get_glyph_list(font_rid: RID, size: Vector2i) virtual required const 🔗
返回快取條目中的已渲染字形列表。
Vector2 _font_get_glyph_offset(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回字形的基線偏移量。
Vector2 _font_get_glyph_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回該字形的大小。
int _font_get_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回包含該字形的快取紋理的索引。
RID _font_get_glyph_texture_rid(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
回傳包含該字形的快取紋理的資源 ID。
Vector2 _font_get_glyph_texture_size(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
回傳包含該字形的快取紋理的大小。
Rect2 _font_get_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int) virtual required const 🔗
返回包含該字形的快取紋理中的矩形。
Hinting _font_get_hinting(font_rid: RID) virtual const 🔗
返回字形微調模式。僅用於動態字形。
bool _font_get_keep_rounding_remainders(font_rid: RID) virtual const 🔗
回傳字形位置的捨入行為。如果設為 true,在將字形對齊到像素邊界時會累積余數,確保字形分布更加均勻。如果啟用了次像素定位,則該設定無效。
Vector2 _font_get_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual const 🔗
返回字形對的字距調整。
Array[Vector2i] _font_get_kerning_list(font_rid: RID, size: int) virtual const 🔗
返回字距調整覆蓋的列表。
bool _font_get_language_support_override(font_rid: RID, language: String) virtual 🔗
如果為 language 啟用了支援覆蓋,則返回 true。
PackedStringArray _font_get_language_support_overrides(font_rid: RID) virtual 🔗
返回語言支援覆蓋的列表。
int _font_get_msdf_pixel_range(font_rid: RID) virtual const 🔗
返回最小和最大可表示有符號距離之間形狀周圍範圍的寬度。
int _font_get_msdf_size(font_rid: RID) virtual const 🔗
返回用於生成 MSDF 紋理的源字形大小。
String _font_get_name(font_rid: RID) virtual const 🔗
返回字形家族名稱。
Dictionary _font_get_opentype_feature_overrides(font_rid: RID) virtual const 🔗
返回字形 OpenType 功能集覆蓋。
Dictionary _font_get_ot_name_strings(font_rid: RID) virtual const 🔗
返回 OpenType 字形名稱字串的 Dictionary(當地語系化的字形名稱、版本、描述、許可資訊、範例文字等)。
float _font_get_oversampling(font_rid: RID) virtual const 🔗
回傳過取樣係數覆蓋值。如果設為正數,則會覆蓋使用該字型的視埠的過取樣係數。見 Viewport.oversampling。該值不會覆蓋 draw_* 方法的 oversampling 參數。僅適用於動態字型。
PackedColorArray _font_get_palette_colors(font_rid: RID, index: int) virtual const 🔗
回傳 index 處預定義顏色調色板中的陣列。調色板包含用於渲染字型字形的所有顏色。每個調色板的顏色數量均相同。可以使用 _font_set_palette_custom_colors() 方法重寫顏色。
int _font_get_palette_count(font_rid: RID) virtual const 🔗
回傳預定義顏色調色板的數量。調色板包含用於渲染字型字形的所有顏色。每個調色板的顏色數量相同。
PackedColorArray _font_get_palette_custom_colors(font_rid: RID) virtual const 🔗
回傳用於覆蓋預定義調色板的自訂顏色陣列。
String _font_get_palette_name(font_rid: RID, index: int) virtual const 🔗
回傳 index 處預定義顏色調色板的名稱。調色板包含用於渲染字型字形的所有顏色。每個調色板的顏色數量相同。
float _font_get_scale(font_rid: RID, size: int) virtual required const 🔗
返回顏色點陣字型的縮放係數。
bool _font_get_script_support_override(font_rid: RID, script: String) virtual 🔗
如果為 script 啟用了支援覆蓋,則返回 true。
PackedStringArray _font_get_script_support_overrides(font_rid: RID) virtual 🔗
返回文字支援覆蓋的列表。
Array[Dictionary] _font_get_size_cache_info(font_rid: RID) virtual const 🔗
回傳字型快取資訊,每個條目都包含以下欄位:Vector2i size_px - 字型大小,單位為像素,float viewport_oversampling - 視埠過取樣係數,int glyphs - 已渲染的字形數,int textures - 已使用的紋理數,int textures_size - 紋理資料大小,單位為位元組。
Array[Vector2i] _font_get_size_cache_list(font_rid: RID) virtual required const 🔗
回傳快取中字型大小的清單。每個大小都是由字型大小和輪廓大小組成的 Vector2i。
int _font_get_spacing(font_rid: RID, spacing: SpacingType) virtual const 🔗
回傳 spacing 的間距,單位為像素(與字型大小無關)。
int _font_get_stretch(font_rid: RID) virtual const 🔗
返回與正常寬度相比的字形拉伸量。一個介於 50% 和 200% 之間的百分比值。
BitField[FontStyle] _font_get_style(font_rid: RID) virtual const 🔗
回傳字型樣式標誌。
String _font_get_style_name(font_rid: RID) virtual const 🔗
返回字形樣式名稱。
SubpixelPositioning _font_get_subpixel_positioning(font_rid: RID) virtual const 🔗
返回字形的次圖元字形定位模式。
String _font_get_supported_chars(font_rid: RID) virtual required const 🔗
返回包含字形中所有可用字元的字串。
PackedInt32Array _font_get_supported_glyphs(font_rid: RID) virtual required const 🔗
回傳包含字型中所有字形索引的陣列。
int _font_get_texture_count(font_rid: RID, size: Vector2i) virtual required const 🔗
返回字形快取條目所使用的紋理數。
Image _font_get_texture_image(font_rid: RID, size: Vector2i, texture_index: int) virtual required const 🔗
返回字形快取紋理影像資料。
PackedInt32Array _font_get_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int) virtual const 🔗
返回包含字形打包資料的陣列。
Transform2D _font_get_transform(font_rid: RID) virtual const 🔗
返回套用於字形輪廓的 2D 變換。
float _font_get_underline_position(font_rid: RID, size: int) virtual required const 🔗
返回基線下方底線的圖元偏移。
float _font_get_underline_thickness(font_rid: RID, size: int) virtual required const 🔗
返回底線的粗細度,單位為圖元。
int _font_get_used_palette(font_rid: RID) virtual const 🔗
回傳已使用的調色板索引。
Dictionary _font_get_variation_coordinates(font_rid: RID) virtual const 🔗
回傳指定字型快取條目的變體座標。
int _font_get_weight(font_rid: RID) virtual const 🔗
返回該字形的字重(粗度)。一個在 100...999 範圍內的值,正常字形字重為 400,粗體字形字重為 700。
bool _font_has_char(font_rid: RID, char: int) virtual required const 🔗
如果該字形中包含 Unicode 字元 char,則返回 true。
bool _font_is_allow_system_fallback(font_rid: RID) virtual const 🔗
如果可以自動使用系統字形作為退回字形,則返回 true。
bool _font_is_force_autohinter(font_rid: RID) virtual const 🔗
如果設定為 true,則支援自動微調,優先於字型內建微調。
bool _font_is_language_supported(font_rid: RID, language: String) virtual const 🔗
如果該字型支援給定的語言(以 ISO 639 碼),則回傳 true。
bool _font_is_modulate_color_glyphs(font_rid: RID) virtual const 🔗
如果繪製字型彩色字形時應用了顏色調制,則回傳 true。
bool _font_is_multichannel_signed_distance_field(font_rid: RID) virtual const 🔗
如果使用從動態字形向量資料生成的單個多通道有符號距離場渲染所有大小的字形,則返回 true。
bool _font_is_script_supported(font_rid: RID, script: String) virtual const 🔗
如果該字型支援給定的文字(以 ISO 15924 碼),則回傳 true。
void _font_remove_glyph(font_rid: RID, size: Vector2i, glyph: int) virtual required 🔗
從快取條目中移除指定的字型大小。
void _font_remove_kerning(font_rid: RID, size: int, glyph_pair: Vector2i) virtual 🔗
移除字形對的字距調整覆蓋。
void _font_remove_language_support_override(font_rid: RID, language: String) virtual 🔗
移除語言支援覆蓋。
void _font_remove_script_support_override(font_rid: RID, script: String) virtual 🔗
移除文字支援覆蓋。
void _font_remove_size_cache(font_rid: RID, size: Vector2i) virtual required 🔗
從快取條目中移除指定的字形大小。
void _font_remove_texture(font_rid: RID, size: Vector2i, texture_index: int) virtual required 🔗
從快取條目中移除指定的紋理。
void _font_render_glyph(font_rid: RID, size: Vector2i, index: int) virtual 🔗
將指定的字元渲染到字形快取紋理。
void _font_render_range(font_rid: RID, size: Vector2i, start: int, end: int) virtual 🔗
將範圍內的字元渲染到字形快取紋理。
void _font_set_allow_system_fallback(font_rid: RID, allow_system_fallback: bool) virtual 🔗
如果設定為 true,則可以自動將系統字形作為退回使用。
void _font_set_antialiasing(font_rid: RID, antialiasing: FontAntialiasing) virtual 🔗
使用字形反鋸齒模式。
void _font_set_ascent(font_rid: RID, size: int, ascent: float) virtual required 🔗
設定字形的升部(基線上方的圖元數)。
void _font_set_baseline_offset(font_rid: RID, baseline_offset: float) virtual 🔗
設定額外的基線偏移(作為字型高度的一部分)。
void _font_set_data(font_rid: RID, data: PackedByteArray) virtual 🔗
設定字形來源資料,例如動態字形的原始檔案內容。
void _font_set_data_ptr(font_rid: RID, data_ptr: const uint8_t*, data_size: int) virtual 🔗
設定字型來源資料指針,例如動態字型的原始檔內容。
void _font_set_descent(font_rid: RID, size: int, descent: float) virtual required 🔗
設定字形的降部(基線下方的圖元數)。
void _font_set_disable_embedded_bitmaps(font_rid: RID, disable_embedded_bitmaps: bool) virtual 🔗
如果設定為 true,則停用內嵌字型點陣圖的載入。
void _font_set_embolden(font_rid: RID, strength: float) virtual 🔗
設定字形的加粗強度。如果 strength 不等於零,則會加粗字形輪廓。負值會減小輪廓的粗細度。
void _font_set_face_index(font_rid: RID, face_index: int) virtual 🔗
在 TrueType / OpenType 集合中設定活動字形索引。
void _font_set_fixed_size(font_rid: RID, fixed_size: int) virtual required 🔗
設定點陣字型的固定大小。如果設定為大於零的值,則會為所有字形大小使用相同的快取條目。
void _font_set_fixed_size_scale_mode(font_rid: RID, fixed_size_scale_mode: FixedSizeScaleMode) virtual required 🔗
設定點陣圖字型縮放模式。僅當 fixed_size 大於零時才使用該屬性。
void _font_set_force_autohinter(font_rid: RID, force_autohinter: bool) virtual 🔗
如果設定為 true,則優先使用自動微調,而不是字形的內建微調。
void _font_set_generate_mipmaps(font_rid: RID, generate_mipmaps: bool) virtual 🔗
如果設定為 true,則啟用字形紋理 mipmap 生成。
void _font_set_global_oversampling(oversampling: float) virtual 🔗
回傳過取樣係數,由 TextServer 中的所有字型共享。
void _font_set_glyph_advance(font_rid: RID, size: int, glyph: int, advance: Vector2) virtual required 🔗
設定字形推進(下一個字形的偏移量)。
void _font_set_glyph_offset(font_rid: RID, size: Vector2i, glyph: int, offset: Vector2) virtual required 🔗
設定字形相對於基線的偏移量。
void _font_set_glyph_size(font_rid: RID, size: Vector2i, glyph: int, gl_size: Vector2) virtual required 🔗
設定字形的大小。
void _font_set_glyph_texture_idx(font_rid: RID, size: Vector2i, glyph: int, texture_idx: int) virtual required 🔗
設定包含該字形的快取紋理的索引。
void _font_set_glyph_uv_rect(font_rid: RID, size: Vector2i, glyph: int, uv_rect: Rect2) virtual required 🔗
設定包含該字形的快取紋理中,該字形的矩形區域。
void _font_set_hinting(font_rid: RID, hinting: Hinting) virtual 🔗
設定字形微調模式。僅由動態字形使用。
void _font_set_keep_rounding_remainders(font_rid: RID, keep_rounding_remainders: bool) virtual 🔗
設定字形位置的捨入行為。如果設為 true,則會將字形與像素邊界對齊時的捨入余數進行累積,確保字形分布更為均勻。啟用次像素定位時該設定無效。
void _font_set_kerning(font_rid: RID, size: int, glyph_pair: Vector2i, kerning: Vector2) virtual 🔗
設定字形對的字距調整。
void _font_set_language_support_override(font_rid: RID, language: String, supported: bool) virtual 🔗
為 _font_is_language_supported() 新增覆蓋。
void _font_set_modulate_color_glyphs(font_rid: RID, modulate: bool) virtual 🔗
如果設為 true,則繪製彩色字形時會應用顏色調制,否則只會對灰度字形應用。
void _font_set_msdf_pixel_range(font_rid: RID, msdf_pixel_range: int) virtual 🔗
設定最小和最大可表示有符號距離之間形狀周圍範圍的寬度。
void _font_set_msdf_size(font_rid: RID, msdf_size: int) virtual 🔗
設定用於生成 MSDF 紋理的源字形大小。
void _font_set_multichannel_signed_distance_field(font_rid: RID, msdf: bool) virtual 🔗
如果設定為 true,則所有大小的字形都使用從動態字型向量資料生成的單個多通道帶符號距離場進行渲染。MSDF 渲染能夠使用任意縮放係數顯示字型,字型不會變得模糊,字型大小的改變也不會消耗 CPU 的效能(因為字型不再需要在 CPU 上進行光柵化)。缺點是MSDF 無法使用字型微調。缺少字型微調時,銳度可能降低,較小的字型可能不易閱讀。
void _font_set_name(font_rid: RID, name: String) virtual 🔗
設定該字形的家族名稱。
void _font_set_opentype_feature_overrides(font_rid: RID, overrides: Dictionary) virtual 🔗
設定字形 OpenType 功能集覆蓋。
void _font_set_oversampling(font_rid: RID, oversampling: float) virtual 🔗
如果設為正數,則會覆蓋使用該字型的視埠的過取樣係數。見 Viewport.oversampling。該值不會覆蓋 draw_* 方法的 oversampling 參數。僅適用於動態字型。
void _font_set_palette_custom_colors(font_rid: RID, colors: PackedColorArray) virtual 🔗
設定自訂顏色陣列以覆蓋預定義調色板。設定為空陣列可重設覆蓋。使用 Color(0, 0, 0, 0) 以保留特定位置的預定義調色板顏色。
void _font_set_scale(font_rid: RID, size: int, scale: float) virtual required 🔗
設定彩色點陣字型的縮放係數。
void _font_set_script_support_override(font_rid: RID, script: String, supported: bool) virtual 🔗
為 _font_is_script_supported() 新增覆蓋。
void _font_set_spacing(font_rid: RID, spacing: SpacingType, value: int) virtual 🔗
將 spacing 的間距設定為 value,單位為像素(與字型大小無關)。
void _font_set_stretch(font_rid: RID, stretch: int) virtual 🔗
設定與正常寬度相比的字型拉伸量,是一個在 50% 和 200% 之間的百分比值。
void _font_set_style(font_rid: RID, style: BitField[FontStyle]) virtual 🔗
設定字型的樣式標誌。
void _font_set_style_name(font_rid: RID, name_style: String) virtual 🔗
設定字形的樣式名稱。
void _font_set_subpixel_positioning(font_rid: RID, subpixel_positioning: SubpixelPositioning) virtual 🔗
設定字形的次圖元字形定位模式。
void _font_set_texture_image(font_rid: RID, size: Vector2i, texture_index: int, image: Image) virtual required 🔗
設定字形的快取紋理影像資料。
void _font_set_texture_offsets(font_rid: RID, size: Vector2i, texture_index: int, offset: PackedInt32Array) virtual 🔗
設定包含字形打包資料的陣列。
void _font_set_transform(font_rid: RID, transform: Transform2D) virtual 🔗
設定套用至字型輪廓的 2D 變換,可用於傾斜、翻轉、旋轉字形。
void _font_set_underline_position(font_rid: RID, size: int, underline_position: float) virtual required 🔗
設定基線下方底線的圖元偏移。
void _font_set_underline_thickness(font_rid: RID, size: int, underline_thickness: float) virtual required 🔗
設定底線的粗細度,單位為圖元。
void _font_set_used_palette(font_rid: RID, index: int) virtual 🔗
設定已使用的調色板索引。
void _font_set_variation_coordinates(font_rid: RID, variation_coordinates: Dictionary) virtual 🔗
為指定的字型快取條目設定變體座標。
void _font_set_weight(font_rid: RID, weight: int) virtual 🔗
設定字型的字重(粗度),是一個在 100...999 範圍內的值。正常字型字重為 400,粗體字型字重為 700。
Dictionary _font_supported_feature_list(font_rid: RID) virtual const 🔗
返回支援的 OpenType 功能的字典。
Dictionary _font_supported_variation_list(font_rid: RID) virtual const 🔗
返回支援的 OpenType 變體座標的字典。
bool _font_validate(font_rid: RID) virtual const 🔗
Returns true if the font data is valid.
String _format_number(number: String, language: String) virtual const 🔗
已棄用: Use TranslationServer.format_number() instead.
將數字從西阿拉伯數字(0..9)轉換為給定 language 中使用的記數系統。
如果 language 為空字串,則會使用啟用的區域設定。
void _free_rid(rid: RID) virtual required 🔗
釋放由該 TextServer 建立的某個對象。
int _get_features() virtual required const 🔗
回傳文字伺服器的特性,見 Feature。
Vector2 _get_hex_code_box_size(size: int, index: int) virtual const 🔗
返回替換字元的大小(在無效字元處繪製的帶十六進位字元程式碼的框)。
String _get_name() virtual required const 🔗
返回該伺服器介面的名稱。
String _get_short_name() virtual const 🔗
Returns the short name of the server interface. By convention, this should return a lowercase string that follows the snake_case naming scheme.
PackedByteArray _get_support_data() virtual const 🔗
回傳預設的 TextServer 資料庫(例如 ICU 中斷迭代器和字典)。
String _get_support_data_filename() virtual const 🔗
返回預設的 TextServer 資料庫(例如 ICU 中斷反覆運算器和字典)檔案名。
String _get_support_data_info() virtual const 🔗
返回 TextServer 資料庫(例如 ICU 中斷反覆運算器和字典)的描述。
bool _has(rid: RID) virtual required 🔗
如果 rid 是該文字伺服器擁有的有效資源,則返回 true。
bool _has_feature(feature: Feature) virtual required const 🔗
如果伺服器支援某個功能,則返回 true。
int _is_confusable(string: String, dict: PackedStringArray) virtual const 🔗
回傳 dict 中第一個與 string 在視覺上可能產生混淆的字串的索引,如果沒有找到則回傳 -1。
bool _is_locale_right_to_left(locale: String) virtual const 🔗
如果區域設定為從右至左,則返回 true。
bool _is_locale_using_support_data(locale: String) virtual const 🔗
如果區域設定需要文字伺服器支援資料以進行斷行、斷詞,則回傳 true。
bool _is_valid_identifier(string: String) virtual const 🔗
如果 string 是有效的標識符,則回傳 true。
bool _is_valid_letter(unicode: int) virtual const 🔗
There is currently no description for this method. Please help us by contributing one!
bool _load_support_data(filename: String) virtual 🔗
載入可選的 TextServer 資料庫(例如 ICU 中斷迭代器和字典)。
int _name_to_tag(name: String) virtual const 🔗
將給定的特性、變體、文字、語言的可讀名稱轉換為 OpenType 標記。
String _parse_number(number: String, language: String) virtual const 🔗
已棄用: Use TranslationServer.parse_number() instead.
將 number 從給定 language 所使用的記數系統轉換為西阿拉伯數字(0..9)。
如果 language 為空字串,則會使用啟用的區域設定。
Array[Vector3i] _parse_structured_text(parser_type: StructuredTextParser, args: Array, text: String) virtual const 🔗
BiDi 算法覆蓋函式的預設實作。
String _percent_sign(language: String) virtual const 🔗
已棄用: Use TranslationServer.get_percent_sign() instead.
回傳給定 language 中使用的百分號符號。
void _reference_oversampling_level(oversampling: float) virtual 🔗
將指定過取樣等級的參照計數調大。該方法由 Viewport 呼叫,不應直接使用。
bool _save_support_data(filename: String) virtual const 🔗
將可選的 TextServer 資料庫(例如 ICU 中斷迭代器和字典)儲存至檔案。
int _shaped_get_run_count(shaped: RID) virtual const 🔗
回傳緩衝中統一文字行程的個數。
Direction _shaped_get_run_direction(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的方向。
RID _shaped_get_run_font_rid(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的字型 RID。
int _shaped_get_run_font_size(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的字型大小。
Vector2i _shaped_get_run_glyph_range(shaped: RID, index: int) virtual const 🔗
回傳 index 文字執行(text run)的字形範圍(按視覺順序)。
String _shaped_get_run_language(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的語言。
Variant _shaped_get_run_object(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的內嵌物件。
Vector2i _shaped_get_run_range(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的源文字範圍。
String _shaped_get_run_text(shaped: RID, index: int) virtual const 🔗
回傳索引為 index 的文字行程(按顯示順序)的源文字。
int _shaped_get_span_count(shaped: RID) virtual required const 🔗
回傳使用 _shaped_text_add_string() 或 _shaped_text_add_object() 新增的文字區間的數量。
Variant _shaped_get_span_embedded_object(shaped: RID, index: int) virtual required const 🔗
回傳文字內嵌物件的鍵。
Variant _shaped_get_span_meta(shaped: RID, index: int) virtual required const 🔗
返回文字區間的中繼資料。
Variant _shaped_get_span_object(shaped: RID, index: int) virtual required const 🔗
回傳文字區間內嵌物件的鍵。
String _shaped_get_span_text(shaped: RID, index: int) virtual required const 🔗
回傳文字區間的源文字。
String _shaped_get_text(shaped: RID) virtual required const 🔗
回傳文字緩衝的源文字,包含物件替換字元。
void _shaped_set_span_update_font(shaped: RID, index: int, fonts: Array[RID], size: int, opentype_features: Dictionary) virtual required 🔗
在不更改文字的情況下,更改文字區間的字型、字型大小和 OpenType 特性。
bool _shaped_text_add_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, length: int, baseline: float) virtual required 🔗
向文字緩衝中新增行內物件,key 必須唯一。在文字中,物件使用 length 個物件替換字元表示。
bool _shaped_text_add_string(shaped: RID, text: String, fonts: Array[RID], size: int, opentype_features: Dictionary, language: String, meta: Variant) virtual required 🔗
新增文字區間和字形,將其繪製到文字緩衝中。
void _shaped_text_clear(shaped: RID) virtual required 🔗
清空文字緩衝(移除文字和行內物件)。
int _shaped_text_closest_character_pos(shaped: RID, pos: int) virtual const 🔗
返回距離 pos 最近的組合字元結束位置。
void _shaped_text_draw(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, color: Color, oversampling: float) virtual const 🔗
在畫布項的給定位置繪製塑形後的文字,顏色為 color。pos 指定的是基線的最左側(橫向排版)或基線的最頂部(縱向排版)。如果 oversampling 大於零則會用作字型過取樣係數,否則使用視埠的過取樣設定。
void _shaped_text_draw_outline(shaped: RID, canvas: RID, pos: Vector2, clip_l: float, clip_r: float, outline_size: int, color: Color, oversampling: float) virtual const 🔗
在畫布項的給定位置繪製塑形後的文字輪廓,顏色為 color。pos 指定的是基線的最左側(橫向排版)或基線的最頂部(縱向排版)。如果 oversampling 大於零則會用作字型過取樣係數,否則使用視埠的過取樣設定。
RID _shaped_text_duplicate(shaped: RID) virtual required 🔗
複製塑形文字緩衝區。
float _shaped_text_fit_to_width(shaped: RID, width: float, justification_flags: BitField[JustificationFlag]) virtual 🔗
兩端對齊文字以適合指定寬度,返回新的文字寬度。
float _shaped_text_get_ascent(shaped: RID) virtual required const 🔗
返回該文字的升部(水平排版時為基線上方的圖元數,垂直排版時為基線左側的圖元數)。
void _shaped_text_get_carets(shaped: RID, position: int, r_caret: CaretInfo*) virtual const 🔗
返回與文字中字元偏移 position 對應的文字游標的形狀。返回的游標形狀是寬度為 1 圖元的矩形。
PackedInt32Array _shaped_text_get_character_breaks(shaped: RID) virtual const 🔗
返回字形快取條目的數量。
int _shaped_text_get_custom_ellipsis(shaped: RID) virtual const 🔗
回傳文字裁剪時使用的省略字元。
String _shaped_text_get_custom_punctuation(shaped: RID) virtual const 🔗
返回自訂標點字元列表,用於斷字。如果被設定為空字串,則使用服務的預設值。
float _shaped_text_get_descent(shaped: RID) virtual required const 🔗
返回該文字的降部(水平排版時為基線下方的圖元數,垂直排版時為基線右側的圖元數)。
Direction _shaped_text_get_direction(shaped: RID) virtual const 🔗
返回文字的方向。
int _shaped_text_get_dominant_direction_in_range(shaped: RID, start: int, end: int) virtual const 🔗
返回文字範圍內的主要書寫方向。
int _shaped_text_get_ellipsis_glyph_count(shaped: RID) virtual required const 🔗
返回省略號中的字形數。
const Glyph* _shaped_text_get_ellipsis_glyphs(shaped: RID) virtual required const 🔗
返回省略號中的字形陣列。
int _shaped_text_get_ellipsis_pos(shaped: RID) virtual required const 🔗
返回省略號的位置。
int _shaped_text_get_glyph_count(shaped: RID) virtual required const 🔗
返回緩衝區中的字形數。
const Glyph* _shaped_text_get_glyphs(shaped: RID) virtual required const 🔗
返回字形陣列,按視覺順序排序。
Vector2 _shaped_text_get_grapheme_bounds(shaped: RID, pos: int) virtual const 🔗
將複合字元的邊界返回為距行首的偏移量。
Direction _shaped_text_get_inferred_direction(shaped: RID) virtual const 🔗
返回由 BiDi 演算法推斷的文字書寫方向。
PackedInt32Array _shaped_text_get_line_breaks(shaped: RID, width: float, start: int, break_flags: BitField[LineBreakFlag]) virtual const 🔗
對文字進行斷行,返回每一行的字元範圍。
PackedInt32Array _shaped_text_get_line_breaks_adv(shaped: RID, width: PackedFloat32Array, start: int, once: bool, break_flags: BitField[LineBreakFlag]) virtual const 🔗
將文字拆分為行和列。返回每段的字元範圍。
int _shaped_text_get_object_glyph(shaped: RID, key: Variant) virtual required const 🔗
回傳內聯物件的字形索引。
Vector2i _shaped_text_get_object_range(shaped: RID, key: Variant) virtual required const 🔗
回傳內聯物件的字元範圍。
Rect2 _shaped_text_get_object_rect(shaped: RID, key: Variant) virtual required const 🔗
返回行內對象的邊界矩形。
Array _shaped_text_get_objects(shaped: RID) virtual required const 🔗
返回行內物件的陣列。
Orientation _shaped_text_get_orientation(shaped: RID) virtual const 🔗
返回文字朝向。
RID _shaped_text_get_parent(shaped: RID) virtual required const 🔗
返回子字串源自哪個父緩衝區。
bool _shaped_text_get_preserve_control(shaped: RID) virtual const 🔗
如果文字緩衝區被配置為顯示控制字元,則返回 true。
bool _shaped_text_get_preserve_invalid(shaped: RID) virtual const 🔗
如果文字緩衝區被設定為顯示十六進位程式碼來代替無效字元,則回傳 true。
Vector2i _shaped_text_get_range(shaped: RID) virtual required const 🔗
返回父緩衝區中子字串緩衝區的字元範圍。
PackedVector2Array _shaped_text_get_selection(shaped: RID, start: int, end: int) virtual const 🔗
返回用於指定字元範圍的選區矩形。
Vector2 _shaped_text_get_size(shaped: RID) virtual required const 🔗
返回該文字的大小。
int _shaped_text_get_spacing(shaped: RID, spacing: SpacingType) virtual const 🔗
返回字形或行之間新增的額外間距,單位為圖元。
int _shaped_text_get_trim_pos(shaped: RID) virtual required const 🔗
返回超出修剪的位置。
float _shaped_text_get_underline_position(shaped: RID) virtual required const 🔗
返回基線下方底線的圖元偏移。
float _shaped_text_get_underline_thickness(shaped: RID) virtual required const 🔗
返回底線的粗細度。
float _shaped_text_get_width(shaped: RID) virtual required const 🔗
返回文字的寬度(對於水平排版)或高度(對於垂直排版)。
PackedInt32Array _shaped_text_get_word_breaks(shaped: RID, grapheme_flags: BitField[GraphemeFlag], skip_grapheme_flags: BitField[GraphemeFlag]) virtual const 🔗
將文字分解成單詞並回傳字元範圍的陣列。請使用 grapheme_flags 來設定哪些字元會被用於分解。
bool _shaped_text_has_object(shaped: RID, key: Variant) virtual required const 🔗
如果該塑形文字緩衝區中嵌入了具有 key 的物件,則回傳 true。
int _shaped_text_hit_test_grapheme(shaped: RID, coord: float) virtual const 🔗
返回字素的索引,該字素位於基線上指定圖元偏移的位置,如果沒有找到,則返回 -1。
int _shaped_text_hit_test_position(shaped: RID, coord: float) virtual const 🔗
返回基線處指定圖元偏移處的文字游標的偏移量。該函式始終返回一個有效位置。
bool _shaped_text_is_ready(shaped: RID) virtual required const 🔗
如果緩衝區成功塑形,則返回 true。
int _shaped_text_next_character_pos(shaped: RID, pos: int) virtual const 🔗
返回距離 pos 最近的組合字元結束位置。
int _shaped_text_next_grapheme_pos(shaped: RID, pos: int) virtual const 🔗
返回距離 pos 最近的組合字元結束位置。
void _shaped_text_overrun_trim_to_width(shaped: RID, width: float, trim_flags: BitField[TextOverrunFlag]) virtual 🔗
如果文字超出給定寬度,則修剪文字。
int _shaped_text_prev_character_pos(shaped: RID, pos: int) virtual const 🔗
返回距離 pos 最近的組合字元開始位置。
int _shaped_text_prev_grapheme_pos(shaped: RID, pos: int) virtual const 🔗
返回距離 pos 最近的組合字元開始位置。
bool _shaped_text_resize_object(shaped: RID, key: Variant, size: Vector2, inline_align: InlineAlignment, baseline: float) virtual required 🔗
設定內嵌物件的新大小和對齊方式。
void _shaped_text_set_bidi_override(shaped: RID, override: Array) virtual 🔗
為結構化文字設定 BiDi 算法覆蓋。
void _shaped_text_set_custom_ellipsis(shaped: RID, char: int) virtual 🔗
設定文字裁剪時使用的省略字元。
void _shaped_text_set_custom_punctuation(shaped: RID, punct: String) virtual 🔗
設定自訂標點字元列表,用於斷字。如果被設定為空字串,則使用服務的預設值。
void _shaped_text_set_direction(shaped: RID, direction: Direction) virtual 🔗
設定所需的文字方向。如果設定為 TextServer.DIRECTION_AUTO,方向將根據緩衝區的內容和目前的區域設定來檢測。
void _shaped_text_set_orientation(shaped: RID, orientation: Orientation) virtual 🔗
設定想要的文字朝向。
void _shaped_text_set_preserve_control(shaped: RID, enabled: bool) virtual 🔗
如果設定為 true,則文字緩衝區將顯示控制字元。
void _shaped_text_set_preserve_invalid(shaped: RID, enabled: bool) virtual 🔗
如果設定為 true,則文字緩衝區會將無效字元顯示為十六進位程式碼,否則不顯示任何內容。
void _shaped_text_set_spacing(shaped: RID, spacing: SpacingType, value: int) virtual 🔗
設定字形之間或行與行之間新增的額外圖元間距。
bool _shaped_text_shape(shaped: RID) virtual required 🔗
形狀緩衝區(如果未塑形)。如果字串塑形成功,則回傳 true。
const Glyph* _shaped_text_sort_logical(shaped: RID) virtual required 🔗
按邏輯順序返回文字字形。
RID _shaped_text_substr(shaped: RID, start: int, length: int) virtual required const 🔗
返回 shaped 文字緩衝區中字串的子字串的文字緩衝區(包括行內對象)。
float _shaped_text_tab_align(shaped: RID, tab_stops: PackedFloat32Array) virtual 🔗
將塑形文字與給定的定位停駐點對齊。
bool _shaped_text_update_breaks(shaped: RID) virtual 🔗
更新塑形文字中的斷點。該方法由分詞函式的預設實作呼叫。
bool _shaped_text_update_justification_ops(shaped: RID) virtual 🔗
更新塑形文字中的對齊點。該方法由文字對齊函式的預設實作呼叫。
bool _spoof_check(string: String) virtual const 🔗
如果 string 可能試圖混淆讀者,則回傳 true。
PackedInt32Array _string_get_character_breaks(string: String, language: String) virtual const 🔗
返回字形快取條目的數量。
PackedInt32Array _string_get_word_breaks(string: String, language: String, chars_per_line: int) virtual const 🔗
回傳分詞邊界的陣列。陣列中的元素是單詞起始位置和結束位置的偏移量。因此陣列的長度始終為偶數。
String _string_to_lower(string: String, language: String) virtual const 🔗
回傳將該字串轉換為小寫 lowercase 的結果。
String _string_to_title(string: String, language: String) virtual const 🔗
回傳轉換為 Title Case 的字串。
String _string_to_upper(string: String, language: String) virtual const 🔗
回傳將該字串轉換為大寫 UPPERCASE 的結果。
String _strip_diacritics(string: String) virtual const 🔗
從字串中剝離變音符號。
String _tag_to_name(tag: int) virtual const 🔗
將給定的 OpenType 標籤轉換為特性、變體、文字、語言的可讀名稱。
void _unreference_oversampling_level(oversampling: float) virtual 🔗
將指定過取樣等級的參照計數調小,計數變零時釋放過取樣等級的字型快取。該方法由 Viewport 呼叫,不應直接使用。