Text-Renderer/README.md

37 lines
861 B
Markdown
Raw Normal View History

# vKVM TextRenderer
## Installation
Use the installation script provided in the Scripts repository
to install the full package.
Installing a single component is currently not supported.
2019-10-23 12:22:45 +02:00
## Target
2019-10-24 12:18:56 +02:00
TextRender build exports an interface target TextRender::TextRender.
2019-10-23 12:22:45 +02:00
2019-10-24 12:14:49 +02:00
This means that if TextRender has been installed on the Project Path, it
should be enough to do.
2019-10-23 12:22:45 +02:00
2019-10-29 13:25:46 +01:00
translate a string from terminal to the readable form of shared memory .
2019-10-24 12:14:49 +02:00
## Usage
mkdir build
cd build
cmake ..
make
2019-10-29 13:25:46 +01:00
## Description
TextRender has two class, Bitmap class and Font class.
res/font.bmp (bitmap data, used by Bitmap::load() function)
2019-10-24 12:14:49 +02:00
2019-10-29 13:25:46 +01:00
res/font.toml (configuration file, it configure how to read the font.bmp)
2019-10-29 12:50:43 +01:00
2019-10-29 13:25:46 +01:00
src/Bitmap class, it used to load the font.bmp file.
2019-10-29 12:50:43 +01:00
2019-10-29 13:25:46 +01:00
src/Font class, it read the font.bmp data by Bitmap class,
translate a string to a bitmap