libtcod

Core

  • Colors
  • Console
  • System layer

Base toolkits

  • Line Drawing Toolkit
  • Contexts
  • REXPaint Files
  • Tilesets

How-tos

  • Upgrading
  • Getting Started

API

  • Library API
    • Page Hierarchy
    • File Hierarchy
    • Full API
      • Namespaces
      • Classes and Structs
      • Enums
      • Unions
      • Functions
        • Function tcod::blit
        • Function tcod::check_path
        • Function tcod::check_throw_error(int)
        • Function tcod::check_throw_error(TCOD_Error)
        • Function tcod::console::init_root(int, int, const std::string&, bool, TCOD_renderer_t)
        • Function tcod::console::init_root(int, int, const std::string&, bool, TCOD_renderer_t, bool)
        • Function tcod::draw_frame
        • Function tcod::draw_quartergraphics
        • Function tcod::draw_rect
        • Function tcod::get_height_rect
        • Function tcod::load_bdf
        • Template Function tcod::load_tilesheet
        • Function tcod::load_xp
        • Function tcod::new_context(const TCOD_ContextParams&, TCOD_Error&)
        • Function tcod::new_context(const TCOD_ContextParams&)
        • Function tcod::print
        • Function tcod::print_frame
        • Function tcod::print_rect
        • Function tcod::save_xp
        • Function tcod::sdl2::process_event(const union SDL_Event&, TCOD_key_t&)
        • Function tcod::sdl2::process_event(const union SDL_Event&, TCOD_mouse_t&)
        • Function tcod::set_error(const std::string&)
        • Function tcod::set_error(const std::exception&)
        • Template Function tcod::stringf
        • Function tcod::tileset::new_fallback_tileset
        • Function TCOD_bsp_contains
        • Function TCOD_bsp_delete
        • Function TCOD_bsp_father
        • Function TCOD_bsp_find_node
        • Function TCOD_bsp_is_leaf
        • Function TCOD_bsp_left
        • Function TCOD_bsp_new
        • Function TCOD_bsp_new_with_size
        • Function TCOD_bsp_remove_sons
        • Function TCOD_bsp_resize
        • Function TCOD_bsp_right
        • Function TCOD_bsp_split_once
        • Function TCOD_bsp_split_recursive
        • Function TCOD_bsp_traverse_in_order
        • Function TCOD_bsp_traverse_inverted_level_order
        • Function TCOD_bsp_traverse_level_order
        • Function TCOD_bsp_traverse_post_order
        • Function TCOD_bsp_traverse_pre_order
        • Function TCOD_clear_error
        • Function TCOD_close_library
        • Function TCOD_color_add
        • Function TCOD_color_add_wrapper
        • Function TCOD_color_alpha_blend
        • Function TCOD_color_equals
        • Function TCOD_color_equals_wrapper
        • Function TCOD_color_gen_map
        • Function TCOD_color_get_HSV
        • Function TCOD_color_get_HSV_wrapper
        • Function TCOD_color_get_hue
        • Function TCOD_color_get_hue_wrapper
        • Function TCOD_color_get_saturation
        • Function TCOD_color_get_saturation_wrapper
        • Function TCOD_color_get_value
        • Function TCOD_color_get_value_wrapper
        • Function TCOD_color_HSV
        • Function TCOD_color_lerp
        • Function TCOD_color_lerp_wrapper
        • Function TCOD_color_multiply
        • Function TCOD_color_multiply_scalar
        • Function TCOD_color_multiply_scalar_wrapper
        • Function TCOD_color_multiply_wrapper
        • Function TCOD_color_RGB
        • Function TCOD_color_scale_HSV
        • Function TCOD_color_set_HSV
        • Function TCOD_color_set_hue
        • Function TCOD_color_set_saturation
        • Function TCOD_color_set_value
        • Function TCOD_color_shift_hue
        • Function TCOD_color_subtract
        • Function TCOD_color_subtract_wrapper
        • Function TCOD_condition_broadcast
        • Function TCOD_condition_delete
        • Function TCOD_condition_new
        • Function TCOD_condition_signal
        • Function TCOD_condition_wait
        • Function TCOD_console_blit
        • Function TCOD_console_blit_key_color
        • Function TCOD_console_check_for_keypress
        • Function TCOD_console_check_for_keypress_wrapper
        • Function TCOD_console_clear
        • Function TCOD_console_credits
        • Function TCOD_console_credits_render
        • Function TCOD_console_credits_render_ex
        • Function TCOD_console_credits_reset
        • Function TCOD_console_delete
        • Function TCOD_console_disable_keyboard_repeat
        • Function TCOD_console_double_hline
        • Function TCOD_console_double_vline
        • Function TCOD_console_draw_frame_rgb
        • Function TCOD_console_draw_rect_rgb
        • Function TCOD_console_fill_background
        • Function TCOD_console_fill_char
        • Function TCOD_console_fill_foreground
        • Function TCOD_console_flush
        • Function TCOD_console_flush_ex
        • Function TCOD_console_from_file
        • Function TCOD_console_from_xp
        • Function TCOD_console_get_alignment
        • Function TCOD_console_get_background_flag
        • Function TCOD_console_get_char
        • Function TCOD_console_get_char_background
        • Function TCOD_console_get_char_background_wrapper
        • Function TCOD_console_get_char_foreground
        • Function TCOD_console_get_char_foreground_wrapper
        • Function TCOD_console_get_default_background
        • Function TCOD_console_get_default_background_wrapper
        • Function TCOD_console_get_default_foreground
        • Function TCOD_console_get_default_foreground_wrapper
        • Function TCOD_console_get_fade
        • Function TCOD_console_get_fading_color
        • Function TCOD_console_get_fading_color_wrapper
        • Function TCOD_console_get_height
        • Function TCOD_console_get_height_rect
        • Function TCOD_console_get_height_rect_fmt
        • Function TCOD_console_get_height_rect_n
        • Function TCOD_console_get_height_rect_utf
        • Function TCOD_console_get_height_rect_wn
        • Function TCOD_console_get_width
        • Function TCOD_console_has_mouse_focus
        • Function TCOD_console_hline
        • Function TCOD_console_init_root
        • Function TCOD_console_is_active
        • Function TCOD_console_is_fullscreen
        • Function TCOD_console_is_key_pressed
        • Function TCOD_console_is_window_closed
        • Function TCOD_console_list_from_xp
        • Function TCOD_console_list_save_xp
        • Function TCOD_console_load_apf
        • Function TCOD_console_load_asc
        • Function TCOD_console_load_xp
        • Function TCOD_console_map_ascii_code_to_font
        • Function TCOD_console_map_ascii_codes_to_font
        • Function TCOD_console_map_string_to_font
        • Function TCOD_console_map_string_to_font_utf
        • Function TCOD_console_new
        • Function TCOD_console_print
        • Function TCOD_console_print_double_frame
        • Function TCOD_console_print_ex
        • Function TCOD_console_print_ex_utf
        • Function TCOD_console_print_frame
        • Function TCOD_console_print_rect
        • Function TCOD_console_print_rect_ex
        • Function TCOD_console_print_rect_ex_utf
        • Function TCOD_console_print_rect_utf
        • Function TCOD_console_print_return_string
        • Function TCOD_console_print_utf
        • Function TCOD_console_printf
        • Function TCOD_console_printf_ex
        • Function TCOD_console_printf_frame
        • Function TCOD_console_printf_rect
        • Function TCOD_console_printf_rect_ex
        • Function TCOD_console_printn
        • Function TCOD_console_printn_frame
        • Function TCOD_console_printn_rect
        • Function TCOD_console_put_char
        • Function TCOD_console_put_char_ex
        • Function TCOD_console_put_char_ex_wrapper
        • Function TCOD_console_put_rgb
        • Function TCOD_console_rect
        • Function TCOD_console_save_apf
        • Function TCOD_console_save_asc
        • Function TCOD_console_save_xp
        • Function TCOD_console_set_alignment
        • Function TCOD_console_set_background_flag
        • Function TCOD_console_set_char
        • Function TCOD_console_set_char_background
        • Function TCOD_console_set_char_background_wrapper
        • Function TCOD_console_set_char_foreground
        • Function TCOD_console_set_char_foreground_wrapper
        • Function TCOD_console_set_color_control
        • Function TCOD_console_set_color_control_wrapper
        • Function TCOD_console_set_custom_font
        • Function TCOD_console_set_default_background
        • Function TCOD_console_set_default_background_wrapper
        • Function TCOD_console_set_default_foreground
        • Function TCOD_console_set_default_foreground_wrapper
        • Function TCOD_console_set_dirty
        • Function TCOD_console_set_fade
        • Function TCOD_console_set_fade_wrapper
        • Function TCOD_console_set_fullscreen
        • Function TCOD_console_set_key_color
        • Function TCOD_console_set_key_color_wrapper
        • Function TCOD_console_set_keyboard_repeat
        • Function TCOD_console_set_window_title
        • Function TCOD_console_vline
        • Function TCOD_console_vprintf
        • Function TCOD_console_vprintf_rect
        • Function TCOD_console_wait_for_keypress
        • Function TCOD_console_wait_for_keypress_wrapper
        • Function TCOD_context_change_tileset
        • Function TCOD_context_convert_event_coordinates
        • Function TCOD_context_delete
        • Function TCOD_context_get_renderer_type
        • Function TCOD_context_get_sdl_renderer
        • Function TCOD_context_get_sdl_window
        • Function TCOD_context_new
        • Function TCOD_context_present
        • Function TCOD_context_recommended_console_size
        • Function TCOD_context_save_screenshot
        • Function TCOD_context_screen_capture
        • Function TCOD_context_screen_capture_alloc
        • Function TCOD_context_screen_pixel_to_tile_d
        • Function TCOD_context_screen_pixel_to_tile_i
        • Function TCOD_context_set_mouse_transform
        • Function TCOD_dijkstra_compute
        • Function TCOD_dijkstra_delete
        • Function TCOD_dijkstra_get
        • Function TCOD_dijkstra_get_distance
        • Function TCOD_dijkstra_is_empty
        • Function TCOD_dijkstra_new
        • Function TCOD_dijkstra_new_using_function
        • Function TCOD_dijkstra_path_set
        • Function TCOD_dijkstra_path_walk
        • Function TCOD_dijkstra_reverse
        • Function TCOD_dijkstra_size
        • Function TCOD_frontier_clear
        • Function TCOD_frontier_delete
        • Function TCOD_frontier_new
        • Function TCOD_frontier_pop
        • Function TCOD_frontier_push
        • Function TCOD_frontier_size
        • Function TCOD_get_default_tileset
        • Function TCOD_get_error
        • Function TCOD_get_function_address
        • Function TCOD_heap_clear
        • Function TCOD_heap_init
        • Function TCOD_heap_uninit
        • Function TCOD_heightmap_add
        • Function TCOD_heightmap_add_fbm
        • Function TCOD_heightmap_add_hill
        • Function TCOD_heightmap_add_hm
        • Function TCOD_heightmap_add_voronoi
        • Function TCOD_heightmap_clamp
        • Function TCOD_heightmap_clear
        • Function TCOD_heightmap_copy
        • Function TCOD_heightmap_count_cells
        • Function TCOD_heightmap_delete
        • Function TCOD_heightmap_dig_bezier
        • Function TCOD_heightmap_dig_hill
        • Function TCOD_heightmap_get_interpolated_value
        • Function TCOD_heightmap_get_minmax
        • Function TCOD_heightmap_get_normal
        • Function TCOD_heightmap_get_slope
        • Function TCOD_heightmap_get_value
        • Function TCOD_heightmap_has_land_on_border
        • Function TCOD_heightmap_islandify
        • Function TCOD_heightmap_kernel_transform
        • Function TCOD_heightmap_lerp_hm
        • Function TCOD_heightmap_mid_point_displacement
        • Function TCOD_heightmap_multiply_hm
        • Function TCOD_heightmap_new
        • Function TCOD_heightmap_normalize
        • Function TCOD_heightmap_rain_erosion
        • Function TCOD_heightmap_scale
        • Function TCOD_heightmap_scale_fbm
        • Function TCOD_heightmap_set_value
        • Function TCOD_image_blit
        • Function TCOD_image_blit_2x
        • Function TCOD_image_blit_rect
        • Function TCOD_image_clear
        • Function TCOD_image_clear_wrapper
        • Function TCOD_image_delete
        • Function TCOD_image_from_console
        • Function TCOD_image_get_alpha
        • Function TCOD_image_get_mipmap_pixel
        • Function TCOD_image_get_mipmap_pixel_wrapper
        • Function TCOD_image_get_pixel
        • Function TCOD_image_get_pixel_wrapper
        • Function TCOD_image_get_size
        • Function TCOD_image_hflip
        • Function TCOD_image_invert
        • Function TCOD_image_is_pixel_transparent
        • Function TCOD_image_load
        • Function TCOD_image_new
        • Function TCOD_image_put_pixel
        • Function TCOD_image_put_pixel_wrapper
        • Function TCOD_image_refresh_console
        • Function TCOD_image_rotate90
        • Function TCOD_image_save
        • Function TCOD_image_scale
        • Function TCOD_image_set_key_color
        • Function TCOD_image_set_key_color_wrapper
        • Function TCOD_image_vflip
        • Function TCOD_line
        • Function TCOD_line_init
        • Function TCOD_line_init_mt
        • Function TCOD_line_mt
        • Function TCOD_line_step
        • Function TCOD_line_step_mt
        • Function TCOD_list_add_all
        • Function TCOD_list_allocate
        • Function TCOD_list_begin
        • Function TCOD_list_clear
        • Function TCOD_list_clear_and_delete
        • Function TCOD_list_contains
        • Function TCOD_list_delete
        • Function TCOD_list_duplicate
        • Function TCOD_list_end
        • Function TCOD_list_get
        • Function TCOD_list_insert_before
        • Function TCOD_list_is_empty
        • Function TCOD_list_new
        • Function TCOD_list_peek
        • Function TCOD_list_pop
        • Function TCOD_list_push
        • Function TCOD_list_remove
        • Function TCOD_list_remove_fast
        • Function TCOD_list_remove_iterator
        • Function TCOD_list_remove_iterator_fast
        • Function TCOD_list_reverse
        • Function TCOD_list_set
        • Function TCOD_list_size
        • Function TCOD_load_bdf
        • Function TCOD_load_bdf_memory
        • Function TCOD_load_library
        • Function TCOD_load_xp
        • Function TCOD_load_xp_from_memory
        • Function TCOD_map_clear
        • Function TCOD_map_compute_fov
        • Function TCOD_map_copy
        • Function TCOD_map_delete
        • Function TCOD_map_get_height
        • Function TCOD_map_get_nb_cells
        • Function TCOD_map_get_width
        • Function TCOD_map_is_in_fov
        • Function TCOD_map_is_transparent
        • Function TCOD_map_is_walkable
        • Function TCOD_map_new
        • Function TCOD_map_set_in_fov
        • Function TCOD_map_set_properties
        • Function TCOD_minheap_heapify
        • Function TCOD_minheap_pop
        • Function TCOD_minheap_push
        • Function TCOD_mouse_get_status
        • Function TCOD_mouse_get_status_wrapper
        • Function TCOD_mouse_includes_touch
        • Function TCOD_mouse_is_cursor_visible
        • Function TCOD_mouse_move
        • Function TCOD_mouse_show_cursor
        • Function TCOD_mutex_delete
        • Function TCOD_mutex_in
        • Function TCOD_mutex_new
        • Function TCOD_mutex_out
        • Function TCOD_namegen_destroy
        • Function TCOD_namegen_generate
        • Function TCOD_namegen_generate_custom
        • Function TCOD_namegen_get_nb_sets_wrapper
        • Function TCOD_namegen_get_sets
        • Function TCOD_namegen_get_sets_wrapper
        • Function TCOD_namegen_parse
        • Function TCOD_noise_delete
        • Function TCOD_noise_get
        • Function TCOD_noise_get_ex
        • Function TCOD_noise_get_fbm
        • Function TCOD_noise_get_fbm_ex
        • Function TCOD_noise_get_fbm_vectorized
        • Function TCOD_noise_get_turbulence
        • Function TCOD_noise_get_turbulence_ex
        • Function TCOD_noise_get_turbulence_vectorized
        • Function TCOD_noise_get_vectorized
        • Function TCOD_noise_new
        • Function TCOD_noise_set_type
        • Function TCOD_parse_bool_value
        • Function TCOD_parse_char_value
        • Function TCOD_parse_color_value
        • Function TCOD_parse_dice_value
        • Function TCOD_parse_float_value
        • Function TCOD_parse_integer_value
        • Function TCOD_parse_property_value
        • Function TCOD_parse_string_value
        • Function TCOD_parse_value_list_value
        • Function TCOD_parser_delete
        • Function TCOD_parser_error
        • Function TCOD_parser_get_bool_property
        • Function TCOD_parser_get_char_property
        • Function TCOD_parser_get_color_property
        • Function TCOD_parser_get_color_property_wrapper
        • Function TCOD_parser_get_custom_property
        • Function TCOD_parser_get_dice_property
        • Function TCOD_parser_get_dice_property_py
        • Function TCOD_parser_get_float_property
        • Function TCOD_parser_get_int_property
        • Function TCOD_parser_get_list_property
        • Function TCOD_parser_get_string_property
        • Function TCOD_parser_has_property
        • Function TCOD_parser_new
        • Function TCOD_parser_new_custom_type
        • Function TCOD_parser_new_struct
        • Function TCOD_parser_run
        • Function TCOD_path_compute
        • Function TCOD_path_delete
        • Function TCOD_path_get
        • Function TCOD_path_get_destination
        • Function TCOD_path_get_origin
        • Function TCOD_path_is_empty
        • Function TCOD_path_new_using_function
        • Function TCOD_path_new_using_map
        • Function TCOD_path_reverse
        • Function TCOD_path_size
        • Function TCOD_path_walk
        • Function TCOD_pf_compute
        • Function TCOD_pf_compute_step
        • Function TCOD_pf_delete
        • Function TCOD_pf_new
        • Function TCOD_pf_recompile
        • Function TCOD_pf_set_distance_pointer
        • Function TCOD_pf_set_graph2d_pointer
        • Function TCOD_pf_set_traversal_pointer
        • Function TCOD_printf_rgb
        • Function TCOD_printn_rgb
        • Function TCOD_quit
        • Function TCOD_random_delete
        • Function TCOD_random_dice_new
        • Function TCOD_random_dice_roll
        • Function TCOD_random_dice_roll_s
        • Function TCOD_random_get_double
        • Function TCOD_random_get_double_mean
        • Function TCOD_random_get_float
        • Function TCOD_random_get_float_mean
        • Function TCOD_random_get_instance
        • Function TCOD_random_get_int
        • Function TCOD_random_get_int_mean
        • Function TCOD_random_new
        • Function TCOD_random_new_from_seed
        • Function TCOD_random_restore
        • Function TCOD_random_save
        • Function TCOD_random_set_distribution
        • Function TCOD_renderer_init_sdl2
        • Function TCOD_renderer_init_sdl3
        • Function TCOD_renderer_init_xterm
        • Function TCOD_rng_splitmix64_next
        • Function TCOD_save_xp
        • Function TCOD_save_xp_to_memory
        • Function TCOD_sdl2_atlas_delete
        • Function TCOD_sdl2_atlas_new
        • Function TCOD_sdl2_render_texture
        • Function TCOD_sdl2_render_texture_setup
        • Function TCOD_semaphore_delete
        • Function TCOD_semaphore_lock
        • Function TCOD_semaphore_new
        • Function TCOD_semaphore_unlock
        • Function TCOD_set_default_tileset
        • Function TCOD_set_error
        • Function TCOD_set_errorf
        • Function TCOD_set_log_callback
        • Function TCOD_set_log_level
        • Function TCOD_strcasecmp
        • Function TCOD_strdup
        • Function TCOD_strncasecmp
        • Function TCOD_struct_add_flag
        • Function TCOD_struct_add_list_property
        • Function TCOD_struct_add_property
        • Function TCOD_struct_add_structure
        • Function TCOD_struct_add_value_list
        • Function TCOD_struct_add_value_list_sized
        • Function TCOD_struct_get_name
        • Function TCOD_struct_get_type
        • Function TCOD_struct_is_mandatory
        • Function TCOD_sys_accumulate_console
        • Function TCOD_sys_check_for_event
        • Function TCOD_sys_clipboard_get
        • Function TCOD_sys_clipboard_set
        • Function TCOD_sys_create_directory
        • Function TCOD_sys_delete_directory
        • Function TCOD_sys_delete_file
        • Function TCOD_sys_elapsed_milli
        • Function TCOD_sys_elapsed_seconds
        • Function TCOD_sys_file_exists
        • Function TCOD_sys_force_fullscreen_resolution
        • Function TCOD_sys_get_char_size
        • Function TCOD_sys_get_current_resolution
        • Function TCOD_sys_get_current_resolution_x
        • Function TCOD_sys_get_current_resolution_y
        • Function TCOD_sys_get_directory_content
        • Function TCOD_sys_get_fps
        • Function TCOD_sys_get_fullscreen_offsets
        • Function TCOD_sys_get_internal_console
        • Function TCOD_sys_get_internal_context
        • Function TCOD_sys_get_last_frame_length
        • Function TCOD_sys_get_num_cores
        • Function TCOD_sys_get_renderer
        • Function TCOD_sys_get_sdl_renderer
        • Function TCOD_sys_get_SDL_renderer
        • Function TCOD_sys_get_sdl_window
        • Function TCOD_sys_get_SDL_window
        • Function TCOD_sys_is_directory
        • Function TCOD_sys_process_key_event
        • Function TCOD_sys_process_mouse_event
        • Function TCOD_sys_read_file
        • Function TCOD_sys_register_SDL_renderer
        • Function TCOD_sys_save_screenshot
        • Function TCOD_sys_set_fps
        • Function TCOD_sys_set_renderer
        • Function TCOD_sys_shutdown
        • Function TCOD_sys_sleep_milli
        • Function TCOD_sys_startup
        • Function TCOD_sys_update_char
        • Function TCOD_sys_wait_for_event
        • Function TCOD_sys_write_file
        • Function TCOD_text_delete
        • Function TCOD_text_get
        • Function TCOD_text_init
        • Function TCOD_text_init2
        • Function TCOD_text_render
        • Function TCOD_text_reset
        • Function TCOD_text_set_colors
        • Function TCOD_text_set_pos
        • Function TCOD_text_set_properties
        • Function TCOD_text_update
        • Function TCOD_thread_delete
        • Function TCOD_thread_new
        • Function TCOD_thread_wait
        • Function TCOD_tileset_assign_tile
        • Function TCOD_tileset_delete
        • Function TCOD_tileset_get_tile
        • Function TCOD_tileset_load
        • Function TCOD_tileset_load_mem
        • Function TCOD_tileset_load_raw
        • Function TCOD_tileset_new
        • Function TCOD_tileset_notify_tile_changed
        • Function TCOD_tileset_observer_delete
        • Function TCOD_tileset_observer_new
        • Function TCOD_tileset_render_to_surface
        • Function TCOD_tileset_reserve
        • Function TCOD_tree_add_son
        • Function TCOD_tree_new
        • Function TCOD_viewport_delete
        • Function TCOD_viewport_new
        • Function TCOD_vprintf_rgb
        • Function TCOD_zip_delete
        • Function TCOD_zip_get_char
        • Function TCOD_zip_get_color
        • Function TCOD_zip_get_console
        • Function TCOD_zip_get_current_bytes
        • Function TCOD_zip_get_data
        • Function TCOD_zip_get_float
        • Function TCOD_zip_get_image
        • Function TCOD_zip_get_int
        • Function TCOD_zip_get_random
        • Function TCOD_zip_get_remaining_bytes
        • Function TCOD_zip_get_string
        • Function TCOD_zip_load_from_file
        • Function TCOD_zip_new
        • Function TCOD_zip_put_char
        • Function TCOD_zip_put_color
        • Function TCOD_zip_put_console
        • Function TCOD_zip_put_data
        • Function TCOD_zip_put_float
        • Function TCOD_zip_put_image
        • Function TCOD_zip_put_int
        • Function TCOD_zip_put_random
        • Function TCOD_zip_put_string
        • Function TCOD_zip_save_to_file
        • Function TCOD_zip_skip_bytes
      • Defines
      • Typedefs
libtcod
  • Library API
  • Function TCOD_context_recommended_console_size
  • View page source

Function TCOD_context_recommended_console_size¶

  • Defined in File context.h

Function Documentation¶

TCOD_Error TCOD_context_recommended_console_size(struct TCOD_Context *context, float magnification, int *columns, int *rows)

Set columns and rows to the recommended console size for this context.

magnification determines the apparent size of the tiles on the output. Values of 0.0f or lower will default to 1.0f.

Added in version 1.16.

Previous Next

© Copyright 2008-2022, Richard Tew.

Built with Sphinx using a theme provided by Read the Docs.