chafa_symbol_map_new ()

ChafaSymbolMap *
chafa_symbol_map_new (void);

Creates a new ChafaSymbolMap representing a set of Unicode symbols. The symbol map starts out empty.

chafa_symbol_map_copy ()

ChafaSymbolMap *
chafa_symbol_map_copy (const ChafaSymbolMap *symbol_map);

Creates a new ChafaSymbolMap that's a copy of symbol_map .

chafa_symbol_map_ref ()

void
chafa_symbol_map_ref (ChafaSymbolMap *symbol_map);

Adds a reference to symbol_map .

chafa_symbol_map_unref ()

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.

chafa_symbol_map_add_by_tags ()

void
chafa_symbol_map_add_by_tags (ChafaSymbolMap *symbol_map,
                              ChafaSymbolTags tags);

Adds symbols matching the set of tags to symbol_map .

chafa_symbol_map_add_by_range ()

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 .

Since: 1.4

chafa_symbol_map_remove_by_tags ()

void
chafa_symbol_map_remove_by_tags (ChafaSymbolMap *symbol_map,
                                 ChafaSymbolTags tags);

Removes symbols matching the set of tags from symbol_map .

chafa_symbol_map_remove_by_range ()

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 .

Since: 1.4

chafa_symbol_map_apply_selectors ()

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.

chafa_symbol_map_get_allow_builtin_glyphs ()

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

chafa_symbol_map_set_allow_builtin_glyphs ()

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.

Since: 1.4

chafa_symbol_map_get_glyph ()

gboolean
chafa_symbol_map_get_glyph (ChafaSymbolMap *symbol_map,
                            gunichar code_point,
                            ChafaPixelType pixel_format,
                            gpointer *pixels_out,
                            gint *width_out,
                            gint *height_out,
                            gint *rowstride_out);

Returns data for the glyph corresponding to code_point stored in symbol_map . Any of pixels_out , width_out , height_out and rowstride_out can be NULL, in which case the corresponding data is not retrieved.

If pixels_out is not NULL, a pointer to freshly allocated memory containing height * rowstride bytes in the pixel format specified by pixel_format will be stored at this address. It must be freed using g_free() when you're done with it.

Monochrome glyphs (the only kind currently supported) will be rendered as opaque white on a transparent black background (0xffffffff for inked pixels and 0x00000000 for uninked).

Since: 1.12

chafa_symbol_map_add_glyph ()

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.

Since: 1.4

CHAFA_SYMBOL_WIDTH_PIXELS

#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.

CHAFA_SYMBOL_HEIGHT_PIXELS

#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.

enum ChafaSymbolTags

ChafaSymbolMap

typedef struct ChafaSymbolMap ChafaSymbolMap;