| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the BitmapFont.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_BitmapFont:
- BitmapFont
- ==========
- **Inherits:** :ref:`Font<class_font>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Renders text using ``*.fnt`` fonts.
- Member Functions
- ----------------
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_char<class_BitmapFont_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_kerning_pair<class_BitmapFont_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_texture<class_BitmapFont_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_BitmapFont_clear>` **(** **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`create_from_fnt<class_BitmapFont_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_BitmapFont_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_kerning_pair<class_BitmapFont_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Texture<class_texture>` | :ref:`get_texture<class_BitmapFont_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_texture_count<class_BitmapFont_get_texture_count>` **(** **)** const |
- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- .. _class_BitmapFont_ascent:
- - :ref:`float<class_float>` **ascent** - Ascent (number of pixels above the baseline).
- .. _class_BitmapFont_distance_field:
- - :ref:`bool<class_bool>` **distance_field** - If ``true`` distance field hint is enabled.
- .. _class_BitmapFont_fallback:
- - :ref:`BitmapFont<class_bitmapfont>` **fallback** - The fallback font.
- .. _class_BitmapFont_height:
- - :ref:`float<class_float>` **height** - Total font height (ascent plus descent) in pixels.
- Description
- -----------
- Renders text using ``*.fnt`` fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see :ref:`DynamicFont<class_dynamicfont>`.
- Member Function Description
- ---------------------------
- .. _class_BitmapFont_add_char:
- - void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2( 0, 0 ), :ref:`float<class_float>` advance=-1 **)**
- Adds a character to the font, where ``character`` is the unicode value, ``texture`` is the texture index, ``rect`` is the region in the texture (in pixels!), ``align`` is the (optional) alignment for the character and ``advance`` is the (optional) advance.
- .. _class_BitmapFont_add_kerning_pair:
- - void **add_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)**
- Adds a kerning pair to the ``BitmapFont`` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
- .. _class_BitmapFont_add_texture:
- - void **add_texture** **(** :ref:`Texture<class_texture>` texture **)**
- Adds a texture to the ``BitmapFont``.
- .. _class_BitmapFont_clear:
- - void **clear** **(** **)**
- Clears all the font data and settings.
- .. _class_BitmapFont_create_from_fnt:
- - :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
- Creates a BitmapFont from the ``*.fnt`` file at ``path``.
- .. _class_BitmapFont_get_char_size:
- - :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
- Returns the size of a character, optionally taking kerning into account if the next character is provided.
- .. _class_BitmapFont_get_kerning_pair:
- - :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
- Returns a kerning pair as a difference.
- .. _class_BitmapFont_get_texture:
- - :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
- Returns the font atlas texture at index ``idx``.
- .. _class_BitmapFont_get_texture_count:
- - :ref:`int<class_int>` **get_texture_count** **(** **)** const
- Returns the number of textures in the BitmapFont atlas.
|
