this module manages the cache of images. More...
Classes | |
class | adjust_alpha_modification |
Adjust Alpha (ADJUST_ALPHA) modification. More... | |
class | adjust_channels_modification |
Adjust Channels (CHAN) modification. More... | |
struct | background_modification |
Fill background with a color (BG). More... | |
class | bl_modification |
Gaussian-like blur (BL) modification. More... | |
class | blend_modification |
Color blending (BLEND) modification. More... | |
class | blit_modification |
Scale (BLIT) modification. More... | |
class | bw_modification |
Black and white (BW) modification. More... | |
class | cache_type |
class | crop_modification |
Crop (CROP) modification. More... | |
class | cs_modification |
Color-shift (CS, R, G, B) modification. More... | |
class | fl_modification |
Mirror (FL) modification. More... | |
class | gs_modification |
Grayscale (GS) modification. More... | |
class | light_modification |
LIGHT (L) modification. More... | |
class | locator |
struct | manager |
the image manager is responsible for setting up images, and destroying all images when the program exits. More... | |
class | mask_modification |
Mask (MASK) modification. More... | |
class | modification |
Base abstract class for an image-path modification. More... | |
class | modification_queue |
A modified priority queue used to order image modifications. More... | |
class | negative_modification |
Make an image negative (NEG) More... | |
class | o_modification |
Opacity (O) modification. More... | |
class | pixel_callable |
class | plot_alpha_modification |
Plot Alpha (Alpha) modification. More... | |
class | rc_modification |
Recolor (RC/TC/PAL) modification. More... | |
class | rotate_modification |
Rotate (ROTATE) modification. More... | |
class | scale_exact_modification |
Scale exact modification. More... | |
class | scale_into_modification |
Scale into (SCALE_INTO) modification. More... | |
class | scale_modification |
Scaling modifications base class. More... | |
struct | sepia_modification |
Give to the image a sepia tint (SEPIA) More... | |
class | swap_modification |
Channel swap (SWAP). More... | |
class | wipe_alpha_modification |
Wipe Alpha (Wipe_Alpha) modification. More... | |
class | xbrz_modification |
xBRZ scale (xBRZ) modification More... | |
Typedefs | |
typedef cache_type< surface > | image_cache |
typedef cache_type< bool > | bool_cache |
typedef std::map< t_translation::terrain_code, surface > | mini_terrain_cache_map |
typedef std::basic_string< signed char > | light_string |
light_string store colors info of central and adjacent hexes. More... | |
typedef std::map< light_string, surface > | lit_variants |
typedef cache_type< lit_variants > | lit_cache |
Enumerations | |
enum | TYPE { UNSCALED, SCALED_TO_ZOOM, HEXED, SCALED_TO_HEX, TOD_COLORED, BRIGHTENED } |
UNSCALED : image will be drawn "as is" without changing size, even in case of redraw SCALED_TO_ZOOM : image will be scaled taking zoom into account HEXED : the hex mask is applied on the image SCALED_TO_HEX : image will be scaled to fit into a hex, taking zoom into account TOD_COLORED : same as SCALED_TO_HEX but ToD coloring is also applied BRIGHTENED : same as TOD_COLORED but also brightened. More... | |
enum | save_result { save_result::success, save_result::unsupported_format, save_result::save_failed, save_result::no_image } |
Functions | |
surface | getMinimap (int w, int h, const gamemap &map_, const team *vm=nullptr, const std::map< map_location, unsigned int > *reach_map=nullptr, bool ignore_terrain_disabled=false) |
function to create the minimap for a given map the surface returned must be freed by the user More... | |
void | flush_cache () |
static void | add_localized_overlay (const std::string &ovr_file, surface &orig_surf) |
static surface | load_image_file (const image::locator &loc) |
static surface | load_image_sub_file (const image::locator &loc) |
static surface | load_image_data_uri (const image::locator &loc) |
static signed char | col_to_uchar (int i) |
light_string | get_light_string (int op, int r, int g, int b) |
return light_string of one light operation(see above) More... | |
static surface | apply_light (surface surf, const light_string &ls) |
surface | load_from_disk (const locator &loc) |
void | set_color_adjustment (int r, int g, int b) |
will make all scaled images have these rgb values added to all their pixels. More... | |
void | set_team_colors (const std::vector< std::string > *colors=nullptr) |
set the team colors used by the TC image modification use a vector with one string for each team using nullptr will reset to default TC More... | |
const std::vector< std::string > & | get_team_colors () |
void | set_zoom (unsigned int zoom) |
sets the amount scaled images should be scaled. More... | |
static surface | get_hexed (const locator &i_locator) |
static surface | get_scaled_to_hex (const locator &i_locator) |
static surface | get_tod_colored (const locator &i_locator) |
static surface | get_scaled_to_zoom (const locator &i_locator) |
static surface | get_brightened (const locator &i_locator) |
static TYPE | simplify_type (const image::locator &i_locator, TYPE type) |
translate type to a simpler one when possible More... | |
surface | get_image (const locator &i_locator, TYPE type=UNSCALED) |
function to get the surface corresponding to an image. More... | |
surface | get_lighted_image (const image::locator &i_locator, const light_string &ls, TYPE type) |
function to get the surface corresponding to an image. More... | |
surface | get_hexmask () |
function to get the standard hex mask More... | |
bool | is_in_hex (const locator &i_locator) |
function to check if an image fit into an hex return false if the image has not the standard size. More... | |
bool | is_empty_hex (const locator &i_locator) |
function to check if an image is empty after hex cut should be only used on terrain image (cache the hex cut version) More... | |
surface | reverse_image (const surface &surf) |
function to reverse an image. More... | |
bool | exists (const locator &i_locator) |
returns true if the given image actually exists, without loading it. More... | |
static void | precache_file_existence_internal (const std::string &dir, const std::string &subdir) |
void | precache_file_existence (const std::string &subdir="") |
precache the existence of files in the subdir (ex: "terrain/") More... | |
bool | precached_file_exists (const std::string &file) |
save_result | save_image (const locator &i_locator, const std::string &filename) |
save_result | save_image (const surface &surf, const std::string &filename) |
Variables | |
mini_terrain_cache_map | mini_terrain_cache |
mini_terrain_cache_map | mini_fogged_terrain_cache |
mini_terrain_cache_map | mini_highlighted_terrain_cache |
static int | last_index_ = 0 |
this module manages the cache of images.
With an image name, you can get the surface corresponding to that image.
typedef cache_type<bool> image::bool_cache |
Definition at line 128 of file picture.hpp.
typedef cache_type<surface> image::image_cache |
Definition at line 127 of file picture.hpp.
typedef std::basic_string<signed char> image::light_string |
light_string store colors info of central and adjacent hexes.
The structure is one or several 4 chars blocks (L,R,G,B) where RGB is the color and L is the lightmap to use: -1: none 0: full hex 1-6: concave corners 7-12: convex half-corners 1 13-19: convex half-corners 2
Definition at line 143 of file picture.hpp.
typedef cache_type<lit_variants> image::lit_cache |
Definition at line 150 of file picture.hpp.
typedef std::map<light_string, surface> image::lit_variants |
Definition at line 148 of file picture.hpp.
typedef std::map<t_translation::terrain_code, surface> image::mini_terrain_cache_map |
Definition at line 130 of file picture.hpp.
|
strong |
Enumerator | |
---|---|
success | |
unsupported_format | |
save_failed | |
no_image |
Definition at line 217 of file picture.hpp.
enum image::TYPE |
UNSCALED : image will be drawn "as is" without changing size, even in case of redraw SCALED_TO_ZOOM : image will be scaled taking zoom into account HEXED : the hex mask is applied on the image SCALED_TO_HEX : image will be scaled to fit into a hex, taking zoom into account TOD_COLORED : same as SCALED_TO_HEX but ToD coloring is also applied BRIGHTENED : same as TOD_COLORED but also brightened.
Enumerator | |
---|---|
UNSCALED | |
SCALED_TO_ZOOM | |
HEXED | |
SCALED_TO_HEX | |
TOD_COLORED | |
BRIGHTENED |
Definition at line 185 of file picture.hpp.
|
static |
Definition at line 447 of file picture.cpp.
References filesystem::make_read_RWops(), and sdl_blit().
Referenced by load_image_file().
|
static |
Definition at line 608 of file picture.cpp.
References adjust_surface_color(), c, surface::clone(), get_lighted_image(), HEXED, i, light_surface(), p, and sdl_blit().
Referenced by get_lighted_image().
|
static |
Definition at line 591 of file picture.cpp.
Referenced by get_light_string().
bool image::exists | ( | const image::locator & | i_locator | ) |
returns true if the given image actually exists, without loading it.
Definition at line 1028 of file picture.cpp.
References gui2::cache, filesystem::get_binary_file_location(), image::locator::get_filename(), image::locator::get_type(), image::locator::is_data_uri(), and success.
Referenced by wesnothd::server::authenticate(), persist_file_context::clear_var(), filesystem::create_directory_if_missing(), filesystem::create_directory_if_missing_recursive(), addon_info::display_icon(), gui2::dialogs::game_load::display_savegame_internal(), filesystem::file_exists(), display::fill_images_list(), filesystem::find_other_version_saves_dirs(), filesystem::get_exe_dir(), display::get_fog_shroud_images(), filesystem::get_version_path_suffix(), image_exists(), ng::depcheck::MAKE_ENUM(), and gui2::dialogs::addon_manager::publish_addon().
void image::flush_cache | ( | ) |
Definition at line 225 of file picture.cpp.
Referenced by events::console_handler::do_refresh(), game_config_manager::load_game_config_for_game(), gui2::dialogs::title_screen::pre_show(), editor::editor_controller::refresh_image_cache(), game_config_manager::reload_changed_game_config(), and image::manager::~manager().
Definition at line 785 of file picture.cpp.
References brighten_image(), ftofxp, get_image(), game_config::hex_brightening, and TOD_COLORED.
Referenced by get_image().
Definition at line 742 of file picture.cpp.
References image::locator::add_to_cache(), image::locator::get_filename(), get_hexmask(), get_image(), mask_surface(), and UNSCALED.
Referenced by get_image().
surface image::get_hexmask | ( | ) |
function to get the standard hex mask
Definition at line 958 of file picture.cpp.
References get_image(), game_config::images::terrain_mask, and UNSCALED.
Referenced by get_hexed(), is_empty_hex(), is_in_hex(), load_image_sub_file(), and editor::mouse_action::set_terrain_mouse_overlay().
surface image::get_image | ( | const image::locator & | i_locator, |
TYPE | type | ||
) |
function to get the surface corresponding to an image.
Definition at line 833 of file picture.cpp.
References image::locator::add_to_cache(), BRIGHTENED, get_brightened(), get_hexed(), get_scaled_to_hex(), get_scaled_to_zoom(), get_tod_colored(), HEXED, image::locator::in_cache(), image::locator::is_void(), load_from_disk(), image::locator::locate_in_cache(), SCALED_TO_HEX, SCALED_TO_ZOOM, simplify_type(), TOD_COLORED, and UNSCALED.
Referenced by help::help_text_area::add_img_item(), draw_background(), unit_drawer::draw_bar(), gui::scrollbar::draw_contents(), editor::editor_display::draw_hex(), wb::attack::draw_hex(), wb::suppose_dead::draw_hex(), arrow::draw_hex(), game_display::draw_hex(), display::draw_hex(), editor::item_palette::draw_item(), editor::unit_palette::draw_item(), editor::terrain_palette::draw_item(), draw_label(), game_display::draw_movement_info(), draw_panel(), gui::menu::draw_row(), footsteps_images(), get_brightened(), display::get_flag(), display::get_fog_shroud_images(), get_hexed(), get_hexmask(), gui::menu::style::get_item_image(), get_lighted_image(), unit_frame::get_overlaped_hex(), get_scaled_to_hex(), get_scaled_to_zoom(), get_tod_colored(), getMinimap(), help::image_width(), game_launcher::init_video(), intf_get_image_size(), is_empty_hex(), is_in_hex(), gui::menu::imgsel_style::load_image(), load_image_file(), load_image_sub_file(), gui::button::load_images(), game_display::new_turn(), unit_frame::redraw(), unit_drawer::redraw_unit(), display::refresh_report(), halo::halo_impl::effect::render(), save_image(), gui::scrollbar::scrollbar(), editor::mouse_action_item::set_item_mouse_overlay(), editor::mouse_action_map_label::set_mouse_overlay(), editor::mouse_action_village::set_mouse_overlay(), editor::mouse_action_select::set_mouse_overlay(), editor::mouse_action_paste::set_mouse_overlay(), editor::mouse_action_starting_position::set_mouse_overlay(), editor::mouse_action::set_terrain_mouse_overlay(), editor::mouse_action_unit::set_unit_mouse_overlay(), and gui::tristate_button::tristate_button().
light_string image::get_light_string | ( | int | op, |
int | r, | ||
int | g, | ||
int | b | ||
) |
return light_string of one light operation(see above)
Definition at line 596 of file picture.cpp.
References col_to_uchar().
Referenced by display::draw_hex().
surface image::get_lighted_image | ( | const image::locator & | i_locator, |
const light_string & | ls, | ||
TYPE | type | ||
) |
function to get the surface corresponding to an image.
after applying the lightmap encoded in ls type should be HEXED or SCALED_TO_HEX
Definition at line 906 of file picture.cpp.
References image::locator::access_in_cache(), image::locator::add_to_cache(), apply_light(), get_image(), HEXED, image::locator::in_cache(), image::locator::is_void(), image::locator::locate_in_cache(), scale_surface_nn(), SCALED_TO_HEX, and game_config::tile_size.
Referenced by apply_light(), and display::draw_hex().
Definition at line 752 of file picture.cpp.
References get_image(), HEXED, and scale_surface_nn().
Referenced by get_image().
Definition at line 771 of file picture.cpp.
References get_image(), scale_surface_nn(), game_config::tile_size, and UNSCALED.
Referenced by get_image().
const std::vector< std::string > & image::get_team_colors | ( | ) |
Definition at line 717 of file picture.cpp.
Definition at line 765 of file picture.cpp.
References adjust_surface_color(), get_image(), and SCALED_TO_HEX.
Referenced by get_image().
surface image::getMinimap | ( | int | w, |
int | h, | ||
const gamemap & | map, | ||
const team * | vw, | ||
const std::map< map_location, unsigned int > * | reach_map, | ||
bool | ignore_terrain_disabled | ||
) |
function to create the minimap for a given map the surface returned must be freed by the user
Definition at line 39 of file minimap.cpp.
References adjust_surface_color(), preferences::allied_color(), color_t::b, gui2::cache, game_config::color_info(), DBG_DP, preferences::enemy_color(), sdl::fill_surface_rect(), team::fogged(), color_t::g, resources::gameboard, get_image(), team::get_minimap_color(), display::get_singleton(), terrain_type_data::get_terrain_info(), gamemap::h(), HEXED, i, terrain_type::id(), display::is_blindfolded(), terrain_type::is_combined(), team::is_enemy(), is_odd(), terrain_type::is_village(), mini_fogged_terrain_cache, mini_highlighted_terrain_cache, mini_terrain_cache, preferences::minimap_draw_terrain(), preferences::minimap_draw_villages(), terrain_type::minimap_image(), terrain_type::minimap_image_overlay(), preferences::minimap_movement_coding(), preferences::minimap_terrain_coding(), gamemap::on_board_with_border(), team::owns_village(), color_t::r, color_range::rep(), xbrz::scale(), scale_surface_sharp(), sdl_blit(), team::shrouded(), gamemap::tdata(), game_config::team_rgb_range, gui2::terrain, gamemap::total_height(), gamemap::total_width(), terrain_type_data::underlying_union_terrain(), preferences::unmoved_color(), display_context::village_owner(), t_translation::VOID_TERRAIN, and gamemap::w().
Referenced by display::draw_minimap(), and gui2::minimap::get_image().
bool image::is_empty_hex | ( | const locator & | i_locator | ) |
function to check if an image is empty after hex cut should be only used on terrain image (cache the hex cut version)
Definition at line 987 of file picture.cpp.
References image::locator::add_to_cache(), get_hexmask(), get_image(), HEXED, image::locator::in_cache(), image::locator::locate_in_cache(), and mask_surface().
Referenced by terrain_builder::tile::rebuild_cache().
bool image::is_in_hex | ( | const locator & | i_locator | ) |
function to check if an image fit into an hex return false if the image has not the standard size.
Definition at line 964 of file picture.cpp.
References image::locator::add_to_cache(), get_hexmask(), get_image(), image::locator::in_cache(), in_mask_surface(), image::locator::locate_in_cache(), and UNSCALED.
Referenced by unit_frame::get_overlaped_hex().
Definition at line 669 of file picture.cpp.
References image::locator::FILE, image::locator::get_type(), image::locator::is_data_uri(), load_image_data_uri(), load_image_file(), load_image_sub_file(), and image::locator::SUB_FILE.
Referenced by get_image().
|
static |
Definition at line 560 of file picture.cpp.
References base64::decode(), ERR_DP, utils::basic_string_view< charT, traits >::find(), image::locator::get_filename(), and utils::basic_string_view< charT, traits >::substr().
Referenced by load_from_disk().
|
static |
Definition at line 460 of file picture.cpp.
References add_localized_overlay(), game_config::debug, ERR_DP, filesystem::get_binary_file_location(), image::locator::get_filename(), get_image(), filesystem::get_localized_path(), filesystem::make_read_RWops(), game_config::images::missing, and UNSCALED.
Referenced by load_from_disk().
|
static |
Definition at line 496 of file picture.cpp.
References image::locator::add_to_cache(), sdl::create_rect(), cut_surface(), image::modification::decode(), e, image::modification_queue::empty(), ERR_CFG, image::locator::get_center_x(), image::locator::get_center_y(), image::locator::get_filename(), get_hexmask(), get_image(), image::locator::get_loc(), image::locator::get_modifications(), mask_surface(), image::modification::imod_exception::message, utils::parenthetical_split(), image::modification_queue::pop(), game_config::tile_size, image::modification_queue::top(), UNSCALED, map_location::valid(), map_location::x, and map_location::y.
Referenced by load_from_disk().
void image::precache_file_existence | ( | const std::string & | subdir | ) |
precache the existence of files in the subdir (ex: "terrain/")
Definition at line 1082 of file picture.cpp.
References filesystem::get_binary_paths(), p, and precache_file_existence_internal().
Referenced by terrain_builder::terrain_builder().
|
static |
Definition at line 1055 of file picture.cpp.
References d, filesystem::DONT_REORDER, f, filesystem::FILE_NAME_ONLY, filesystem::get_files_in_dir(), filesystem::is_directory(), and filesystem::NO_FILTER.
Referenced by precache_file_existence().
bool image::precached_file_exists | ( | const std::string & | file | ) |
function to reverse an image.
The image MUST have originally been returned from an image:: function. Returned images have the same semantics as for get_image()
Definition at line 1006 of file picture.cpp.
References flip_surface().
Referenced by halo::halo_impl::effect::render(), and display::render_image().
save_result image::save_image | ( | const locator & | i_locator, |
const std::string & | filename | ||
) |
Definition at line 1101 of file picture.cpp.
References get_image().
Referenced by editor::editor_controller::do_screenshot(), game_launcher::play_render_image_mode(), and gui2::dialogs::screenshot_notification::save_screenshot().
save_result image::save_image | ( | const surface & | surf, |
const std::string & | filename | ||
) |
Definition at line 1106 of file picture.cpp.
References filesystem::ends_with(), lg::err(), LOG_DP, filesystem::make_write_RWops(), no_image, save_failed, success, and unsupported_format.
void image::set_color_adjustment | ( | int | r, |
int | g, | ||
int | b | ||
) |
will make all scaled images have these rgb values added to all their pixels.
i.e. add a certain color hint to images. useful for representing day/night. Invalidates all scaled images.
Definition at line 694 of file picture.cpp.
Referenced by display::update_tod().
void image::set_team_colors | ( | const std::vector< std::string > * | colors | ) |
set the team colors used by the TC image modification use a vector with one string for each team using nullptr will reset to default TC
Definition at line 708 of file picture.cpp.
Referenced by do_gameloop(), and display::init_flags().
void image::set_zoom | ( | unsigned int | zoom | ) |
sets the amount scaled images should be scaled.
Invalidates all scaled images.
Definition at line 722 of file picture.cpp.
References game_config::tile_size.
Referenced by display::bounds_check_position(), display::display(), display::idle_anim_rate(), and display::set_zoom().
|
static |
translate type to a simpler one when possible
Definition at line 792 of file picture.cpp.
References BRIGHTENED, ftofxp, image::locator::get_loc(), game_config::hex_brightening, HEXED, SCALED_TO_HEX, SCALED_TO_ZOOM, game_config::tile_size, TOD_COLORED, UNSCALED, and map_location::valid().
Referenced by get_image().
|
static |
Definition at line 223 of file picture.cpp.
mini_terrain_cache_map image::mini_fogged_terrain_cache |
Definition at line 220 of file picture.cpp.
Referenced by getMinimap().
mini_terrain_cache_map image::mini_highlighted_terrain_cache |
Definition at line 221 of file picture.cpp.
Referenced by getMinimap().
mini_terrain_cache_map image::mini_terrain_cache |
Definition at line 219 of file picture.cpp.
Referenced by getMinimap().