The Battle for Wesnoth  1.15.2+dev
Classes | Namespaces | Typedefs | Enumerations | Functions
picture.hpp File Reference
#include "map/location.hpp"
#include "terrain/translation.hpp"
#include <SDL2/SDL.h>
#include <unordered_map>
Include dependency graph for picture.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  image::cache_type< T >
 
class  image::locator
 
struct  image::locator::value
 
struct  image::manager
 the image manager is responsible for setting up images, and destroying all images when the program exits. More...
 

Namespaces

 image
 this module manages the cache of images.
 

Typedefs

typedef cache_type< surfaceimage::image_cache
 
typedef cache_type< bool > image::bool_cache
 
typedef std::map< t_translation::terrain_code, surfaceimage::mini_terrain_cache_map
 
typedef std::basic_string< signed char > image::light_string
 light_string store colors info of central and adjacent hexes. More...
 
typedef std::map< light_string, surfaceimage::lit_variants
 
typedef cache_type< lit_variants > image::lit_cache
 

Enumerations

enum  image::TYPE {
  image::UNSCALED, image::SCALED_TO_ZOOM, image::HEXED, image::SCALED_TO_HEX,
  image::TOD_COLORED, image::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  image::save_result { image::save_result::success, image::save_result::unsupported_format, image::save_result::save_failed, image::save_result::no_image }
 

Functions

surface image::load_from_disk (const locator &loc)
 
light_string image::get_light_string (int op, int r, int g, int b)
 return light_string of one light operation(see above) More...
 
void image::flush_cache ()
 
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. More...
 
void image::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 > & image::get_team_colors ()
 
void image::set_zoom (unsigned int zoom)
 sets the amount scaled images should be scaled. More...
 
surface image::get_image (const locator &i_locator, TYPE type=UNSCALED)
 function to get the surface corresponding to an image. More...
 
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. More...
 
surface image::get_hexmask ()
 function to get the standard hex mask More...
 
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. More...
 
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) More...
 
surface image::reverse_image (const surface &surf)
 function to reverse an image. More...
 
bool image::exists (const locator &i_locator)
 returns true if the given image actually exists, without loading it. More...
 
void image::precache_file_existence (const std::string &subdir="")
 precache the existence of files in the subdir (ex: "terrain/") More...
 
bool image::precached_file_exists (const std::string &file)
 
bool image::update_from_preferences ()
 initialize any private data, e.g. algorithm choices from preferences More...
 
save_result image::save_image (const locator &i_locator, const std::string &filename)
 
save_result image::save_image (const surface &surf, const std::string &filename)