Skip to content

Commit

Permalink
Add html docs, fix typo in script names, cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
bruvzg committed May 6, 2019
1 parent e27b25a commit f1d14a6
Show file tree
Hide file tree
Showing 117 changed files with 28,233 additions and 193 deletions.
4 changes: 2 additions & 2 deletions demos/get_sample_texts_builtin/main.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ func _ready():

var ms_rg_phli = TLDynamicFontFace.new()
ms_rg_phli.load(\"res://fonts/NotoFull/NotoSansInscriptionalPahlavi-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phil\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phli\")

var ms_rg_prti = TLDynamicFontFace.new()
ms_rg_prti.load(\"res://fonts/NotoFull/NotoSansInscriptionalParthian-Regular.ttf\")
Expand Down Expand Up @@ -378,7 +378,7 @@ func _ready():

var ms_rg_lydi = TLDynamicFontFace.new()
ms_rg_lydi.load(\"res://fonts/NotoFull/NotoSansLydian-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lidi\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lydi\")

var ms_rg_mand = TLDynamicFontFace.new()
ms_rg_mand.load(\"res://fonts/NotoFull/NotoSansMandaic-Regular.ttf\")
Expand Down
4 changes: 2 additions & 2 deletions demos/input_builtin/main.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@ func _ready():

var ms_rg_phli = TLDynamicFontFace.new()
ms_rg_phli.load(\"res://fonts/NotoFull/NotoSansInscriptionalPahlavi-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phil\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phli\")

var ms_rg_prti = TLDynamicFontFace.new()
ms_rg_prti.load(\"res://fonts/NotoFull/NotoSansInscriptionalParthian-Regular.ttf\")
Expand Down Expand Up @@ -649,7 +649,7 @@ func _ready():

var ms_rg_lydi = TLDynamicFontFace.new()
ms_rg_lydi.load(\"res://fonts/NotoFull/NotoSansLydian-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lidi\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lydi\")

var ms_rg_mand = TLDynamicFontFace.new()
ms_rg_mand.load(\"res://fonts/NotoFull/NotoSansMandaic-Regular.ttf\")
Expand Down
4 changes: 2 additions & 2 deletions demos/input_gdnative/main.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ func _ready():

var ms_rg_phli = TLDynamicFontFace.new()
ms_rg_phli.load(\"res://fonts/NotoFull/NotoSansInscriptionalPahlavi-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phil\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_phli, \"phli\")

var ms_rg_prti = TLDynamicFontFace.new()
ms_rg_prti.load(\"res://fonts/NotoFull/NotoSansInscriptionalParthian-Regular.ttf\")
Expand Down Expand Up @@ -657,7 +657,7 @@ func _ready():

var ms_rg_lydi = TLDynamicFontFace.new()
ms_rg_lydi.load(\"res://fonts/NotoFull/NotoSansLydian-Regular.ttf\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lidi\")
nt_fam_full.add_face_for_script(\"Regular\", ms_rg_lydi, \"lydi\")

var ms_rg_mand = TLDynamicFontFace.new()
ms_rg_mand.load(\"res://fonts/NotoFull/NotoSansMandaic-Regular.ttf\")
Expand Down
10 changes: 10 additions & 0 deletions doc_classes/TLFontFamily.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@
<description>
</description>
</method>
<method name="add_face_unlinked">
<return type="void">
</return>
<argument index="0" name="style" type="String">
</argument>
<argument index="1" name="ref" type="TLFontFace">
</argument>
<description>
</description>
</method>
<method name="add_face_for_language">
<return type="void">
</return>
Expand Down
4 changes: 4 additions & 0 deletions docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: e70b50e5b9717ef76ff02fcfe560711b
tags: 645f666f9bcd5a90fca523b33c5a78b7
98 changes: 98 additions & 0 deletions docs/html/_sources/about/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
.. _doc_about_intro:

libgdtl Introduction
====================

BiDi, shaping and basic text layout for Godot Engine.

Dependencies
------------

- Godot 3.1+
- C++14 compiler
- Meson build system (for gdnative module build only)
- SCons build system

Compiling (as builtin module)
-----------------------------

Build options
^^^^^^^^^^^^^

+-----------------+--------------------------------------------+---------------+
| Name | Description | Default value |
+=================+============================================+===============+
| builtin_runtime | Use the built-in libraries | true |
+-----------------+--------------------------------------------+---------------+
| use_graphite2 | Enable SIL Graphite 2 complementary shaper | true |
+-----------------+--------------------------------------------+---------------+

Building `libdgtl` module
^^^^^^^^^^^^^^^^^^^^^^^^^

Clone this repository (without `--recursive` flag) into Godot's `modules` subfolder as `godot_tl`.
Rebuild Godot engine as ususal.

Compiling (as gdnative module)
------------------------------

Build options
^^^^^^^^^^^^^

+--------------------+------------------------------------------------------------------+---------------+
| Name | Description | Default value |
+====================+==================================================================+===============+
| godot-cpp-lib-name | godot-cpp static library name (without `.a` or `.lib` extension) | libgodot-cpp |
+--------------------+------------------------------------------------------------------+---------------+
| static-runtime | Link libraries statically for better portability | false |
+--------------------+------------------------------------------------------------------+---------------+
| builtin-runtime | Use the built-in libraries | false |
+--------------------+------------------------------------------------------------------+---------------+
| use-graphite2 | Enable SIL Graphite 2 complementary shaper | true |
+--------------------+------------------------------------------------------------------+---------------+

Building `godot-cpp` static library
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See `<https://github.com/GodotNativeTools/godot-cpp/blob/master/README.md#compiling-the-cpp-bindings-library>`_

Building `libdgtl` module
^^^^^^^^^^^^^^^^^^^^^^^^^

You can compile this module by executing:
::

meson {Targer-Folder} -Dgodot-cpp-lib-name={Godot-CPP-Name} --buildtype=release
ninja -C {Targer-Folder}

License
-------

- The source code of the **libgdtl** module is released under unlicense.

For more information, see `<http://unlicense.org/>`_ or the accompanying UNLICENSE file.
- **Godot** and **GodotNativeTools** are licensed under MIT license.

For more information, see `<https://github.com/godotengine/godot/blob/master/LICENSE.txt>`_.
- **HarfBuzz** is licensed under MIT-like License.

For more information, see `<https://github.com/harfbuzz/harfbuzz/blob/master/COPYING>`_
- **ICU4C** is licensed under Unicode, Inc. License.

For more information, see `<http://www.unicode.org/copyright.html#License>`_
- **FreeType** is licensed under FreeType License (BSD-like) or GNU General Public License (GPL), version 2.

For more information, see `<https://www.freetype.org/license.html>`_
- **SIL Graphite engine** is licensed under GNU Lesser General Public License (LGPL), version 2.1+ or GNU General Public License (GPL), version 2 or Mozilla Public License.

For more information, see `<https://github.com/silnrsi/graphite/blob/master/COPYING>`_

Demo data
---------

`Montserrat <https://github.com/JulietaUla/Montserrat/>`_, `Awami Nastaliq <https://software.sil.org/awami/download/>`_, `Comic Neue <http://comicneue.com/>`_ and `Noto <https://www.google.com/get/noto/>`_ fonts are published under the `SIL Open Font License, Version 1.1 <https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL>`_

`Material Design icons by Google <https://github.com/google/material-design-icons>`_ are published under the `Apache License Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0.txt>`_


Noto Color Emoji font is cut down to single glyph (U+1F604) using `glyphhanger <https://github.com/filamentgroup/glyphhanger>`_.
25 changes: 25 additions & 0 deletions docs/html/_sources/classes/class_tlbitmapfontface.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TLBitmapFontFace.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_TLBitmapFontFace:

TLBitmapFontFace
================

**Inherits:** :ref:`TLFontFace<class_TLFontFace>`

**Category:** Core

Brief Description
-----------------

An AngelCode Bitmap Font Generator bitmap font for drawing text.

Description
-----------

TLBitmapFontFace have limited shaping support.

TLBitmapFontFace doesn't support OpenType features.

103 changes: 103 additions & 0 deletions docs/html/_sources/classes/class_tldynamicfontface.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TLDynamicFontFace.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_TLDynamicFontFace:

TLDynamicFontFace
=================

**Inherits:** :ref:`TLFontFace<class_TLFontFace>`

**Category:** Core

Brief Description
-----------------

A TrueType, OpenType or Graphite font for drawing text.

Properties
----------

+-------+----------------------------------------------------------------------------+
| bool | :ref:`force_autohinter<class_TLDynamicFontFace_property_force_autohinter>` |
+-------+----------------------------------------------------------------------------+
| int | :ref:`hinting<class_TLDynamicFontFace_property_hinting>` |
+-------+----------------------------------------------------------------------------+
| float | :ref:`oversampling<class_TLDynamicFontFace_property_oversampling>` |
+-------+----------------------------------------------------------------------------+

Methods
-------

+------+------------------------------------------------------------------------------------+
| bool | :ref:`has_graphite<class_TLDynamicFontFace_method_has_graphite>` **(** **)** const |
+------+------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_TLDynamicFontFace_DynamicFaceHinting:

.. _class_TLDynamicFontFace_constant_DF_HINTING_NONE:

.. _class_TLDynamicFontFace_constant_DF_HINTING_LIGHT:

.. _class_TLDynamicFontFace_constant_DF_HINTING_NORMAL:

enum **DynamicFaceHinting**:

- **DF_HINTING_NONE** = **0** --- Disable font hinting (smoother but less crisp)

- **DF_HINTING_LIGHT** = **1** --- Use the light font hinting mode

- **DF_HINTING_NORMAL** = **2** --- Use the default font hinting mode (crisper but less smooth)

Property Descriptions
---------------------

.. _class_TLDynamicFontFace_property_force_autohinter:

- bool **force_autohinter**

+----------+-----------------------------+
| *Setter* | set_force_autohinter(value) |
+----------+-----------------------------+
| *Getter* | get_force_autohinter() |
+----------+-----------------------------+

If ``true``, prefers FreeType auto-hinter over the font's native hinter. Default: ``false``

.. _class_TLDynamicFontFace_property_hinting:

- int **hinting**

+----------+--------------------+
| *Setter* | set_hinting(value) |
+----------+--------------------+
| *Getter* | get_hinting() |
+----------+--------------------+

The font hinting mode used by FreeType auto-hinter. Default: ``DF_HINTING_NONE``

.. _class_TLDynamicFontFace_property_oversampling:

- float **oversampling**

+----------+-------------------------+
| *Setter* | set_oversampling(value) |
+----------+-------------------------+
| *Getter* | get_oversampling() |
+----------+-------------------------+

Font oversampling factor. Default: ``1.0``

Method Descriptions
-------------------

.. _class_TLDynamicFontFace_method_has_graphite:

- bool **has_graphite** **(** **)** const

Returns ``true`` if module is built with SIL Graphite 2 shaper support.

Loading

0 comments on commit f1d14a6

Please sign in to comment.