chafa_canvas_config_new ()

ChafaCanvasConfig *
chafa_canvas_config_new (void);

Creates a new ChafaCanvasConfig with default settings. This object can later be used in the creation of a ChafaCanvas.

chafa_canvas_config_copy ()

ChafaCanvasConfig *
chafa_canvas_config_copy (const ChafaCanvasConfig *config);

Creates a new ChafaCanvasConfig that's a copy of config .

chafa_canvas_config_ref ()

void
chafa_canvas_config_ref (ChafaCanvasConfig *config);

Adds a reference to config .

chafa_canvas_config_unref ()

void
chafa_canvas_config_unref (ChafaCanvasConfig *config);

Removes a reference from config .

chafa_canvas_config_get_geometry ()

void
chafa_canvas_config_get_geometry (const ChafaCanvasConfig *config,
                                  gint *width_out,
                                  gint *height_out);

Returns config 's width and height in character cells in the provided output locations.

chafa_canvas_config_set_geometry ()

void
chafa_canvas_config_set_geometry (ChafaCanvasConfig *config,
                                  gint width,
                                  gint height);

Sets config 's width and height in character cells to width x height .

chafa_canvas_config_get_cell_geometry ()

void
chafa_canvas_config_get_cell_geometry (const ChafaCanvasConfig *config,
                                       gint *cell_width_out,
                                       gint *cell_height_out);

Returns config 's cell width and height in pixels in the provided output locations.

Since: 1.4

chafa_canvas_config_set_cell_geometry ()

void
chafa_canvas_config_set_cell_geometry (ChafaCanvasConfig *config,
                                       gint cell_width,
                                       gint cell_height);

Sets config 's cell width and height in pixels to cell_width x cell_height .

Since: 1.4

chafa_canvas_config_get_pixel_mode ()

ChafaPixelMode
chafa_canvas_config_get_pixel_mode (const ChafaCanvasConfig *config);

Returns config 's ChafaPixelMode.

Since: 1.4

chafa_canvas_config_set_pixel_mode ()

void
chafa_canvas_config_set_pixel_mode (ChafaCanvasConfig *config,
                                    ChafaPixelMode pixel_mode);

Sets config 's stored ChafaPixelMode to pixel_mode . This determines how pixel graphics are rendered in the output.

Since: 1.4

chafa_canvas_config_get_canvas_mode ()

ChafaCanvasMode
chafa_canvas_config_get_canvas_mode (const ChafaCanvasConfig *config);

Returns config 's ChafaCanvasMode. This determines how colors (and color control codes) are used in the output.

chafa_canvas_config_set_canvas_mode ()

void
chafa_canvas_config_set_canvas_mode (ChafaCanvasConfig *config,
                                     ChafaCanvasMode mode);

Sets config 's stored ChafaCanvasMode to mode . This determines how colors (and color control codes) are used in the output.

chafa_canvas_config_get_color_extractor ()

ChafaColorExtractor
chafa_canvas_config_get_color_extractor
                               (const ChafaCanvasConfig *config);

Returns config 's ChafaColorExtractor. This determines how colors are approximated in character symbol output.

Since: 1.4

chafa_canvas_config_set_color_extractor ()

void
chafa_canvas_config_set_color_extractor
                               (ChafaCanvasConfig *config,
                                ChafaColorExtractor color_extractor);

Sets config 's stored ChafaColorExtractor to color_extractor . This determines how colors are approximated in character symbol output.

Since: 1.4

chafa_canvas_config_get_color_space ()

ChafaColorSpace
chafa_canvas_config_get_color_space (const ChafaCanvasConfig *config);

Returns config 's ChafaColorSpace.

chafa_canvas_config_set_color_space ()

void
chafa_canvas_config_set_color_space (ChafaCanvasConfig *config,
                                     ChafaColorSpace color_space);

Sets config 's stored ChafaColorSpace to color_space .

chafa_canvas_config_get_preprocessing_enabled ()

gboolean
chafa_canvas_config_get_preprocessing_enabled
                               (const ChafaCanvasConfig *config);

Queries whether automatic image preprocessing is enabled. This allows Chafa to boost contrast and saturation in an attempt to improve legibility. The type of preprocessing applied (if any) depends on the canvas mode.

chafa_canvas_config_set_preprocessing_enabled ()

void
chafa_canvas_config_set_preprocessing_enabled
                               (ChafaCanvasConfig *config,
                                gboolean preprocessing_enabled);

Indicates whether automatic image preprocessing should be enabled. This allows Chafa to boost contrast and saturation in an attempt to improve legibility. The type of preprocessing applied (if any) depends on the canvas mode.

chafa_canvas_config_peek_symbol_map ()

const ChafaSymbolMap *
chafa_canvas_config_peek_symbol_map (const ChafaCanvasConfig *config);

Returns a pointer to the symbol map belonging to config . This can be inspected using the ChafaSymbolMap getter functions, but not changed.

chafa_canvas_config_set_symbol_map ()

void
chafa_canvas_config_set_symbol_map (ChafaCanvasConfig *config,
                                    const ChafaSymbolMap *symbol_map);

Assigns a copy of symbol_map to config .

chafa_canvas_config_peek_fill_symbol_map ()

const ChafaSymbolMap *
chafa_canvas_config_peek_fill_symbol_map
                               (const ChafaCanvasConfig *config);

Returns a pointer to the fill symbol map belonging to config . This can be inspected using the ChafaSymbolMap getter functions, but not changed.

Fill symbols are assigned according to their overall foreground to background coverage, disregarding shape.

chafa_canvas_config_set_fill_symbol_map ()

void
chafa_canvas_config_set_fill_symbol_map
                               (ChafaCanvasConfig *config,
                                const ChafaSymbolMap *fill_symbol_map);

Assigns a copy of fill_symbol_map to config .

chafa_canvas_config_get_transparency_threshold ()

gfloat
chafa_canvas_config_get_transparency_threshold
                               (const ChafaCanvasConfig *config);

Returns the threshold above which full transparency will be used.

chafa_canvas_config_set_transparency_threshold ()

void
chafa_canvas_config_set_transparency_threshold
                               (ChafaCanvasConfig *config,
                                gfloat alpha_threshold);

Sets the threshold above which full transparency will be used.

chafa_canvas_config_get_fg_only_enabled ()

gboolean
chafa_canvas_config_get_fg_only_enabled
                               (const ChafaCanvasConfig *config);

Queries whether to use foreground colors only, leaving the background unmodified in the canvas output. This is relevant only when the ChafaPixelMode is set to CHAFA_PIXEL_MODE_SYMBOLS.

When this is set, the canvas will emit escape codes to set the foreground color only.

Since: 1.8

chafa_canvas_config_set_fg_only_enabled ()

void
chafa_canvas_config_set_fg_only_enabled
                               (ChafaCanvasConfig *config,
                                gboolean fg_only_enabled);

Indicates whether to use foreground colors only, leaving the background unmodified in the canvas output. This is relevant only when the ChafaPixelMode is set to CHAFA_PIXEL_MODE_SYMBOLS.

When this is set, the canvas will emit escape codes to set the foreground color only.

Since: 1.8

chafa_canvas_config_get_fg_color ()

guint32
chafa_canvas_config_get_fg_color (const ChafaCanvasConfig *config);

Gets the assumed foreground color of the output device. This is used to determine how to apply the foreground pen in FGBG modes.

chafa_canvas_config_set_fg_color ()

void
chafa_canvas_config_set_fg_color (ChafaCanvasConfig *config,
                                  guint32 fg_color_packed_rgb);

Sets the assumed foreground color of the output device. This is used to determine how to apply the foreground pen in FGBG modes.

chafa_canvas_config_get_bg_color ()

guint32
chafa_canvas_config_get_bg_color (const ChafaCanvasConfig *config);

Gets the assumed background color of the output device. This is used to determine how to apply the background pen in FGBG modes.

chafa_canvas_config_set_bg_color ()

void
chafa_canvas_config_set_bg_color (ChafaCanvasConfig *config,
                                  guint32 bg_color_packed_rgb);

Sets the assumed background color of the output device. This is used to determine how to apply the background and transparency pens in FGBG modes, and will also be substituted for partial transparency.

chafa_canvas_config_get_work_factor ()

gfloat
chafa_canvas_config_get_work_factor (const ChafaCanvasConfig *config);

Gets the work/quality tradeoff factor. A higher value means more time and memory will be spent towards a higher quality output.

chafa_canvas_config_set_work_factor ()

void
chafa_canvas_config_set_work_factor (ChafaCanvasConfig *config,
                                     gfloat work_factor);

Sets the work/quality tradeoff factor. A higher value means more time and memory will be spent towards a higher quality output.

chafa_canvas_config_get_dither_mode ()

ChafaDitherMode
chafa_canvas_config_get_dither_mode (const ChafaCanvasConfig *config);

Returns config 's ChafaDitherMode.

Since: 1.2

chafa_canvas_config_set_dither_mode ()

void
chafa_canvas_config_set_dither_mode (ChafaCanvasConfig *config,
                                     ChafaDitherMode dither_mode);

Sets config 's stored ChafaDitherMode to dither_mode .

Since: 1.2

chafa_canvas_config_get_dither_grain_size ()

void
chafa_canvas_config_get_dither_grain_size
                               (const ChafaCanvasConfig *config,
                                gint *width_out,
                                gint *height_out);

Returns config 's dither grain size in width_out and height_out .

Since: 1.2

chafa_canvas_config_set_dither_grain_size ()

void
chafa_canvas_config_set_dither_grain_size
                               (ChafaCanvasConfig *config,
                                gint width,
                                gint height);

Sets config 's stored dither grain size to width by height pixels. These values can be 1, 2, 4 or 8. 8 corresponds to the size of an entire character cell. The default is 4 pixels by 4 pixels.

Since: 1.2

chafa_canvas_config_get_dither_intensity ()

gfloat
chafa_canvas_config_get_dither_intensity
                               (const ChafaCanvasConfig *config);

Returns the relative intensity of the dithering pattern applied during image conversion. 1.0 is the default, corresponding to a moderate intensity.

Since: 1.2

chafa_canvas_config_set_dither_intensity ()

void
chafa_canvas_config_set_dither_intensity
                               (ChafaCanvasConfig *config,
                                gfloat intensity);

Sets config 's stored relative intensity of the dithering pattern applied during image conversion. 1.0 is the default, corresponding to a moderate intensity. Possible values range from 0.0 to infinity, but in practice, values above 10.0 are rarely useful.

Since: 1.2

chafa_canvas_config_get_optimizations ()

ChafaOptimizations
chafa_canvas_config_get_optimizations (const ChafaCanvasConfig *config);

Returns config 's optimization flags. When enabled, these may produce more compact output at the cost of reduced compatibility and increased CPU use. Output quality is unaffected.

Since: 1.6

chafa_canvas_config_set_optimizations ()

void
chafa_canvas_config_set_optimizations (ChafaCanvasConfig *config,
                                       ChafaOptimizations optimizations);

Sets config 's stored optimization flags. When enabled, these may produce more compact output at the cost of reduced compatibility and increased CPU use. Output quality is unaffected.

Since: 1.6

chafa_canvas_config_get_passthrough ()

ChafaPassthrough
chafa_canvas_config_get_passthrough (const ChafaCanvasConfig *config);

Returns config 's ChafaPassthrough setting. This defaults to CHAFA_PASSTHROUGH_NONE.

Passthrough is needed to transmit certain escape codes to the outer terminal when running in an inner terminal environment like tmux. When enabled, this will happen automatically as needed, dictated by information contained in a ChafaTermInfo.

Since: 1.14

chafa_canvas_config_set_passthrough ()

void
chafa_canvas_config_set_passthrough (ChafaCanvasConfig *config,
                                     ChafaPassthrough passthrough);

Indicates which passthrough mode to use. This defaults to CHAFA_PASSTHROUGH_NONE.

Passthrough is needed to transmit certain escape codes to the outer terminal when running in an inner terminal environment like tmux. When enabled, this will happen automatically as needed, dictated by information contained in a ChafaTermInfo.

Since: 1.14

enum ChafaPixelMode

enum ChafaColorSpace

enum ChafaCanvasMode

enum ChafaDitherMode

enum ChafaColorExtractor

enum ChafaOptimizations

enum ChafaPassthrough

ChafaCanvasConfig

typedef struct ChafaCanvasConfig ChafaCanvasConfig;