Commit a6ee7629 authored by Nicolas P. Rougier's avatar Nicolas P. Rougier

Merge pull request #13 from jhasse/patch-readme

Use Markdown for README file
parents c1b66a37 3b8f6921
......@@ -5,41 +5,42 @@ This code intends to show how to display fonts efficiently using regular C,
Freetype and OpenGL. The idea is to use a single texture and a single vertex
buffer. The code is fairly simple and organized as follow:
** mandatory **
Mandatory
---------
texture-font: The texture-font structure is in charge of creating bitmap
glyphs and to upload them to the texture atlas.
* **texture-font**: The texture-font structure is in charge of creating bitmap
glyphs and to upload them to the texture atlas.
texture-atlas: This structure is responsible for the packing of small regions
into a bigger texture. It is based on the skyline bottom left
algorithm which appear to be well suited for storing glyphs.
* **texture-atlas**: This structure is responsible for the packing of small
regions into a bigger texture. It is based on the skyline
bottom left algorithm which appear to be well suited for
storing glyphs. More information at:
http://clb.demon.fi/files/RectangleBinPack.pdf
More information at:
http://clb.demon.fi/files/RectangleBinPack.pdf
* **vector**: This structure loosely mimics the std::vector class from
c++. It is used by texture-atlas (for storing nodes),
texture-font (for storing glyphs) and font-manager (for
storing fonts). More information at:
http://www.cppreference.com/wiki/container/vector/start
vector: This structure loosely mimics the std::vector class from c++. It
is used by texture-atlas (for storing nodes), texture-font (for
storing glyphs) and font-manager (for storing fonts).
More information at:
http://www.cppreference.com/wiki/container/vector/start
Optional
--------
* **markup**: Simple structure that describes text properties (font
family, font size, colors, underline, etc.)
** optional ***
* **font-manager**: Structure in charge of caching fonts.
markup: Simple structure that describes text properties (font family,
font size, colors, underline, etc.)
* **vertex-buffer**: Generic vertex buffer structure inspired by pyglet
(python). (more information at http://www.pyglet.org)
font-manager: Structure in charge of caching fonts.
* **edtaa3func**: Distance field computation by Stefan Gustavson
(more information at http://contourtextures.wikidot.com/)
vertex-buffer: Generic vertex buffer structure inspired by pyglet (python).
(more information at http://www.pyglet.org)
edtaa3func: Distance field computation by Stefan Gustavson
(more information at http://contourtextures.wikidot.com/)
makefont: Allow to generate header file with font information (texture + glyphs)
such that it can be used without freetype.
* **makefont**: Allow to generate header file with font information
(texture + glyphs) such that it can be used without
freetype.
Contributors:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment