| Top |
| #define | CHAFA_SYMBOL_WIDTH_PIXELS |
| #define | CHAFA_SYMBOL_HEIGHT_PIXELS |
| enum | ChafaSymbolTags |
| typedef | ChafaSymbolMap |
A ChafaSymbolMap describes a selection of the supported textual symbols that can be used in building a printable output string from a ChafaCanvas.
To create a new ChafaSymbolMap, use chafa_symbol_map_new(). You can then
add symbols to it using chafa_symbol_map_add_by_tags() before copying
it into a ChafaCanvasConfig using chafa_canvas_config_set_symbol_map().
Note that some symbols match multiple tags, so it makes sense to e.g. add symbols matching CHAFA_SYMBOL_TAG_BORDER and then removing symbols matching CHAFA_SYMBOL_TAG_DIAGONAL.
The number of available symbols is a significant factor in the speed of ChafaCanvas. For the fastest possible operation you could use a single symbol -- CHAFA_SYMBOL_TAG_VHALF works well by itself.
ChafaSymbolMap *
chafa_symbol_map_new (void);
Creates a new ChafaSymbolMap representing a set of Unicode symbols. The symbol map starts out empty.
ChafaSymbolMap *
chafa_symbol_map_copy (const ChafaSymbolMap *symbol_map);
Creates a new ChafaSymbolMap that's a copy of symbol_map
.
void
chafa_symbol_map_ref (ChafaSymbolMap *symbol_map);
Adds a reference to symbol_map
.
void
chafa_symbol_map_unref (ChafaSymbolMap *symbol_map);
Removes a reference from symbol_map
. When remaining references drops to
zero, the symbol map is freed and can no longer be used.
void chafa_symbol_map_add_by_tags (ChafaSymbolMap *symbol_map,ChafaSymbolTags tags);
Adds symbols matching the set of tags
to symbol_map
.
void chafa_symbol_map_add_by_range (ChafaSymbolMap *symbol_map,gunichar first,gunichar last);
Adds symbols in the code point range starting with first
and ending with last
to symbol_map
.
symbol_map |
Symbol map to add symbols to |
|
first |
First code point to add, inclusive |
|
last |
Last code point to add, inclusive |
Since: 1.4
void chafa_symbol_map_remove_by_tags (ChafaSymbolMap *symbol_map,ChafaSymbolTags tags);
Removes symbols matching the set of tags
from symbol_map
.
void chafa_symbol_map_remove_by_range (ChafaSymbolMap *symbol_map,gunichar first,gunichar last);
Removes symbols in the code point range starting with first
and ending with last
from symbol_map
.
symbol_map |
Symbol map to remove symbols from |
|
first |
First code point to remove, inclusive |
|
last |
Last code point to remove, inclusive |
Since: 1.4
gboolean chafa_symbol_map_apply_selectors (ChafaSymbolMap *symbol_map,const gchar *selectors,GError **error);
Parses a string consisting of symbol tags separated by [+-,] and
applies the pattern to symbol_map
. If the string begins with + or -,
it's understood to be relative to the current set in symbol_map
,
otherwise the map is cleared first.
The symbol tags are string versions of ChafaSymbolTags, i.e. [all, none, space, solid, stipple, block, border, diagonal, dot, quad, half, hhalf, vhalf, braille, technical, geometric, ascii, extra].
Examples: "block,border" sets map to contain symbols matching either of those tags. "+block,border-dot,stipple" adds block and border symbols then removes dot and stipple symbols.
If there is a parse error, none of the changes are applied.
symbol_map |
Symbol map to apply selection to |
|
selectors |
A string specifying selections |
|
error |
Return location for an error, or |
gboolean
chafa_symbol_map_get_allow_builtin_glyphs
(ChafaSymbolMap *symbol_map);
Queries whether a symbol map is allowed to use built-in glyphs for
symbol selection. This can be turned off if you want to use your
own glyphs exclusively (see chafa_symbol_map_add_glyph()).
Defaults to TRUE.
Since: 1.4
void chafa_symbol_map_set_allow_builtin_glyphs (ChafaSymbolMap *symbol_map,gboolean use_builtin_glyphs);
Controls whether a symbol map is allowed to use built-in glyphs for
symbol selection. This can be turned off if you want to use your
own glyphs exclusively (see chafa_symbol_map_add_glyph()).
Defaults to TRUE.
symbol_map |
A symbol map |
|
use_builtin_glyphs |
A boolean indicating whether to use built-in glyphs |
Since: 1.4
void chafa_symbol_map_add_glyph (ChafaSymbolMap *symbol_map,gunichar code_point,ChafaPixelType pixel_format,gpointer pixels,gint width,gint height,gint rowstride);
Assigns a rendered glyph to a Unicode code point. This tells Chafa what the glyph looks like so the corresponding symbol can be used appropriately in output.
Assigned glyphs override built-in glyphs and any earlier glyph that may have been assigned to the same code point.
If the input is in a format with an alpha channel, the alpha channel will be used for the shape. If not, an average of the color channels will be used.
symbol_map |
A symbol map |
|
code_point |
The Unicode code point for this glyph |
|
pixel_format |
Glyph pixel format of |
|
pixels |
The glyph data |
|
width |
Width of glyph, in pixels |
|
height |
Height of glyph, in pixels |
|
rowstride |
Offset from start of one row to the next, in bytes |
Since: 1.4
#define CHAFA_SYMBOL_WIDTH_PIXELS 8
The width of an internal symbol pixel matrix. If you are prescaling input graphics, you will get the best results when scaling to a multiple of this value.
#define CHAFA_SYMBOL_HEIGHT_PIXELS 8
The height of an internal symbol pixel matrix. If you are prescaling input graphics, you will get the best results when scaling to a multiple of this value.
|
Special value meaning no symbols. |
||
|
Space. |
||
|
Solid (inverse of space). |
||
|
Stipple symbols. |
||
|
Block symbols. |
||
|
Border symbols. |
||
|
Diagonal border symbols. |
||
|
Symbols that look like isolated dots (excluding Braille). |
||
|
Quadrant block symbols. |
||
|
Horizontal half block symbols. |
||
|
Vertical half block symbols. |
||
|
Joint set of horizontal and vertical halves. |
||
|
Symbols that are the inverse of simpler symbols. When two symbols complement each other, only one will have this tag. |
||
|
Braille symbols. |
||
|
Miscellaneous technical symbols. |
||
|
Geometric shapes. |
||
|
Printable ASCII characters. |
||
|
Letters. |
||
|
Digits. |
||
|
Joint set of letters and digits. |
||
|
Characters that are one cell wide. |
||
|
Characters that are two cells wide. |
||
|
Characters of uncertain width. Always excluded unless specifically asked for. |
||
|
Characters that are generally undesired or unlikely to render well. Always excluded unless specifically asked for. |
||
|
Symbols not in any other category. |
||
|
Joint set of ugly and ambiguous characters. Always excluded unless specifically asked for. |
||
|
Special value meaning all supported symbols. |