API Index: Chafa Reference Manual

# API Index

### A

ChafaAlign, enum in ChafaPlacement

### C

chafa_calc_canvas_geometry, function in Miscellaneous
ChafaCanvas, typedef in ChafaCanvas
ChafaCanvasConfig, typedef in ChafaCanvasConfig
ChafaCanvasMode, enum in ChafaCanvasConfig
chafa_canvas_build_ansi, function in ChafaCanvas
chafa_canvas_config_copy, function in ChafaCanvasConfig
chafa_canvas_config_get_bg_color, function in ChafaCanvasConfig
chafa_canvas_config_get_canvas_mode, function in ChafaCanvasConfig
chafa_canvas_config_get_cell_geometry, function in ChafaCanvasConfig
chafa_canvas_config_get_color_extractor, function in ChafaCanvasConfig
chafa_canvas_config_get_color_space, function in ChafaCanvasConfig
chafa_canvas_config_get_dither_grain_size, function in ChafaCanvasConfig
chafa_canvas_config_get_dither_intensity, function in ChafaCanvasConfig
chafa_canvas_config_get_dither_mode, function in ChafaCanvasConfig
chafa_canvas_config_get_fg_color, function in ChafaCanvasConfig
chafa_canvas_config_get_fg_only_enabled, function in ChafaCanvasConfig
chafa_canvas_config_get_geometry, function in ChafaCanvasConfig
chafa_canvas_config_get_optimizations, function in ChafaCanvasConfig
chafa_canvas_config_get_passthrough, function in ChafaCanvasConfig
chafa_canvas_config_get_pixel_mode, function in ChafaCanvasConfig
chafa_canvas_config_get_preprocessing_enabled, function in ChafaCanvasConfig
chafa_canvas_config_get_transparency_threshold, function in ChafaCanvasConfig
chafa_canvas_config_get_work_factor, function in ChafaCanvasConfig
chafa_canvas_config_new, function in ChafaCanvasConfig
chafa_canvas_config_peek_fill_symbol_map, function in ChafaCanvasConfig
chafa_canvas_config_peek_symbol_map, function in ChafaCanvasConfig
chafa_canvas_config_ref, function in ChafaCanvasConfig
chafa_canvas_config_set_bg_color, function in ChafaCanvasConfig
chafa_canvas_config_set_canvas_mode, function in ChafaCanvasConfig
chafa_canvas_config_set_cell_geometry, function in ChafaCanvasConfig
chafa_canvas_config_set_color_extractor, function in ChafaCanvasConfig
chafa_canvas_config_set_color_space, function in ChafaCanvasConfig
chafa_canvas_config_set_dither_grain_size, function in ChafaCanvasConfig
chafa_canvas_config_set_dither_intensity, function in ChafaCanvasConfig
chafa_canvas_config_set_dither_mode, function in ChafaCanvasConfig
chafa_canvas_config_set_fg_color, function in ChafaCanvasConfig
chafa_canvas_config_set_fg_only_enabled, function in ChafaCanvasConfig
chafa_canvas_config_set_fill_symbol_map, function in ChafaCanvasConfig
chafa_canvas_config_set_geometry, function in ChafaCanvasConfig
chafa_canvas_config_set_optimizations, function in ChafaCanvasConfig
chafa_canvas_config_set_passthrough, function in ChafaCanvasConfig
chafa_canvas_config_set_pixel_mode, function in ChafaCanvasConfig
chafa_canvas_config_set_preprocessing_enabled, function in ChafaCanvasConfig
chafa_canvas_config_set_symbol_map, function in ChafaCanvasConfig
chafa_canvas_config_set_transparency_threshold, function in ChafaCanvasConfig
chafa_canvas_config_set_work_factor, function in ChafaCanvasConfig
chafa_canvas_config_unref, function in ChafaCanvasConfig
chafa_canvas_draw_all_pixels, function in ChafaCanvas
chafa_canvas_get_char_at, function in ChafaCanvas
chafa_canvas_get_colors_at, function in ChafaCanvas
chafa_canvas_get_raw_colors_at, function in ChafaCanvas
chafa_canvas_new, function in ChafaCanvas
chafa_canvas_new_similar, function in ChafaCanvas
chafa_canvas_peek_config, function in ChafaCanvas
chafa_canvas_print, function in ChafaCanvas
chafa_canvas_print_rows, function in ChafaCanvas
chafa_canvas_print_rows_strv, function in ChafaCanvas
chafa_canvas_ref, function in ChafaCanvas
chafa_canvas_set_char_at, function in ChafaCanvas
chafa_canvas_set_colors_at, function in ChafaCanvas
chafa_canvas_set_contents_rgba8, function in ChafaCanvas
chafa_canvas_set_placement, function in ChafaCanvas
chafa_canvas_set_raw_colors_at, function in ChafaCanvas
chafa_canvas_unref, function in ChafaCanvas
ChafaColorExtractor, enum in ChafaCanvasConfig
ChafaColorSpace, enum in ChafaCanvasConfig

### D

chafa_describe_features, function in Features
ChafaDitherMode, enum in ChafaCanvasConfig

### F

ChafaFeatures, enum in Features
ChafaFrame, typedef in ChafaFrame
chafa_frame_new, function in ChafaFrame
chafa_frame_new_borrow, function in ChafaFrame
chafa_frame_new_steal, function in ChafaFrame
chafa_frame_ref, function in ChafaFrame
chafa_frame_unref, function in ChafaFrame
chafa_free_gstring_array, function in Miscellaneous

### G

chafa_get_builtin_features, function in Features
chafa_get_n_actual_threads, function in Features
chafa_get_n_threads, function in Features
chafa_get_supported_features, function in Features

### I

ChafaImage, typedef in ChafaImage
chafa_image_new, function in ChafaImage
chafa_image_ref, function in ChafaImage
chafa_image_set_frame, function in ChafaImage
chafa_image_unref, function in ChafaImage

### M

CHAFA_MAJOR_VERSION, macro in Miscellaneous
CHAFA_MICRO_VERSION, macro in Miscellaneous
CHAFA_MINOR_VERSION, macro in Miscellaneous

### O

ChafaOptimizations, enum in ChafaCanvasConfig

### P

ChafaParseResult, enum in ChafaTermInfo
ChafaPassthrough, enum in ChafaCanvasConfig
ChafaPixelMode, enum in ChafaCanvasConfig
ChafaPixelType, enum in Miscellaneous
ChafaPlacement, typedef in ChafaPlacement
chafa_placement_get_halign, function in ChafaPlacement
chafa_placement_get_tuck, function in ChafaPlacement
chafa_placement_get_valign, function in ChafaPlacement
chafa_placement_new, function in ChafaPlacement
chafa_placement_ref, function in ChafaPlacement
chafa_placement_set_halign, function in ChafaPlacement
chafa_placement_set_tuck, function in ChafaPlacement
chafa_placement_set_valign, function in ChafaPlacement
chafa_placement_unref, function in ChafaPlacement

### S

chafa_set_n_threads, function in Features
ChafaSymbolMap, typedef in ChafaSymbolMap
ChafaSymbolTags, enum in ChafaSymbolMap
CHAFA_SYMBOL_HEIGHT_PIXELS, macro in ChafaSymbolMap
chafa_symbol_map_add_by_range, function in ChafaSymbolMap
chafa_symbol_map_add_by_tags, function in ChafaSymbolMap
chafa_symbol_map_add_glyph, function in ChafaSymbolMap
chafa_symbol_map_apply_selectors, function in ChafaSymbolMap
chafa_symbol_map_copy, function in ChafaSymbolMap
chafa_symbol_map_get_allow_builtin_glyphs, function in ChafaSymbolMap
chafa_symbol_map_get_glyph, function in ChafaSymbolMap
chafa_symbol_map_new, function in ChafaSymbolMap
chafa_symbol_map_ref, function in ChafaSymbolMap
chafa_symbol_map_remove_by_range, function in ChafaSymbolMap
chafa_symbol_map_remove_by_tags, function in ChafaSymbolMap
chafa_symbol_map_set_allow_builtin_glyphs, function in ChafaSymbolMap
chafa_symbol_map_unref, function in ChafaSymbolMap
CHAFA_SYMBOL_WIDTH_PIXELS, macro in ChafaSymbolMap

### T

ChafaTermDb, typedef in ChafaTermDb
ChafaTermInfo, typedef in ChafaTermInfo
ChafaTermInfoError, enum in ChafaTermInfo
ChafaTermQuirks, enum in ChafaTermInfo
ChafaTermSeq, enum in ChafaTermInfo
chafa_term_db_copy, function in ChafaTermDb
chafa_term_db_detect, function in ChafaTermDb
chafa_term_db_get_default, function in ChafaTermDb
chafa_term_db_get_fallback_info, function in ChafaTermDb
chafa_term_db_new, function in ChafaTermDb
chafa_term_db_ref, function in ChafaTermDb
chafa_term_db_unref, function in ChafaTermDb
chafa_term_info_chain, function in ChafaTermInfo
chafa_term_info_copy, function in ChafaTermInfo
chafa_term_info_emit_backspace_key, function in ChafaTermInfo
chafa_term_info_emit_begin_hyperlink, function in ChafaTermInfo
chafa_term_info_emit_begin_hyperlink_anchor, function in ChafaTermInfo
chafa_term_info_emit_begin_iterm2_image, function in ChafaTermInfo
chafa_term_info_emit_begin_kitty_image_chunk, function in ChafaTermInfo
chafa_term_info_emit_begin_kitty_immediate_image_v1, function in ChafaTermInfo
chafa_term_info_emit_begin_kitty_immediate_virt_image_v1, function in ChafaTermInfo
chafa_term_info_emit_begin_screen_passthrough, function in ChafaTermInfo
chafa_term_info_emit_begin_sixels, function in ChafaTermInfo
chafa_term_info_emit_begin_tmux_passthrough, function in ChafaTermInfo
chafa_term_info_emit_cell_size_px, function in ChafaTermInfo
chafa_term_info_emit_clear, function in ChafaTermInfo
chafa_term_info_emit_cursor_down, function in ChafaTermInfo
chafa_term_info_emit_cursor_down_1, function in ChafaTermInfo
chafa_term_info_emit_cursor_down_scroll, function in ChafaTermInfo
chafa_term_info_emit_cursor_left, function in ChafaTermInfo
chafa_term_info_emit_cursor_left_1, function in ChafaTermInfo
chafa_term_info_emit_cursor_right, function in ChafaTermInfo
chafa_term_info_emit_cursor_right_1, function in ChafaTermInfo
chafa_term_info_emit_cursor_to_bottom_left, function in ChafaTermInfo
chafa_term_info_emit_cursor_to_pos, function in ChafaTermInfo
chafa_term_info_emit_cursor_to_top_left, function in ChafaTermInfo
chafa_term_info_emit_cursor_up, function in ChafaTermInfo
chafa_term_info_emit_cursor_up_1, function in ChafaTermInfo
chafa_term_info_emit_cursor_up_scroll, function in ChafaTermInfo
chafa_term_info_emit_delete_cells, function in ChafaTermInfo
chafa_term_info_emit_delete_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_delete_key, function in ChafaTermInfo
chafa_term_info_emit_delete_rows, function in ChafaTermInfo
chafa_term_info_emit_delete_shift_key, function in ChafaTermInfo
chafa_term_info_emit_disable_alt_screen, function in ChafaTermInfo
chafa_term_info_emit_disable_cursor, function in ChafaTermInfo
chafa_term_info_emit_disable_echo, function in ChafaTermInfo
chafa_term_info_emit_disable_insert, function in ChafaTermInfo
chafa_term_info_emit_disable_sixel_scrolling, function in ChafaTermInfo
chafa_term_info_emit_disable_wrap, function in ChafaTermInfo
chafa_term_info_emit_down_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_down_key, function in ChafaTermInfo
chafa_term_info_emit_down_shift_key, function in ChafaTermInfo
chafa_term_info_emit_enable_alt_screen, function in ChafaTermInfo
chafa_term_info_emit_enable_bold, function in ChafaTermInfo
chafa_term_info_emit_enable_cursor, function in ChafaTermInfo
chafa_term_info_emit_enable_echo, function in ChafaTermInfo
chafa_term_info_emit_enable_insert, function in ChafaTermInfo
chafa_term_info_emit_enable_sixel_scrolling, function in ChafaTermInfo
chafa_term_info_emit_enable_wrap, function in ChafaTermInfo
chafa_term_info_emit_end_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_end_hyperlink, function in ChafaTermInfo
chafa_term_info_emit_end_iterm2_image, function in ChafaTermInfo
chafa_term_info_emit_end_key, function in ChafaTermInfo
chafa_term_info_emit_end_kitty_image, function in ChafaTermInfo
chafa_term_info_emit_end_kitty_image_chunk, function in ChafaTermInfo
chafa_term_info_emit_end_screen_passthrough, function in ChafaTermInfo
chafa_term_info_emit_end_shift_key, function in ChafaTermInfo
chafa_term_info_emit_end_sixels, function in ChafaTermInfo
chafa_term_info_emit_end_tmux_passthrough, function in ChafaTermInfo
chafa_term_info_emit_f10_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f10_key, function in ChafaTermInfo
chafa_term_info_emit_f10_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f11_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f11_key, function in ChafaTermInfo
chafa_term_info_emit_f11_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f12_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f12_key, function in ChafaTermInfo
chafa_term_info_emit_f12_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f1_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f1_key, function in ChafaTermInfo
chafa_term_info_emit_f1_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f2_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f2_key, function in ChafaTermInfo
chafa_term_info_emit_f2_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f3_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f3_key, function in ChafaTermInfo
chafa_term_info_emit_f3_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f4_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f4_key, function in ChafaTermInfo
chafa_term_info_emit_f4_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f5_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f5_key, function in ChafaTermInfo
chafa_term_info_emit_f5_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f6_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f6_key, function in ChafaTermInfo
chafa_term_info_emit_f6_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f7_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f7_key, function in ChafaTermInfo
chafa_term_info_emit_f7_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f8_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f8_key, function in ChafaTermInfo
chafa_term_info_emit_f8_shift_key, function in ChafaTermInfo
chafa_term_info_emit_f9_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_f9_key, function in ChafaTermInfo
chafa_term_info_emit_f9_shift_key, function in ChafaTermInfo
chafa_term_info_emit_home_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_home_key, function in ChafaTermInfo
chafa_term_info_emit_home_shift_key, function in ChafaTermInfo
chafa_term_info_emit_insert_cells, function in ChafaTermInfo
chafa_term_info_emit_insert_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_insert_key, function in ChafaTermInfo
chafa_term_info_emit_insert_rows, function in ChafaTermInfo
chafa_term_info_emit_insert_shift_key, function in ChafaTermInfo
chafa_term_info_emit_invert_colors, function in ChafaTermInfo
chafa_term_info_emit_left_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_left_key, function in ChafaTermInfo
chafa_term_info_emit_left_shift_key, function in ChafaTermInfo
chafa_term_info_emit_page_down_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_page_down_key, function in ChafaTermInfo
chafa_term_info_emit_page_down_shift_key, function in ChafaTermInfo
chafa_term_info_emit_page_up_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_page_up_key, function in ChafaTermInfo
chafa_term_info_emit_page_up_shift_key, function in ChafaTermInfo
chafa_term_info_emit_primary_device_attributes, function in ChafaTermInfo
chafa_term_info_emit_query_cell_size_px, function in ChafaTermInfo
chafa_term_info_emit_query_default_bg, function in ChafaTermInfo
chafa_term_info_emit_query_default_fg, function in ChafaTermInfo
chafa_term_info_emit_query_primary_device_attributes, function in ChafaTermInfo
chafa_term_info_emit_query_text_area_size_cells, function in ChafaTermInfo
chafa_term_info_emit_query_text_area_size_px, function in ChafaTermInfo
chafa_term_info_emit_repeat_char, function in ChafaTermInfo
chafa_term_info_emit_reset_attributes, function in ChafaTermInfo
chafa_term_info_emit_reset_color_bg, function in ChafaTermInfo
chafa_term_info_emit_reset_color_fg, function in ChafaTermInfo
chafa_term_info_emit_reset_color_fgbg, function in ChafaTermInfo
chafa_term_info_emit_reset_default_bg, function in ChafaTermInfo
chafa_term_info_emit_reset_default_fg, function in ChafaTermInfo
chafa_term_info_emit_reset_scrolling_rows, function in ChafaTermInfo
chafa_term_info_emit_reset_terminal_hard, function in ChafaTermInfo
chafa_term_info_emit_reset_terminal_soft, function in ChafaTermInfo
chafa_term_info_emit_restore_cursor_pos, function in ChafaTermInfo
chafa_term_info_emit_return_key, function in ChafaTermInfo
chafa_term_info_emit_right_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_right_key, function in ChafaTermInfo
chafa_term_info_emit_right_shift_key, function in ChafaTermInfo
chafa_term_info_emit_save_cursor_pos, function in ChafaTermInfo
chafa_term_info_emit_seq, function in ChafaTermInfo
chafa_term_info_emit_seq_valist, function in ChafaTermInfo
chafa_term_info_emit_set_color_bg_16, function in ChafaTermInfo
chafa_term_info_emit_set_color_bg_256, function in ChafaTermInfo
chafa_term_info_emit_set_color_bg_8, function in ChafaTermInfo
chafa_term_info_emit_set_color_bg_direct, function in ChafaTermInfo
chafa_term_info_emit_set_color_fgbg_16, function in ChafaTermInfo
chafa_term_info_emit_set_color_fgbg_256, function in ChafaTermInfo
chafa_term_info_emit_set_color_fgbg_8, function in ChafaTermInfo
chafa_term_info_emit_set_color_fgbg_direct, function in ChafaTermInfo
chafa_term_info_emit_set_color_fg_16, function in ChafaTermInfo
chafa_term_info_emit_set_color_fg_256, function in ChafaTermInfo
chafa_term_info_emit_set_color_fg_8, function in ChafaTermInfo
chafa_term_info_emit_set_color_fg_direct, function in ChafaTermInfo
chafa_term_info_emit_set_default_bg, function in ChafaTermInfo
chafa_term_info_emit_set_default_fg, function in ChafaTermInfo
chafa_term_info_emit_set_scrolling_rows, function in ChafaTermInfo
chafa_term_info_emit_set_sixel_advance_down, function in ChafaTermInfo
chafa_term_info_emit_set_sixel_advance_right, function in ChafaTermInfo
chafa_term_info_emit_tab_key, function in ChafaTermInfo
chafa_term_info_emit_tab_shift_key, function in ChafaTermInfo
chafa_term_info_emit_text_area_size_cells, function in ChafaTermInfo
chafa_term_info_emit_text_area_size_px, function in ChafaTermInfo
chafa_term_info_emit_up_ctrl_key, function in ChafaTermInfo
chafa_term_info_emit_up_key, function in ChafaTermInfo
chafa_term_info_emit_up_shift_key, function in ChafaTermInfo
CHAFA_TERM_INFO_ERROR, macro in ChafaTermInfo
chafa_term_info_get_best_canvas_mode, function in ChafaTermInfo
chafa_term_info_get_best_pixel_mode, function in ChafaTermInfo
chafa_term_info_get_inherit_seq, function in ChafaTermInfo
chafa_term_info_get_is_pixel_passthrough_needed, function in ChafaTermInfo
chafa_term_info_get_name, function in ChafaTermInfo
chafa_term_info_get_passthrough_type, function in ChafaTermInfo
chafa_term_info_get_quirks, function in ChafaTermInfo
chafa_term_info_get_safe_symbol_tags, function in ChafaTermInfo
chafa_term_info_get_seq, function in ChafaTermInfo
chafa_term_info_have_seq, function in ChafaTermInfo
chafa_term_info_is_canvas_mode_supported, function in ChafaTermInfo
chafa_term_info_is_pixel_mode_supported, function in ChafaTermInfo
chafa_term_info_new, function in ChafaTermInfo
chafa_term_info_parse_seq, function in ChafaTermInfo
chafa_term_info_parse_seq_varargs, function in ChafaTermInfo
chafa_term_info_ref, function in ChafaTermInfo
chafa_term_info_set_inherit_seq, function in ChafaTermInfo
chafa_term_info_set_is_pixel_passthrough_needed, function in ChafaTermInfo
chafa_term_info_set_name, function in ChafaTermInfo
chafa_term_info_set_quirks, function in ChafaTermInfo
chafa_term_info_set_safe_symbol_tags, function in ChafaTermInfo
chafa_term_info_set_seq, function in ChafaTermInfo
chafa_term_info_supplement, function in ChafaTermInfo
chafa_term_info_unref, function in ChafaTermInfo
CHAFA_TERM_SEQ_ARGS_MAX, macro in ChafaTermInfo
CHAFA_TERM_SEQ_LENGTH_MAX, macro in ChafaTermInfo
ChafaTuck, enum in ChafaPlacement

### V

CHAFA_VERSION_1_0, macro in Miscellaneous
CHAFA_VERSION_1_10, macro in Miscellaneous
CHAFA_VERSION_1_12, macro in Miscellaneous
CHAFA_VERSION_1_14, macro in Miscellaneous
CHAFA_VERSION_1_16, macro in Miscellaneous
CHAFA_VERSION_1_18, macro in Miscellaneous
CHAFA_VERSION_1_2, macro in Miscellaneous
CHAFA_VERSION_1_4, macro in Miscellaneous
CHAFA_VERSION_1_6, macro in Miscellaneous
CHAFA_VERSION_1_8, macro in Miscellaneous
CHAFA_VERSION_CUR_STABLE, macro in Miscellaneous
CHAFA_VERSION_MAX_ALLOWED, macro in Miscellaneous
CHAFA_VERSION_MIN_REQUIRED, macro in Miscellaneous
CHAFA_VERSION_PREV_STABLE, macro in Miscellaneous