Files
godot-docs-l10n/classes/ru/class_systemfont.rst

376 lines
23 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_SystemFont:
SystemFont
==========
**Наследует:** :ref:`Font<class_Font>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Шрифт, загруженный из системного шрифта. Возвращается к шрифту темы по умолчанию, если он не реализован в хостовой ОС.
.. rst-class:: classref-introduction-group
Описание
----------------
**SystemFont** загружает шрифт из системного шрифта с первым совпадающим именем из :ref:`font_names<class_SystemFont_property_font_names>`.
Он попытается сопоставить стиль шрифта, но это не гарантируется.
Возвращаемый шрифт может быть частью коллекции шрифтов или быть переменным шрифтом с набором функций OpenType «weight», «width» и/или «italic».
Вы можете создать :ref:`FontVariation<class_FontVariation>` системного шрифта для точного управления его функциями.
\ **Примечание:** Этот класс реализован в iOS, Linux, macOS и Windows, на других платформах он будет возвращаться к шрифту темы по умолчанию.
.. rst-class:: classref-reftable-group
Свойства
----------------
.. table::
:widths: auto
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`allow_system_fallback<class_SystemFont_property_allow_system_fallback>` | ``true`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`antialiasing<class_SystemFont_property_antialiasing>` | ``1`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`disable_embedded_bitmaps<class_SystemFont_property_disable_embedded_bitmaps>` | ``true`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`font_italic<class_SystemFont_property_font_italic>` | ``false`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_names<class_SystemFont_property_font_names>` | ``PackedStringArray()`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>` | :ref:`font_stretch<class_SystemFont_property_font_stretch>` | ``100`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>` | :ref:`font_weight<class_SystemFont_property_font_weight>` | ``400`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`force_autohinter<class_SystemFont_property_force_autohinter>` | ``false`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`generate_mipmaps<class_SystemFont_property_generate_mipmaps>` | ``false`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`hinting<class_SystemFont_property_hinting>` | ``1`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`keep_rounding_remainders<class_SystemFont_property_keep_rounding_remainders>` | ``true`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`modulate_color_glyphs<class_SystemFont_property_modulate_color_glyphs>` | ``false`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>` | :ref:`msdf_pixel_range<class_SystemFont_property_msdf_pixel_range>` | ``16`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>` | :ref:`msdf_size<class_SystemFont_property_msdf_size>` | ``48`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>` | :ref:`multichannel_signed_distance_field<class_SystemFont_property_multichannel_signed_distance_field>` | ``false`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>` | :ref:`oversampling<class_SystemFont_property_oversampling>` | ``0.0`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
| :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`subpixel_positioning<class_SystemFont_property_subpixel_positioning>` | ``1`` |
+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описания свойств
--------------------------------
.. _class_SystemFont_property_allow_system_fallback:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **allow_system_fallback** = ``true`` :ref:`🔗<class_SystemFont_property_allow_system_fallback>`
.. rst-class:: classref-property-setget
- |void| **set_allow_system_fallback**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_allow_system_fallback**\ (\ )
Если задано значение ``true``, системные шрифты могут автоматически использоваться в качестве резервных.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_antialiasing:
.. rst-class:: classref-property
:ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **antialiasing** = ``1`` :ref:`🔗<class_SystemFont_property_antialiasing>`
.. rst-class:: classref-property-setget
- |void| **set_antialiasing**\ (\ value\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ )
- :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **get_antialiasing**\ (\ )
Способ сглаживания шрифтов.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_disable_embedded_bitmaps:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **disable_embedded_bitmaps** = ``true`` :ref:`🔗<class_SystemFont_property_disable_embedded_bitmaps>`
.. rst-class:: classref-property-setget
- |void| **set_disable_embedded_bitmaps**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_disable_embedded_bitmaps**\ (\ )
Если задано значение ``true``, загрузка встроенного растрового изображения шрифта отключена (только растровые и цветные шрифты игнорируют это свойство).
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_font_italic:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **font_italic** = ``false`` :ref:`🔗<class_SystemFont_property_font_italic>`
.. rst-class:: classref-property-setget
- |void| **set_font_italic**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_font_italic**\ (\ )
Если установлено значение ``true``, предпочтительным будет курсивный или наклонный шрифт.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_font_names:
.. rst-class:: classref-property
:ref:`PackedStringArray<class_PackedStringArray>` **font_names** = ``PackedStringArray()`` :ref:`🔗<class_SystemFont_property_font_names>`
.. rst-class:: classref-property-setget
- |void| **set_font_names**\ (\ value\: :ref:`PackedStringArray<class_PackedStringArray>`\ )
- :ref:`PackedStringArray<class_PackedStringArray>` **get_font_names**\ (\ )
Массив названий семейств шрифтов для поиска, используется первый найденный совпадающий шрифт.
**Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray<class_PackedStringArray>` for more details.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_font_stretch:
.. rst-class:: classref-property
:ref:`int<class_int>` **font_stretch** = ``100`` :ref:`🔗<class_SystemFont_property_font_stretch>`
.. rst-class:: classref-property-setget
- |void| **set_font_stretch**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_font_stretch**\ (\ )
Предпочтительная величина растяжения шрифта по сравнению с нормальной шириной. Процентное значение между ``50%`` и ``200%``.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_font_weight:
.. rst-class:: classref-property
:ref:`int<class_int>` **font_weight** = ``400`` :ref:`🔗<class_SystemFont_property_font_weight>`
.. rst-class:: classref-property-setget
- |void| **set_font_weight**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_font_weight**\ (\ )
Предпочтительная толщина (жирность) шрифта. Значение в диапазоне ``100...999``, нормальная толщина шрифта ``400``, жирная толщина шрифта ``700``.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_force_autohinter:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **force_autohinter** = ``false`` :ref:`🔗<class_SystemFont_property_force_autohinter>`
.. rst-class:: classref-property-setget
- |void| **set_force_autohinter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_force_autohinter**\ (\ )
Если установлено значение ``true``, поддерживается автоматическая подсказка (auto-hinting), которая имеет приоритет над встроенной подсказкой шрифта.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_generate_mipmaps:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **generate_mipmaps** = ``false`` :ref:`🔗<class_SystemFont_property_generate_mipmaps>`
.. rst-class:: classref-property-setget
- |void| **set_generate_mipmaps**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_generate_mipmaps**\ (\ )
Если установлено значение ``true``, будут сгенерированы MIP-текстуры для текстур шрифтов.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_hinting:
.. rst-class:: classref-property
:ref:`Hinting<enum_TextServer_Hinting>` **hinting** = ``1`` :ref:`🔗<class_SystemFont_property_hinting>`
.. rst-class:: classref-property-setget
- |void| **set_hinting**\ (\ value\: :ref:`Hinting<enum_TextServer_Hinting>`\ )
- :ref:`Hinting<enum_TextServer_Hinting>` **get_hinting**\ (\ )
Режим подсказки шрифтов.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_keep_rounding_remainders:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **keep_rounding_remainders** = ``true`` :ref:`🔗<class_SystemFont_property_keep_rounding_remainders>`
.. rst-class:: classref-property-setget
- |void| **set_keep_rounding_remainders**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_keep_rounding_remainders**\ (\ )
Если установлено значение ``true``, при выравнивании глифов по границам пикселей остатки округления накапливаются для обеспечения более равномерного распределения глифов. Этот параметр не действует, если включено субпиксельное позиционирование.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_modulate_color_glyphs:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **modulate_color_glyphs** = ``false`` :ref:`🔗<class_SystemFont_property_modulate_color_glyphs>`
.. rst-class:: classref-property-setget
- |void| **set_modulate_color_glyphs**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_modulate_color_glyphs**\ (\ )
Если установлено значение ``true``, цветовая модуляция применяется при рисовании цветных глифов, в противном случае она применяется только к монохромным глифам.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_msdf_pixel_range:
.. rst-class:: classref-property
:ref:`int<class_int>` **msdf_pixel_range** = ``16`` :ref:`🔗<class_SystemFont_property_msdf_pixel_range>`
.. rst-class:: classref-property-setget
- |void| **set_msdf_pixel_range**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_msdf_pixel_range**\ (\ )
Ширина диапазона вокруг фигуры между минимальным и максимальным представимым расстоянием со знаком. При использовании контуров шрифта :ref:`msdf_pixel_range<class_SystemFont_property_msdf_pixel_range>` должен быть установлен как минимум в *дважды* размера самого большого контура шрифта. Значение :ref:`msdf_pixel_range<class_SystemFont_property_msdf_pixel_range>` по умолчанию ``16`` позволяет контурам размером до ``8`` выглядеть правильно.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_msdf_size:
.. rst-class:: classref-property
:ref:`int<class_int>` **msdf_size** = ``48`` :ref:`🔗<class_SystemFont_property_msdf_size>`
.. rst-class:: classref-property-setget
- |void| **set_msdf_size**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_msdf_size**\ (\ )
Исходный размер шрифта, используемый для генерации текстур MSDF. Более высокие значения обеспечивают большую точность, но медленнее отрисовываются и требуют больше памяти. Увеличивайте это значение только в том случае, если вы заметили видимую неточность в отрисовке глифов.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_multichannel_signed_distance_field:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **multichannel_signed_distance_field** = ``false`` :ref:`🔗<class_SystemFont_property_multichannel_signed_distance_field>`
.. rst-class:: classref-property-setget
- |void| **set_multichannel_signed_distance_field**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_multichannel_signed_distance_field**\ (\ )
Если установлено значение ``true``, глифы всех размеров визуализируются с использованием одного многоканального знакового поля расстояния, созданного из динамических векторных данных шрифта.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_oversampling:
.. rst-class:: classref-property
:ref:`float<class_float>` **oversampling** = ``0.0`` :ref:`🔗<class_SystemFont_property_oversampling>`
.. rst-class:: classref-property-setget
- |void| **set_oversampling**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_oversampling**\ (\ )
Положительное значение переопределяет коэффициент передискретизации области просмотра, в которой используется этот шрифт. См. :ref:`Viewport.oversampling<class_Viewport_property_oversampling>`. Это значение не переопределяет параметр ``oversampling`` методов ``draw_*``.
.. rst-class:: classref-item-separator
----
.. _class_SystemFont_property_subpixel_positioning:
.. rst-class:: classref-property
:ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **subpixel_positioning** = ``1`` :ref:`🔗<class_SystemFont_property_subpixel_positioning>`
.. rst-class:: classref-property-setget
- |void| **set_subpixel_positioning**\ (\ value\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ )
- :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **get_subpixel_positioning**\ (\ )
Режим субпиксельного позиционирования глифа шрифта. Субпиксельное позиционирование обеспечивает более четкий текст и лучший кернинг для шрифтов меньшего размера за счет использования памяти и скорости растеризации шрифта. Используйте :ref:`TextServer.SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` для автоматического включения на основе размера шрифта.
.. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)`
.. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)`
.. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)`
.. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)`
.. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)`
.. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)`
.. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`